e70f4d3819
* feat(hw_cdc): creates documentation for the example Adds a README file that exaplains the example. * feat(hw_cdc): create cmake config file Adds necessary CMakeLists.txt file to the project with the HW CDC defines that will enable it. * feat(hw_cdc): create sdkconfig.defaults Adds necessary and minimum sdkconfig settings in order to make Arduino run as IDF Compoenent. * feat(hw_cdc): create cmake config file Create the Arduino Sketch source code CMakeLists.txt file that will include all source code files and header files in the proejct. * feat(hw_cdc): create main.cpp Adds the minimum Arduino Sketch that will print "Hello World!" in the HW Serial USB CDC port. * feat(hw_cdc): create idf_component.yml Adds necessary ESP32 Registry information in order to make ESP32 Arduino to be automatically included in the project as an IDF component. * feat(hw_cdc): update main.cpp adds code to wait for the user to open the Serial Monitor * feat(hw_cdc): formating text code Applying Code style and formating. * feat(hw_cdc): adds the example to idf_component.yml Adds the example to the list of example in the ESP32 Registry. * ci(pre-commit): Apply automatic fixes * fix(chw_cdc): typo fix Fixed Typo in the documentation. * fix(hw_cdc): fixed a commentary typo Fixed commantary typo --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| cores/esp32 | ||
| docs | ||
| idf_component_examples | ||
| libraries | ||
| package | ||
| tests | ||
| tools | ||
| variants | ||
| .clang-format | ||
| .codespellrc | ||
| .editorconfig | ||
| .flake8 | ||
| .gitignore | ||
| .gitmodules | ||
| .pre-commit-config.yaml | ||
| .prettierignore | ||
| .readthedocs.yaml | ||
| .vale.ini | ||
| boards.txt | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| idf_component.yml | ||
| Kconfig.projbuild | ||
| LICENSE.md | ||
| package.json | ||
| platform.txt | ||
| programmers.txt | ||
| README.md | ||
Arduino core for the ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C6 and ESP32-H2
Need help or have a question? Join the chat at Gitter 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-S2 | Yes | Yes | ESP32-S2 |
| ESP32-C3 | Yes | Yes | ESP32-C3 |
| ESP32-S3 | Yes | Yes | ESP32-S3 |
| ESP32-C6 | Yes | Yes | ESP32-C6 |
| ESP32-H2 | Yes | Yes | ESP32-H2 |
Note
ESP32-C2 is also supported by Arduino-ESP32 but requires rebuilding the static libraries. This is not trivial and requires a good understanding of the ESP-IDF build system. For more information, see the Lib Builder documentation.
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.