Skip to content

Commit 4f54a34

Browse files
authored
Reorganized client library section. (#281)
* Reorganized pages in client library section. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Updated intro text on Client Library. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Moved decision paper to a PDF file. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Wrote preliminary page on micro-ROS diagnostics. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Create basic feature list page.
1 parent 416af30 commit 4f54a34

36 files changed

Lines changed: 74 additions & 396 deletions

_data/docs.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212

1313
- title: Client Library
1414
docs:
15-
- concepts/client_library
16-
- concepts/client_library/real-time_executor
17-
- concepts/client_library/system_modes
18-
- concepts/client_library/decision_paper
19-
- concepts/client_library/rcutils_analysis
15+
- concepts/client_library/introduction
16+
- concepts/client_library/features
17+
- concepts/client_library/execution_management
18+
- concepts/client_library/lifecycle_and_system_modes
19+
- concepts/client_library/diagnostics
2020

2121
- title: Middleware
2222
docs:
Binary file not shown.
Binary file not shown.

_docs/concepts/client_library/decision_paper/index.md

Lines changed: 0 additions & 213 deletions
This file was deleted.
42.9 KB
Loading
Binary file not shown.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Diagnostics
3+
permalink: /docs/concepts/client_library/diagnostics/
4+
---
5+
6+
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.
7+
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:
9+
10+
* Diagnostic message types (optimized for Micro-XRCE-DDS - no dynamic arrays)
11+
* Updater mechanisms for rclc
12+
* Selected basic diagnostic monitors
13+
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:
15+
16+
<img src="diagnostics_architecture.png" style="display:block; width:60%; margin-left:auto; margin-right:auto;"/>
17+
18+
For more information, please see [https://github.com/micro-ROS/micro_ros_diagnostics/](https://github.com/micro-ROS/micro_ros_diagnostics/).

_docs/concepts/client_library/real-time_executor/cbg-executor_sample_system.png renamed to _docs/concepts/client_library/execution_management/cbg-executor_sample_system.png

File renamed without changes.

_docs/concepts/client_library/real-time_executor/cbg-executor_test-bench_architecture.png renamed to _docs/concepts/client_library/execution_management/cbg-executor_test-bench_architecture.png

File renamed without changes.

_docs/concepts/client_library/real-time_executor/cbg-executor_test-bench_results.png renamed to _docs/concepts/client_library/execution_management/cbg-executor_test-bench_results.png

File renamed without changes.

0 commit comments

Comments
 (0)