Skip to content

Commit

Permalink
Update docs after review
Browse files Browse the repository at this point in the history
  • Loading branch information
Wiktor-99 committed Nov 7, 2024
1 parent 13ba72b commit a8228af
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions gpio_controllers/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,13 @@ This controller uses the `generate_parameter_library <https://github.com/PickNik
.. generate_parameter_library_details::
../src/gpio_command_controller_parameters.yaml

The controller expects at least one gpio interface and the corresponding command interface names or state interface.
Command and state interfaces are optional. When no state interface is provided in the param file then controller will try use state_interfaces from ros2_control's config placed in the URDF for configured gpio interfaces.
Command interfaces will not be configured based on available URDF setup.
A yaml file for using it could be:
The controller expects at least one GPIO interface and the corresponding command interface names or state interface.
Command and state interfaces are optional.

.. 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.

.. code-block:: yaml
Expand All @@ -52,4 +55,4 @@ A yaml file for using it could be:
- ana.1
- ana.2
With such configuration controller will accept commands for all gpios' interfaces and will publish state only of Gpio2.
With the above-defined controller configuration, the controller will accept commands for all gpios' interfaces and will only publish the state of Gpio2.

0 comments on commit a8228af

Please sign in to comment.