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 Sep 26, 2024
1 parent c88515b commit f6ed6a6
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 35 deletions.
34 changes: 17 additions & 17 deletions _sources/configuration/packages/configuring-docking-server.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ SimpleChargingDock Parameters

Simple Charging Dock is a provided charging dock plugin that can handle many docks and common techniques.

:controller.staging_x_offset:
:<dock_name>.staging_x_offset:

============== ==============
Type Default
Expand All @@ -292,7 +292,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Staging pose offset forward (negative) of dock pose (m).

:controller.staging_yaw_offset:
:<dock_name>.staging_yaw_offset:

============== ==============
Type Default
Expand All @@ -303,7 +303,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Staging pose angle relative to dock pose (rad).

:controller.use_battery_status:
:<dock_name>.use_battery_status:

============== ==============
Type Default
Expand All @@ -314,7 +314,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Whether to use the battery state message or ``isDocked()`` for ``isCharging()``.

:controller.use_external_detection_pose:
:<dock_name>.use_external_detection_pose:

============== ==============
Type Default
Expand All @@ -325,7 +325,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Whether to use external detection topic for dock or use the databases' pose.

:controller.external_detection_timeout:
:<dock_name>.external_detection_timeout:

============== ==============
Type Default
Expand All @@ -337,7 +337,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Timeout (s) at which if the newest detection update does not meet to fail.


:controller.external_detection_translation_x:
:<dock_name>.external_detection_translation_x:

============== ==============
Type Default
Expand All @@ -348,7 +348,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
X offset from detected pose for docking pose (m).

:controller.external_detection_translation_y:
:<dock_name>.external_detection_translation_y:

============== ==============
Type Default
Expand All @@ -359,7 +359,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Y offset from detected pose for docking pose (m).

:controller.external_detection_rotation_yaw:
:<dock_name>.external_detection_rotation_yaw:

============== ==============
Type Default
Expand All @@ -370,7 +370,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Yaw offset from detected pose for docking pose (rad).

:controller.external_detection_rotation_pitch:
:<dock_name>.external_detection_rotation_pitch:

============== ==============
Type Default
Expand All @@ -381,7 +381,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Pitch offset from detected pose for docking pose (rad). Note: The external detection rotation angles are setup to work out of the box with Apriltags detectors in `image_proc` and `isaac_ros`.

:controller.external_detection_rotation_roll:
:<dock_name>.external_detection_rotation_roll:

============== ==============
Type Default
Expand All @@ -392,7 +392,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Roll offset from detected pose for docking pose (rad). Note: The external detection rotation angles are setup to work out of the box with Apriltags detectors in `image_proc` and `isaac_ros`.

:controller.filter_coef:
:<dock_name>.filter_coef:

============== ==============
Type Default
Expand All @@ -403,7 +403,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Dock external detection method filtering algorithm coefficient.

:controller.charging_threshold:
:<dock_name>.charging_threshold:

============== ==============
Type Default
Expand All @@ -414,7 +414,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Threshold of current in battery state above which ``isCharging() = true``.

:controller.use_stall_detection:
:<dock_name>.use_stall_detection:

============== ==============
Type Default
Expand All @@ -425,7 +425,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Whether or not to use stall detection for ``isDocked()`` or positional threshold.

:controller.stall_joint_names:
:<dock_name>.stall_joint_names:

============== ==============
Type Default
Expand All @@ -436,7 +436,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Names in ``joint_states`` topic of joints to track.

:controller.stall_velocity_threshold:
:<dock_name>.stall_velocity_threshold:

============== ==============
Type Default
Expand All @@ -447,7 +447,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
The joint velocity below which to trigger ``isDocked() = true``.

:controller.stall_effort_threshold:
:<dock_name>.stall_effort_threshold:

============== ==============
Type Default
Expand All @@ -458,7 +458,7 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
Description
Current or motor effort in joint state to trigger ``isDocked() = true``.

:controller.docking_threshold:
:<dock_name>.docking_threshold:

============== ==============
Type Default
Expand Down
34 changes: 17 additions & 17 deletions configuration/packages/configuring-docking-server.html
Original file line number Diff line number Diff line change
Expand Up @@ -1573,7 +1573,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
<h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock-parameters" title="Permalink to this headline"></a></h2>
<p>Simple Charging Dock is a provided charging dock plugin that can handle many docks and common techniques.</p>
<dl class="field-list">
<dt class="field-odd">controller.staging_x_offset</dt>
<dt class="field-odd">&lt;dock_name&gt;.staging_x_offset</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1593,7 +1593,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.staging_yaw_offset</dt>
<dt class="field-even">&lt;dock_name&gt;.staging_yaw_offset</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1613,7 +1613,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.use_battery_status</dt>
<dt class="field-odd">&lt;dock_name&gt;.use_battery_status</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1633,7 +1633,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.use_external_detection_pose</dt>
<dt class="field-even">&lt;dock_name&gt;.use_external_detection_pose</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1653,7 +1653,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.external_detection_timeout</dt>
<dt class="field-odd">&lt;dock_name&gt;.external_detection_timeout</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1673,7 +1673,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.external_detection_translation_x</dt>
<dt class="field-even">&lt;dock_name&gt;.external_detection_translation_x</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1693,7 +1693,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.external_detection_translation_y</dt>
<dt class="field-odd">&lt;dock_name&gt;.external_detection_translation_y</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1713,7 +1713,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.external_detection_rotation_yaw</dt>
<dt class="field-even">&lt;dock_name&gt;.external_detection_rotation_yaw</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1733,7 +1733,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.external_detection_rotation_pitch</dt>
<dt class="field-odd">&lt;dock_name&gt;.external_detection_rotation_pitch</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1753,7 +1753,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.external_detection_rotation_roll</dt>
<dt class="field-even">&lt;dock_name&gt;.external_detection_rotation_roll</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1773,7 +1773,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.filter_coef</dt>
<dt class="field-odd">&lt;dock_name&gt;.filter_coef</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1793,7 +1793,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.charging_threshold</dt>
<dt class="field-even">&lt;dock_name&gt;.charging_threshold</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1813,7 +1813,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.use_stall_detection</dt>
<dt class="field-odd">&lt;dock_name&gt;.use_stall_detection</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1833,7 +1833,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.stall_joint_names</dt>
<dt class="field-even">&lt;dock_name&gt;.stall_joint_names</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1853,7 +1853,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.stall_velocity_threshold</dt>
<dt class="field-odd">&lt;dock_name&gt;.stall_velocity_threshold</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1873,7 +1873,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-even">controller.stall_effort_threshold</dt>
<dt class="field-even">&lt;dock_name&gt;.stall_effort_threshold</dt>
<dd class="field-even"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand All @@ -1893,7 +1893,7 @@ <h2>SimpleChargingDock Parameters<a class="headerlink" href="#simplechargingdock
</dd>
</dl>
</dd>
<dt class="field-odd">controller.docking_threshold</dt>
<dt class="field-odd">&lt;dock_name&gt;.docking_threshold</dt>
<dd class="field-odd"><table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit f6ed6a6

Please sign in to comment.