Skip to content

Commit 5bef8b4

Browse files
authored
Fix broken links and text indentation in example_16 doc (#746)
1 parent d50a266 commit 5bef8b4

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

example_16/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# ros2_control_demo_example_16
22

3-
*DiffBot*, or ''Differential Mobile Robot'', is a simple mobile base with differential drive.
4-
The robot is basically a box moving according to differential drive kinematics.
3+
*DiffBot*, or ''Differential Mobile Robot'', is a simple mobile base with differential drive. This example shows how to create chained controllers using diff_drive_controller and pid_controllers to control a differential drive robot.
54

65
Find the documentation in [doc/userdoc.rst](doc/userdoc.rst) or on [control.ros.org](https://control.ros.org/master/doc/ros2_control_demos/example_16/doc/userdoc.html).

example_16/doc/userdoc.rst

+14-14
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Tutorial steps
2222

2323
1. To start *DiffBot* example open a terminal, source your ROS2-workspace and execute its launch file with
2424

25-
.. code-block:: shell
25+
.. code-block:: shell
2626
2727
ros2 launch ros2_control_demo_example_16 diffbot.launch.py
2828
@@ -34,13 +34,13 @@ Tutorial steps
3434

3535
2. Check controllers
3636

37-
.. code-block:: shell
37+
.. code-block:: shell
3838
3939
ros2 control list_controllers
4040
4141
You should get
4242

43-
.. code-block:: shell
43+
.. code-block:: shell
4444
4545
joint_state_broadcaster joint_state_broadcaster/JointStateBroadcaster active
4646
diffbot_base_controller diff_drive_controller/DiffDriveController active
@@ -49,7 +49,7 @@ Tutorial steps
4949
5050
3. Check the hardware interface loaded by opening another terminal and executing
5151

52-
.. code-block:: shell
52+
.. code-block:: shell
5353
5454
ros2 control list_hardware_interfaces
5555
@@ -99,7 +99,7 @@ Tutorial steps
9999
100100
6. Now we are ready to send a command to move the robot. Send a command to *Diff Drive Controller* by opening another terminal and executing
101101

102-
.. code-block:: shell
102+
.. code-block:: shell
103103
104104
ros2 topic pub --rate 10 /cmd_vel geometry_msgs/msg/TwistStamped "
105105
twist:
@@ -181,31 +181,31 @@ Before we proceed, we stop all previous steps from terminal and start from the b
181181

182182
1. To start *DiffBot* example open a terminal, source your ROS2-workspace and execute its launch file with
183183

184-
.. code-block:: shell
184+
.. code-block:: shell
185185
186186
ros2 launch ros2_control_demo_example_16 diffbot.launch.py
187187
188-
Like before, if you can see an orange box in *RViz*, everything has started properly.
188+
Like before, if you can see an orange box in *RViz*, everything has started properly.
189189

190190
2. To start the plotjuggler with a provided layout file(plotjuggler.xml), open another terminal and run following command.
191191

192-
.. code-block:: shell
192+
.. code-block:: shell
193193
194194
ros2 run plotjuggler plotjuggler --layout $(ros2 pkg prefix ros2_control_demo_example_16 --share)/config/plotjuggler.xml
195195
196-
After this, you will see a few dialogs popping up. For example:
196+
After this, you will see a few dialogs popping up. For example:
197197

198-
.. code-block:: shell
198+
.. code-block:: shell
199199
200200
Start the previously used streaming plugin?
201201
202202
ROS2 Topic Subscriber
203203
204-
Click 'Yes' for the first dialog and 'OK" to the following two dialogs, then you will see the plotjuggler window.
204+
Click 'Yes' for the first dialog and 'OK" to the following two dialogs, then you will see the plotjuggler window.
205205

206206
3. To enable feedforward mode and published a command to move the robot, instead of doing these manually, we will use the demo_test.launch.py. Open another terminal and execute
207207

208-
.. code-block:: shell
208+
.. code-block:: shell
209209
210210
ros2 launch ros2_control_demo_example_16 demo_test.launch.py
211211
@@ -217,7 +217,7 @@ Click 'Yes' for the first dialog and 'OK" to the following two dialogs, then you
217217

218218
5. Change the ``gains`` in the ``diffbot_chained_controllers.yaml`` file with some different values, repeat above steps and observe its effect to the pid_controller commands. For example, to change the ``feedforward_gain`` of the right wheel to 0.50, you can use the following command:
219219

220-
.. code-block:: shell
220+
.. code-block:: shell
221221
222222
ros2 param set /pid_controller_right_wheel_joint gains.right_wheel_joint.feedforward_gain 0.50
223223
@@ -226,7 +226,7 @@ Files used for this demo
226226
--------------------------
227227

228228
* Launch file: `diffbot.launch.py <https://github.com/ros-controls/ros2_control_demos/tree/{REPOS_FILE_BRANCH}/example_16/bringup/launch/diffbot.launch.py>`__
229-
* Controllers yaml: `diffbot_chained_controllers.yaml <https://github.com/ros-controls/ros2_control_demos/tree/{REPOS_FILE_BRANCH}/example_16/config/diffbot_chained_controllers.yaml>`__
229+
* Controllers yaml: `diffbot_chained_controllers.yaml <https://github.com/ros-controls/ros2_control_demos/tree/{REPOS_FILE_BRANCH}/example_16/bringup/config/diffbot_chained_controllers.yaml>`__
230230
* URDF file: `diffbot.urdf.xacro <https://github.com/ros-controls/ros2_control_demos/tree/{REPOS_FILE_BRANCH}/example_16/description/urdf/diffbot.urdf.xacro>`__
231231

232232
* Description: `diffbot_description.urdf.xacro <https://github.com/ros-controls/ros2_control_demos/tree/{REPOS_FILE_BRANCH}/ros2_control_demo_description/diffbot/urdf/diffbot_description.urdf.xacro>`__

0 commit comments

Comments
 (0)