Skip to content

Add ros2 param load documentation #1101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
audrow merged 2 commits into from
Feb 13, 2021
Merged

Add ros2 param load documentation #1101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab850e7
Add ros2 param load documentation
v-lopez Feb 12, 2021
e454ec7
Fix trailing space
v-lopez Feb 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion source/Tutorials/Parameters/Understanding-ROS2-Parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,41 @@ However, you can save your settings changes and reload them next time you start
background_r: 150
use_sim_time: false

6 Load parameter file
6 ros2 param load
^^^^^^^^^^^^^^^^^

.. tabs::

.. group-tab:: Foxy and newer

You can load parameters from a file to a currently running node using the command:

.. code-block:: console

ros2 param load <node_name> <parameter_file>

To load the ./turtlesim.yaml file generated with ``ros2 param dump`` into ``/turtlesim`` node’s parameters, enter the command:

.. code-block:: console

ros2 param load /turtlesim ./turtlesim.yaml

Your terminal will return the message:

.. code-block:: console

Set parameter background_b succesful
Set parameter background_g succesful
Set parameter background_r succesful
Set parameter use_sim_time succesful


.. group-tab:: Eloquent

Eloquent and earlier do not have the ``param load`` command.
See the next section on how to start a node with parameters from a YAML file.

7 Load parameter file
^^^^^^^^^^^^^^^^^^^^^

.. tabs::
Expand Down