Skip to content

Commit b3de161

Browse files
docs_api_note (espressif#9128)
1 parent a871518 commit b3de161

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/
3636

3737
---
3838

39+
**APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is explained [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html#apis).**
40+
41+
---
42+
3943
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
4044
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
4145
* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)

docs/en/libraries.rst

+5
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ APIs
7171

7272
The Arduino ESP32 offers some unique APIs, described in this section:
7373

74+
.. note::
75+
Please be advised that we cannot ensure continuous compatibility between the Arduino Core ESP32 APIs and ESP8266 APIs, as well as Arduino-Core APIs (Arduino.cc).
76+
While our aim is to maintain harmony, the addition of new features may result in occasional divergence. We strive to achieve the best possible integration but acknowledge
77+
that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations.
78+
7479
.. toctree::
7580
:maxdepth: 1
7681
:glob:

0 commit comments

Comments
 (0)