Skip to content

Commit d6a563f

Browse files
committed
Expand migration guide
Signed-off-by: Adi Vardi <adi.vardi@enway.ai>
1 parent 88aae05 commit d6a563f

1 file changed

Lines changed: 54 additions & 2 deletions

File tree

migration/Kilted.rst

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,5 +293,57 @@ Below are measured bandwidth values for different transport types with default p
293293
Private BT Navigator's BlackBoard ID parameters
294294
-----------------------------------------------
295295

296-
The parameters ``xx_blackboard_id`` used in the BT navigator to specify the name of the blackboard variables from the behavior trees were moved into the respective navigators. They now have to be specified under the namespace of the particular navigator.
297-
See :ref:`configuring_bt_navigator`
296+
The parameters ``xx_blackboard_id`` used in the BT navigator to specify the name of the blackboard variables from the
297+
behavior trees were moved into the respective navigators. They now have to be specified under the namespace of the particular navigator.
298+
299+
These parameters are:
300+
301+
- NavigateToPose:
302+
303+
- ``<navigate_to_pose_name>.goal_blackboard_id``
304+
- ``<navigate_to_pose_name>.path_blackboard_id``
305+
306+
- NavigateThroughPoses:
307+
308+
- ``<navigate_through_poses_name>.goals_blackboard_id``
309+
- ``<navigate_through_poses_name>.path_blackboard_id``
310+
- ``<navigate_through_poses_name>.waypoint_statuses_blackboard_id``
311+
312+
- CoverageNavigator:
313+
314+
- ``<coverage_navigator_name>.path_blackboard_id``
315+
- ``<coverage_navigator_name>.field_file_blackboard_id``
316+
- ``<coverage_navigator_name>.field_polygon_blackboard_id``
317+
- ``<coverage_navigator_name>.polygon_frame_blackboard_id``
318+
319+
Example:
320+
321+
.. code-block:: yaml
322+
323+
bt_navigator:
324+
ros__parameters:
325+
other parameters: ....
326+
327+
navigate_to_pose:
328+
plugin: "nav2_bt_navigator::NavigateToPoseNavigator"
329+
enable_groot_monitoring: false
330+
groot_server_port: 1667
331+
goal_blackboard_id: "goal"
332+
path_blackboard_id: "path"
333+
334+
navigate_through_poses:
335+
plugin: "nav2_bt_navigator::NavigateThroughPosesNavigator"
336+
enable_groot_monitoring: false
337+
groot_server_port: 1669
338+
goals_blackboard_id: "goals"
339+
path_blackboard_id: "path"
340+
waypoint_statuses_blackboard_id: "waypoint_statuses"
341+
342+
navigate_complete_coverage:
343+
plugin: "opennav_coverage_navigator/CoverageNavigator"
344+
path_blackboard_id: "path"
345+
field_file_blackboard_id: "field_filepath"
346+
field_polygon_blackboard_id: "field_polygon"
347+
polygon_frame_blackboard_id: "polygon_frame_id"
348+
349+
See also :ref:`configuring_bt_navigator`

0 commit comments

Comments
 (0)