Skip to content

Commit 5b2b926

Browse files
Doc for allow_navigator_preemption and navigator_preemption_timeout (#892)
Signed-off-by: avanmalleghem <antoine.vanmalleghem@botronics.be>
1 parent a3ada46 commit 5b2b926

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

configuration/packages/configuring-bt-navigator.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,28 @@ Parameters
270270
Description
271271
List of directories that hosts behavior trees XML files. Used to register all behavior trees and subtrees.
272272

273+
:allow_navigator_preemption:
274+
275+
============== ==================================================
276+
Type Default
277+
-------------- --------------------------------------------------
278+
bool false
279+
============== ==================================================
280+
281+
Description
282+
Controls whether a new navigation goal can preempt a currently active navigator. If set to false, if a navigator is already running and a new goal arrives for a different navigator, the new goal is rejected. If set to true, the new goal signals the active navigator to stop, waits for it to finish, then hands control over to the new navigator.
283+
284+
:navigator_preemption_timeout:
285+
286+
============== ==================================================
287+
Type Default
288+
-------------- --------------------------------------------------
289+
int 500
290+
============== ==================================================
291+
292+
Description
293+
Only relevant when ``allow_navigator_preemption`` is true. Sets the maximum time (in ms) to wait for the currently active navigator to stop. If the active navigator doesn't finish within this timeout, the new goal is rejected.
294+
273295
NavigateToPose Parameters
274296
*************************
275297

0 commit comments

Comments
 (0)