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…

这是什么?ESP32 系列 SoC 的 Arduino 核心——它让你可以用标准 Arduino API 为 ESP32 系列芯片编写并烧录程序,而不必直接使用 ESP-IDF。
这是 Arduino IDE 本身,还是要添加到 IDE 里的东西?不是 IDE 本身:它是一个开发板支持核心,添加在 Arduino 工具链之上,也可以作为组件嵌入到 ESP-IDF 项目中。
怎么安装?支持我的操作系统吗?按照 Arduino-ESP32 在线文档中的 Installing 指南,把核心添加到你的 Arduino 环境即可——Windows、Linux 和 macOS 都有覆盖,文档还包括库、常见问题和故障排查页面。
这些芯片都能开箱即用吗?不能——ESP32-C2 和 ESP32-C61 不在预编译包的覆盖范围内:它们需要走 Arduino-as-ESP-IDF-component 的方式,或者重新编译静态库。
我能构建包含这个核心的 ESP-IDF 项目吗?可以——文档中介绍的一种配置方式就是把 Arduino 作为 ESP-IDF 组件使用,这样 Arduino API 就叠加在原生 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