Skip to content

Added setup path details for running clearpath_viz. #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2025
Merged

Added setup path details for running clearpath_viz. #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs_versioned_docs/version-ros2humble/ros/tutorials/rviz.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,18 @@ This launch file is used to visualize the robot model without needing a robot pr
#### View Robot

```bash
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000 setup_path:=SETUP_PATH

```

> Replace `SETUP_PATH` with the path to the directory where the `robot.yaml` is located.

> Do not include `~` in the `SETUP_PATH`, use `$HOME` instead.

> Make sure that `SETUP_PATH` ends with `/`.

> If following the [offboard computer setup instructions](../installation/offboard_pc.mdx), this will be `$HOME/clearpath`.

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.

#### View Navigation
Expand Down
11 changes: 10 additions & 1 deletion docs_versioned_docs/version-ros2jazzy/ros/tutorials/rviz.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,18 @@ This launch file is used to visualize the robot model without needing a robot pr
### View Robot

```bash
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000
ros2 launch clearpath_viz view_robot.launch.py namespace:=a200_0000 setup_path:=SETUP_PATH

```

> Replace `SETUP_PATH` with the path to the directory where the `robot.yaml` is located.

> Do not include `~` in the `SETUP_PATH`, use `$HOME` instead.

> Make sure that `SETUP_PATH` ends with `/`.

> If following the [offboard computer setup instructions](../installation/offboard_pc.mdx), this will be `$HOME/clearpath`.

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.

### View Navigation
Expand Down