Remove ROS 2 topic parameters in favor of standard remapping#343
Remove ROS 2 topic parameters in favor of standard remapping#343sgrizan-nv merged 2 commits intomainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR removes runtime ROS 2 parameters for teleop topic names in the teleop_ros2_publisher node, hardcodes those topic names, and updates README to remove topic parameters, add remapping guidance, and show example Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
examples/teleop_ros2/README.md (1)
75-88:⚠️ Potential issue | 🟡 MinorDocument topic remapping explicitly in this section.
After removing topic parameters, users need a concrete replacement workflow here (e.g.,
--ros-args -r old:=new). Line 88 updates the parameter list, but the section does not yet show the new remapping path.📘 Proposed README addition
### Overriding parameters It's possible to set ROS 2 parameters from the command line when running the container. Append `--ros-args -p param_name:=value` after the image name: @@ Available parameters: `rate_hz`, `mode`, `world_frame`, `right_wrist_frame`, `left_wrist_frame`. Use `ros2 param list /teleop_ros2_publisher` and `ros2 param describe /teleop_ros2_publisher <param>` (with the node running) for the full set. + +Topic names are no longer ROS parameters. Use standard ROS 2 remapping instead, for example: + +```bash +teleop_ros2_ref --ros-args \ + -r xr_teleop/hand:=my_robot/hand \ + -r xr_teleop/ee_poses:=my_robot/ee_poses +```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/teleop_ros2/README.md` around lines 75 - 88, The README's "Overriding parameters" section mentions runtime parameter overrides but no longer documents how to remap topics after topic parameters were removed; update the paragraph for the container run example (referencing the teleop_ros2_ref invocation) to include a concrete topic-remapping example using ROS 2 remap arguments (e.g., use --ros-args -r old_topic:=new_topic) and show remapping of xr_teleop/hand and xr_teleop/ee_poses to user topics (use the -r flag twice), and also note users can inspect active remaps with ros2 node info /teleop_ros2_publisher or similar if needed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/teleop_ros2/python/teleop_ros2_publisher.py`:
- Around line 451-467: Update the stale wording in the module/class docstrings
and inline comments in teleop_ros2_publisher.py (any text referring to
"configurable via parameters" for topics like self._pub_hand, self._pub_ee_pose,
self._pub_root_twist, self._pub_root_pose, self._pub_controller,
self._pub_full_body, self._pub_finger_joints) to say "remappable via ROS 2
remapping" instead; search the file for phrases mentioning "configurable via
parameters" or "configurable via parameter" and replace them with "remappable
via ROS 2 remapping" or equivalent concise wording so the documentation reflects
the removed parameter-based topic configuration.
---
Outside diff comments:
In `@examples/teleop_ros2/README.md`:
- Around line 75-88: The README's "Overriding parameters" section mentions
runtime parameter overrides but no longer documents how to remap topics after
topic parameters were removed; update the paragraph for the container run
example (referencing the teleop_ros2_ref invocation) to include a concrete
topic-remapping example using ROS 2 remap arguments (e.g., use --ros-args -r
old_topic:=new_topic) and show remapping of xr_teleop/hand and
xr_teleop/ee_poses to user topics (use the -r flag twice), and also note users
can inspect active remaps with ros2 node info /teleop_ros2_publisher or similar
if needed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 4e4cc1ed-3cc4-4ce9-b64c-e8befa898c2c
📒 Files selected for processing (2)
examples/teleop_ros2/README.mdexamples/teleop_ros2/python/teleop_ros2_publisher.py
a0fb72c to
db70def
Compare
Remove redundant topic parameters from the ROS 2 publisher node and its documentation, relying on standard ROS 2 topic remapping
Summary by CodeRabbit
Documentation
Changes