From 1f390c44f3b3dbc79e3014e5fa773b2856789cdc Mon Sep 17 00:00:00 2001 From: Tony Baltovski Date: Thu, 11 Sep 2025 17:32:50 -0400 Subject: [PATCH] Added setup path details for running clearpath_viz. --- .../version-ros2humble/ros/tutorials/rviz.mdx | 11 ++++++++++- .../version-ros2jazzy/ros/tutorials/rviz.mdx | 11 ++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/docs_versioned_docs/version-ros2humble/ros/tutorials/rviz.mdx b/docs_versioned_docs/version-ros2humble/ros/tutorials/rviz.mdx index 88451a44e..f0000012c 100644 --- a/docs_versioned_docs/version-ros2humble/ros/tutorials/rviz.mdx +++ b/docs_versioned_docs/version-ros2humble/ros/tutorials/rviz.mdx @@ -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 diff --git a/docs_versioned_docs/version-ros2jazzy/ros/tutorials/rviz.mdx b/docs_versioned_docs/version-ros2jazzy/ros/tutorials/rviz.mdx index b29f86951..6b04458cf 100644 --- a/docs_versioned_docs/version-ros2jazzy/ros/tutorials/rviz.mdx +++ b/docs_versioned_docs/version-ros2jazzy/ros/tutorials/rviz.mdx @@ -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