Skip to content

Commit 4035b37

Browse files
norroralph-lange
andauthored
Updated diagnostics architecture description (#285)
* Improved uros diagnostic architecture diagram * Mention necessary translation of diagnostic messages * Update _docs/concepts/client_library/diagnostics/index.md Signed-off-by: Arne Nordmann (CR/AEA2) <arne.nordmann@de.bosch.com> Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
1 parent 713de0e commit 4035b37

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

-11.4 KB
Loading
Binary file not shown.

_docs/concepts/client_library/diagnostics/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@ permalink: /docs/concepts/client_library/diagnostics/
55

66
Although diagnostics is not part of the ROS 2 Client Library packages (i.e., rclcpp, rclpy), it definitely can be counted to the extended client library as it provides very generic and application-independent functionalities.
77

8-
That's why the micro-ROS Client Library also comes with basic diagnostics functionalities. These are compatible with ROS 2 diagnostics, but comprise three features only:
8+
That's why the micro-ROS Client Library comes with basic diagnostics functionalities. These are compatible with ROS 2 diagnostics and comprise three features only:
99

1010
* Diagnostic message types (optimized for Micro-XRCE-DDS - no dynamic arrays)
1111
* Updater mechanisms for rclc
12-
* Selected basic diagnostic monitors
12+
* Selected basic diagnostic monitors for microcontrollers
1313

14-
The micro-ROS diagnostics packages do not provide any aggregation mechanisms as we assume that such aggregation takes place on a microprocessor running standard ROS 2. Hence, we assume the following typical architecture:
14+
The micro-ROS diagnostics packages do not provide any aggregator as we assume that such aggregation takes place on a microprocessor running standard ROS 2. Hence, we assume the following typical architecture:
1515

1616
<img src="diagnostics_architecture.png" style="display:block; width:60%; margin-left:auto; margin-right:auto;"/>
1717

18-
For more information, please see [https://github.com/micro-ROS/micro_ros_diagnostics/](https://github.com/micro-ROS/micro_ros_diagnostics/).
18+
In order for the standard ROS 2 diagnostic aggregator to aggregate micro-ROS diagnostic message types, the ROS 2 agent has to translate micro-ROS diagnostic messages to standard ROS 2 diagnostic messages (*tbd*).
19+
20+
For more information, please see [https://github.com/micro-ROS/micro_ros_diagnostics/](https://github.com/micro-ROS/micro_ros_diagnostics/). For further information on ROS 2 diagnostics, see [ROS 2 diagnostics](https://github.com/ros/diagnostics/tree/ros2-devel) and [ROS 2 diagnostic_msgs](https://github.com/ros2/common_interfaces/tree/master/diagnostic_msgs).

0 commit comments

Comments
 (0)