https://github.com/espressif/esp-aws-iot

AWS IoT SDK for ESP32 based chipsets
https://github.com/espressif/esp-aws-iot

Last synced: 2 days ago
JSON representation

AWS IoT SDK for ESP32 based chipsets

• Host: GitHub
• URL: https://github.com/espressif/esp-aws-iot
• Owner: espressif
• License: apache-2.0
• Created: 2019-03-25T12:38:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-30T11:12:46.000Z (27 days ago)
• Last Synced: 2024-09-18T15:59:40.482Z (8 days ago)
• Language: C
• Homepage:
• Size: 721 KB
• Stars: 266
• Watchers: 24
• Forks: 156
• Open Issues: 130
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ESP-AWS-IoT

> **IMPORTANT**: Please choose the branch of this repo, based on the [FreeRTOS-LTS release](https://github.com/FreeRTOS/FreeRTOS-LTS/releases) 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`](https://github.com/espressif/esp-aws-iot/tree/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](https://github.com/aws/aws-iot-device-sdk-embedded-C).

## Getting Started

- Please clone this branch of the repository using

    ```

    git clone -b "" --recursive https://github.com/espressif/esp-aws-iot

    ```

  For example: To clone just `release/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`, and `release/v4.4` of 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](#support-policy) below for more details.

- Please refer to the [example README](examples/README.md) 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](https://github.com/FreeRTOS/iot-reference-esp32c3).

- Please refer to the [Security Guide](https://github.com/espressif/esp-aws-iot/blob/release/202210.01-LTS/examples/ota/SecurityGuide.md) 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](https://github.com/espressif/esp-cryptoauthlib#how-to-use-esp-cryptoauthlib-with-esp-idf).

  - The Security Guide includes detailed steps and pointers to configure and use the Digital Signature Peripheral on supported chips, using [esp_secure_cert_mgr](https://components.espressif.com/components/espressif/esp_secure_cert_mgr).

## Supported SoCs

The following table shows esp-aws-iot support with the ESP-IDF support of Espressif SoCs:  

Cell marked as ![alt text][supported] denotes supported combination.

   

    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

    

    

    

  

[supported]: https://img.shields.io/badge/-supported-green "supported"

## Support Policy

IDF version support for esp-aws-iot releases is based on [IDF Release Support Schedule](https://github.com/espressif/esp-idf#esp-idf-release-support-schedule).  

For example, support for IDF v4.4 for Release 202406.01-LTS will expire on 31st July 2024.