Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
saikishor committed Feb 11, 2025
1 parent 3c36a4e commit 5b6fb02
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ class ControllerManager : public rclcpp::Node
* The method is used to get the clock that is used for triggering the controllers and the
* hardware components.
*
* @note When the controller manager is used with real-time kernel, the trigger clock should be
* monotonic and not affected by the system time changes. Otherwise, the clock should be ROS Clock
* @note When the use_sim_time parameter is set to true, the clock will be the ROS clock.
* Otherwise, the clock will be the Steady Clock.
*
* \returns trigger clock of the controller manager.
*/
Expand Down
2 changes: 1 addition & 1 deletion doc/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ controller_manager
* The ``--service-call-timeout`` was added as parameter to the helper scripts ``spawner.py``. Useful when the CPU load is high at startup and the service call does not return immediately (`#1808 <https://github.com/ros-controls/ros2_control/pull/1808>`_).
* The ``cpu_affinity`` parameter can now accept of types ``int`` or ``int_array`` to bind the process to a specific CPU core or multiple CPU cores. (`#1915 <https://github.com/ros-controls/ros2_control/pull/1915>`_).
* A python module ``test_utils`` was added to the ``controller_manager`` package to help with integration testing (`#1955 <https://github.com/ros-controls/ros2_control/pull/1955>`_).
* When a realtime kernel is present, the controller manager will use a monotonic clock for triggering read-update-write cycles (`#2046 <https://github.com/ros-controls/ros2_control/pull/2046>`_).
* The controller manager will use a monotonic clock for triggering read-update-write cycles, but when the ``use_sim_time`` parameter is set to true, it will use the ROS Clock (`#2046 <https://github.com/ros-controls/ros2_control/pull/2046>`_).

hardware_interface
******************
Expand Down

0 comments on commit 5b6fb02

Please sign in to comment.