Skip to content
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.

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

Added documentation for SmootherSelector #374

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 58 additions & 0 deletions configuration/packages/bt-plugins/actions/SmootherSelector.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
.. _bt_smoother_selector_node:

SmootherSelector
==================

It is used to select the Smoother that will be used by the Smoother server. It subscribes to the ``smoother_selector`` topic to receive command messages with the name of the Smoother to be used. It is commonly used before of the FollowPathAction. If none is provided on the topic, the ``default_smoother`` is used.

Any publisher to this topic needs to be configured with some QoS defined as ``reliable`` and ``transient local``.

.. _bt_navigator: https://github.com/ros-planning/navigation2/tree/main/nav2_bt_navigator

Input Ports
-----------

:topic_name:

====== =======
Type Default
------ -------
string smoother_selector
====== =======

Description
The name of the topic used to received select command messages. This is used to support multiple SmootherSelector nodes.

:default_smoother:

====== =======
Type Default
------ -------
string N/A
====== =======

Description
The default value for the selected Smoother if no message is received from the input topic.


Output Ports
------------

:selected_smoother:

====== =======
Type Default
------ -------
string N/A
====== =======

Description
The output selected Smoother id.


Example
-------

.. code-block:: xml

<SmootherSelector selected_smoother="{selected_smoother}" default_smoother="SimpleSmoother" topic_name="smoother_selector"/>
1 change: 1 addition & 0 deletions configuration/packages/configuring-bt-xml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Action Plugins
bt-plugins/actions/TruncatePathLocal.rst
bt-plugins/actions/PlannerSelector.rst
bt-plugins/actions/ControllerSelector.rst
bt-plugins/actions/SmootherSelector.rst
bt-plugins/actions/GoalCheckerSelector.rst
bt-plugins/actions/NavigateThroughPoses.rst
bt-plugins/actions/ComputePathThroughPoses.rst
Expand Down
4 changes: 4 additions & 0 deletions migration/Humble.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,7 @@ Adding a new smoother algorithm, the Savitzky-Golay smoother to the smoother ser
Changes to Map yaml file path for map_server node in Launch
***********************************************************
`PR #3174 <https://github.com/ros-planning/navigation2/pull/3174>`_ adds a way to set the path to map yaml file for the map_server node either from the yaml file or using the launch configuration parameter ``map`` giving priority to the launch configuration parameter. ``yaml_filename`` is no longer strictly required to be present in ``nav2_params.yaml``.

SmootherSelector BT Node
************************
`PR #3283 <https://github.com/ros-planning/navigation2/pull/3283>`_ adds a BT node to set the smoother based on a topic or a default. See the configuration guide :ref:`SimpleSmoother` for more details.
4 changes: 4 additions & 0 deletions plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,10 @@ Behavior Tree Nodes
| | | topic input, otherwises uses a default |
| | | goal checker id |
+--------------------------------------------+---------------------+------------------------------------------+
| `Smoother Selector`_ | Owen Hooper | Selects the smoother based on a |
| | | topic input, otherwises uses a default |
| | | smoother id |
+--------------------------------------------+---------------------+------------------------------------------+
| `Navigate Through Poses`_ | Steve Macenski | BT Node for other BehaviorTree.CPP BTs |
| | | to call Nav2's NavThroughPoses action |
| | | |
Expand Down