Skip to content

Commit 216e877

Browse files
committed
Noted incompatibility with Arduino IDE
1 parent e1fa521 commit 216e877

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

.github/workflows/arduino.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: Arduino Library
22

3-
on:
4-
pull_request:
5-
branches:
6-
- main
3+
# on:
4+
# pull_request:
5+
# branches:
6+
# - main
77

88
jobs:
99
Arduino-Checks:

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Optionally it can handle Wi-Fi connectivity.
66

77
> It is not yet available through library managers.
88
9+
> **Not working in Arduino IDE** because of a mismatch in `arduino-esp32` versions.
10+
911

1012
## Getting started
1113

@@ -20,8 +22,8 @@ We recommend using the [PlatformIO VSCode extension](https://platformio.org/plat
2022
You will find more instructions [here](documentation/platformio_usage.md)
2123

2224
#### Arduino IDE
23-
It is also possible to use the application using *Arduino IDE*.
24-
You will find more instructions [here](documentation/arduino_ide_usage.md)
25+
It currently not possible to use with Arduino IDE.
26+
Since the used `arduino-esp32` is 3+ (based on ESP-IDF 5+) which introduced breaking changes and is unavailable for platformIO
2527

2628
### Usage examples
2729
Two example scripts are available in the `examples` folder:
@@ -41,6 +43,6 @@ This library uses the following dependencies.
4143

4244
* [Arduino ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#about-arduino-esp32)
4345
(In particular, the [Wi-Fi library](https://docs.espressif.com/projects/arduino-esp32/en/latest/api/wifi.html),
44-
[message logging](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/log.html) and
45-
[MQTT client](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/protocols/mqtt.html#api-reference)) \
46-
__Caution__: the ArduinoEspressif implementation of the ESP MQTT Client does not match the official API documentation!
46+
[message logging](https://docs.espressif.com/projects/esp-idf/en/v4.4.7/esp32/api-reference/system/log.html) and
47+
[MQTT client](https://docs.espressif.com/projects/esp-idf/en/v4.4.7/esp32/api-reference/protocols/mqtt.html#api-reference)) \
48+
__Caution__: The version of ESP-IDF used by PlatformIO is v4.4.7 ! Not 5.x.x ...

0 commit comments

Comments
 (0)