Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 3,232 Commits
.github		.github
cores/esp32		cores/esp32
docs		docs
idf_component_examples		idf_component_examples
libraries		libraries
package		package
tests		tests
tools		tools
variants		variants
.clang-format		.clang-format
.codespellrc		.codespellrc
.editorconfig		.editorconfig
.flake8		.flake8
.gitignore		.gitignore
.gitmodules		.gitmodules
.pre-commit-config.yaml		.pre-commit-config.yaml
.prettierignore		.prettierignore
.readthedocs.yaml		.readthedocs.yaml
.shellcheckrc		.shellcheckrc
.vale.ini		.vale.ini
CMakeLists.txt		CMakeLists.txt
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
Kconfig.projbuild		Kconfig.projbuild
LICENSE.md		LICENSE.md
README.md		README.md
boards.txt		boards.txt
idf_component.yml		idf_component.yml
package.json		package.json
platform.txt		platform.txt
programmers.txt		programmers.txt

Repository files navigation

Arduino core for the ESP32, ESP32-C3, ESP32-C6, ESP32-H2, ESP32-P4, ESP32-S2 and ESP32-S3.

Need help or have a question? Join the chat atDiscord oropen a new Discussion

Development Status

Latest Stable Release

Latest Development Release

Development Planning

Our Development is fully tracked on this publicRoadmap 🎉

For even more information you can join ourMonthly Community Meetings 🔔.

Documentation

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

Migration guide from version 2.x to 3.x is availablehere.

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

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-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 is also supported by Arduino-ESP32 but requires using Arduino as an ESP-IDF component or rebuilding the static libraries.For more information, see theArduino as an ESP-IDF component documentation or theLib Builder documentation, respectively.

For more details visit thesupported chips documentation page.

Decoding exceptions

You can useEspExceptionDecoder 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 asType: For reference.

Finally, if you are sure no one else had the issue, follow theIssue template orFeature request template while reporting anynew 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 fileLIBRARIES_TEST.For more information and how to add your library to the test seeexternal library testing in the documentation.

Contributing

We welcome contributions to the Arduino ESP32 project!

Seecontributing 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 atCode of Conduct.