Skip to content

Commit

Permalink
[skip ci] publish latest
Browse files Browse the repository at this point in the history
Signed-off-by: navigation2-ci <[email protected]>
  • Loading branch information
navigation2-ci committed Sep 20, 2024
1 parent b0f03e6 commit f7b9aef
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 22 deletions.
4 changes: 0 additions & 4 deletions _sources/commander_api/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,6 @@ New as of September 2023: the simple navigator constructor will accept a `namesp
| undockRobot(dock_type="") | Undocks robot. If docking server instance was used to dock, type is not |
| | required. |
+---------------------------------------+----------------------------------------------------------------------------+
| getandTrackRoute(start, goal, | Gets and tracks a sparse route and dense path from start to goal, where |
| use_start=False) | start & goal may be of type ``PoseStamped`` or ``int`` for known NodeIDs. |
+---------------------------------------+----------------------------------------------------------------------------+
| smoothPath(path, smoother_id='', | Smooths a given path of type ``nav_msgs/Path``. |
| max_duration=2.0, | |
| check_for_collision=False) | |
Expand Down Expand Up @@ -231,7 +228,6 @@ The ``nav2_simple_commander`` has a few examples to highlight the API functions
- ``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 like path smoothing.
- ``example_assisted_teleop.py`` - Demonstrates the assisted teleop capabilities of the navigator.
- ``example_route.py`` - Demonstrates the Route server capabilities of the navigator.

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

Expand Down
28 changes: 11 additions & 17 deletions commander_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1224,50 +1224,45 @@ <h2>Commander API<a class="headerlink" href="#id1" title="Permalink to this head
<td><p>Undocks robot. If docking server instance was used to dock, type is not
required.</p></td>
</tr>
<tr class="row-even"><td><p>getandTrackRoute(start, goal,
use_start=False)</p></td>
<td><p>Gets and tracks a sparse route and dense path from start to goal, where
start &amp; goal may be of type <code class="docutils literal notranslate"><span class="pre">PoseStamped</span></code> or <code class="docutils literal notranslate"><span class="pre">int</span></code> for known NodeIDs.</p></td>
</tr>
<tr class="row-odd"><td><p>smoothPath(path, smoother_id=’‘,
<tr class="row-even"><td><p>smoothPath(path, smoother_id=’‘,
max_duration=2.0,
check_for_collision=False)</p></td>
<td><p>Smooths a given path of type <code class="docutils literal notranslate"><span class="pre">nav_msgs/Path</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p>changeMap(map_filepath)</p></td>
<tr class="row-odd"><td><p>changeMap(map_filepath)</p></td>
<td><p>Requests a change from the current map to <cite>map_filepath</cite>’s yaml.</p></td>
</tr>
<tr class="row-odd"><td><p>clearAllCostmaps()</p></td>
<tr class="row-even"><td><p>clearAllCostmaps()</p></td>
<td><p>Clears both the global and local costmaps.</p></td>
</tr>
<tr class="row-even"><td><p>clearLocalCostmap()</p></td>
<tr class="row-odd"><td><p>clearLocalCostmap()</p></td>
<td><p>Clears the local costmap.</p></td>
</tr>
<tr class="row-odd"><td><p>clearGlobalCostmap()</p></td>
<tr class="row-even"><td><p>clearGlobalCostmap()</p></td>
<td><p>Clears the global costmap.</p></td>
</tr>
<tr class="row-even"><td><p>getGlobalCostmap()</p></td>
<tr class="row-odd"><td><p>getGlobalCostmap()</p></td>
<td><p>Returns the global costmap, <code class="docutils literal notranslate"><span class="pre">nav2_msgs/Costmap</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p>getLocalCostmap()</p></td>
<tr class="row-even"><td><p>getLocalCostmap()</p></td>
<td><p>Returns the local costmap, <code class="docutils literal notranslate"><span class="pre">nav2_msgs/Costmap</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p>waitUntilNav2Active(
<tr class="row-odd"><td><p>waitUntilNav2Active(
navigator=’bt_navigator’,
localizer=’amcl’)</p></td>
<td><p>Blocks until Nav2 is completely online and lifecycle nodes are in the
active state. To be used in conjunction with autostart or external
lifecycle bringup. Custom navigator and localizer nodes can be specified</p></td>
</tr>
<tr class="row-odd"><td><p>lifecycleStartup()</p></td>
<tr class="row-even"><td><p>lifecycleStartup()</p></td>
<td><p>Sends a request to all lifecycle management servers to bring them into
the active state, to be used if autostart is <code class="docutils literal notranslate"><span class="pre">False</span></code> and you want this
program to control Nav2’s lifecycle.</p></td>
</tr>
<tr class="row-even"><td><p>lifecycleShutdown()</p></td>
<tr class="row-odd"><td><p>lifecycleShutdown()</p></td>
<td><p>Sends a request to all lifecycle management servers to shut them down.</p></td>
</tr>
<tr class="row-odd"><td><p>destroyNode()</p></td>
<tr class="row-even"><td><p>destroyNode()</p></td>
<td><p>Releases the resources used by the object.</p></td>
</tr>
</tbody>
Expand Down Expand Up @@ -1394,7 +1389,6 @@ <h2>Examples and Demos<a class="headerlink" href="#examples-and-demos" title="Pe
<li><p><code class="docutils literal notranslate"><span class="pre">example_waypoint_follower.py</span></code> - Demonstrates the waypoint following capabilities of the navigator, as well as a number of auxiliary methods.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">example_follow_path.py</span></code> - Demonstrates the path following capabilities of the navigator, as well as a number of auxiliary methods like path smoothing.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">example_assisted_teleop.py</span></code> - Demonstrates the assisted teleop capabilities of the navigator.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">example_route.py</span></code> - Demonstrates the Route server capabilities of the navigator.</p></li>
</ul>
<p>The <code class="docutils literal notranslate"><span class="pre">nav2_simple_commander</span></code> has a few demonstrations to highlight a couple of simple autonomy applications you can build using the API:</p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit f7b9aef

Please sign in to comment.