rosparam command-line tools

Introduction

The rosparam command-line tools help you manage parameters in ROS easily. They let you set, get, and delete parameters from the command line without writing code.

You want to quickly change a robot's configuration without restarting nodes.

You need to check the current value of a parameter during debugging.

You want to load a set of parameters from a file before running your robot.

You want to clear parameters that are no longer needed.

You want to save parameters to a file for backup or sharing.

Syntax

ROS

rosparam set <param_name> <value>
rosparam get <param_name>
rosparam delete <param_name>
rosparam load <file.yaml>
rosparam dump <file.yaml>

<param_name> is the name of the parameter, like /robot_speed.

<value> can be a number, string, boolean, or YAML structure.

Examples

Sets the parameter /robot_speed to 1.5.

ROS

rosparam set /robot_speed 1.5

Gets and shows the current value of /robot_speed.

ROS

rosparam get /robot_speed

Removes the parameter /robot_speed from the parameter server.

ROS

rosparam delete /robot_speed

Loads parameters from the config.yaml file into the parameter server.

ROS

rosparam load config.yaml

Sample Program

This example shows how to set a parameter called /greeting to 'Hello ROS', get its value, delete it, and then try to get it again to see it is removed.

ROS

# In terminal 1: Set a parameter
rosparam set /greeting 'Hello ROS'

# In terminal 2: Get the parameter
rosparam get /greeting

# Output:
Hello ROS

# Then delete the parameter
rosparam delete /greeting

# Try to get it again
rosparam get /greeting

# Output:
Parameter [/greeting] not set

Important Notes

Parameter names usually start with a slash / to make them global.

You can use YAML files to load many parameters at once with rosparam load.

Deleting a parameter removes it from the parameter server immediately.

Summary

rosparam tools let you manage ROS parameters from the command line.

You can set, get, delete, load, and dump parameters easily.

Using these tools helps you quickly change robot settings without code changes.

Practice

1. What is the primary purpose of the rosparam command-line tool in ROS?

easy

A. To compile ROS packages

B. To visualize robot models

C. To launch ROS nodes

D. To manage parameters on the ROS parameter server

Solution

1. Step 1: Understand the role of rosparam

   rosparam is designed to interact with the ROS parameter server, allowing users to set, get, and delete parameters.

2. Step 2: Differentiate from other ROS tools

   Compiling packages is done by catkin_make, launching nodes by roslaunch, and visualization by tools like rviz. These are unrelated to parameter management.

3. Final Answer:

   To manage parameters on the ROS parameter server -> Option D

4. Quick Check:

   rosparam manages parameters = B [OK]

Hint: rosparam always deals with parameters, not nodes or builds [OK]

Common Mistakes:

• Confusing rosparam with roslaunch
• Thinking rosparam compiles code
• Assuming rosparam visualizes data

2. Which of the following is the correct syntax to set a parameter named robot_speed to 1.5 using rosparam?

easy

A. rosparam get robot_speed 1.5

B. rosparam set robot_speed 1.5

C. rosparam load robot_speed 1.5

D. rosparam delete robot_speed 1.5

Solution

1. Step 1: Identify the command to assign a value

   The set command is used to assign a value to a parameter on the ROS parameter server.

2. Step 2: Check the syntax format

   The correct syntax is rosparam set <param_name> <value>. So rosparam set robot_speed 1.5 is correct.

3. Final Answer:

   rosparam set robot_speed 1.5 -> Option B

4. Quick Check:

   Set command assigns value = A [OK]

Hint: Use 'set' to assign values, not 'get' or 'load' [OK]

Common Mistakes:

• Using 'get' to set a value
• Confusing 'load' with 'set'
• Adding extra arguments after parameter name

3. Given the following commands run in order:

rosparam set /max_speed 2.0
rosparam get /max_speed
rosparam delete /max_speed
rosparam get /max_speed

What will be the output of the second rosparam get /max_speed command?

medium

A. Parameter /max_speed not set

B. 0

C. 2.0

D. Error: invalid command

Solution

1. Step 1: Understand the sequence of commands

   First, the parameter /max_speed is set to 2.0. Then it is retrieved, so the first get returns 2.0. Next, the parameter is deleted.

2. Step 2: Check the second get command after deletion

   After deletion, the parameter no longer exists on the server. So the second get command will report that the parameter is not set.

3. Final Answer:

   Parameter /max_speed not set -> Option A

4. Quick Check:

   Deleted parameter returns 'not set' = C [OK]

Hint: Deleted parameters return 'not set' on get [OK]

Common Mistakes:

• Assuming deleted parameters return default 0
• Expecting an error instead of a message
• Confusing set and delete effects

4. You run the command rosparam load config.yaml but get an error saying the file does not exist. What is the most likely cause?

medium

A. The YAML file path is incorrect or file is missing

B. rosparam cannot load YAML files

C. You need to use rosparam set instead of load

D. The parameter server is not running

Solution

1. Step 1: Understand rosparam load requirements

   The rosparam load command requires a valid YAML file path to load parameters from.

2. Step 2: Identify common causes of file errors

   If the file does not exist or the path is wrong, rosparam will report an error. The parameter server must be running, but that usually causes a different error.

3. Final Answer:

   The YAML file path is incorrect or file is missing -> Option A

4. Quick Check:

   File missing causes load error = A [OK]

Hint: Check file path carefully before loading YAML [OK]

Common Mistakes:

• Thinking rosparam can't load YAML files
• Using set instead of load for files
• Ignoring parameter server status

5. You want to save all current parameters under the namespace /robot to a file named robot_params.yaml. Which command correctly does this?

hard

A. rosparam get /robot > robot_params.yaml

B. rosparam load robot_params.yaml /robot

C. rosparam dump robot_params.yaml /robot

D. rosparam set /robot robot_params.yaml

Solution

1. Step 1: Identify the command to save parameters

   rosparam dump saves parameters to a YAML file. It takes the filename and optionally a namespace.

2. Step 2: Match the syntax to the requirement

   To save parameters under /robot to robot_params.yaml, the command is rosparam dump robot_params.yaml /robot.

3. Final Answer:

   rosparam dump robot_params.yaml /robot -> Option C

4. Quick Check:

   Dump saves parameters to file = D [OK]

Hint: Use 'dump' to save parameters, 'load' to restore [OK]

Common Mistakes:

• Using load instead of dump to save
• Trying to redirect get output to file
• Confusing set with dump