Skip to content

ROS: Standardize hand and EE pose topics with NamedPoseArray#755

Open
sgrizan-nv wants to merge 8 commits into
mainfrom
sgrizan/branch2
Open

ROS: Standardize hand and EE pose topics with NamedPoseArray#755
sgrizan-nv wants to merge 8 commits into
mainfrom
sgrizan/branch2

Conversation

@sgrizan-nv

@sgrizan-nv sgrizan-nv commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Description

Fixes #645

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Testing

Manual & integration testing

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

Summary by CodeRabbit

  • New Features

    • Added NamedPoseArray message support (names alongside poses and per-entry validity).
    • Unified end-effector publishing on xr_teleop/ee_pose using NamedPoseArray.
    • Updated hand publishing to named left/right joint poses on xr_teleop/hand using NamedPoseArray.
    • Added the teleop_ros2_interfaces ROS 2 package and installation of its interfaces for examples/teleop_ros2.
  • Bug Fixes

    • Strengthened runtime topic verification (frame, name ordering/uniqueness, array consistency, and validity/non-zero pose expectations).
  • Documentation

    • Updated README topics, remapping examples, and echo guidance to match the new message format and topic names.

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c5122b12-b385-4701-9ff0-83c36a92b658

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds the NamedPoseArray ROS 2 interface and packages it for installation. Teleoperation builders now emit named left/right EE and hand poses with validity flags. The node publishes unified xr_teleop/ee_pose and named xr_teleop/hand messages, while wrist transforms derive from unified EE data. Integration validators, README topic contracts, Docker setup, and source guidance are updated accordingly.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant TeleopRos2Node
  participant MessageBuilders
  participant NamedPoseTopics
  participant WristTFBroadcaster
  TeleopRos2Node->>MessageBuilders: Build NamedPoseArray
  MessageBuilders-->>TeleopRos2Node: Return named poses and validity flags
  TeleopRos2Node->>NamedPoseTopics: Publish xr_teleop/ee_pose or xr_teleop/hand
  TeleopRos2Node->>WristTFBroadcaster: Broadcast wrist transforms
Loading
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 11.11% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: standardizing ROS hand and EE pose topics with NamedPoseArray.
Linked Issues check ✅ Passed The PR satisfies #645 by replacing PoseArray-based EE and hand messaging with a custom NamedPoseArray that includes a header/frame ID.
Out of Scope Changes check ✅ Passed The changed docs, tests, build files, and runtime code all support the NamedPoseArray interface work and do not appear unrelated.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sgrizan/branch2

Comment @coderabbitai help to get the list of available commands.

@sgrizan-nv sgrizan-nv changed the title ROS: Publish hand joint poses in separate topics ROS: Standardize hand and EE pose topics with NamedPoseArray Jul 13, 2026
@sgrizan-nv

Copy link
Copy Markdown
Collaborator Author

@coderabbitai help

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

CodeRabbit commands

These commands are invoked using PR/Issue comments.

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai rate limit to show your current review rate limit status.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai evaluate custom pre-merge check --instructions <custom-checks-instructions> --name <custom-checks-title> [--mode <error|warning>] to validate the custom pre-merge checks instructions. Defaults to error when --mode is omitted.
  • @coderabbitai ignore pre-merge checks to override pre-merge checks and get an approval on PR.
  • @coderabbitai run pre-merge checks to run pre-merge checks on the pull request.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai emit path instructions to emit generated path-specific review instructions for this repository.
  • @coderabbitai resolve merge conflict to automatically resolve merge conflicts.
  • @coderabbitai autofix to automatically fix issues identified in unresolved review comments.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai generate configuration to create a PR that adds the current resolved configuration as .coderabbit.yaml (or show it if already present).
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, support, documentation and community

  • Visit our status page to check the current availability of CodeRabbit.
  • Create a ticket on our support page for assistance with any issues or questions.
  • Visit our documentation site for detailed information on how to use CodeRabbit.
  • Join our Discord community to connect with other users and get help from the community.
  • Follow us on X/Twitter for updates and announcements.

@sgrizan-nv

Copy link
Copy Markdown
Collaborator Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Full review finished.

@@ -0,0 +1,8 @@
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: we should consider renaming this

Some options are:

Not sure what else, but we should look at what other ROS Msgs are available and trying to have a similar name to that basically

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'm not happy with the current name either, but it doesn't feel like either PoseStampedArray or LinkState describe this message better

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious what Lionel thinks a better name is since I agree that those two message names aren't ideal either

<name>teleop_ros2_interfaces</name>
<version>0.1.0</version>
<description>Custom ROS 2 interfaces for the Isaac Teleop ROS 2 example.</description>
<maintainer email="isaacteleop-maintainers@nvidia.com">Isaac Teleop Maintainers</maintainer>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the email actually work?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, we don't have an alias. Changed it to my email address

Comment thread examples/teleop_ros2/teleop_ros2_interfaces/package.xml Outdated
Comment thread examples/teleop_ros2/teleop_ros2_interfaces/CMakeLists.txt Outdated
Comment thread examples/teleop_ros2/Dockerfile Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@examples/teleop_ros2/teleop_ros2_interfaces/package.xml`:
- Around line 13-21: Update the package.xml dependency declarations: replace the
separate build_depend and exec_depend entries for geometry_msgs and std_msgs
with <depend> entries, and move rosidl_default_generators from build_depend to
buildtool_depend alongside ament_cmake. Preserve rosidl_default_runtime as an
exec_depend.
🪄 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: CHILL

Plan: Enterprise

Run ID: a2f80567-1198-4360-a56c-08f64aef76a9

📥 Commits

Reviewing files that changed from the base of the PR and between 615cf8c and 7ab32a5.

📒 Files selected for processing (11)
  • examples/teleop_ros2/AGENTS.md
  • examples/teleop_ros2/CMakeLists.txt
  • examples/teleop_ros2/Dockerfile
  • examples/teleop_ros2/README.md
  • examples/teleop_ros2/python/constants.py
  • examples/teleop_ros2/python/integration_tests/teleop_ros2_topic_verifier.py
  • examples/teleop_ros2/python/messages.py
  • examples/teleop_ros2/python/teleop_ros2_node.py
  • examples/teleop_ros2/teleop_ros2_interfaces/CMakeLists.txt
  • examples/teleop_ros2/teleop_ros2_interfaces/msg/NamedPoseArray.msg
  • examples/teleop_ros2/teleop_ros2_interfaces/package.xml

Comment thread examples/teleop_ros2/teleop_ros2_interfaces/package.xml Outdated
SPDX-License-Identifier: Apache-2.0
-->
<package format="3">
<name>teleop_ros2_interfaces</name>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would we want to rename this package into something else? The current name is fine, but another name could be:

  • isaac_teleop_ros2_interfaces

Comment on lines +39 to +43
def _compose_ee_msg(
left_pose: Pose | None,
right_pose: Pose | None,
now,
frame_id: str,

@kajananchinniahNV kajananchinniahNV Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: could we make the interface of this into:

def _compose_ee_msg(pose, name, frame_id) 

instead and then just call it twice:
_compose_ee_msg(left_pose, "left", now, frame_id)
_compose_ee_msg(right_pose, "right", now, frame_id)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_compose_ee_msg produces one NamedPoseArray. Calling it twice will produce two NamedPoseArrays

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarified what I meant here: #755 (comment)

We can discuss it offline if it's still not clear; it's mostly just an idea for restructuring the code not changing the final output

Comment on lines +186 to +188
def build_ee_msg_from_controllers(
left_ctrl: OptionalTensorGroup,
right_ctrl: OptionalTensorGroup,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we keep the call here the same as before and just call it twice?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build_ee_msg_from_controllers and build_ee_msg_from_hands package left and right poses into the same NamedPoseArray, just as it was with PoseArray. Do you suggest splitting both EEs and hand poses into two topics (left and right)?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think keeping them in the same namedposearray makes sense; although we can have the hand poses in a separate topic (similar to how it was before)

The proposal is just changing it in code so it looks structually like:

named_pose_msg = NamedPoseMessage()
left_pose = build_left_msg()
right_pose = build_right_msg()
named_pose_msg.append([left_pose, right_pose])

Admittedly since we are doing the message as an structure of arrays it might not fit as nicely but I'd prefer trying to make things generic until we can't - since I feel like it'd support non-bimanual cases in the future easier

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current approach is to isolate all message building logic in messages.py, so that downstream functions just send it over without modifying. Any common logic between different builders is extracted into private functions within messages.py

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would accepting an array instead make sense here or do you think we should just resolve this for now until we explicitly want to support non-bimanual cases? That case is the main reason I'm worried

I think we can resolve this for now however

Comment thread examples/teleop_ros2/python/messages.py
Comment thread examples/teleop_ros2/python/messages.py
@sgrizan-nv

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@kajananchinniahNV kajananchinniahNV left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM beyond the minor nitpicks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: TBD

Development

Successfully merging this pull request may close these issues.

Standardize interfaces for EE poses and hand commands in ROS or introduce custom messages

2 participants