Skip to content

Commit e88dc37

Browse files
Update standalone build tools section (backport #380) (#382)
* Update standalone build tools section (#380) * Update standalone build tools section * Upd * Updates (cherry picked from commit e13e64d) # Conflicts: # README.md * Update Co-authored-by: Pablo Garrido <[email protected]>
1 parent ae44150 commit e88dc37

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +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)
5+
- [Standalone build system tools](#standalone-build-system-tools)
66
- [Dependencies](#dependencies)
77
- [Building](#building)
88
- [Creating micro-ROS firmware](#creating-micro-ros-firmware)
@@ -29,10 +29,10 @@ This package is the **official build system for micro-ROS**. It provides tools a
2929
| [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` |
3030
| [FreeRTOS](https://www.freertos.org/) | [ST Nucleo F767ZI](https://www.st.com/en/evaluation-tools/nucleo-f746zg.html) <sup>1</sup> | STM32CubeMX latest | `freertos nucleo_f767zi` |
3131
| [FreeRTOS](https://www.freertos.org/) | [Espressif ESP32](https://www.espressif.com/en/products/socs/esp32/overview) | v8.2.0 | `freertos esp32` |
32-
| [Zephyr](https://www.zephyrproject.org/) | [Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware) | v2.6.0 | `zephyr olimex-stm32-e407` |
33-
| [Zephyr](https://www.zephyrproject.org/) | [ST B-L475E-IOT01A](https://docs.zephyrproject.org/latest/boards/arm/disco_l475_iot1/doc/index.html) | v2.6.0 | `zephyr discovery_l475_iot1` |
34-
| [Zephyr](https://www.zephyrproject.org/) | [ST Nucleo H743ZI](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html) <sup>1</sup> | v2.6.0 | `zephyr nucleo_h743zi` |
35-
| [Zephyr](https://www.zephyrproject.org/) | [Zephyr emulator](https://docs.zephyrproject.org/2.3.0/boards/posix/native_posix/doc/index.html) | v2.6.0 | `zephyr host` |
32+
| [Zephyr](https://www.zephyrproject.org/) | [Olimex STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware) | v2.6.0 | `zephyr olimex-stm32-e407` |
33+
| [Zephyr](https://www.zephyrproject.org/) | [ST B-L475E-IOT01A](https://docs.zephyrproject.org/latest/boards/arm/disco_l475_iot1/doc/index.html) | v2.6.0 | `zephyr discovery_l475_iot1` |
34+
| [Zephyr](https://www.zephyrproject.org/) | [ST Nucleo H743ZI](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html) <sup>1</sup> | v2.6.0 | `zephyr nucleo_h743zi` |
35+
| [Zephyr](https://www.zephyrproject.org/) | [Zephyr emulator](https://docs.zephyrproject.org/2.3.0/boards/posix/native_posix/doc/index.html) | v2.6.0 | `zephyr host` |
3636
| - | Static library (.a) and headers (.h) <sup>3</sup> | - | `generate_lib` |
3737
| Linux | *Host <sup>2</sup>* | Ubuntu 18.04/20.04 | `host` |
3838

@@ -42,33 +42,39 @@ This package is the **official build system for micro-ROS**. It provides tools a
4242

4343
*<sup>3</sup> a valid CMake toolchain with custom crosscompilation definition is required*
4444

45-
Please note that NuttX with Olimex STM32-E407 board is the reference platform and not everything might be supported on other platforms.
46-
47-
## Secondary build system tools
45+
## Standalone build system tools
4846

4947
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:
5048

49+
- a standalone **[micro-ROS component for Renesas e<sup>2</sup> studio and RA6M5](https://github.com/micro-ROS/micro_ros_renesas2estudio_component)**: this package enables the integration of micro-ROS in Renesas e<sup>2</sup> studio and RA6M5 MCU family.
5150
- 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.
5251
- 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.
52+
- a standalone **[micro-ROS module for Mbed RTOS](https://github.com/micro-ROS/micro_ros_mbed)**: this package enables the integration of micro-ROS in any Mbed RTOS workspace.
53+
- a standalone **[micro-ROS module for NuttX RTOS](https://github.com/micro-ROS/micro_ros_nuttx_app)**: this package enables the integration of micro-ROS in any NuttX RTOS workspace.
54+
- a standalone **[micro-ROS module for Microsoft Azure RTOS](https://github.com/micro-ROS/micro_ros_azure_rtos_app)**: this package enables the integration of micro-ROS in a Microsoft Azure RTOS workspace.
55+
- a set of **[micro-ROS utils for STM32CubeMX and STM32CubeIDE](https://github.com/micro-ROS/micro_ros_stm32cubemx_utils)**: this package enables the integration of micro-ROS in STM32CubeMX and STM32CubeIDE.
5356
- 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.
57+
- a precompiled set of **[Raspberry Pi Pico SDK libraries](https://github.com/micro-ROS/micro_ros_raspberrypi_pico_sdk)**: this package enables the integration of micro-ROS in the Raspberry Pi Pico SDK.
5458

5559
# Dependencies
5660

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

59-
| ROS 2 Distro | State | Branch |
60-
| ------------ | --------- | --------- |
61-
| Crystal | Supported | `crystal` |
62-
| Dashing | Supported | `dashing` |
63-
| Foxy | Supported | `foxy` |
63+
| ROS 2 Distro | State | Branch |
64+
| ------------ | --------- | ---------- |
65+
| Crystal | EOL | `crystal` |
66+
| Dashing | EOL | `dashing` |
67+
| Foxy | Supported | `foxy` |
68+
| Galactic | Supported | `galactic` |
69+
| Rolling | Supported | `main` |
6470

6571
Some other prerequisites needed for building a firmware using this package are:
6672

6773
```
6874
sudo apt install python3-rosdep
6975
```
7076

71-
# Building
77+
# Building
7278

7379
Create a ROS 2 workspace and build this package for a given ROS 2 distro (see table above):
7480

@@ -180,7 +186,7 @@ This folder contains up to four scripts:
180186
- `configure.sh`: modifies and configure parameters of the installed dependencies. This step is **optional**.
181187
- `build.sh`: builds the firmware and create a platform-specific linked binary.
182188
- `flash.sh`: flashes the binary in the target platform.
183-
189+
184190
Some other required files inside the folder can be accessed from these scripts using the following paths:
185191

186192
```bash
@@ -211,4 +217,4 @@ see the file [3rd-party-licenses.txt](3rd-party-licenses.txt).
211217

212218
There are no known limitations.
213219

214-
If you find issues, [please report them](https://github.com/micro-ROS/micro_ros_setup/issues).
220+
If you find issues, [please report them](https://github.com/micro-ROS/micro_ros_setup/issues).

0 commit comments

Comments
 (0)