Skip to content

Commit

Permalink
Add documentation on ros2_control_node and make lock_memory false b…
Browse files Browse the repository at this point in the history
…y default (#1890)
  • Loading branch information
saikishor authored Nov 27, 2024
1 parent e284af2 commit abb4c68
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
32 changes: 32 additions & 0 deletions controller_manager/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,38 @@ The workaround for this is to specify another node name remap rule in the ``Node
auto cm = std::make_shared<controller_manager::ControllerManager>(
executor, "_target_node_name", "some_optional_namespace", options);
Launching controller_manager with ros2_control_node
---------------------------------------------------

The controller_manager can be launched with the ros2_control_node executable. The following example shows how to launch the controller_manager with the ros2_control_node executable:

.. code-block:: python
control_node = Node(
package="controller_manager",
executable="ros2_control_node",
parameters=[robot_controllers],
output="both",
)
The ros2_control_node executable uses the following parameters from the ``controller_manager`` node:

lock_memory (optional; bool; default: false)
Locks the memory of the ``controller_manager`` node at startup to physical RAM in order to avoid page faults
and to prevent the node from being swapped out to disk.
Find more information about the setup for memory locking in the following link : `How to set ulimit values <https://access.redhat.com/solutions/61334>`_
The following command can be used to set the memory locking limit temporarily : ``ulimit -l unlimited``.

cpu_affinity (optional; int; default: -1)
Sets the CPU affinity of the ``controller_manager`` node to the specified CPU core.
The value of -1 means that the CPU affinity is not set.

thread_priority (optional; int; default: 50)
Sets the thread priority of the ``controller_manager`` node to the specified value. The value must be between 0 and 99.

use_sim_time (optional; bool; default: false)
Enables the use of simulation time in the ``controller_manager`` node.

Concepts
-----------

Expand Down
2 changes: 1 addition & 1 deletion controller_manager/src/ros2_control_node.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ int main(int argc, char ** argv)

const bool use_sim_time = cm->get_parameter_or("use_sim_time", false);

const bool lock_memory = cm->get_parameter_or<bool>("lock_memory", true);
const bool lock_memory = cm->get_parameter_or<bool>("lock_memory", false);
std::string message;
if (lock_memory && !realtime_tools::lock_memory(message))
{
Expand Down

0 comments on commit abb4c68

Please sign in to comment.