Skip to content

Commit 144a646

Browse files
authored
Documentation for acceleration limits in DriveOnHeading and BackUp behaviors (#634)
* Add new params to docs Signed-off-by: RBT22 <rozgonyibalint@gmail.com> * Fix star number Signed-off-by: RBT22 <rozgonyibalint@gmail.com> * Update minimum speed descriptions Signed-off-by: RBT22 <rozgonyibalint@gmail.com> * Fix backup acc params' descriptions Signed-off-by: RBT22 <rozgonyibalint@gmail.com> --------- Signed-off-by: RBT22 <rozgonyibalint@gmail.com>
1 parent 306c2c3 commit 144a646

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

configuration/packages/configuring-behavior-server.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,39 @@ Backup distance, speed and time_allowance is given from the action request.
271271
True uses TwistStamped, false uses Twist.
272272
Note: This parameter is default ``false`` in Jazzy or older! Kilted or newer uses ``TwistStamped`` by default.
273273

274+
:backup.acceleration_limit:
275+
276+
============== =============================
277+
Type Default
278+
-------------- -----------------------------
279+
double 2.5
280+
============== =============================
281+
282+
Description
283+
Maximum acceleration limit (m/s^2). This parameter limits the rate at which speed increases when moving backward.
284+
285+
:backup.deceleration_limit:
286+
287+
============== =============================
288+
Type Default
289+
-------------- -----------------------------
290+
double -2.5
291+
============== =============================
292+
293+
Description
294+
Maximum deceleration limit (m/s^2). Negative value. This parameter limits the rate at which speed decreases when moving backward.
295+
296+
:backup.minimum_speed:
297+
298+
============== =============================
299+
Type Default
300+
-------------- -----------------------------
301+
double 0.10
302+
============== =============================
303+
304+
Description
305+
Minimum speed to move, the deadband velocity of the robot behavior (m/s). Positive value.
306+
274307
DriveOnHeading Behavior Parameters
275308
**********************************
276309

@@ -311,6 +344,39 @@ DriveOnHeading distance, speed and time_allowance is given from the action reque
311344
Description
312345
The lifecycle node bond mechanism publishing period (on the /bond topic). Disabled if inferior or equal to 0.0.
313346

347+
:drive_on_heading.acceleration_limit:
348+
349+
============== =============================
350+
Type Default
351+
-------------- -----------------------------
352+
double 2.5
353+
============== =============================
354+
355+
Description
356+
Maximum acceleration limit (m/s^2).
357+
358+
:drive_on_heading.deceleration_limit:
359+
360+
============== =============================
361+
Type Default
362+
-------------- -----------------------------
363+
double -2.5
364+
============== =============================
365+
366+
Description
367+
Maximum deceleration limit (m/s^2). Negative value.
368+
369+
:drive_on_heading.minimum_speed:
370+
371+
============== =============================
372+
Type Default
373+
-------------- -----------------------------
374+
double 0.10
375+
============== =============================
376+
377+
Description
378+
Minimum speed to move, the deadband velocity of the robot behavior (m/s). Positive value.
379+
314380
AssistedTeleop Behavior Parameters
315381
**********************************
316382

migration/Jazzy.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,3 +253,11 @@ MPPI controller re-implemented using Eigen library and performance improved by 4
253253

254254
In the `PR #4621 <https://github.com/ros-navigation/navigation2/pull/4621>`_ MPPI controller is fully reimplemented using Eigen as it is well supported hpc library and suits better for our use case of two dimensional batches of trajectories. GPU support for rolling out trajectories could also be possible in future using Eigen.
255255
MPPI Optimizer's performance is improved by 40-50%. Now MPPI Controller can also be run on ARM processors which do not support SIMD Instructions extensively.
256+
257+
DriveOnHeading and BackUp behaviors: Addition of acceleration constraints
258+
*************************************************************************
259+
`PR #4810 <https://github.com/ros-navigation/navigation2/pull/4810>`_ adds new parameters ``acceleration_limit``, ``deceleration_limit``, ``minimum_speed`` for the `DriveOnHeading` and `BackUp` Behaviors. The default values are as follows:
260+
261+
- ``acceleration_limit``: 2.5
262+
- ``deceleration_limit``: -2.5
263+
- ``minimum_speed``: 0.10

0 commit comments

Comments
 (0)