Skip to content

Added description for Commander API - followPath and example_follow_path.py #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteveMacenski merged 1 commit into from
Feb 5, 2022
Merged

Added description for Commander API - followPath and example_follow_path.py #272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion commander_api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ If a server fails, it may throw an exception or return a `None` object, so pleas
| followWaypoints(poses) | Requests the robot to follow a set of waypoints (list of ``PoseStamped``). |
| | This will execute the chosen ``TaskExecutor`` plugin at each pose. |
+-----------------------------------+----------------------------------------------------------------------------+
| followPath(path) | Requests the robot to follow a path from a starting to a goal |
| | ``PoseStamped``, ``nav_msgs/Path``. |
+-----------------------------------+----------------------------------------------------------------------------+
| spin(spin_dist, time_allowance) | Requests the robot to performs an in-place rotation by a given angle. |
+-----------------------------------+----------------------------------------------------------------------------+
| backup(backup_dist, | Requests the robot to back up by a given distance. |
Expand Down Expand Up @@ -120,7 +123,8 @@ The ``nav2_simple_commander`` has a few examples to highlight the API functions

- ``example_nav_to_pose.py`` - Demonstrates the navigate to pose capabilities of the navigator, as well as a number of auxiliary methods.
- ``example_nav_through_poses.py`` - Demonstrates the navigate through poses capabilities of the navigator, as well as a number of auxiliary methods.
- ``example_waypoint_follower.py`` - Demonstrates the waypoint following capabilities of the navigator, as well as a number of auxiliary methods required.
- ``example_waypoint_follower.py`` - Demonstrates the waypoint following capabilities of the navigator, as well as a number of auxiliary methods.
- ``example_follow_path.py`` - Demonstrates the path following capabilities of the navigator, as well as a number of auxiliary methods.

The ``nav2_simple_commander`` has a few demonstrations to highlight a couple of simple autonomy applications you can build using the API:

Expand Down