Skip to content

Commit 2d50f50

Browse files
adding input at waypoint plugin (#108)
1 parent e7137e1 commit 2d50f50

File tree

4 files changed

+52
-0
lines changed

4 files changed

+52
-0
lines changed

configuration/packages/configuring-waypoint-follower.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Provided Plugins
7070
:maxdepth: 1
7171

7272
nav2_waypoint_follower-plugins/wait_at_waypoint.rst
73+
nav2_waypoint_follower-plugins/input_at_waypoint.rst
7374

7475

7576
Default Plugins
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _configuring_nav2_waypoint_follower_input_at_waypoint_plugin:
2+
3+
InputAtWaypoint
4+
===============
5+
6+
Lets robot to wait for external input, with timeout, at a waypoint.
7+
8+
Parameters
9+
**********
10+
11+
``<nav2_waypoint_follower plugin>``: nav2_waypoint_follower plugin name defined in the **waypoint_task_executor_plugin_id** parameter in :ref:`configuring_waypoint_follower`.
12+
13+
:``<nav2_waypoint_follower plugin>``.enabled:
14+
15+
============== =============================
16+
Type Default
17+
-------------- -----------------------------
18+
bool true
19+
============== =============================
20+
21+
Description
22+
Whether waypoint_task_executor plugin is enabled.
23+
24+
25+
:``<nav2_waypoint_follower plugin>``.timeout:
26+
27+
============== =============================
28+
Type Default
29+
-------------- -----------------------------
30+
double 10.0
31+
============== =============================
32+
33+
Description
34+
Amount of time in seconds to wait for user input before moving on to the next waypoint.
35+
36+
:``<nav2_waypoint_follower plugin>``.input_topic:
37+
38+
============== =============================
39+
Type Default
40+
-------------- -----------------------------
41+
string "input_at_waypoint/input"
42+
============== =============================
43+
44+
Description
45+
Topic input is published to to indicate to move to the next waypoint, in `std_msgs/Empty`.

migration/Foxy.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ For instance;
4949
Original GitHub tickets:
5050

5151
- `WaypointTaskExecutor <https://github.com/ros-planning/navigation2/pull/1993>`_
52+
- `InputAtWaypoint <https://github.com/ros-planning/navigation2/pull/2049>`_
5253

5354
Costmap Filters
5455
***************

plugins/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,13 @@ Waypoint Task Executors
156156
| | | waypoint arrivals. |
157157
| | | |
158158
+---------------------------------+------------------------+----------------------------------+
159+
| `InputAtWaypoint`_ | Steve Macenski | A plugin to wait for user input |
160+
| | | before moving onto the next |
161+
| | | waypoint. |
162+
+---------------------------------+------------------------+----------------------------------+
159163

160164
.. _WaitAtWaypoint: https://github.com/ros-planning/navigation2/tree/main/nav2_waypoint_follower/plugins/wait_at_waypoint.cpp
165+
.. _InputAtWaypoint: https://github.com/ros-planning/navigation2/tree/main/nav2_waypoint_follower/plugins/input_at_waypoint.cpp
161166

162167
Goal Checkers
163168
=============

0 commit comments

Comments
 (0)