rosapi.params module

rosapi.params.delete_param(node_name, name, params_glob)

Delete a parameter in a given node.

rosapi.params.get_node_param_names(node_name, params_glob)

Get list of parameter names for a given node.

rosapi.params.get_param(node_name, name, default, params_glob)

Get a parameter from a given node.

rosapi.params.get_param_names(params_glob)
rosapi.params.has_param(node_name, name, params_glob)

Check whether a given node has a parameter or not.

rosapi.params.init(parent_node_name, timeout_sec=5.0)

Initialize params module with a rclpy.node.Node for further use.

This function has to be called before any other for the module to work.

Parameters:

  • node (Node) – The rclpy node to use for service calls.

  • timeout_sec (float | int, optional) – The timeout in seconds for service calls.

Raises:

ValueError – If the timeout is not a positive number.

rosapi.params.set_param(node_name, name, value, params_glob)

Set a parameter in a given node.