Browse Source

Included the breakdown of the move.py node

pull/1/head
hello-sanchez 3 years ago
parent
commit
4712309d3d
1 changed files with 90 additions and 36 deletions
  1. +90
    -36
      example_1.md

+ 90
- 36
example_1.md View File

@ -1,75 +1,129 @@
## Example 1
![image](images/move.gif)
![image](images/move_stretch.gif)
The goal of this example to give you an enhance understanding how to control the mobile base by sending `Twist` messages to a Stretch robot.
First, bringup [Stretch in the empty world simulation](getting_started). Open a new terminal and go into the *src* folder where the [move](src/move.py) node is located. To drive the robot forward, type the following in the terminal.
To drive the robot forward, type the following in the terminal.
<!-- Open a new terminal and go into the *src* folder where the [move](src/move.py) node is located. -->
```
cd catkin_ws/src/stretch_ros_turotials/src/
python move.py
```
This will drive the robot forward ...
### The Code
Below is the code and it will drive the robot forward.
```python
#!/usr/bin/env python
# Every python controller needs these lines
import rospy
# The Twist message is used to send velocities to the robot.
from geometry_msgs.msg import Twist
class Move:
def __init__(self):
# Setup a publisher that will send the velocity commands for the Stretch
# This will publish on a topic called "/stretch_diff_drive_controller/cmd_vel"
# with a message type Twist.
self.pub = rospy.Publisher('/stretch_diff_drive_controller/cmd_vel', Twist, queue_size=1)
self.pub = rospy.Publisher('/stretch/cmd_vel', Twist, queue_size=1) #/stretch_diff_drive_controller/cmd_vel for gazebo
def move_forward(self):
# Make a Twist message. We're going to set all of the elements, since we
# can't depend on them defaulting to safe values.
command = Twist()
# A Twist has three linear velocities (in meters per second), along each of the axes.
# For Stretch, it will only pay attention to the x velocity, since it can't
# directly move in the y direction or the z direction.
command.linear.x = 0.1
command.linear.y = 0.0
command.linear.z = 0.0
# A Twist also has three rotational velocities (in radians per second).
# The Stretch will only respond to rotations around the z (vertical) axis.
command.angular.x = 0.0
command.angular.y = 0.0
command.angular.z = 0.0
# Publish the Twist commands
self.pub.publish(command)
if __name__ == '__main__':
# Initialize the node, and call it "move".
rospy.init_node('move')
# Setup Move class to base_motion
base_motion = Move()
# Rate allows us to control the (approximate) rate at which we publish things.
# For this example, we want to publish at 10Hz.
rate = rospy.Rate(10)
# This will loop until ROS shuts down the node. This can be done on the
# command line with a ctrl-C, or automatically from roslaunch.
while not rospy.is_shutdown():
# Run the move_foward function in the Move class
base_motion.move_forward()
# Do an idle wait to control the publish rate. If we don't control the
# rate, the node will publish as fast as it can, and consume all of the
# available CPU resources. This will also add a lot of network traffic,
# possibly slowing down other things.
rate.sleep()
```
<!-- Don't forget to make the node executable:
```
chmod +x move.py
``` -->
### The Code Explained
Now let's break the code down.
```python
#!/usr/bin/env python
```
Every Python ROS [Node](http://wiki.ros.org/Nodes) will have this declaration at the top. The first line makes sure your script is executed as a Python script.
```python
import rospy
from geometry_msgs.msg import Twist
```
You need to import rospy if you are writing a ROS Node. The geometry_msgs.msg import is so that we can send velocities for to the robot.
```python
class Move:
def __init__(self):
self.pub = rospy.Publisher('/stretch/cmd_vel', Twist, queue_size=1)
```
This section of code defines the talker's interface to the rest of ROS. pub = rospy.Publisher("/stretch/cmd_vel", Twist, queue_size=1) declares that your node is publishing to the /stretch/cmd_vel topic using the message type Twist. The queue_size argument limits the amount of queued messages if any subscriber is not receiving them fast enough.
```Python
command = Twist()
```
Make a Twist message. We're going to set all of the elements, since we
can't depend on them defaulting to safe values.
```python
command.linear.x = 0.1
command.linear.y = 0.0
command.linear.z = 0.0
```
A Twist has three linear velocities (in meters per second), along each of the axes. For Stretch, it will only pay attention to the x velocity, since it can't directly move in the y direction or the z direction.
```python
command.angular.x = 0.0
command.angular.y = 0.0
command.angular.z = 0.0
```
A Twist also has three rotational velocities (in radians per second).
The Stretch will only respond to rotations around the z (vertical) axis.
```python
self.pub.publish(command)
```
Publish the Twist commands in the previously defined topic name */stretch/cmd_vel*.
```Python
rospy.init_node('move')
base_motion = Move()
rate = rospy.Rate(10)
```
The next line, rospy.init_node(NAME, ...), is very important as it tells rospy the name of your node -- until rospy has this information, it cannot start communicating with the ROS Master. In this case, your node will take on the name talker. NOTE: the name must be a base name, i.e. it cannot contain any slashes "/".
The `rospy.Rate()` function creates a Rate object rate. With the help of its method sleep(), it offers a convenient way for looping at the desired rate. With its argument of 10, we should expect to go through the loop 10 times per second (as long as our processing time does not exceed 1/10th of a second!)
```python
while not rospy.is_shutdown():
base_motion.move_forward()
rate.sleep()
```
This loop is a fairly standard rospy construct: checking the rospy.is_shutdown() flag and then doing work. You have to check is_shutdown() to check if your program should exit (e.g. if there is a Ctrl-C or otherwise). The loop calls rate.sleep(), which sleeps just long enough to maintain the desired rate through the loop.
## Move Stretch in Simulation
![image](images/move.gif)
First, bringup [Stretch in the empty world simulation](getting_started).

Loading…
Cancel
Save