- C++ 74.1%
- C 21.2%
- Python 3.9%
- HTML 0.4%
- CMake 0.3%
- Other 0.1%
d8a1bf60d0
Some checks failed
Arduino as ESP-IDF Component / Check CMakeLists (push) Has been cancelled
Arduino as ESP-IDF Component / Check Examples Match (push) Has been cancelled
Arduino as ESP-IDF Component / Set Matrix (push) Has been cancelled
CodeQL Analysis / CodeQL actions analysis (push) Has been cancelled
CodeQL Analysis / CodeQL cpp analysis (push) Has been cancelled
CodeQL Analysis / CodeQL python analysis (push) Has been cancelled
Documentation Build and Deploy CI / Build ESP-Docs (push) Has been cancelled
Documentation Build and Production Deploy CI / Deploy Documentation on Production (push) Has been cancelled
Pre-commit hooks / Check if fixes are needed (push) Has been cancelled
Compilation Tests / Generate chunks (push) Has been cancelled
Compilation Tests / Upload PR number (push) Has been cancelled
Upload Tests / Check if mock upload should run (push) Has been cancelled
Compilation Tests / Arduino on macOS-latest (push) Has been cancelled
Compilation Tests / Arduino on windows-latest (push) Has been cancelled
Compilation Tests / Save master artifacts (push) Has been cancelled
Compilation Tests / Merge compile commands (push) Has been cancelled
Upload Tests / Mock upload on macos-26-intel (push) Has been cancelled
Upload Tests / Mock upload on ubuntu-latest (push) Has been cancelled
Upload Tests / Mock upload on windows-latest (push) Has been cancelled
* docs(compatibility): Add notes on ESP8266 compatibility * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| .gitlab | ||
| cores/esp32 | ||
| docs | ||
| idf_component_examples | ||
| libraries | ||
| package | ||
| tests | ||
| tools | ||
| variants | ||
| .clang-format | ||
| .codespellrc | ||
| .editorconfig | ||
| .flake8 | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .pre-commit-config.yaml | ||
| .prettierignore | ||
| .readthedocs.yaml | ||
| .shellcheckrc | ||
| .vale.ini | ||
| boards.txt | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| idf_component.yml | ||
| Kconfig.projbuild | ||
| LICENSE.md | ||
| package.json | ||
| platform.txt | ||
| programmers.txt | ||
| README.md | ||
| SECURITY.md | ||
Arduino core for the ESP32 family of SoCs
)
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 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.