Skip to content

Commit 88aae05

Browse files
committed
Document moved parameters
Signed-off-by: Adi Vardi <adi.vardi@enway.ai>
1 parent 9f304b4 commit 88aae05

2 files changed

Lines changed: 61 additions & 44 deletions

File tree

configuration/packages/configuring-bt-navigator.rst

Lines changed: 55 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -180,50 +180,6 @@ Parameters
180180
Description
181181
Topic on which odometry is published
182182

183-
:goal_blackboard_id:
184-
185-
====== =======
186-
Type Default
187-
------ -------
188-
string "goal"
189-
====== =======
190-
191-
Description
192-
Blackboard variable to use to supply the goal to the behavior tree for ``NavigateToPose``. Should match ports of BT XML file.
193-
194-
:path_blackboard_id:
195-
196-
====== =======
197-
Type Default
198-
------ -------
199-
string "path"
200-
====== =======
201-
202-
Description
203-
Blackboard variable to get the path from the behavior tree for ``NavigateThroughPoses`` feedback. Should match port names of BT XML file.
204-
205-
:goals_blackboard_id:
206-
207-
====== =======
208-
Type Default
209-
------ -------
210-
string "goals"
211-
====== =======
212-
213-
Description
214-
Blackboard variable to use to supply the goals to the behavior tree for ``NavigateThroughPoses``. Should match ports of BT XML file.
215-
216-
:waypoint_statuses_blackboard_id:
217-
218-
====== ===================
219-
Type Default
220-
------ -------------------
221-
string "waypoint_statuses"
222-
====== ===================
223-
224-
Description
225-
Blackboard variable to get the statuses of waypoints from the behavior tree for ``NavigateThroughPoses`` feedback/result. Should match ports of BT XML file.
226-
227183
:error_code_name_prefixes:
228184

229185
============== ===========================
@@ -284,6 +240,28 @@ Parameters
284240
NavigateToPose Parameters
285241
*************************
286242

243+
:``<navigate_to_pose_name>``.goal_blackboard_id:
244+
245+
====== =======
246+
Type Default
247+
------ -------
248+
string "goal"
249+
====== =======
250+
251+
Description
252+
Blackboard variable to use to supply the goal to the behavior tree for ``NavigateToPose``. Should match ports of BT XML file.
253+
254+
:``<navigate_to_pose_name>``.path_blackboard_id:
255+
256+
====== =======
257+
Type Default
258+
------ -------
259+
string "path"
260+
====== =======
261+
262+
Description
263+
Blackboard variable to get the path from the behavior tree for ``NavigateToPose`` feedback. Should match port names of BT XML file.
264+
287265
:``<navigate_to_pose_name>``.enable_groot_monitoring:
288266

289267
============== =======
@@ -309,6 +287,39 @@ NavigateToPose Parameters
309287
NavigateThroughPoses Parameters
310288
*******************************
311289

290+
:``<navigate_through_poses>``.goals_blackboard_id:
291+
292+
====== =======
293+
Type Default
294+
------ -------
295+
string "goals"
296+
====== =======
297+
298+
Description
299+
Blackboard variable to use to supply the goals to the behavior tree for ``NavigateThroughPoses``. Should match ports of BT XML file.
300+
301+
:``<navigate_through_poses>``.path_blackboard_id:
302+
303+
====== =======
304+
Type Default
305+
------ -------
306+
string "path"
307+
====== =======
308+
309+
Description
310+
Blackboard variable to get the path from the behavior tree for ``NavigateThroughPoses`` feedback. Should match port names of BT XML file.
311+
312+
:``<navigate_through_poses>``.waypoint_statuses_blackboard_id:
313+
314+
====== ===================
315+
Type Default
316+
------ -------------------
317+
string "waypoint_statuses"
318+
====== ===================
319+
320+
Description
321+
Blackboard variable to get the statuses of waypoints from the behavior tree for ``NavigateThroughPoses`` feedback/result. Should match ports of BT XML file.
322+
312323
:``<navigate_through_poses>``.enable_groot_monitoring:
313324

314325
============== =======

migration/Kilted.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,3 +289,9 @@ Below are measured bandwidth values for different transport types with default p
289289
+------------------+----------------+
290290
| zlib | 121.95 |
291291
+------------------+----------------+
292+
293+
Private BT Navigator's BlackBoard ID parameters
294+
-----------------------------------------------
295+
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`

0 commit comments

Comments
 (0)