-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[rcl_interfaces] Homogenize iface definition (#23)
* homogenize interfaces definition * move rcl_interfaces README inside rcl_interfaces package * add generic README for rcl_interfaces repo * Update readme with changes from discussion
- Loading branch information
1 parent
d8c73c5
commit 7710246
Showing
5 changed files
with
36 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,2 @@ | ||
# 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. | ||
|
||
|
||
## Parameter Groups | ||
Parameters are contained in groups. | ||
The default group is '/'. | ||
It behaves like a filepath, where you can nest sub-groups within groups. | ||
|
||
## 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 occuring 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 occuring 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. | ||
# rcl_interfaces repository | ||
This repository contains a set of packages that primarily contain interface files (.msg and .srv) which are used both to implement client library concepts and for testing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# 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. | ||
|
||
|
||
## Parameter Groups | ||
Parameters are contained in groups. | ||
The default group is '/'. | ||
It behaves like a filepath, where you can nest sub-groups within groups. | ||
|
||
## 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 occuring 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 occuring 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# A list of parameters to set | ||
rcl_interfaces/Parameter[] parameters | ||
Parameter[] parameters | ||
|
||
--- | ||
|
||
|