Skip to content

Commit 7b86df9

Browse files
Fix the docs
1 parent 7e55cc9 commit 7b86df9

File tree

3 files changed

+29
-18
lines changed

3 files changed

+29
-18
lines changed

joint_trajectory_controller/doc/parameters.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,24 @@ This controller uses the `generate_parameter_library <https://github.com/PickNik
1111
List of parameters
1212
=========================
1313

14+
joint_trajectory_controller
15+
---------------------------
16+
1417
.. generate_parameter_library_details::
1518
../src/joint_trajectory_controller_parameters.yaml
1619
parameters_context.yaml
1720

21+
pid_trajectory_plugin
22+
-----------------------------------
23+
24+
.. generate_parameter_library_details::
25+
../../joint_trajectory_controller_plugins/src/pid_trajectory_plugin_parameters.yaml
26+
../../joint_trajectory_controller_plugins/doc/parameters_context.yaml
27+
1828
An example parameter file
1929
=========================
2030

21-
.. generate_parameter_library_default::
22-
../src/joint_trajectory_controller_parameters.yaml
31+
An example parameter file for this controller can be found in `the test directory <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/joint_trajectory_controller/test/test_joint_trajectory_controller_params.yaml>`_:
32+
33+
.. literalinclude:: ../test/test_joint_trajectory_controller_params.yaml
34+
:language: yaml
Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,2 @@
11
constraints:
22
Default values for tolerances if no explicit values are set in the ``JointTrajectory`` message.
3-
4-
gains: |
5-
If ``velocity`` is the only command interface for all joints or an ``effort`` command interface is configured, PID controllers are used for every joint.
6-
This structure contains the controller gains for every joint with the control law
7-
8-
.. math:: u = k_{ff} v_d + k_p e + k_i \sum e dt + k_d (v_d - v)
9-
10-
with the desired velocity :math:`v_d`, the measured velocity :math:`v`, the position error :math:`e` (definition see below),
11-
the controller period :math:`dt`, and the ``velocity`` or ``effort`` manipulated variable (control variable) :math:`u`, respectively.
12-
13-
If the joint is of continuous type, the position error :math:`e = normalize(s_d - s)` is normalized between :math:`-\pi, \pi`,
14-
i.e., the shortest rotation to the target position is the desired motion.
15-
Otherwise :math:`e = s_d - s` is used, with the desired position :math:`s_d` and the measured
16-
position :math:`s` from the state interface.
17-
18-
If you want to turn off the PIDs (open loop control), set the feedback gains to zero.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
gains: |
2+
If ``velocity`` is the only command interface for all joints or an ``effort`` command interface is configured, PID controllers are used for every joint.
3+
This structure contains the controller gains for every joint with the control law
4+
5+
.. math:: u = k_{ff} v_d + k_p e + k_i \sum e dt + k_d (v_d - v)
6+
7+
with the desired velocity :math:`v_d`, the measured velocity :math:`v`, the position error :math:`e` (definition see below),
8+
the controller period :math:`dt`, and the ``velocity`` or ``effort`` manipulated variable (control variable) :math:`u`, respectively.
9+
10+
If the joint is of continuous type, the position error :math:`e = normalize(s_d - s)` is normalized between :math:`-\pi, \pi`,
11+
i.e., the shortest rotation to the target position is the desired motion.
12+
Otherwise :math:`e = s_d - s` is used, with the desired position :math:`s_d` and the measured
13+
position :math:`s` from the state interface.
14+
15+
If you want to turn off the PIDs (open loop control), set the feedback gains to zero.

0 commit comments

Comments
 (0)