Skip to content

Extend how to manipulate parameters at runtime to mention ability to do so from client libraries #5761

@tfoote

Description

@tfoote

Issue Type

  • 🐛 Bug / Problem
  • ✏️ Typo / Grammar
  • 📖 Outdated Content
  • 🚀 Enhancement

Generated by Generative AI

No

Distribution

Rolling et al

Description

The parameter capabilities include the ability to interact with them at runtime from all the client libraries.

However the default parameter documentation doesn't mention that in the section: Manipulating parameter values at runtime

https://docs.ros.org/en/rolling/Concepts/Basic/About-Parameters.html#manipulating-parameter-values-at-runtime

https://github.com/ros2/ros2_documentation/blob/c8a8a89eb78503f22381bb9ee03c0b748d414255/source/Concepts/Basic/About-Parameters.rst?plain=1#L113C3-L119

Affected Pages/Sections

https://docs.ros.org/en/rolling/Concepts/Basic/About-Parameters.html#manipulating-parameter-values-at-runtime

Screenshots or Examples (if applicable)

No response

Suggested Fix

It would be good to add documentation to mention that and give pointers to some of the client libraries.

Similar to ROS 1 wiki:

Parameter Tools
The [rosparam](https://wiki.ros.org/rosparam) command-line tool enables you to query and set parameters on the Parameter Server using YAML syntax.


Client Library Support

Python
See the [rospy overview](https://wiki.ros.org/rospy/Overview/Parameter%20Server).


C++
See the [roscpp overview](https://wiki.ros.org/roscpp/Overview/Parameter%20Server).


Lisp
See [roslisp/Overview/Parameters](https://wiki.ros.org/roslisp/Overview/Parameters)

Additional Context

This came from this question where the asker didn't know that there was convenient ways to set parameters: https://robotics.stackexchange.com/questions/113686/c-equivalent-of-ros2-params-load

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions