Skip to content

Commit edcb7e0

Browse files
[PID] Add example yaml to docs (ros-controls#951)
* Add default yaml to docs * Add examples from test folder
1 parent d51306a commit edcb7e0

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

pid_controller/doc/userdoc.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,21 @@ Parameters
8383

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

86+
List of parameters
87+
=========================
8688
.. generate_parameter_library_details:: ../src/pid_controller.yaml
89+
90+
91+
An example parameter file
92+
=========================
93+
94+
95+
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>`_:
96+
97+
.. literalinclude:: ../test/pid_controller_params.yaml
98+
:language: yaml
99+
100+
or as `preceding controller <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/pid_controller/test/pid_controller_preceding_params.yaml>`_:
101+
102+
.. literalinclude:: ../test/pid_controller_preceding_params.yaml
103+
:language: yaml

0 commit comments

Comments
 (0)