Skip to content

Commit 8525841

Browse files
committed
Restructuring of RTOS subsection in concepts section #108.
Signed-off-by: Ralph Lange (CR/AEE1) <ralph.lange@de.bosch.com>
1 parent 2bc396f commit 8525841

7 files changed

Lines changed: 77 additions & 21 deletions

File tree

‎_data/docs.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- overview/comparison
88

99

10-
1110
- title: Client Library
1211
docs:
1312
- concepts/client_library
@@ -27,13 +26,17 @@
2726
- title: RTOS
2827
docs:
2928
- concepts/rtos
29+
- concepts/rtos/FreeRTOS
30+
- concepts/rtos/NuttX
31+
- concepts/rtos/Zephyr
32+
- concepts/rtos/comparison
33+
- concepts/rtos/integration_with_colcon
3034

3135
- title: Benchmarking
3236
docs:
3337
- concepts/benchmarking
3438

3539

36-
3740
- title: Basic Tutorials
3841
docs:
3942
- tutorials/basic/getting_started
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: FreeRTOS
3+
permalink: /docs/concepts/rtos/FreeRTOS/
4+
---
5+
6+
<img style="float:right; padding-left:5px;" width="263" height="100" src="https://upload.wikimedia.org/wikipedia/commons/4/4e/Logo_freeRTOS.png">
7+
8+
FreeRTOS is distributed under the MIT license. It is know particularly for is simplicity and the extension a:FreeRTOS provided by Amazon. For micro-ROS, we make use of the [POSIX extension](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_POSIX/).
9+
10+
## Links
11+
12+
* Main website: [https://www.freertos.org/](https://www.freertos.org/)
13+
* Download: [https://www.freertos.org/a00104.html](https://www.freertos.org/a00104.html)
14+
* Documentation: [https://www.freertos.org/Documentation/RTOS_book.html](https://www.freertos.org/Documentation/RTOS_book.html)

‎_docs/concepts/rtos/NuttX/index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: NuttX
3+
permalink: /docs/concepts/rtos/NuttX/
4+
---
5+
6+
<img style="float:right; padding-left:5px;" width="125" height="125" src="https://upload.wikimedia.org/wikipedia/commons/b/b0/NuttX_logo.png">
7+
8+
NuttX emphasizes its compliance with standards - including POSIX - and small footprint. It can be fit on 8- to 32-bit microcontrollers. The use of POSIX and ANSI standards, together with the mimic it does to UNIX APIs, makes it friendly to the developers that are used to Linux. NuttX is licensed under BSD license and makes use of the GNU toolchain.
9+
10+
## Links
11+
12+
* Main website: [https://nuttx.apache.org/](https://nuttx.apache.org/)
13+
* Download: [https://nuttx.apache.org/download/](https://nuttx.apache.org/download/)
14+
* Documentation: [https://cwiki.apache.org/confluence/display/NUTTX/Nuttx](https://cwiki.apache.org/confluence/display/NUTTX/Nuttx)
15+
16+
## Supported development boards
17+
18+
Check [supported board](/docs/overview/hardware/) section for more information about the boards we are currently using.
19+
20+
## Getting started with NuttX and micro-ROS
21+
22+
In order to obtain more information about how to get started using this RTOS, please check our [tutorials section](/docs/tutorials/basic/getting_started/).
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Zephyr
3+
permalink: /docs/concepts/rtos/Zephyr/
4+
---
5+
6+
<img style="float:right; padding-left:5px;" width="220" height="114" src="https://upload.wikimedia.org/wikipedia/commons/2/2d/Zephyr-logo.png">
7+
8+
Zephyr is a fairly new open-source RTOS, developed in a Linux Foundation Project. The members of this project include several renowned semiconductor companies. Zephyr [strives for a functional safety certification](https://www.zephyrproject.org/zephyr-project-rtos-first-functional-safety-certification-submission-for-an-open-source-real-time-operating-system/), which would make it the first open-source RTOS with such a certification.
9+
10+
## Links
11+
12+
* Main website: [https://www.zephyrproject.org/](https://www.zephyrproject.org/)
13+
* Meta-tool *West*: [https://docs.zephyrproject.org/latest/guides/west/](https://docs.zephyrproject.org/latest/guides/west/)
14+
* Download: [https://github.com/zephyrproject-rtos/zephyr](https://github.com/zephyrproject-rtos/zephyr)
15+
* Documentation: [https://docs.zephyrproject.org/latest/](https://docs.zephyrproject.org/latest/)
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Comparison of these RTOS
3+
permalink: /docs/concepts/rtos/comparison/
4+
---
5+
6+
Work in progress.

‎_docs/concepts/rtos/index.md‎

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Real-Time Operating Systems (RTOS)
2+
title: Why a Real-Time Operating System?
33
permalink: /docs/concepts/rtos/
44
---
55

6-
The use of Real-Time Operating Systems (RTOS) is a general practice in nowadays embedded systems. These embedded devices typically consist of a resource-constrained microcontroller that executes an application where the interaction with external components is performed. In many cases, this application contains a time-critical task where a time-deadline or deterministic response is required.
6+
The use of Real-Time Operating Systems (RTOS) is a general practice in nowadays embedded systems. These embedded devices typically consist of a resource-constrained microcontroller that executes an application where the interaction with external components is performed. In many cases, this application contains a time-critical task where a deadline or deterministic response is required.
77

88
Bare-metal applications are also used nowadays, but it requires a very low-level programming skills and lacks of hardware abstraction layers that RTOSes offers. On the other hand, RTOSes typically uses hardware abstraction layers (HAL) that eases the use of hardware resources, such us timers and communication buses, making easier the development and allowing the reuse of code. In addition, they offer thread and tasks entities that, together with the use of schedulers, provides the necessary tools to implement determinism in the applications. The scheduling normally consists of different algorithms where the user can choose from. Another feature that RTOSes normally offers is the stack management, helping in the correct memory usage of the MCU, a valuable resource in embedded-systems.
99

@@ -15,22 +15,10 @@ As the Operating Systems (OS) that are available for computers, the RTOSes also
1515

1616
Notice that the RTOS call are made by several top layers in the micro-ROS stack. The main one using the RTOS primitives is the middleware. The middleware requires accessing to the transport resources of the RTOS (serial, UDP or 6LOWPAN communications for example), it also requires of the time resources of the RTOS to operate properly. In addition, it is expected that the micro-ROS client library could have access to RTOS resources to have control of mechanisms such as scheduling or power management, so the developer could optimize the application in many domains.
1717

18-
Unfortunately, these resources normally are not POSIX compliant, so the use of abstraction layers at RTOS level is required. These layers will allow to abstract the RTOSes in use and provide unified calls to control aforementioned resources.
18+
By now, micro-ROS supports three RTOSes, which all come with (basic) POSIX implementations:
1919

20-
## NuttX RTOS
20+
* [FreeRTOS](FreeRTOS/)
21+
* [NuttX](NuttX/)
22+
* [Zephyr](Zephyr/)
2123

22-
<br/><br/>
23-
24-
<img align="left" width="125" height="125" src="https://upload.wikimedia.org/wikipedia/commons/b/b0/NuttX_logo.png">
25-
26-
[NuttX](http://www.nuttx.org/) is a RTOS that emphasizes its compliance with standards (such us POSIX) and small footprint, it can be fit in 8 to 32 bit microcontrollers. The use of POSIX and ANSI standards, together with the mimic it does to UNIX APIs, makes it friendly to the developers that are used to Linux. The RTOS is licensed under BSD license and makes use of GNU toolchain. In order to obtain more information, please visit [NuttX overview page](https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Overview).
27-
28-
<br/><br/>
29-
30-
## Supported development boards
31-
32-
Check [supported board](/docs/overview/hardware/) section for more information about the boards we are currently using.
33-
34-
## Getting started with NuttX and micro-ROS
35-
36-
In order to obtain more information about how to get started using this RTOS, please check our [tutorials section](/docs/tutorials/basic/getting_started/).
24+
Most important, we [integrated these RTOSes with the ROS meta build system colcon](integration_with_colcon/).
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Integration with colcon
3+
permalink: /docs/concepts/rtos/integration_with_colcon/
4+
---
5+
6+
In order to streamline the use of different RTOSes with micro-ROS, we integrated the build systems of [FreeRTOS](../FreeRTOS/), [NuttX](../NuttX/), and [Zephyr](../Zephyr/) with the ROS 2 meta-build tool [colcon](https://colcon.readthedocs.io/) using [cmake](https://cmake.org/).
7+
8+
To learn more, please see [https://github.com/micro-ROS/micro-ros-build](https://github.com/micro-ROS/micro-ros-build).

0 commit comments

Comments
 (0)