Skip to content

Commit 5dba2f3

Browse files
document docking detector toggling options (#773)
* Document docking detector toggling options Signed-off-by: bkoensgen <b.koensgen@gmail.com> * Update configuration/packages/configuring-docking-server.rst Signed-off-by: Steve Macenski <stevenmacenski@gmail.com> * Update configuration/packages/configuring-docking-server.rst Signed-off-by: Steve Macenski <stevenmacenski@gmail.com> --------- Signed-off-by: bkoensgen <b.koensgen@gmail.com> Signed-off-by: Steve Macenski <stevenmacenski@gmail.com> Co-authored-by: Steve Macenski <stevenmacenski@gmail.com>
1 parent f033bb4 commit 5dba2f3

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

configuration/packages/configuring-docking-server.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -479,6 +479,40 @@ Simple Charging Dock is a provided charging dock plugin that can handle many doc
479479
Description
480480
Whether to use external detection topic for dock or use the databases' pose.
481481

482+
:<dock_name>.detector_service_name:
483+
484+
============== ==============
485+
Type Default
486+
-------------- --------------
487+
string ""
488+
============== ==============
489+
490+
Description
491+
Optional ``std_srvs/Trigger`` service invoked when detection starts or stops via ``startDetectionProcess`` / ``stopDetectionProcess`` if detection method accepts a service call to start and stop.
492+
493+
:<dock_name>.detector_service_timeout:
494+
495+
============== ==================
496+
Type Default
497+
-------------- ------------------
498+
double 5.0
499+
============== ==================
500+
501+
Description
502+
Timeout (s) to wait for ``detector_service_name`` to become available and respond.
503+
504+
:<dock_name>.subscribe_toggle:
505+
506+
============== ==============
507+
Type Default
508+
-------------- --------------
509+
bool false
510+
============== ==============
511+
512+
Description
513+
When true, subscribe to ``detected_dock_pose`` only while detection is active; otherwise keep the subscription persistent.
514+
515+
482516
:<dock_name>.external_detection_timeout:
483517

484518
============== ==============
@@ -675,6 +709,9 @@ Example
675709
docking_threshold: 0.05
676710
staging_x_offset: -0.7
677711
use_external_detection_pose: true
712+
detector_service_name: '/detector/toggle'
713+
detector_service_timeout: 5.0
714+
subscribe_toggle: true
678715
use_battery_status: false # true
679716
use_stall_detection: false
680717
rotate_to_dock: false

migration/Kilted.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,16 @@ Removed Parameter action_server_result_timeout
202202
Removed the parameter ``action_server_result_timeout`` from all action servers after resolution within ``rcl`` and ``rclcpp`` to address early goal removal.
203203
This is not longer required to be set.
204204

205+
Dock Plugin Detector Control
206+
----------------------------
207+
208+
`PR #5218 <https://github.com/ros-navigation/navigation2/pull/5218>`_ adds on-demand detector control to ``opennav_docking``.
209+
``ChargingDock`` and ``NonChargingDock`` now provide pure virtual ``startDetectionProcess`` / ``stopDetectionProcess`` functions that the docking server invokes around the perception loop.
210+
211+
- Custom dock plugins must implement the new hooks (return ``true`` if nothing extra is required).
212+
- ``Simple(Non)ChargingDock`` gained ``detector_service_name``, ``detector_service_timeout``, and ``subscribe_toggle`` parameters so a detector service can be triggered only while detections are needed.
213+
- See :ref:`configuring_docking_server` for the updated parameter reference and YAML example.
214+
205215
Added Corner Smoothing functionality to route_server
206216
----------------------------------------------------
207217

0 commit comments

Comments
 (0)