diff --git a/configuration/packages/configuring-rotation-shim-controller.rst b/configuration/packages/configuring-rotation-shim-controller.rst index c6d3af8894..cc63b48078 100644 --- a/configuration/packages/configuring-rotation-shim-controller.rst +++ b/configuration/packages/configuring-rotation-shim-controller.rst @@ -140,6 +140,17 @@ Rotation Shim Controller Parameters 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. +:use_path_orientations: + + ============== =========================== + Type Default + -------------- --------------------------- + bool false + ============== =========================== + + Description + If true, the controller will use the orientations of the path points to compute the heading of the path instead of computing the heading from the path point's relative locations. If true, the controller will use the orientations of the path points to compute the heading of the path instead of computing the heading from the path points. Use for for feasible planners like the Smac Planner which generate feasible paths with orientations for forward and reverse motion. + Example ******* .. code-block:: yaml diff --git a/migration/Jazzy.rst b/migration/Jazzy.rst index abc7277c22..7e96740489 100644 --- a/migration/Jazzy.rst +++ b/migration/Jazzy.rst @@ -362,3 +362,12 @@ In `PR #4996 `_ a new p Default value: - 253 + +Rotation Shim Using Path Orientations +************************************* + +The parameter ``use_path_orientations`` was introduced to the Rotation Shim Controller to allow users to choose between using the orientations of the path points to compute the heading of the path instead of computing the heading from the path point's relative locations. This is useful for planners that generate feasible paths with orientations for forward and reverse motion, such as the Smac Planner. + +Default value: + +- false