arduino-esp32 README

The project's README from github.com/espressif/arduino-esp32. As one markdown file: README.md.

Arduino core for the ESP32 family of SoCs

Build Status Verbose Build Status External Libraries Test Runtime Tests

Need help or have a question? Join the chat at Discord or open a new Discussion

Discord invite

Contents

Development Status

Latest Stable Release

Release Version Release Date Downloads

Latest Development Release

Release Version Release Date Downloads

Development Planning

Our Development is fully tracked on this public Roadmap 🎉

For even more information you can join our Monthly Community Meetings 🔔.

Documentation

You can use the Arduino-ESP32 Online Documentation to get all information about this project.


Migration guide from version 2.x to 3.x is available here.


APIs compatibility with ESP8266 and Arduino-CORE (Arduino.cc) is explained here.


Supported Chips

Here are the ESP32 series supported by the Arduino-ESP32 project:

SoC Stable Development Datasheet
ESP32 Yes Yes ESP32
ESP32-C3 Yes Yes ESP32-C3
ESP32-C5 Yes Yes ESP32-C5
ESP32-C6 Yes Yes ESP32-C6
ESP32-H2 Yes Yes ESP32-H2
ESP32-P4 Yes Yes ESP32-P4
ESP32-S2 Yes Yes ESP32-S2
ESP32-S3 Yes Yes ESP32-S3

[!NOTE] ESP32-C2 and ESP32-C61 are also supported by Arduino-ESP32 but require using Arduino as an ESP-IDF component or rebuilding the static libraries. For more information, see the Arduino as an ESP-IDF component documentation or the Lib Builder documentation, respectively.

For more details visit the supported chips documentation page.

Decoding exceptions

You can use EspExceptionDecoder to get meaningful call trace.

Issue/Bug report template

Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labeled as Type: For reference.

Finally, if you are sure no one else had the issue, follow the Issue template or Feature request template while reporting any new Issue.

External libraries compilation test

We have set-up CI testing for external libraries for ESP32 Arduino core. You can check test results in the file LIBRARIES_TEST. For more information and how to add your library to the test see external library testing in the documentation.

Contributing

We welcome contributions to the Arduino ESP32 project!

See contributing in the documentation for more information on how to contribute to the project.

We would like to have this repository in a polite and friendly atmosphere, so please be kind and respectful to others. For more details, look at Code of Conduct.

arduino-esp32 (espressif/arduino-esp32)

esp32
Searching Database…

What is this?The Arduino core for the ESP32 family of SoCs — it lets you write and flash programs for ESP32-series chips using the standard Arduino API instead of raw ESP-IDF.
Is this the Arduino IDE itself, or something I add to it?Not the IDE itself: it is a board support core you add on top of the Arduino toolchain, and it can also be embedded into ESP-IDF projects as a component.
How do I install it, and does it work on my OS?Follow the Installing guide in the Arduino-ESP32 online documentation to add the core to your Arduino setup — Windows, Linux and macOS are all covered, along with libraries, FAQ and troubleshooting pages.
Do all of those chips work out of the box?No — ESP32-C2 and ESP32-C61 are not covered by the prebuilt packages: they require the Arduino-as-ESP-IDF-component route or rebuilding the static libraries.
Can I build ESP-IDF projects that include this core?Yes — one documented setup mode is using Arduino as an ESP-IDF component, so the Arduino API is layered inside a native ESP-IDF project. That is also the required route for ESP32-C2 and ESP32-C61.
Is the core still actively developed?Yes — the README lists both latest stable and latest development releases, development is tracked on a public roadmap, and the team holds monthly community meetings. Help is available via Discord and GitHub Discussions.
Are third-party Arduino libraries tested against it?Yes — CI compilation testing is set up for external libraries, with results published in the LIBRARIESTEST file, and library authors can add their library to the test.
Creator
espressif
Size
2.2 GB
Stars
17.6K
Age
10y
Commits · 90 Days