README

Arduino core for the ESP32 family of SoCs


![Verbose Build Status)](https://github.com/espressif/arduino-esp32/actions/workflows/push.yml?query=branch%3Amaster+event%3Aschedule)



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



 Contents

  - Development Status
  - Development Planning
  - Documentation
  - Supported Chips
  - Decoding exceptions
  - Issue/Bug report template
  - Contributing

 Development Status

 Latest Stable Release





 Latest Development Release





 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.

---

 Getting Started
 Installing (Windows, Linux and macOS)
 Libraries
 Arduino as an ESP-IDF component
 FAQ
 Troubleshooting

 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