diff --git a/configuration/packages/configuring-docking-server.rst b/configuration/packages/configuring-docking-server.rst index 4be6d0d5b8..b29f09bb8e 100644 --- a/configuration/packages/configuring-docking-server.rst +++ b/configuration/packages/configuring-docking-server.rst @@ -126,7 +126,7 @@ Parameters ============== ============== Description - Whether the robot is docking with the dock forward or backward in motion. + Whether the robot is docking with the dock forward or backward in motion. This parameter is deprecated. Use the dock plugin's ``dock_direction`` parameter instead. :dock_prestaging_tolerance: @@ -557,6 +557,17 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc Description If not using stall detection, the pose threshold to the docking pose where ``isDocked() = true``. +::dock_direction: + + ============== ============== + Type Default + -------------- -------------- + string "forward" + ============== ============== + + Description + Whether the robot is docking with the dock forward or backward in motion. This is the replacement for the deprecated ``dock_backwards`` parameter. Options are "forward" or "backward". + Example ******* .. code-block:: yaml @@ -572,7 +583,6 @@ Example max_retries: 3 base_frame: "base_link" fixed_frame: "odom" - dock_backwards: false dock_prestaging_tolerance: 0.5 service_introspection_mode: "disabled" @@ -593,6 +603,7 @@ Example external_detection_rotation_pitch: -1.57 external_detection_rotation_yaw: 0.0 filter_coef: 0.1 + dock_direction: "forward" # "backward" # Dock instances docks: ['home_dock'] diff --git a/migration/Jazzy.rst b/migration/Jazzy.rst index 2970aeed87..07726c3c91 100644 --- a/migration/Jazzy.rst +++ b/migration/Jazzy.rst @@ -439,3 +439,9 @@ Because live monitoring of Behavior Tree with more than 20 nodes and visualizing .. note:: Currently, there is a known bug that crashes Groot 2 when visualizing vectors and related types (e.g., ``Goals`` and ``Path``) contained in the blackboard. Efforts are underway to resolve this issue. For updates, please refer to the following links: `Groot2 issue #55 `_ and `BehaviorTree PR #958 `_. + +Docking backwards as plugin parameter +************************************* +In `PR #5079 `_, the ``dock_backwards`` boolean parameter has been moved from the docking server to the dock plugin as the string parameter ``dock_direction``. This allows the user to have multiple dock plugins with different directions in the same docking server. Default value is ``forward`` but may also be set as ``backward``. + +See :ref:`_configuring_docking_server` for more information.