adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs_api_note (#9128)

Browse source
This commit is contained in:
Vojtěch Bartoška 2024-01-18 16:33:38 +08:00 committed by GitHub
parent a871518e51
commit b3de161860
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -36,6 +36,10 @@ You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/
--- ---
**APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is explained [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html#apis).**
---
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html) * [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html) * [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html) * [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)

5
docs/en/libraries.rst
View file

@ -71,6 +71,11 @@ APIs
The Arduino ESP32 offers some unique APIs, described in this section: The Arduino ESP32 offers some unique APIs, described in this section:
.. 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).
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
that perfect compatibility might not always be feasible. Please refer to the documentation for any specific considerations.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:glob: :glob: