Add documentation for wait_for_service_timeout ros-navigation#3960 (r…

…os-navigation#490) * Add documentation for wait_for_service_timeout ros-navigation#3960 * Update configuration/packages/configuring-bt-navigator.rst --------- Co-authored-by: Steve Macenski <[email protected]>
mini-1235 · Nov 17, 2023 · 9d76bb0 · 9d76bb0
1 parent e41a18b
commit 9d76bb0
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/configuration/packages/configuring-bt-navigator.rst b/configuration/packages/configuring-bt-navigator.rst
@@ -111,6 +111,18 @@ Parameters
     Default timeout value (in milliseconds) while a BT action node is waiting for acknowledgement from an action server.
     This value will be overwritten for a BT node if the input port "server_timeout" is provided.
 
+:wait_for_service_timeout:
+
+  ==== =======
+  Type Default
+  ---- -------
+  int  1000
+  ==== =======
+
+  Description
+    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)``).
+    This value will be overwritten for a BT node if the input port "wait_for_service_timeout" is provided.
+
 :action_server_result_timeout:
 
   ====== ======= =======