Skip to content

Conversation

rishitej04
Copy link
Contributor

@rishitej04 rishitej04 commented Aug 18, 2025

This PR updates the existing doc/userdoc.rst for the joint_state_broadcaster.

What’s included

  • Added a new "Published topics" section:
    • /joint_states: publishes movement-related interfaces (position, velocity, effort).
    • /dynamic_joint_states: publishes all available state interfaces per joint,
      including custom ones (e.g., temperature, voltage, torque sensor readings).
  • Added a YAML-style example payload for clarity.
  • Added a note about the use_local_topics parameter.

Why

  • The previous documentation only stated that both topics are published but did not
    explain their contents in detail.
  • This clarification makes the documentation consistent with demos and API expectations
    and answers common questions from new users.

Fixes #1716

Copy link
Contributor

@christophfroehlich christophfroehlich left a comment

Choose a reason for hiding this comment

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

there is already a userdoc.rst file in the doc folder. please update it instead.

…terfaces) and add examples; note use_local_topics
@rishitej04 rishitej04 force-pushed the docs/joint-state-broadcaster-dynamic-topic branch from ba37856 to d53e542 Compare August 18, 2025 08:01
@rishitej04
Copy link
Contributor Author

yep done have a look at it and let me know

Copy link
Member

@bmagyar bmagyar left a comment

Choose a reason for hiding this comment

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

thank you!

@bmagyar bmagyar added backport-humble This label should be used by maintainers only! Label triggers PR backport to ROS2 humble. backport-jazzy labels Aug 26, 2025
@bmagyar bmagyar enabled auto-merge (squash) August 26, 2025 18:00
@bmagyar bmagyar disabled auto-merge August 26, 2025 18:00
@bmagyar bmagyar merged commit cd23dba into ros-controls:master Aug 26, 2025
4 checks passed
mergify bot pushed a commit that referenced this pull request Aug 26, 2025
bmagyar pushed a commit that referenced this pull request Aug 26, 2025
mergify bot pushed a commit that referenced this pull request Aug 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-humble This label should be used by maintainers only! Label triggers PR backport to ROS2 humble. backport-jazzy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation of joint_state_broadcaster
3 participants