Skip to content

Commit

Permalink
adding disengagement param to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Macenski <[email protected]>
  • Loading branch information
SteveMacenski committed Oct 1, 2024
1 parent cb6b431 commit 3342f61
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
13 changes: 12 additions & 1 deletion configuration/packages/configuring-rotation-shim-controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,18 @@ Rotation Shim Controller Parameters
============== ===========================

Description
Maximum angular distance, in radians, away from the path heading to trigger rotation until within.
Maximum angular distance, in radians, away from the path heading to trigger rotation

:angular_disengage_threshold:

============== ===========================
Type Default
-------------- ---------------------------
double 0.3925
============== ===========================

Description
Angular distance, in radians, away from the path heading to rotation until within (new as of Oct 1, 2024 - previous behavior rotated until ``angular_dist_threshold``).

:forward_sampling_distance:

Expand Down
6 changes: 6 additions & 0 deletions migration/Jazzy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,9 @@ In `PR #4675 <https://github.com/ros-navigation/navigation2/pull/4675>`_ a ``pub
Default value:

- true

Rotation Shim Disengagement Threshold
*************************************

The parameter ``angular_disengage_threshold`` was introduced as a new threshold for disengagement of the rotation in the rotation shim controller.
Previous behavior rotated until the ``angular_dist_threshold``, now it can rotate until the ``angular_disengage_threshold``, which can be set closer to the path's orientation if desired.

0 comments on commit 3342f61

Please sign in to comment.