Skip to content

Commit 3555685

Browse files
authored
added documentation on common controller parameters (#855)
1 parent b6841ea commit 3555685

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/controllers_index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,12 @@ In the sense of ros2_control, broadcasters are still controllers using the same
7272
IMU Sensor Broadcaster <../imu_sensor_broadcaster/doc/userdoc.rst>
7373
Joint State Broadcaster <../joint_state_broadcaster/doc/userdoc.rst>
7474
Range Sensor Broadcaster <../range_sensor_broadcaster/doc/userdoc.rst>
75+
76+
77+
Common Controller Parameters
78+
****************************
79+
80+
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.
81+
82+
* ``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.
83+
* ``is_async``: A boolean parameter that is needed to specify if the controller update needs to run asynchronously.

0 commit comments

Comments
 (0)