Skip to content

Commit a7b24cf

Browse files
Deprecate platformIO support (#957) (#959)
* Deprecate platformIO support * Update README.md Co-authored-by: Pablo Garrido <[email protected]> Co-authored-by: Pablo Garrido <[email protected]> (cherry picked from commit a67de52) Co-authored-by: Antonio Cuadros <[email protected]>
1 parent bbccee7 commit a7b24cf

File tree

1 file changed

+1
-87
lines changed

1 file changed

+1
-87
lines changed

README.md

Lines changed: 1 addition & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ As the build process for ROS 2 and micro-ROS is based on custom meta-build syste
1919
- [How to use the precompiled library](#how-to-use-the-precompiled-library)
2020
- [Arduino IDE](#arduino-ide)
2121
- [PlatformIO](#platformio)
22-
- [Known issues](#known-issues)
2322
- [How to build the precompiled library](#how-to-build-the-precompiled-library)
2423
- [Patch Arduino board for support precompiled libraries](#patch-arduino-board-for-support-precompiled-libraries)
2524
- [Patch Teensyduino](#patch-teensyduino)
@@ -73,92 +72,7 @@ docker run -it --rm -v /dev:/dev --privileged --net=host microros/micro-ros-agen
7372
```
7473
### PlatformIO
7574

76-
For boards supported by micro-ROS, all you have to do to add the library to your project is including the following lines in the existing `platformio.ini` file:
77-
78-
```ini
79-
[env:<YOUR_BOARD>]
80-
81-
...
82-
lib_deps =
83-
https://github.com/micro-ROS/micro_ros_arduino
84-
85-
build_flags =
86-
-L ./.pio/libdeps/<YOUR_BOARD>/micro_ros_arduino/src/<BOARD_ARCHITECTURE>/
87-
-l microros
88-
-D <TARGET_DEFINITION>
89-
```
90-
91-
| Board | <YOUR_BOARD> | <BOARD_ARCHITECTURE> | <TARGET_DEFINITION> |
92-
| ----------------------------| ------------------- | ---------------------------- | ----------------------------------- |
93-
| Arduino Portenta H7 M7 Core | portenta_h7_m7 | cortex-m7/fpv5-d16-softfp | TARGET_PORTENTA_H7_M7 |
94-
| Arduino Nano RP2040 Connect | nanorp2040connect | cortex-m0plus | ARDUINO_NANO_RP2040_CONNECT |
95-
| Teensy 4.1/4.0 | teensy41 / teensy40 | imxrt1062/fpv5-d16-hard | ARDUINO_TEENSY41 |
96-
| Teensy 3.6 | teensy36 | mk66fx1m0/fpv4-sp-d16-hard | ARDUINO_TEENSY36 |
97-
| Teensy 3.5 | teensy35 | mk64fx512/fpv4-sp-d16-hard | ARDUINO_TEENSY35 |
98-
| Teensy 3.2 / 3.1 | teensy31 | mk20dx256 | ARDUINO_TEENSY32 / ARDUINO_TEENSY31 |
99-
| ESP32 Dev Module | esp32dev | esp32 | ESP32 |
100-
| STM32-E407 | olimex_e407 | cortex-m4 | TARGET_STM32F4 |
101-
| Arduino Due | due | cortex-m3 | - |
102-
| Arduino Zero | zero | cortex-m0plus | - |
103-
104-
Now to proceed with the PlatformIO workflow:
105-
106-
```bash
107-
pio lib install # Install dependencies
108-
pio run # Build the firmware
109-
pio run --target upload # Flash the firmware
110-
```
111-
112-
An example of a micro-ROS application using PlatformIO is available [here](https://github.com/husarion/micro_ros_stm32_template).
113-
114-
#### Known issues
115-
116-
- Arduino Nano RP2040 Connect
117-
118-
- The following versioning shall be used:
119-
```
120-
lib_deps =
121-
arduino-libraries/WiFiNINA@^1.8.13
122-
...
123-
124-
platform_packages =
125-
toolchain-gccarmnoneeabi @ ~1.70201.0
126-
framework-arduino-mbed @ ~2.4.1
127-
```
128-
129-
- Library dependency finder shall be set to `chain+`: `lib_ldf_mode = chain+`
130-
131-
Related: https://github.com/micro-ROS/micro_ros_arduino/issues/780
132-
133-
- Arduino Due
134-
- The following versioning shall be used:
135-
```
136-
platform_packages =
137-
toolchain-gccarmnoneeabi@<1.50000.0
138-
```
139-
140-
Related: https://github.com/micro-ROS/micro_ros_arduino/issues/698
141-
142-
- ESP32 Dev Module
143-
- Known issues with espressif32 arduino package, use `2.0.2` version:
144-
```
145-
[env:esp32dev]
146-
platform = https://github.com/platformio/platform-espressif32.git#feature/arduino-upstream
147-
board = esp32dev
148-
framework = arduino
149-
lib_deps =
150-
https://github.com/micro-ROS/micro_ros_arduino.git
151-
build_flags =
152-
-L ./.pio/libdeps/esp32dev/micro_ros_arduino/src/esp32/
153-
-l microros
154-
-D ESP32
155-
156-
platform_packages =
157-
toolchain-xtensa32 @ ~2.80400.0
158-
framework-arduinoespressif32@https://github.com/espressif/arduino-esp32.git#2.0.2
159-
```
160-
161-
Related: https://github.com/micro-ROS/micro_ros_arduino/issues/736, https://github.com/platformio/platform-espressif32/issues/616
75+
PlatformIO support for this repository has been deprecated in favor of its own build system: [micro_ros_platformio](https://github.com/micro-ROS/micro_ros_platformio)
16276

16377
## How to build the precompiled library
16478

0 commit comments

Comments
 (0)