Skip to content

Commit 2093b3c

Browse files
committed
First draft for new features list.
Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com>
1 parent a2b88e4 commit 2093b3c

2 files changed

Lines changed: 102 additions & 32 deletions

File tree

_docs/overview/features/index.md

Lines changed: 66 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,70 @@
11
---
2-
title: Features Status
2+
title: Features Overview
33
permalink: /docs/overview/features/
44
---
55

6-
Status of micro-ROS features. The features list has been compiled from [https://index.ros.org/doc/ros2/Features/](https://index.ros.org/doc/ros2/Features/) and [https://index.ros.org/doc/ros2/Roadmap/](https://index.ros.org/doc/ros2/Roadmap/).
7-
8-
All *status in italics* point to on-going works or open issues. If you could make any contribution, please open a pull request at a relevant [micro-ROS repository](https://github.com/micro-ROS/) or contact us via [Slack](https://micro-ros.slack.com/).
9-
10-
Feature | Status
11-
-- | --
12-
Discovery, transport and serialization over DDS | Use of resource-optimized middleware standard [DDS for Extremely Resource Constrained Environments (DDS-XRCE)](https://www.omg.org/spec/DDS-XRCE/), implemented by [Micro XRCE-DDS](https://github.com/eProsima/Micro-XRCE-DDS) and compatible with standard DDS via an XRCE Agent on connected stronger microprocessor.
13-
Support for multiple DDS implementations, chosen at runtime | Support is possible in principle, but at compile-time only. So far there is only one DDS-XRCE implementation available, namely [Micro DDS-XRCE](https://github.com/eProsima/Micro-XRCE-DDS).
14-
Common core client library that is wrapped by language-specific libraries | micro-ROS uses the core library [rcl](https://github.com/ros2/rcl/) from ROS 2 mainly as-is. The [rclc](https://github.com/micro-ROS/rclc) package provides convenience functions and an executor for use of rcl+rclc as an API for the C programming language. The standard rclcpp, which makes extensive use of dynamic data structures, may be used on MCUs with sufficient RAM.
15-
Publish/subscribe over topics | Concept available as known from ROS 2. Convenience functions for creation of publishers and subscriptions in C provided in [rclc](https://github.com/micro-ROS/rclc). Note that micro-ROS supports fixed-size message types only to avoid dynamic memory allocations.*
16-
Clients and services | Concept available as known from ROS 2. Note that micro-ROS supports fixed-size message types only to avoid dynamic memory allocations. *Convenience functions for clients and services as well as support by the rclc Executor are under development.*
17-
ROS 1 -- ROS 2 communication bridge | Not applicable, but the standard ROS 1 -- ROS 2 bridge can be used via micro-ROS-Agent on a stronger microprocessor to communicate with micro-ROS nodes.
18-
Quality of service settings for handling non-ideal networks | Two QoS semantics, reliable and best-effort semantics, are provided. It can be set at compile-time.
19-
Inter- and intra-process communication using the same API | No shared-memory interprocess communication on the MCU available, but all communication is performed via the micro-ROS-Agent running on a connected microprocessor. *Efficient shared-memory communication on the MCU is considered as an important feature for future releases.*
20-
Composition of node components at compile-, link- or dlopen-time | Composition at compile-time only. Composition at runtime would depend highly on the RTOS.
21-
Support for nodes with managed lifecycles | The [rclc_lifecycle](https://github.com/micro-ROS/rclc/blob/master/rclc_lifecycle/) package provides an `rclc_lifecycle_node` type which bundles an rcl node with the lifecycle state machine as well as corresponding convenience functions.
22-
DDS-Security support | DDS security is supported at micro-ROS-Agent. *Security mechanisms in Micro XRCE-DDS are planned for future releases.*
23-
Command-line introspection tools using an extensible framework | From a remote microprocessor all standard ROS 2 tools can be used to introspect the micro-ROS nodes on an MCU. micro-ROS nodes appear as ROS 2 nodes (by the micro-ROS-Agent). Note, however, that the node graph API is currently *not* available on the MCU.
24-
Launch system for coordinating multiple nodes | No launch system for the micro-ROS nodes on an MCU available. Such a system would depend highly on the RTOS. The system-modes concept developed with micro-ROS allows runtime configuration/orchestration of ROS 2 and micro-ROS nodes together.
25-
Namespace support for nodes and topics | Available just as in ROS 2.
26-
Static remapping of ROS names | *Should be available if passed as argument via standard rcl API -- to be checked.*
27-
Demos of an all-ROS 2 mobile robot | Demos of several ROS 2 + micro-ROS robots available. See [https://micro-ros.github.io/docs/tutorials/demos/](https://micro-ros.github.io/docs/tutorials/demos/).
28-
Support for real-time code | The [rclc Executor](https://github.com/micro-ROS/rclc/tree/master/rclc) provides mechanisms for implementing real-time-critical applications with micro-ROS.
29-
Support for "bare-metal" microcontrollers | Bringing ROS 2 onto MCUs is all that micro-ROS is about. A crucial difference to this requirement from the early design phase of ROS 2 is that micro-ROS assumes an RTOS (e.g., [FreeRTOS](https://www.freertos.org/), [Zephyr](https://www.zephyrproject.org/), or [NuttX](http://nuttx.apache.org/)).
30-
IDL | Same message IDL as with ROS 2, but use of resource-optimized CDR serialization implementation named [Micro-CDR](https://github.com/eProsima/Micro-CDR).
31-
Build system | Build systems of NuttX, FreeRTOS, and Zephyr are integrated with colcon. Furthermore, micro-ROS is provided as a component for ESP-IDF also as a standalone Zephyr module. The build system is likely the most fragile part of micro-ROS w.r.t. the long-term maintenance, due to the many dependencies.
32-
Continuous Integration | Currently, the CI for micro-ROS is distributed to GitHub and Gitlab. *Until the end of 2020, all CI should be moved migrated completely to the new CI actions of GitHub.* Please note that those packages that are released for standard ROS 2 are also built and tested on [build.ros2.org](http://build.ros2.org/).
33-
Documentation | High-level documentation at [micro-ros.github.io](https://micro-ros.github.io/). For detailed information please consult the README.md files in the relevant micro-ROS repositories at [github.com/micro-ROS/](https://github.com/micro-ROS/).
34-
Logging | *Could be available as part of the standard logging mechanism in principle but not supported by Micro-XRCE-DDS due to dynamic message size. To be checked ...*
35-
Time-related: Support of rate and sleep with system clock | rcl timers use POSIX API. Tested successfully on NuttX, but the resolution is very low. A higher resolution could be achieved with hardware timers -- which highly depends on the MCU and possibly the RTOS. *This feature requires further investigation.*
36-
Time-related: Support for simulation time | *Might be supported out of the box, but needs to be checked.* We consider HIL setups with simulation time to be corner cases.
6+
<section style="display: grid; grid-template-columns: 1fr 9fr;">
7+
<h1 style="writing-mode: vertical-lr; text-align: center; color: #C3DBEE;">
8+
ROS Interoperability
9+
</h1>
10+
<div>
11+
<h2>Support for major ROS concepts</h2>
12+
<p>Micro-ROS brings all major core concepts such as nodes, publish/subscribe (topics), client/service, parameters, node lifecycle on microcontrollers (MCU). The client API of micro-ROS (in the C programming language) is based on the standard ROS 2 Client Support Library (rcl) and a set of extensions and convenience functions (rclc).</p>
13+
14+
<h2>Seamless integration with ROS 2</h2>
15+
<p>The micro-ROS agent connects micro-ROS nodes (i.e. components) on MCUs seamlessly with standard ROS 2 systems. This allows accessing micro-ROS nodes with the known ROS 2 tools and APIs just as normal ROS nodes.</p>
16+
</div>
17+
</section>
18+
19+
<section style="display: grid; grid-template-columns: 1fr 9fr; margin-top: 3em;">
20+
<h1 style="writing-mode: vertical-lr; text-align: center; color: #C3DBEE;">
21+
Deeply Embedded
22+
</h1>
23+
<div>
24+
<h2>Multi-RTOS support</h2>
25+
<p>Micro-ROS supports three important open-source real-time operating sytems (RTOS): FreeRTOS, Zephyr, and NuttX. It can be ported on any RTOS that comes with a POSIX interface.</p>
26+
27+
<h2>MCU-optimized middleware</h2>
28+
<p>Micro XRCE-DDS by eProsima meets all requirements for a middleware for deeply embedded systems. That is why micro-ROS has been one of the applications for this implementation of the new DDS for Extremely Resource Constrained Environments (XRCE) standard. For the integration with the ROS middleware interface (rmw) in the micro-ROS stack, static memory pools were introduced to avoid dynamic memory allocations at runtime.</p>
29+
30+
<h2>Support for major transports</h2>
31+
<p>By the Micro XRCE-DDS middleware, micro-ROS comes with built-in support for serial transports, UDP over Ethernet, Wi-Fi, and 6LoWPAN, and Bluetooth. The Micro XRCE-DDS source code provides templates for implementing support for further transports.</p>
32+
33+
<h2>MCU-optimized ROS client API</h2>
34+
<p>The combination rcl+rclc is optimized for MCUs. After an initialization phase, it can be used without any dynamic memory allocations. The rclc package provides advanced execution mechanisms allowing implementing well-proven scheduling patterns from embedded systems engineering.</p>
35+
</div>
36+
</section>
37+
38+
<section style="display: grid; grid-template-columns: 1fr 9fr; margin-top: 3em;">
39+
<h1 style="writing-mode: vertical-lr; text-align: center; color: #C3DBEE;">
40+
Tooling
41+
</h1>
42+
<div>
43+
<h2>Flexible build system</h2>
44+
<p>Micro-ROS integrates the RTOS-specific build systems into few scripts that are provided as a ROS 2 package. Therefore, ROS developers can use their usual command line tools. In addition, micro-ROS provides selected integrations with RTOS-specific tool chains (e.g., for ESP-IDF and Zephyr).</p>
45+
46+
<h2>Benchmarking Tools</h2>
47+
<p>To optimize micro-ROS-based applications to the MCU hardware, micro-ROS provides benchmarking tools. This allows us to check memory usage, CPU time consumption and general performance.</p>
48+
</div>
49+
</section>
50+
51+
<section style="display: grid; grid-template-columns: 1fr 9fr; margin-top: 3em;">
52+
<h1 style="writing-mode: vertical-lr; text-align: center; color: #C3DBEE;">
53+
Openness
54+
</h1>
55+
<div>
56+
<h2>Permissive license</h2>
57+
<p>The micro-ROS stack, including the Micro XRCE-DDS middleware, comes under the same permissive license as ROS 2, which is Apache License 2.0. (When building projects with micro-ROS, please take into account the license(s) of the underlying RTOS.)</p>
58+
59+
<h2>Community and Support</h2>
60+
<p>Micro-ROS is developed by a constantly growing, self-organized community backed by the Embedded Working Group, a formal ROS 2 Working Group. The community shares entry level tutorials, provides support via Slack and GitHub, and meets in public Working Group video-calls on a monthly basis. As a matter of course, commercial support is provided for the Micro XRCE-DDS by eProsima.</p>
61+
62+
<h2>High maintainability</h2>
63+
<p>Micro-ROS is made up of well-established components: Famous open-source RTOSs, a standardized middleware, and the standard ROS 2 Client Support Library (rcl). In this way, the amount of micro-ROS-specific code was minimized for long-term maintainability.</p>
64+
65+
<h2>Interoperability with other standards</h2>
66+
<p>The micro-ROS stack preserves the modularity of the standard ROS 2 stack. It can be used with a custom middleware layer - and thus standard - or a custom ROS client library. Furthermore, in the context of micro-ROS, we have developed the FIROS2 integration services, which connects the Robot Operating System with the FIWARE Context Broker by the NGSIv2 (Next Generation Service Interface) standard.</p>
67+
68+
</div>
69+
</section>
70+
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Features Status
3+
permalink: /docs/overview/features/
4+
---
5+
6+
Status of micro-ROS features. The features list has been compiled from [https://index.ros.org/doc/ros2/Features/](https://index.ros.org/doc/ros2/Features/) and [https://index.ros.org/doc/ros2/Roadmap/](https://index.ros.org/doc/ros2/Roadmap/).
7+
8+
All *status in italics* point to on-going works or open issues. If you could make any contribution, please open a pull request at a relevant [micro-ROS repository](https://github.com/micro-ROS/) or contact us via [Slack](https://micro-ros.slack.com/).
9+
10+
Feature | Status
11+
-- | --
12+
Discovery, transport and serialization over DDS | Use of resource-optimized middleware standard [DDS for Extremely Resource Constrained Environments (DDS-XRCE)](https://www.omg.org/spec/DDS-XRCE/), implemented by [Micro XRCE-DDS](https://github.com/eProsima/Micro-XRCE-DDS) and compatible with standard DDS via an XRCE Agent on connected stronger microprocessor.
13+
Support for multiple DDS implementations, chosen at runtime | Support is possible in principle, but at compile-time only. So far there is only one DDS-XRCE implementation available, namely [Micro DDS-XRCE](https://github.com/eProsima/Micro-XRCE-DDS).
14+
Common core client library that is wrapped by language-specific libraries | micro-ROS uses the core library [rcl](https://github.com/ros2/rcl/) from ROS 2 mainly as-is. The [rclc](https://github.com/micro-ROS/rclc) package provides convenience functions and an executor for use of rcl+rclc as an API for the C programming language. The standard rclcpp, which makes extensive use of dynamic data structures, may be used on MCUs with sufficient RAM.
15+
Publish/subscribe over topics | Concept available as known from ROS 2. Convenience functions for creation of publishers and subscriptions in C provided in [rclc](https://github.com/micro-ROS/rclc). Note that micro-ROS supports fixed-size message types only to avoid dynamic memory allocations.*
16+
Clients and services | Concept available as known from ROS 2. Note that micro-ROS supports fixed-size message types only to avoid dynamic memory allocations. *Convenience functions for clients and services as well as support by the rclc Executor are under development.*
17+
ROS 1 -- ROS 2 communication bridge | Not applicable, but the standard ROS 1 -- ROS 2 bridge can be used via micro-ROS-Agent on a stronger microprocessor to communicate with micro-ROS nodes.
18+
Quality of service settings for handling non-ideal networks | Two QoS semantics, reliable and best-effort semantics, are provided. It can be set at compile-time.
19+
Inter- and intra-process communication using the same API | No shared-memory interprocess communication on the MCU available, but all communication is performed via the micro-ROS-Agent running on a connected microprocessor. *Efficient shared-memory communication on the MCU is considered as an important feature for future releases.*
20+
Composition of node components at compile-, link- or dlopen-time | Composition at compile-time only. Composition at runtime would depend highly on the RTOS.
21+
Support for nodes with managed lifecycles | The [rclc_lifecycle](https://github.com/micro-ROS/rclc/blob/master/rclc_lifecycle/) package provides an `rclc_lifecycle_node` type which bundles an rcl node with the lifecycle state machine as well as corresponding convenience functions.
22+
DDS-Security support | DDS security is supported at micro-ROS-Agent. *Security mechanisms in Micro XRCE-DDS are planned for future releases.*
23+
Command-line introspection tools using an extensible framework | From a remote microprocessor all standard ROS 2 tools can be used to introspect the micro-ROS nodes on an MCU. micro-ROS nodes appear as ROS 2 nodes (by the micro-ROS-Agent). Note, however, that the node graph API is currently *not* available on the MCU.
24+
Launch system for coordinating multiple nodes | No launch system for the micro-ROS nodes on an MCU available. Such a system would depend highly on the RTOS. The system-modes concept developed with micro-ROS allows runtime configuration/orchestration of ROS 2 and micro-ROS nodes together.
25+
Namespace support for nodes and topics | Available just as in ROS 2.
26+
Static remapping of ROS names | *Should be available if passed as argument via standard rcl API -- to be checked.*
27+
Demos of an all-ROS 2 mobile robot | Demos of several ROS 2 + micro-ROS robots available. See [https://micro-ros.github.io/docs/tutorials/demos/](https://micro-ros.github.io/docs/tutorials/demos/).
28+
Support for real-time code | The [rclc Executor](https://github.com/micro-ROS/rclc/tree/master/rclc) provides mechanisms for implementing real-time-critical applications with micro-ROS.
29+
Support for "bare-metal" microcontrollers | Bringing ROS 2 onto MCUs is all that micro-ROS is about. A crucial difference to this requirement from the early design phase of ROS 2 is that micro-ROS assumes an RTOS (e.g., [FreeRTOS](https://www.freertos.org/), [Zephyr](https://www.zephyrproject.org/), or [NuttX](http://nuttx.apache.org/)).
30+
IDL | Same message IDL as with ROS 2, but use of resource-optimized CDR serialization implementation named [Micro-CDR](https://github.com/eProsima/Micro-CDR).
31+
Build system | Build systems of NuttX, FreeRTOS, and Zephyr are integrated with colcon. Furthermore, micro-ROS is provided as a component for ESP-IDF also as a standalone Zephyr module. The build system is likely the most fragile part of micro-ROS w.r.t. the long-term maintenance, due to the many dependencies.
32+
Continuous Integration | Currently, the CI for micro-ROS is distributed to GitHub and Gitlab. *Until the end of 2020, all CI should be moved migrated completely to the new CI actions of GitHub.* Please note that those packages that are released for standard ROS 2 are also built and tested on [build.ros2.org](http://build.ros2.org/).
33+
Documentation | High-level documentation at [micro-ros.github.io](https://micro-ros.github.io/). For detailed information please consult the README.md files in the relevant micro-ROS repositories at [github.com/micro-ROS/](https://github.com/micro-ROS/).
34+
Logging | *Could be available as part of the standard logging mechanism in principle but not supported by Micro-XRCE-DDS due to dynamic message size. To be checked ...*
35+
Time-related: Support of rate and sleep with system clock | rcl timers use POSIX API. Tested successfully on NuttX, but the resolution is very low. A higher resolution could be achieved with hardware timers -- which highly depends on the MCU and possibly the RTOS. *This feature requires further investigation.*
36+
Time-related: Support for simulation time | *Might be supported out of the box, but needs to be checked.* We consider HIL setups with simulation time to be corner cases.

0 commit comments

Comments
 (0)