Skip to content

Commit

Permalink
added documentation on common controller parameters (#855)
Browse files Browse the repository at this point in the history
(cherry picked from commit 3555685)
  • Loading branch information
saikishor authored and mergify[bot] committed Nov 30, 2023
1 parent 1f93eb1 commit f99cfa5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/controllers_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,12 @@ In the sense of ros2_control, broadcasters are still controllers using the same
IMU Sensor Broadcaster <../imu_sensor_broadcaster/doc/userdoc.rst>
Joint State Broadcaster <../joint_state_broadcaster/doc/userdoc.rst>
Range Sensor Broadcaster <../range_sensor_broadcaster/doc/userdoc.rst>


Common Controller Parameters
****************************

Every controller and broadcaster has a few common parameters. They are optional, but if needed they have to be set before ``onConfigure`` transition to ``inactive`` state, see `lifecycle documents <https://design.ros2.org/articles/node_lifecycle.html>`__. Once the controllers are already loaded, this transition is done using the service ``configure_controller`` of the controller_manager.

* ``update_rate``: An unsigned integer parameter representing the rate at which every controller/broadcaster runs its update cycle. When unspecified, they run at the same frequency as the controller_manager.
* ``is_async``: A boolean parameter that is needed to specify if the controller update needs to run asynchronously.

0 comments on commit f99cfa5

Please sign in to comment.