Skip to content

Commit 94b2470

Browse files
adivardimach0312
authored andcommitted
fix wrong units & improve explanation for subTree migration (ros-navigation#867)
* fix wrong units Signed-off-by: Adi Vardi <adi.vardi@enway.ai> * Clearer explanation Signed-off-by: Adi Vardi <adi.vardi@enway.ai> * rm some line breaks --------- Signed-off-by: Adi Vardi <adi.vardi@enway.ai> Signed-off-by: Jaerak Son <sjr9017@naver.com>
1 parent be1b16e commit 94b2470

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

configuration/packages/configuring-bt-navigator.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Parameters
110110
==== =======
111111

112112
Description
113-
Default timeout value (in milliseconds) while a BT action node is waiting for acknowledgement from an action server.
113+
Default timeout value (in milliseconds) for a BT action node to wait for acknowledgement from an action server.
114114
This value will be overwritten for a BT node if the input port "server_timeout" is provided.
115115

116116
:default_cancel_timeout:
@@ -122,7 +122,7 @@ Parameters
122122
==== =======
123123

124124
Description
125-
Default timeout (in seconds) for BT action node cancellation requests during node halt.
125+
Default timeout (in milliseconds) for BT action node cancellation requests during node halt.
126126
This value will be overwritten for a BT node if the input port "cancel_timeout" is provided.
127127

128128
:wait_for_service_timeout:
@@ -134,7 +134,7 @@ Parameters
134134
==== =======
135135

136136
Description
137-
Default timeout value (in milliseconds) while Action or Service BT nodes will waiting for acknowledgement from an service or action server on BT initialization (e.g. ``wait_for_action_server(timeout)``).
137+
Default timeout value (in milliseconds) for an Action or Service BT nodes to wait for acknowledgement from an service or action server on BT initialization (e.g. ``wait_for_action_server(timeout)``).
138138
This value will be overwritten for a BT node if the input port "wait_for_service_timeout" is provided.
139139

140140
:introspection_mode:
@@ -257,7 +257,7 @@ Parameters
257257
============== ==================================================
258258

259259
Description
260-
List of directories that hosts behavior trees XML files. It is needed to register all behavior trees as well as subtrees.
260+
List of directories that hosts behavior trees XML files. Used to register all behavior trees and subtrees.
261261

262262
NavigateToPose Parameters
263263
*************************

migration/Kilted.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -361,10 +361,12 @@ See also :ref:`configuring_bt_navigator`
361361
Add BehaviorTree SubTrees Support
362362
---------------------------------
363363

364-
The BehaviorTree engine now supports SubTrees in different files within directory(s) set through ``bt_search_directories`` parameter. This allows you to modularize your behavior trees into smaller components that can be reused across different trees.
365-
The interface now supports passing the behavior tree file or ID as input to the `loadBehaviorTree` method of the BT action server.
366-
Each behavior tree is now strictly required to have its own unique ID, therefore the need to replace `MainTre` to a unique ID. For example, in `navigate_through_poses_w_replanning_and_recovery.xml
367-
` `MainTree` can be replaced with `NavigateThroughPosesWReplanningAndRecovery`.
364+
The BehaviorTree engine now supports loading SubTrees from multiple files.
365+
This allows you to modularize your behavior trees into smaller components that can be reused across different trees.
366+
The .xml files should be located within directory(s) set through the ``bt_search_directories`` parameter.
367+
368+
The interface also supports requesting the desired behavior tree as a filepath or as an ID.
369+
To use the ID or multiple SubTrees features, each behavior tree is required to have its own unique ID - replace `MainTree` with a unique ID.
368370

369371
Option to have custom window size and poly order in Savitsky-Golay Smoother
370372
---------------------------------------------------------------------------

0 commit comments

Comments
 (0)