Skip to content

Commit 2d53c08

Browse files
committed
Created first draft of client library page.
Signed-off-by: Ralph Lange (CR/AEE1) <ralph.lange@de.bosch.com>
1 parent d39d8f0 commit 2d53c08

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

_data/docs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
- title: Concepts
2121
docs:
2222
- rtos
23+
- client_library
2324
- real-time_executor
24-
- embedded_tf
2525
- system_modes
26+
- embedded_tf
2627
- FIROS2

_docs/client_library/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Client Library
3+
permalink: /docs/client_library/
4+
---
5+
6+
## Overview
7+
8+
The client library provides the micro-ROS API for the user code, i.e. for application-level micro-ROS nodes. The overall goal is to provide all relevant, major ROS 2 concepts in suitable implementation for microcontrollers. Where possible, API compatibility with ROS 2 shall be achieved for ease of portability.
9+
10+
In this undertaking, to minimize the long-term maintenance cost, we strive to use existing data structures and algorithms from the ROS 2 stack or to bring necessary changes in the mainline stack. In detail, this raises a lot of question regarding the applicability of existing ROS 2 layers on microcontrollers in terms of runtime efficiency, portability to different RTOS, dynamic memory management, and many more. These are explored and analyzed in a dedicated [decision paper](decision_paper/).
11+
12+
## Advanced Concepts
13+
14+
Advanced concepts developed in the context of the client library are documented separately. These are:
15+
16+
* [Real-Time Executor](/docs/real-time_executor/)
17+
* [System Modes](/docs/system_modes/)
18+
* [Embedded Transform (TF)](/docs/embedded_tf/)

0 commit comments

Comments
 (0)