Skip to content

Commit

Permalink
Add gpio_controllers to the release_notes and add minor fixes to the …
Browse files Browse the repository at this point in the history
…userdoc
  • Loading branch information
Wiktor-99 committed Nov 18, 2024
1 parent 2f49765 commit 5c32a72
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions doc/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,7 @@ steering_controllers_library
tricycle_controller
************************
* tricycle_controller now uses generate_parameter_library (`#957 <https://github.com/ros-controls/ros2_controllers/pull/957>`_).

gpio_controllers
************************
* The GPIO command controller was added 🎉 (`#1251 <https://github.com/ros-controls/ros2_controllers/pull/1251>`_).
4 changes: 2 additions & 2 deletions gpio_controllers/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Description of controller's interfaces
Parameters
^^^^^^^^^^^^^^^^^^^^^^^^

This controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters. The parameter `definition file located in the src folder <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/gpio_controllers_/src/gpio_command_controller_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.
This controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters. The parameter `definition file located in the src folder <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/gpio_controllers/src/gpio_command_controller_parameters.yaml>`_ contains descriptions for all the parameters used by the controller.

.. generate_parameter_library_details::
../src/gpio_command_controller_parameters.yaml
Expand All @@ -28,7 +28,7 @@ The controller expects at least one GPIO interface and the corresponding command
.. note::

When no state interface is provided in the param file, the controller will try to use state_interfaces from ros2_control's config placed in the URDF for configured gpio interfaces.
However, Command interfaces will not be configured based on the available URDF setup.
However, command interfaces will not be configured based on the available URDF setup.

.. code-block:: yaml
Expand Down

0 comments on commit 5c32a72

Please sign in to comment.