Skip to content

Commit a390c9e

Browse files
authored
Update arguments for custom planner and controller (#687)
Signed-off-by: Maurice-1235 <mauricepurnawan@gmail.com>
1 parent 7117153 commit a390c9e

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

plugin_tutorials/docs/writing_new_nav2controller_plugin.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ The list of methods, their descriptions, and necessity are presented in the tabl
7070
| computeVelocityCommands() | Method is called when a new velocity command is demanded by the controller server | Yes |
7171
| | in-order for the robot to follow the global path. This method returns a | |
7272
| | `geometry_msgs\:\:msg\:\:TwistStamped` which represents the velocity command for the | |
73-
| | robot to drive. This method passes 2 parameters: reference to the current robot | |
74-
| | pose and its current velocity. | |
73+
| | robot to drive. This method passes 3 parameters: reference to the current robot | |
74+
| | pose, its current velocity, and a pointer to the `nav2_core::GoalChecker`. | |
7575
+---------------------------+---------------------------------------------------------------------------------------+------------------------+
7676
| cancel() | Method is called when the controller server receives a cancel request. If this method | No |
7777
| | is unimplemented, the controller will immediately stop when receiving a cancel | |

plugin_tutorials/docs/writing_new_nav2planner_plugin.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ Let's learn more about the methods needed to write a planner plugin.
6060
+----------------------+-----------------------------------------------------------------------------+-------------------------+
6161
| createPlan() | Method is called when planner server demands a global plan for specified | Yes |
6262
| | start and goal pose. This method returns `nav_msgs\:\:msg\:\:Path` carrying | |
63-
| | global plan. This method takes 2 input params: start pose and goal pose. | |
63+
| | global plan. This method takes 3 input params: start pose, goal pose and | |
64+
| | a function to check if the action has been canceled. | |
6465
+----------------------+-----------------------------------------------------------------------------+-------------------------+
6566

6667
For this tutorial, we will be using methods ``StraightLine::configure()`` and ``StraightLine::createPlan()`` to create straight-line planner.

0 commit comments

Comments
 (0)