IMPORTANT: Please choose the branch of this repo, based on the FreeRTOS-LTS release that you would like to base your application on.
If you are using the older (3.x.x) aws-iot-device-sdk-embedded-C release, please checkout the release/v3.1.x branch.
This SDK enables AWS IoT cloud connectivity with ESP32-based platforms using the libraries provided as a part of the AWS IoT Device Embedded C SDK.
- Please clone this branch of the repository using
For example: To clone just
git clone -b "<name_of_the_release_branch>" --recursive https://github.com/espressif/esp-aws-iotrelease/202406.01-LTS, you may run:git clone -b "release/202406.01-LTS" --recursive https://github.com/espressif/esp-aws-iot - Please refer to https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html for setting up ESP-IDF
- ESP-IDF can be downloaded from https://github.com/espressif/esp-idf/
- This SDK supports
release/v5.2,release/v5.1,release/v5.0, andrelease/v4.4of ESP-IDF. - Please set your branch to the IDF release that you would like to use, and pull in the latest changes.
Note: Please read Support Policy below for more details.
- Please refer to the example README for more information on setting up examples.
- For a production-ready starting point for making applications that connect to AWS IoT Core using
esp-aws-iot, refer to the reference example. - Please refer to the Security Guide for steps to enable Security Features on your Espressif chip.
- This SDK supports multiple ways to securely store the PKI credentials.
- The default method is to use PKI credentials which are embedded in the binary, using the certs from the
certs/in every example. - For using Secure Element (ATECC608A), you will need to use esp-cryptoauthlib.
- The Security Guide includes detailed steps and pointers to configure and use the Digital Signature Peripheral on supported chips, using esp_secure_cert_mgr.
The following table shows esp-aws-iot support with the ESP-IDF support of Espressif SoCs:
Cell marked as 
| SoC | Supported IDF Version | master | esp-aws-iot Release | |
|---|---|---|---|---|
| 202406.01-LTS | 202210.01-LTS | |||
| ESP32 | IDF v4.4 | |
|
|
| IDF v5.0 | |
|
|
|
| IDF v5.1 | |
|
|
|
| IDF v5.2 | |
|
||
| ESP32-S2 | IDF v4.4 | |
|
|
| IDF v5.0 | |
|
|
|
| IDF v5.1 | |
|
|
|
| IDF v5.2 | |
|
||
| ESP32-C3 | IDF v4.4 | |
|
|
| IDF v5.0 | |
|
|
|
| IDF v5.1 | |
|
|
|
| IDF v5.2 | |
|
||
| ESP32-S3 | IDF v4.4 | |
|
|
| IDF v5.0 | |
|
|
|
| IDF v5.1 | |
|
|
|
| IDF v5.2 | |
|
||
| ESP32-C2 | IDF v5.0 | |
|
|
| IDF v5.1 | |
|
|
|
| IDF v5.2 | |
|
||
| ESP32-C6 | IDF v5.1 | |
|
|
| IDF v5.2 | |
|
||
IDF version support for esp-aws-iot releases is based on IDF Release Support Schedule.
For example, support for IDF v4.4 for Release 202406.01-LTS will expire on 31st July 2024.