|
| 1 | +# Arduino core for the ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C6 and ESP32-H2 |
| 2 | + |
| 3 | + [](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest) |
| 4 | +[](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md) |
| 5 | + |
| 6 | +### Need help or have a question? Join the chat at [Gitter](https://gitter.im/espressif/arduino-esp32) or [open a new Discussion](https://github.com/espressif/arduino-esp32/discussions) |
| 7 | + |
| 8 | +## Contents |
| 9 | + |
| 10 | + - [Development Status](#development-status) |
| 11 | + - [Development Planning](#development-planning) |
| 12 | + - [Documentation](#documentation) |
| 13 | + - [Supported Chips](#supported-chips) |
| 14 | + - [Decoding exceptions](#decoding-exceptions) |
| 15 | + - [Issue/Bug report template](#issuebug-report-template) |
| 16 | + - [Contributing](#contributing) |
| 17 | + |
| 18 | +### Development Status |
| 19 | + |
| 20 | +Latest Stable Release [](https://github.com/espressif/arduino-esp32/releases/latest/) [](https://github.com/espressif/arduino-esp32/releases/latest/) [](https://github.com/espressif/arduino-esp32/releases/latest/) |
| 21 | + |
| 22 | +Latest Development Release [](https://github.com/espressif/arduino-esp32/releases/) [](https://github.com/espressif/arduino-esp32/releases/) [](https://github.com/espressif/arduino-esp32/releases/) |
| 23 | + |
| 24 | +### Development Planning |
| 25 | + |
| 26 | +Our Development is fully tracked on this public **[Roadmap 🎉](https://github.com/orgs/espressif/projects/3)** |
| 27 | + |
| 28 | +For even more information you can join our **[Monthly Community Meetings 🔔](https://github.com/espressif/arduino-esp32/discussions/categories/monthly-community-meetings).** |
| 29 | + |
| 30 | +### Documentation |
| 31 | + |
| 32 | +You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/) to get all information about this project. |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +**Migration guide from version 2.x to 3.x is available [here](https://docs.espressif.com/projects/arduino-esp32/en/latest/migration_guides/2.x_to_3.0.html).** |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html) |
| 41 | +* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html) |
| 42 | +* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html) |
| 43 | +* [Arduino as an ESP-IDF component](https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html) |
| 44 | +* [FAQ](https://docs.espressif.com/projects/arduino-esp32/en/latest/faq.html) |
| 45 | +* [Troubleshooting](https://docs.espressif.com/projects/arduino-esp32/en/latest/troubleshooting.html) |
| 46 | + |
| 47 | +### Supported Chips |
| 48 | + |
| 49 | +Here are the ESP32 series supported by the Arduino-ESP32 project: |
| 50 | + |
| 51 | +| **SoC** | **Stable** | **Development** | **Datasheet** | |
| 52 | +|----------|:----------:|:---------------:|:-------------------------------------------------------------------------------------------------:| |
| 53 | +| ESP32 | Yes | Yes | [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf) | |
| 54 | +| ESP32-S2 | Yes | Yes | [ESP32-S2](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf) | |
| 55 | +| ESP32-C3 | Yes | Yes | [ESP32-C3](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf) | |
| 56 | +| ESP32-S3 | Yes | Yes | [ESP32-S3](https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf) | |
| 57 | +| ESP32-C6 | No | Yes | [ESP32-C6](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf) | |
| 58 | +| ESP32-H2 | No | Yes | [ESP32-H2](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf) | |
| 59 | + |
| 60 | +For more details visit the [supported chips](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#supported-soc-s) documentation page. |
| 61 | + |
| 62 | +### Decoding exceptions |
| 63 | + |
| 64 | +You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace. |
| 65 | + |
| 66 | +### Issue/Bug report template |
| 67 | + |
| 68 | +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 labelled as [Type: For reference](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue+label%3A%22Type%3A+For+reference%22+). |
| 69 | + |
| 70 | +Finally, if you are sure no one else had the issue, follow the **Issue template** or **Feature request template** while reporting any [new Issue](https://github.com/espressif/arduino-esp32/issues/new/choose). |
| 71 | + |
| 72 | +### External libraries compilation test |
| 73 | + |
| 74 | +We have set-up CI testing for external libraries for ESP32 Arduino core. You can check test results in the file [LIBRARIES_TEST](https://github.com/espressif/arduino-esp32/blob/gh-pages/LIBRARIES_TEST.md). |
| 75 | +For more information and how to add your library to the test see [external library testing](https://docs.espressif.com/projects/arduino-esp32/en/latest/external_libraries_test.html) in the documentation. |
| 76 | + |
| 77 | +### Contributing |
| 78 | + |
| 79 | +We welcome contributions to the Arduino ESP32 project! |
| 80 | + |
| 81 | +See [contributing](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html) in the documentation for more information on how to contribute to the project. |
| 82 | + |
| 83 | +> 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](https://github.com/espressif/arduino-esp32/blob/master/CODE_OF_CONDUCT.md). |
0 commit comments