rcl_interfaces

This package contains the messages and services which ROS client libraries will use under the hood to communicate higher level concepts such as parameters.

For more information about ROS 2 interfaces, see docs.ros.org

Parameter Groups

Parameters are contained in groups. The default group is '/'. It behaves like a filepath, where you can nest sub-groups within groups.

For more information about parameters, see: design.ros2.org

Standard topics for parameters

The ROS API for a node will be as follows inside the node's namespace.

Topics:

• parameter_events: ParameterEvent
  • This topic provides a way to subscribe to all parameter updates occurring on the node, including addition removal and changes in value. Every atomic change will be published separately.
• parameter_event_descriptors: ParameterEventDescriptors
  • This topic provides a way to subscribe to all parameter updates occurring on the node, including addition removal and changes in value. Every atomic change will be published separately. This is provided if large parameter values are expected to slow down the system.

Services:

• get_parameters: GetParameters
  • The service to get the value of parameters which are set on this node.
• has_parameters: HasParameters
  • Query this node if specific parameters are set.
• list_parameters: ListParameters
  • List the parameters on this node matching the filters.
• set_parameters: SetParameters
  • Set parameters on this node.
• get_logger_levels: GetLoggerLevels
  • Get the logger levels of nodes which are in the same process space.
• set_logger_levels: SetLoggerLevels
  • Set the logger levels of nodes which are in the same process space.

Messages (.msg)

• FloatingPointRange: Represents bounds and a step value for a floating point typed parameter
• IntegerRange: Represents bounds and a step value for an integer typed parameter
• IntraProcessMessage: Demonstration message for passing around a pointer to shared memory.
• ListParameterResult: This is the returned result of ListParameters service
• Log: A message for communicating log messages and their levels
• Parameter: A message for setting and getting parameter values
• ParameterDescriptor: A more informational message about parameters and their values
• ParameterEvent: For information regarding setting, changing or removing parameter events
• ParameterEventDescriptors: Message describing parameter updates occurring on the node, including addition removal and changes in value
• ParameterType: Enum definitions for denoting a parameter value's type
• ParameterValue: The associated value and type of a parameter
• SetParameterResult: Result message indicating whether a set parameters event succeeded
• SetLoggerLevelsResult: Result message indicating whether a set logger level event succeeded

Services (.srv)

• DescribeParameters: Request a list of descriptions for a specified list of parameters.
• GetParameters: Get the values of a specific list of parameters
• GetParameterTypes: Get the enum type of a list of parameters
• ListParameters: Get the list of parameters given a list of prefixes
• SetParameters: Add or change a list of parameters individually
• SetParametersAtomically: Add or change all parameters in a list or none at all
• GetLoggerLevels: Get the logger levels of a specific list of nodes which are in the same process space
• SetLoggerLevels: Change a list of logger levels of nodes which are in the same process space

Quality Declaration

This package claims to be in the Quality Level 1 category, see the Quality Declaration for more details.

Changelog for package rcl_interfaces

2.0.2 (2024-04-16)

2.0.1 (2023-10-04)

2.0.0 (2023-09-07)

• Update the Log.msg constant types. (#161)
• Update the comments for SetParametersResult to reflect reality. (#159)
• Contributors: Chris Lalancette

1.7.0 (2023-04-27)

1.6.0 (2023-04-18)

• Add interfaces for logging service. (#154)
• Contributors: Lei Liu

1.5.0 (2023-04-11)

1.4.0 (2023-02-13)

• Update common_interfaces to C++17. (#215) (#151)
• [rolling] Update maintainers - 2022-11-07 (#150)
• Contributors: Audrow Nash, Chris Lalancette

1.3.1 (2022-09-09)

1.3.0 (2022-04-29)

1.2.0 (2022-03-01)

• Update maintainers to Chris Lalancette (#130)
• Contributors: Audrow Nash

1.1.0 (2021-08-06)

1.0.3 (2021-04-06)

• Change index.ros.org -> docs.ros.org. (#122)
• Updating Quality Declaration (#120)
• Contributors: Chris Lalancette, shonigmann

1.0.2 (2021-02-22)

• Add field to the parameter description to specify dynamic/static typing. (#118)
• Update quality declaration to QL 1. (#116)
• Update package maintainers. (#112)
• Contributors: Chris Lalancette, Ivan Santiago Paunovic, Michel Hidalgo, Stephen Brawner

1.0.1 (2020-06-29)

• Increase Quality level of packages to 3 (#108)
• Add Security Vulnerability Policy pointing to REP-2006. (#106)
• Updating QD to reflect package versions (#107)
• Contributors: Chris Lalancette, brawner

1.0.0 (2020-05-26)

• Add documentation of log levels (#93)
• Add quality declarations for each package except test_msgs (#92)
• Contributors: Tully Foote, brawner

0.9.0 (2020-04-25)

• Remove commented code line (#99)
• Remove unused IntraProcessMessage (#89)
• Contributors: Dirk Thomas, Stephen Brawner

0.8.0 (2019-09-26)

0.7.4 (2019-05-29)

0.7.3 (2019-05-20)

• Add mapping file for ROS 1 bridge (#67)
• Contributors: Juan Rodriguez Hortala

0.7.2 (2019-05-08)

• Parameters support ranges (#72)
• Contributors: William Woodall

0.7.1 (2019-04-26)

• Add read_only parameter metadata (#35)
• Contributors: Shane Loretz

0.7.0 (2019-04-14)

0.6.2 (2019-01-11)

0.6.1 (2018-12-06)

• adding node path and timestamp fields to event msg (#51)
• Adding a message type for Log messages that will be sent out over the... (#53)
• Contributors: Nick Burek, bpwilcox

0.6.0 (2018-11-16)

• use add_compile_options instead of setting only cxx flags
• Contributors: Mikael Arguedas

0.5.0 (2018-06-24)

• add array parameter types as defined in https://github.com/ros2/design/pull/152 (#32)
• Byte array parameter rename (#33)
• Contributors: Mikael Arguedas

0.4.0 (2017-12-08)

• member of rosidl_interfaces_packages group (#28)
• [rcl_interfaces] Homogenize iface definition (#23)
• Contributors: Dirk Thomas, Esteve Fernandez, Mikael Arguedas, Morgan Quigley, Tully Foote, William Woodall, dhood