Skip to content

Commit

Permalink
[PID] Add example yaml to docs (#951)
Browse files Browse the repository at this point in the history
* Add default yaml to docs

* Add examples from test folder
  • Loading branch information
christophfroehlich committed Jun 6, 2024
1 parent 996981a commit 5eb6df8
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions pid_controller/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,21 @@ Parameters

The PID controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters.

List of parameters
=========================
.. generate_parameter_library_details:: ../src/pid_controller.yaml


An example parameter file
=========================


An example parameter file for this controller can be found in `the test folder (standalone) <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/pid_controller/test/pid_controller_params.yaml>`_:

.. literalinclude:: ../test/pid_controller_params.yaml
:language: yaml

or as `preceding controller <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/pid_controller/test/pid_controller_preceding_params.yaml>`_:

.. literalinclude:: ../test/pid_controller_preceding_params.yaml
:language: yaml

0 comments on commit 5eb6df8

Please sign in to comment.