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 framework enables AWS IoT cloud connectivity with ESP32 based platforms using 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-iot
release/202012.04-LTS
, you may run:git clone -b "release/202012.04-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/
- Please set your branch to
release/v4.3
orrelease/v4.4
and pull in the latest changes. - IDF
release/v5.0
is not supported.
- Please refer to 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.
- This framework 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.
- For using Digial Signature Peripheral (Available on the ESP32-C3, ESP32-S2 and ESP32-S3), you will need to use esp_secure_cert_mgr.
- The default method is to use PKI credentials which are embedded in the binary, using the certs from the