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)

Searching Database…

Что это такое?Ядро Arduino для семейства микроконтроллеров ESP32 — оно позволяет писать и прошивать программы для чипов серии ESP32 через стандартный API Arduino, не прибегая к «голому» ESP-IDF.
Это сама Arduino IDE или то, что я в неё добавляю?Не сама IDE: это пакет поддержки плат, который устанавливается поверх инструментов Arduino. Его также можно подключить к проекту ESP-IDF в виде компонента.
Как его установить и будет ли он работать в моей системе?Следуйте инструкции Installing из онлайн-документации Arduino-ESP32, чтобы добавить ядро в вашу Arduino — есть руководства для Windows, Linux и macOS, а также разделы по библиотекам, FAQ и устранению неполадок.
Все эти чипы поддерживаются сразу из коробки?Нет — ESP32-C2 и ESP32-C61 не входят в готовые сборки: для них нужно использовать вариант Arduino как компонента ESP-IDF либо пересобрать статические библиотеки.
Могу ли я собирать проекты ESP-IDF с подключённым этим ядром?Да — один из описанных вариантов настройки — использовать Arduino как компонент ESP-IDF: API Arduino работает внутри нативного проекта ESP-IDF. Это же обязательный путь для ESP32-C2 и ESP32-C61.
Ядро до сих пор активно развивается?Да — в README указаны и последний стабильный, и последний девелоперский релизы, разработка ведётся по публичному роадмапу, а команда раз в месяц проводит встречи сообщества. Помощь можно получить в Discord и GitHub Discussions.
Проверяют ли сторонние библиотеки Arduino на совместимость с ним?Да — в CI настроена проверка сборки внешних библиотек, результаты публикуются в файле LIBRARIESTEST, а авторы библиотек могут добавить свою библиотеку в тестирование.
Creator
espressif
Size
2.2 GB
Stars
17.6K
Age
10y
Commits · 90 Days