rosapi.params module

rosapi.params.delete_param(node_name: str, name: str, params_glob: list[str]) → None: Delete a parameter in a given node.

rosapi.params.get_node_param_names(node_name: str, params_glob: list[str]) → list[str]: Get list of parameter names for a given node.

rosapi.params.get_param(node_name: str, name: str, default: str, params_glob: list[str]) → str | None: Get a parameter from a given node.

rosapi.params.has_param(node_name: str, name: str, params_glob: list[str]) → bool: Check whether a given node has a parameter or not.

rosapi.params.init(parent_node_name: str, timeout_sec: float = 5.0) → None

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: str, name: str, value: str, params_glob: list[str]) → None: Set a parameter in a given node.