Skip to content

Commit 018448f

Browse files
Update nav2_bringup docs to include updated robot string. (#5001)
Signed-off-by: Leander Stephen D'Souza <[email protected]>
1 parent 2cd166f commit 018448f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

nav2_bringup/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,15 @@ This is how to launch multi-robot simulation with simple command line. Please se
2525
#### Cloned
2626

2727
This allows to bring up multiple robots, cloning a single robot N times at different positions in the map. The parameter are loaded from `nav2_multirobot_params_all.yaml` file by default.
28-
The multiple robots that consists of name and initial pose in YAML format will be set on the command-line. The format for each robot is `robot_name={x: 0.0, y: 0.0, yaw: 0.0, roll: 0.0, pitch: 0.0, yaw: 0.0}`.
28+
The multiple robots that consists of name and initial pose in YAML format will be set on the command-line. The format for each robot is `{name: 'robot_name', pose: {x: 0.0, y: 0.0, z: 0.0, roll: 0.0, pitch: 0.0, yaw: 0.0}}`.
2929

3030
Please refer to below examples.
3131

3232
```shell
33-
ros2 launch nav2_bringup cloned_multi_tb3_simulation_launch.py robots:="robot1={x: 1.0, y: 1.0, yaw: 1.5707}; robot2={x: 1.0, y: 1.0, yaw: 1.5707}"
33+
ros2 launch nav2_bringup cloned_multi_tb3_simulation_launch.py \
34+
robots:="\
35+
{name: 'robot1', pose: {x: 1.0, y: 1.0, yaw: 1.5707}}; \
36+
{name: 'robot2', pose: {x: 1.0, y: 1.0, yaw: 1.5707}}"
3437
```
3538

3639
#### Unique

0 commit comments

Comments
 (0)