Update docs to add velocity limit parameter in DWB Controller (#591)

* Update docs Signed-off-by: huiyulhy <[email protected]> * update title Signed-off-by: huiyulhy <[email protected]> * Update configuration/packages/dwb-plugins/standard_traj_generator.rst Co-authored-by: Steve Macenski <[email protected]> Signed-off-by: Huiyu Leong <[email protected]> --------- Signed-off-by: huiyulhy <[email protected]> Signed-off-by: Huiyu Leong <[email protected]> Co-authored-by: Steve Macenski <[email protected]>
ros-navigation · Sep 12, 2024 · 84a9b95 · 84a9b95
1 parent 9bcbcf2
commit 84a9b95
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/configuration/packages/configuring-dwb-controller.rst b/configuration/packages/configuring-dwb-controller.rst
@@ -104,6 +104,7 @@ Example
           xy_goal_tolerance: 0.25
           trans_stopped_velocity: 0.25
           short_circuit_trajectory_evaluation: True
+          limit_vel_cmd_in_traj: False
           stateful: True
           critics: ["RotateToGoal", "Oscillation", "BaseObstacle", "GoalAlign", "PathAlign", "PathDist", "GoalDist"]
           BaseObstacle.scale: 0.02

diff --git a/configuration/packages/dwb-plugins/standard_traj_generator.rst b/configuration/packages/dwb-plugins/standard_traj_generator.rst
@@ -73,3 +73,14 @@ Parameters
 
     Description
         Whether to include the last pose in the trajectory.
+
+:``<dwb plugin>``.limit_vel_cmd_in_traj:
+
+  ==== =======
+  Type Default
+  ---- -------
+  bool false
+  ==== =======
+
+    Description
+        Whether to limit velocity command in trajectory using sampled velocity instead of the commanded velocity.
diff --git a/migration/Jazzy.rst b/migration/Jazzy.rst
@@ -80,4 +80,14 @@ Before:
 
 After:
 
-.. image:: images/fix_flickering_visualization_after.png
+.. image:: images/fix_flickering_visualization_after.png
+
+Option to limit velocity through DWB trajectory
+***********************************************
+
+In `PR #4663 <https://github.com/ros-navigation/navigation2/pull/4663>`_ a ``limit_vel_cmd_in_traj`` parameter was introduced to DWB local planner to allow the user to limit the velocity used in the trajectory generation based on the robot's current velocity.
+
+Default value: 
+
+- false
+