Skip to content

Commit 34ca300

Browse files
Update docs
1 parent 36ecdda commit 34ca300

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

doc/migration/Jazzy.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ joint_trajectory_controller
1818
* Empty trajectory messages are discarded (`#902 <https://github.com/ros-controls/ros2_controllers/pull/902>`_).
1919
* Angle wraparound behavior (continuous joints) was added from the current state to the first segment of the incoming trajectory (`#796 <https://github.com/ros-controls/ros2_controllers/pull/796>`_).
2020
* The URDF is now parsed for continuous joints and angle wraparound is automatically activated now (`#949 <https://github.com/ros-controls/ros2_controllers/pull/949>`_). Remove the ``angle_wraparound`` parameter from the configuration and set continuous joint type in the URDF of the respective joint.
21+
* Tolerances sent with the action goal were not used before, but are now processed and used for the upcoming action. (`#716 <https://github.com/ros-controls/ros2_controllers/pull/716>`_). Adaptions to the action goal might be necessary.

doc/release_notes/Jazzy.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,20 @@ joint_trajectory_controller
3333
* Action field ``error_string`` is now filled with meaningful strings (`#887 <https://github.com/ros-controls/ros2_controllers/pull/887>`_).
3434
* Angle wraparound behavior (continuous joints) was added from the current state to the first segment of the incoming trajectory (`#796 <https://github.com/ros-controls/ros2_controllers/pull/796>`_).
3535
* The URDF is now parsed for continuous joints and angle wraparound is automatically activated now (`#949 <https://github.com/ros-controls/ros2_controllers/pull/949>`_). ``angle_wraparound`` parameter was completely removed.
36+
* Tolerances sent with the action goal are now processed and used for the action. (`#716 <https://github.com/ros-controls/ros2_controllers/pull/716>`_). For details, see the `JointTolerance message <https://github.com/ros-controls/control_msgs/blob/master/control_msgs/msg/JointTolerance.msg>`_:
37+
38+
.. code-block:: markdown
39+
40+
The tolerances specify the amount the position, velocity, and
41+
accelerations can vary from the setpoints. For example, in the case
42+
of trajectory control, when the actual position varies beyond
43+
(desired position + position tolerance), the trajectory goal may
44+
abort.
45+
46+
There are two special values for tolerances:
47+
* 0 - The tolerance is unspecified and will remain at whatever the default is
48+
* -1 - The tolerance is "erased". If there was a default, the joint will be
49+
allowed to move without restriction.
3650
3751
pid_controller
3852
************************

joint_trajectory_controller/doc/userdoc.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,21 @@ Actions [#f1]_
152152

153153
The primary way to send trajectories is through the action interface, and should be favored when execution monitoring is desired.
154154

155-
Action goals allow to specify not only the trajectory to execute, but also (optionally) path and goal tolerances.
155+
Action goals allow to specify not only the trajectory to execute, but also (optionally) path and goal tolerances. For details, see the `JointTolerance message <https://github.com/ros-controls/control_msgs/blob/master/control_msgs/msg/JointTolerance.msg>`_:
156+
157+
.. code-block:: markdown
158+
159+
The tolerances specify the amount the position, velocity, and
160+
accelerations can vary from the setpoints. For example, in the case
161+
of trajectory control, when the actual position varies beyond
162+
(desired position + position tolerance), the trajectory goal may
163+
abort.
164+
165+
There are two special values for tolerances:
166+
* 0 - The tolerance is unspecified and will remain at whatever the default is
167+
* -1 - The tolerance is "erased". If there was a default, the joint will be
168+
allowed to move without restriction.
169+
156170
When no tolerances are specified, the defaults given in the parameter interface are used (see :ref:`parameters`).
157171
If tolerances are violated during trajectory execution, the action goal is aborted, the client is notified, and the current position is held.
158172

0 commit comments

Comments
 (0)