Skip to content

Commit 2051643

Browse files
pablogs9jamoralp
andauthored
Update README.md with secondary buildsystems (#221)
* Update README.md with secondary buildsystems * Bold * Bold v2 * Shorter text in table * Update README.md Co-authored-by: Jose Antonio Moral <joseantoniomoralparras@gmail.com> * Update Zephyr version Co-authored-by: Jose Antonio Moral <joseantoniomoralparras@gmail.com>
1 parent 4ac4a45 commit 2051643

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
This ROS 2 package is the entry point for building micro-ROS apps for different embedded platforms.
33

44
- [Supported platforms](#supported-platforms)
5+
- [Secondary build system tools](#secondary-build-system-tools)
56
- [Dependencies](#dependencies)
67
- [Building](#building)
78
- [Creating micro-ROS firmware](#creating-micro-ros-firmware)
@@ -16,6 +17,8 @@ This ROS 2 package is the entry point for building micro-ROS apps for different
1617

1718
# Supported platforms
1819

20+
This package is the **official build system for micro-ROS**. It provides tools and utils to crosscompile micro-ROS with just the common ROS 2 tools for these platforms:
21+
1922
| RTOS | Platform | Version | Example |
2023
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------- | -------------------- | ---------------------------- |
2124
| [Nuttx](https://nuttx.org/) | [Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware) | v7.29 | `nuttx olimex-stm32-e407` |
@@ -24,18 +27,29 @@ This ROS 2 package is the entry point for building micro-ROS apps for different
2427
| [FreeRTOS](https://www.freertos.org/) | [ST Nucleo F446ZE](https://www.st.com/en/evaluation-tools/nucleo-f446ze.html) <sup>1</sup> | STM32CubeMX latest | `freertos nucleo_f446ze` |
2528
| [FreeRTOS](https://www.freertos.org/) | [ST Nucleo F746ZG](https://www.st.com/en/evaluation-tools/nucleo-f746zg.html) <sup>1</sup> | STM32CubeMX latest | `freertos nucleo_f746zg` |
2629
| [FreeRTOS](https://www.freertos.org/) | [Espressif ESP32](https://www.espressif.com/en/products/socs/esp32/overview) | v8.2.0 | `freertos esp32` |
27-
| [Zephyr](https://www.zephyrproject.org/) | [Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware) | v2.3.0 | `zephyr olimex-stm32-e407` |
28-
| [Zephyr](https://www.zephyrproject.org/) | [ST B-L475E-IOT01A](https://docs.zephyrproject.org/latest/boards/arm/disco_l475_iot1/doc/index.html) | v2.3.0 | `zephyr discovery_l475_iot1` |
29-
| [Zephyr](https://www.zephyrproject.org/) | [ST Nucleo H743ZI](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html) <sup>1</sup> | v2.3.0 | `zephyr nucleo_h743zi` |
30-
| [Zephyr](https://www.zephyrproject.org/) | [Zephyr emulator](https://docs.zephyrproject.org/2.3.0/boards/posix/native_posix/doc/index.html) | v2.3.0 | `zephyr host` |
30+
| [Zephyr](https://www.zephyrproject.org/) | [Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware) | v2.4.99 | `zephyr olimex-stm32-e407` |
31+
| [Zephyr](https://www.zephyrproject.org/) | [ST B-L475E-IOT01A](https://docs.zephyrproject.org/latest/boards/arm/disco_l475_iot1/doc/index.html) | v2.4.99 | `zephyr discovery_l475_iot1` |
32+
| [Zephyr](https://www.zephyrproject.org/) | [ST Nucleo H743ZI](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html) <sup>1</sup> | v2.4.99 | `zephyr nucleo_h743zi` |
33+
| [Zephyr](https://www.zephyrproject.org/) | [Zephyr emulator](https://docs.zephyrproject.org/2.3.0/boards/posix/native_posix/doc/index.html) | v2.4.99 | `zephyr host` |
34+
| - | Static library (.a) and headers (.h) <sup>3</sup> | - | `generate_lib` |
3135
| Linux | *Host <sup>2</sup>* | Ubuntu 18.04/20.04 | `host` |
3236

3337
*<sup>1</sup> Community supported, may have lack of official support*
3438

3539
*<sup>2</sup> Support for compiling apps in a native Linux host for testing and debugging*
3640

41+
*<sup>3</sup> a valid CMake toolchain with custom crosscompilation definition is required*
42+
3743
Please note that NuttX with Olimex STM32-E407 board is the reference platform and not everything might be supported on other platforms.
3844

45+
## Secondary build system tools
46+
47+
micro-ROS also offers some other ways to crosscompile it for different platforms. These other options are secondary tools and may not have full support for all features. Currently micro-ROS is also available as:
48+
49+
- a standalone **[micro-ROS component for ESP-IDF](https://github.com/micro-ROS/micro_ros_espidf_component)**: this package enables the integration of micro-ROS in any Espressif ESP32 IDF project.
50+
- a standalone **[micro-ROS module for Zephyr RTOS](https://github.com/micro-ROS/micro_ros_zephyr_module)**: this package enables the integration of micro-ROS in any Zephyr RTOS workspace.
51+
- a precompiled set of **[Arduino IDE libraries](https://github.com/micro-ROS/micro_ros_arduino)**: this package enables the integration of micro-ROS in the Arduino IDE for some hardware platforms.
52+
3953
# Dependencies
4054

4155
This package targets the **ROS 2** installation. ROS 2 supported distributions are:

0 commit comments

Comments
 (0)