Skip to content

Commit 0d3571e

Browse files
adding controller server plugins + reformatting waypoint follower's (#95)
* adding controller server plugins * update plugin description
1 parent b7fea86 commit 0d3571e

File tree

2 files changed

+54
-16
lines changed

2 files changed

+54
-16
lines changed

migration/Foxy.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ For instance;
3737
.. code-block:: yaml
3838
3939
waypoint_follower:
40-
ros__parameters:
40+
ros__parameters:
4141
loop_rate: 20
4242
stop_on_failure: false
43-
waypoint_task_executor_plugin: "waypoint_task_executor"
43+
waypoint_task_executor_plugin: "waypoint_task_executor"
4444
waypoint_task_executor:
45-
plugin: "nav2_waypoint_follower::WaitAtWaypoint"
46-
enabled: True
47-
waypoint_pause_duration: 0
45+
plugin: "nav2_waypoint_follower::WaitAtWaypoint"
46+
enabled: True
47+
waypoint_pause_duration: 0
4848
4949
Original GitHub tickets:
5050

plugins/index.rst

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,55 @@ Recoveries
145145
.. _Wait: https://github.com/ros-planning/navigation2/tree/main/nav2_recoveries/plugins
146146
.. _Clear Costmap: https://github.com/ros-planning/navigation2/blob/main/nav2_costmap_2d/src/clear_costmap_service.cpp
147147

148+
Waypoint Task Executors
149+
=======================
150+
151+
+---------------------------------+------------------------+----------------------------------+
152+
| Plugin Name | Creator | Description |
153+
+=================================+========================+==================================+
154+
| `WaitAtWaypoint`_ | Fetullah Atas | A plugin to execute a wait |
155+
| | | behavior on |
156+
| | | waypoint arrivals. |
157+
| | | |
158+
+---------------------------------+------------------------+----------------------------------+
159+
160+
.. _WaitAtWaypoint: https://github.com/ros-planning/navigation2/tree/main/nav2_waypoint_follower/plugins/wait_at_waypoint.cpp
161+
162+
Goal Checkers
163+
=============
164+
165+
+---------------------------------+------------------------+----------------------------------+
166+
| Plugin Name | Creator | Description |
167+
+=================================+========================+==================================+
168+
| `SimpleGoalChecker`_ | David Lu!! | A plugin check whether robot |
169+
| | | is within translational distance |
170+
| | | and rotational distance of goal. |
171+
| | | |
172+
+---------------------------------+------------------------+----------------------------------+
173+
| `StoppedGoalChecker`_ | David Lu!! | A plugin check whether robot |
174+
| | | is within translational distance |
175+
| | | , rotational distance of goal, |
176+
| | | and velocity threshold. |
177+
+---------------------------------+------------------------+----------------------------------+
178+
179+
.. _SimpleGoalChecker: https://github.com/ros-planning/navigation2/blob/main/nav2_controller/plugins/simple_goal_checker.cpp
180+
.. _StoppedGoalChecker: https://github.com/ros-planning/navigation2/blob/main/nav2_controller/plugins/stopped_goal_checker.cpp
181+
182+
Progress Checkers
183+
=================
184+
185+
+---------------------------------+------------------------+----------------------------------+
186+
| Plugin Name | Creator | Description |
187+
+=================================+========================+==================================+
188+
| `SimpleProgressChecker`_ | David Lu!! | A plugin to check whether the |
189+
| | | robot was able to move a minimum |
190+
| | | distance in a given time to |
191+
| | | make progress towards a goal |
192+
+---------------------------------+------------------------+----------------------------------+
193+
194+
.. _SimpleProgressChecker: https://github.com/ros-planning/navigation2/blob/main/nav2_controller/plugins/simple_progress_checker.cpp
195+
196+
148197
Behavior Tree Nodes
149198
===================
150199

@@ -270,14 +319,3 @@ Behavior Tree Nodes
270319
.. _Pipeline Sequence: https://github.com/ros-planning/navigation2/tree/main/nav2_behavior_tree/plugins/control/pipeline_sequence.cpp
271320
.. _Recovery: https://github.com/ros-planning/navigation2/tree/main/nav2_behavior_tree/plugins/control/recovery_node.cpp
272321
.. _Round Robin: https://github.com/ros-planning/navigation2/tree/main/nav2_behavior_tree/plugins/control/round_robin_node.cpp
273-
274-
+---------------------------------+------------------------+----------------------------------+
275-
| Waypoint Follower Plugin Name | Creator | Description |
276-
+=================================+========================+==================================+
277-
| `Waypoint Task Executor`_ | Fetullah Atas | A plugin interface to define |
278-
| | | specific tasks to be executed on |
279-
| | | waypoint arrivals. |
280-
| | | |
281-
+---------------------------------+------------------------+----------------------------------+
282-
283-
.. _Waypoint Task Executor: https://github.com/ros-planning/navigation2/tree/main/nav2_waypoint_follower/plugins/wait_at_waypoint.cpp

0 commit comments

Comments
 (0)