Skip to content

Commit

Permalink
doc(controller-server): publish_zero_velocity parameter (#593)
Browse files Browse the repository at this point in the history
  • Loading branch information
reinzor authored Sep 20, 2024
1 parent 84a9b95 commit 72901a0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
11 changes: 11 additions & 0 deletions configuration/packages/configuring-controller-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ Parameters
Description
Adds soft real-time prioritization to the controller server to better ensure resources to time sensitive portions of the codebase. This will set the controller's execution thread to a higher priority than the rest of the system (``90``) to meet scheduling deadlines to have less missed loop rates. To use this feature, you use set the following inside of ``/etc/security/limits.conf`` to give userspace access to elevated prioritization permissions: ``<username> soft rtprio 99 <username> hard rtprio 99``

:publish_zero_velocity:

============== =======
Type Default
-------------- -------
bool true
============== =======

Description
Whether to publish a zero velocity command on goal exit. This is useful for stopping the robot when a goal terminates.

:action_server_result_timeout:

====== ======= =======
Expand Down
8 changes: 8 additions & 0 deletions migration/Jazzy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,11 @@ Default value:

- false

Option to disable zero velocity publishing on goal exit
*******************************************************

In `PR #4675 <https://github.com/ros-navigation/navigation2/pull/4675>`_ a ``publish_zero_velocity`` parameter was introduced for the `Controller server </configuration/packages/configuring-controller-server.html#controller-server>`_ in order to disable zero velocity publishing on goal exit.

Default value:

- true

0 comments on commit 72901a0

Please sign in to comment.