Skip to content

Commit fda8865

Browse files
authored
Add interfaces for logging service. (#154)
* Add interfaces for logging service. Signed-off-by: Lei Liu <[email protected]> Signed-off-by: Barry Xu <[email protected]>
1 parent 35e5116 commit fda8865

File tree

6 files changed

+44
-1
lines changed

6 files changed

+44
-1
lines changed

rcl_interfaces/CMakeLists.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,16 @@ rosidl_generate_interfaces(${PROJECT_NAME}
2727
"msg/ParameterType.msg"
2828
"msg/ParameterValue.msg"
2929
"msg/SetParametersResult.msg"
30+
"msg/LoggerLevel.msg"
31+
"msg/SetLoggerLevelsResult.msg"
3032
"srv/DescribeParameters.srv"
3133
"srv/GetParameters.srv"
3234
"srv/GetParameterTypes.srv"
3335
"srv/ListParameters.srv"
3436
"srv/SetParametersAtomically.srv"
3537
"srv/SetParameters.srv"
38+
"srv/GetLoggerLevels.srv"
39+
"srv/SetLoggerLevels.srv"
3640
DEPENDENCIES builtin_interfaces
3741
)
3842

rcl_interfaces/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ The ROS API for a node will be as follows inside the node's namespace.
3232
* List the parameters on this node matching the filters.
3333
* `set_parameters`: `SetParameters`
3434
* Set parameters on this node.
35+
* `get_logger_levels`: `GetLoggerLevels`
36+
* Get the logger levels of nodes which are in the same process space.
37+
* `set_logger_levels`: `SetLoggerLevels`
38+
* Set the logger levels of nodes which are in the same process space.
3539

3640
## Messages (.msg)
3741
* [FloatingPointRange](msg/FloatingPointRange.msg): Represents bounds and a step value for a floating point typed parameter
@@ -46,14 +50,17 @@ The ROS API for a node will be as follows inside the node's namespace.
4650
* [ParameterType](msg/ParameterType.msg): Enum definitions for denoting a parameter value's type
4751
* [ParameterValue](msg/ParameterValue.msg): The associated value and type of a parameter
4852
* [SetParameterResult](msg/SetParametersResult.msg): Result message indicating whether a set parameters event succeeded
53+
* [SetLoggerLevelsResult](msg/SetLoggerLevelsResult.msg): Result message indicating whether a set logger level event succeeded
4954

5055
## Services (.srv)
5156
* [DescribeParameters](srv/DescribeParameters.srv): Request a list of descriptions for a specified list of parameters.
5257
* [GetParameters](srv/GetParameters.srv): Get the values of a specific list of parameters
5358
* [GetParameterTypes](srv/GetParametersTypes.srv): Get the enum type of a list of parameters
5459
* [ListParameters](srv/ListParameters.srv): Get the list of parameters given a list of prefixes
5560
* [SetParameters](srv/SetParameters.srv): Add or change a list of parameters individually
56-
* [SetParametersAtomically](srv/SetParametersAtomically.srv): Add or change all parameters in a list or none at all.
61+
* [SetParametersAtomically](srv/SetParametersAtomically.srv): Add or change all parameters in a list or none at all
62+
* [GetLoggerLevels](srv/GetLoggerLevels.srv): Get the logger levels of a specific list of nodes which are in the same process space
63+
* [SetLoggerLevels](srv/SetLoggerLevels.srv): Change a list of logger levels of nodes which are in the same process space
5764

5865
## Quality Declaration
5966
This package claims to be in the **Quality Level 1** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details.

rcl_interfaces/msg/LoggerLevel.msg

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# All available logger levels; these correspond to the enum in rcutils/logger.h
2+
3+
uint8 LOG_LEVEL_UNKNOWN = 0
4+
uint8 LOG_LEVEL_DEBUG = 10
5+
uint8 LOG_LEVEL_INFO = 20
6+
uint8 LOG_LEVEL_WARN = 30
7+
uint8 LOG_LEVEL_ERROR = 40
8+
uint8 LOG_LEVEL_FATAL = 50
9+
10+
# The logger name.
11+
string name
12+
13+
# The logger level
14+
uint32 level
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# True when succeed, false when failed.
2+
bool successful
3+
4+
# Reason why the setting was either successful or a failure.
5+
string reason
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# A list of logger names to get.
2+
string[] names
3+
4+
---
5+
# List of logger levels which is the same order as the provided names. If a
6+
# logger was not yet set, the value will have 'unknown' as the value.
7+
LoggerLevel[] levels
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# A list of loggers to set.
2+
LoggerLevel[] levels
3+
4+
---
5+
# Indicates whether setting each logger succeeded or not and why.
6+
SetLoggerLevelsResult[] results

0 commit comments

Comments
 (0)