Skip to content

Commit

Permalink
[skip ci] publish latest
Browse files Browse the repository at this point in the history
Signed-off-by: navigation2-ci <[email protected]>
  • Loading branch information
navigation2-ci committed Nov 17, 2023
1 parent b39a642 commit 01eb0b8
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 20 deletions.
12 changes: 12 additions & 0 deletions _sources/configuration/packages/configuring-bt-navigator.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:

====== ======= =======
Expand Down
59 changes: 40 additions & 19 deletions configuration/packages/configuring-bt-navigator.html
Original file line number Diff line number Diff line change
Expand Up @@ -1157,9 +1157,30 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-odd">action_server_result_timeout</dt>
<dt class="field-odd">wait_for_service_timeout</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 36%" />
<col style="width: 64%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>Type</p></td>
<td><p>Default</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>1000</p></td>
</tr>
</tbody>
</table>
<dl class="simple">
<dt>Description</dt><dd><p>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. <code class="docutils literal notranslate"><span class="pre">wait_for_action_server(timeout)</span></code>).
This value will be overwritten for a BT node if the input port “wait_for_service_timeout” is provided.</p>
</dd>
</dl>
</dd>
<dt class="field-even">action_server_result_timeout</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 30%" />
<col style="width: 35%" />
<col style="width: 35%" />
Expand All @@ -1183,8 +1204,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-even">transform_tolerance</dt>
<dd class="field-even"><table class="docutils align-default">
<dt class="field-odd">transform_tolerance</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 30%" />
<col style="width: 35%" />
Expand All @@ -1206,8 +1227,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-odd">global_frame</dt>
<dd class="field-odd"><table class="docutils align-default">
<dt class="field-even">global_frame</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 43%" />
<col style="width: 57%" />
Expand All @@ -1226,8 +1247,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-even">robot_base_frame</dt>
<dd class="field-even"><table class="docutils align-default">
<dt class="field-odd">robot_base_frame</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 40%" />
<col style="width: 60%" />
Expand All @@ -1246,8 +1267,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-odd">odom_topic</dt>
<dd class="field-odd"><table class="docutils align-default">
<dt class="field-even">odom_topic</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 40%" />
<col style="width: 60%" />
Expand All @@ -1266,8 +1287,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-even">goal_blackboard_id</dt>
<dd class="field-even"><table class="docutils align-default">
<dt class="field-odd">goal_blackboard_id</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 46%" />
<col style="width: 54%" />
Expand All @@ -1286,8 +1307,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-odd">path_blackboard_id</dt>
<dd class="field-odd"><table class="docutils align-default">
<dt class="field-even">path_blackboard_id</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 46%" />
<col style="width: 54%" />
Expand All @@ -1306,8 +1327,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-even">goals_blackboard_id</dt>
<dd class="field-even"><table class="docutils align-default">
<dt class="field-odd">goals_blackboard_id</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 46%" />
<col style="width: 54%" />
Expand All @@ -1326,8 +1347,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-odd">use_sim_time</dt>
<dd class="field-odd"><table class="docutils align-default">
<dt class="field-even">use_sim_time</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 36%" />
<col style="width: 64%" />
Expand All @@ -1346,8 +1367,8 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
</dd>
</dl>
</dd>
<dt class="field-even">error_code_names</dt>
<dd class="field-even"><table class="docutils align-default">
<dt class="field-odd">error_code_names</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 34%" />
<col style="width: 66%" />
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 01eb0b8

Please sign in to comment.