Skip to content

Commit

Permalink
Rotation Shim closed_loop param (#639)
Browse files Browse the repository at this point in the history
* Add documentation

Signed-off-by: RBT22 <rozgonyibalint@gmail.com>

* Update docs

Signed-off-by: RBT22 <rozgonyibalint@gmail.com>

---------

Signed-off-by: RBT22 <rozgonyibalint@gmail.com>
  • Loading branch information
RBT22 authored Jan 31, 2025
1 parent 07385e4 commit 912c400
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
11 changes: 11 additions & 0 deletions configuration/packages/configuring-rotation-shim-controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,17 @@ Rotation Shim Controller Parameters
Description
If true, the rotationShimController will only rotate to heading once on a new goal, not each time a path is set.

:closed_loop:

============== =============================
Type Default
-------------- -----------------------------
bool true
============== =============================

Description
If false, the rotationShimController will use the last commanded velocity as the next iteration's current velocity. When acceleration limits are set appropriately and the robot's controllers are responsive, this can be a good assumption. If true, it will use odometry to estimate the robot's current speed. In this case it is important that the source is high-rate and low-latency to account for control delay.

Example
*******
.. code-block:: yaml
Expand Down
9 changes: 9 additions & 0 deletions migration/Jazzy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -283,3 +283,12 @@ A demo can be seen below with the following parameters:
:width: 800
:alt: Rotation Shim Deceleration
:align: center

Rotation Shim Open-loop Control
*******************************

The parameter ``closed_loop`` was introduced to the Rotation Shim Controller to allow users to choose between open-loop and closed-loop control. If false, the rotationShimController will use the last commanded velocity as the next iteration's current velocity. When acceleration limits are set appropriately and the robot's controllers are responsive, this can be a good assumption. If true, it will use odometry to estimate the robot's current speed. In this case it is important that the source is high-rate and low-latency to account for control delay.

Default value:

- true

0 comments on commit 912c400

Please sign in to comment.