Skip to content

Commit 2c3dbf3

Browse files
api_compatibility_note
1 parent 29cde94 commit 2c3dbf3

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

Diff for: README.md

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

3838
---
3939

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

Diff for: docs/source/libraries.rst

+4
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ APIs
7171

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

74+
.. note:: 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).
75+
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
76+
that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations.
77+
7478
.. toctree::
7579
:maxdepth: 1
7680
:glob:

0 commit comments

Comments
 (0)