Skip to content

Commit 0fe8cd7

Browse files
Added setup path details for running clearpath_viz. (#467)
1 parent 842d0d5 commit 0fe8cd7

File tree

2 files changed

+20
-2
lines changed
  • docs_versioned_docs

2 files changed

+20
-2
lines changed

docs_versioned_docs/version-ros2humble/ros/tutorials/rviz.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,18 @@ This launch file is used to visualize the robot model without needing a robot pr
2323
#### View Robot
2424

2525
```bash
26-
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000
26+
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000 setup_path:=SETUP_PATH
27+
2728
```
2829

30+
> Replace `SETUP_PATH` with the path to the directory where the `robot.yaml` is located.
31+
32+
> Do not include `~` in the `SETUP_PATH`, use `$HOME` instead.
33+
34+
> Make sure that `SETUP_PATH` ends with `/`.
35+
36+
> If following the [offboard computer setup instructions](../installation/offboard_pc.mdx), this will be `$HOME/clearpath`.
37+
2938
This launch file should be used when visualizing the robot while connected to the robot (wired or wirelessly). This will subscribe to topics from the robot to populate the visualization. Update the `namespace` parameter to match the robot's namespace.
3039

3140
#### View Navigation

docs_versioned_docs/version-ros2jazzy/ros/tutorials/rviz.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,18 @@ This launch file is used to visualize the robot model without needing a robot pr
2323
### View Robot
2424

2525
```bash
26-
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000
26+
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000 setup_path:=SETUP_PATH
27+
2728
```
2829

30+
> Replace `SETUP_PATH` with the path to the directory where the `robot.yaml` is located.
31+
32+
> Do not include `~` in the `SETUP_PATH`, use `$HOME` instead.
33+
34+
> Make sure that `SETUP_PATH` ends with `/`.
35+
36+
> If following the [offboard computer setup instructions](../installation/offboard_pc.mdx), this will be `$HOME/clearpath`.
37+
2938
This launch file should be used when visualizing the robot while connected to the robot (wired or wirelessly). This will subscribe to topics from the robot to populate the visualization. Update the `namespace` parameter to match the robot's namespace.
3039

3140
### View Navigation

0 commit comments

Comments
 (0)