Skip to content

Commit 576f36e

Browse files
Added doc for collision detection for docking (#610)
* Added doc for collision detection for docking Signed-off-by: Alberto Tudela <ajtudela@gmail.com> * Update configuration/packages/configuring-docking-server.rst Co-authored-by: Steve Macenski <stevenmacenski@gmail.com> Signed-off-by: Alberto Tudela <ajtudela@gmail.com> --------- Signed-off-by: Alberto Tudela <ajtudela@gmail.com> Co-authored-by: Steve Macenski <stevenmacenski@gmail.com>
1 parent 350a689 commit 576f36e

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

‎configuration/packages/configuring-docking-server.rst‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,83 @@ Parameters
272272
Description
273273
Radius to end goal to commense slow down.
274274

275+
:controller.use_collision_detection:
276+
277+
============== ==============
278+
Type Default
279+
-------------- --------------
280+
bool true
281+
============== ==============
282+
283+
Description
284+
Whether to use collision detection to avoid obstacles.
285+
286+
:controller.costmap_topic:
287+
288+
============== ===========================
289+
Type Default
290+
-------------- ---------------------------
291+
string "local_costmap/costmap_raw"
292+
============== ===========================
293+
294+
Description
295+
Raw costmap topic for collision checking.
296+
297+
:controller.footprint_topic:
298+
299+
============== ===================================
300+
Type Default
301+
-------------- -----------------------------------
302+
string "local_costmap/published_footprint"
303+
============== ===================================
304+
305+
Description
306+
Topic for footprint in the costmap frame.
307+
308+
:controller.transform_tolerance:
309+
310+
============== =============================
311+
Type Default
312+
-------------- -----------------------------
313+
double 0.1
314+
============== =============================
315+
316+
Description
317+
Time with which to post-date the transform that is published, to indicate that this transform is valid into the future.
318+
319+
:controller.projection_time:
320+
321+
============== =============================
322+
Type Default
323+
-------------- -----------------------------
324+
double 1.0
325+
============== =============================
326+
327+
Description
328+
Time to look ahead for collisions (s).
329+
330+
:controller.simulation_time_step:
331+
332+
============== =============================
333+
Type Default
334+
-------------- -----------------------------
335+
double 0.1
336+
============== =============================
337+
338+
Description
339+
Time step for projections (s).
340+
341+
:controller.dock_collision_threshold:
342+
343+
============== =============================
344+
Type Default
345+
-------------- -----------------------------
346+
double 0.3
347+
============== =============================
348+
349+
Description
350+
Distance (m) from the dock pose to ignore collisions, i.e. the robot will not check for collisions within this distance from the dock pose, as the robot will make contact with the dock. Set to ``0.0`` when physical contact is not made with a dock.
351+
275352

276353
Note: ``dock_plugins`` and either ``docks`` or ``dock_database`` are required.
277354

‎migration/Jazzy.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,3 +99,12 @@ In `PR #4675 <https://github.com/ros-navigation/navigation2/pull/4675>`_ a ``pub
9999
Default value:
100100

101101
- true
102+
103+
Added optional collision checking for the Docking Server
104+
********************************************************
105+
106+
In `PR #4752 <https://github.com/ros-navigation/navigation2/pull/4752>`_ an optional collision checking feature was added to the `Docking server </configuration/packages/configuring-docking-server.html#docking-server>`_ to check for collisions between the robot and the dock.
107+
108+
Default value:
109+
110+
- true

0 commit comments

Comments
 (0)