Overview

    This library is specifically built for ESP32. Utilizes ESP-IDF as basis and is part of BuildStorm ESP32 product framework for ESP32. The goal of is to allow optimized integration of AWS IoT features for ESP32.

    Documentation

    The documentation of the library can be found hereYou may also refer to the Shadow Updates user guide to know how to use this library to handler shadow updates.

    Getting started with the library

    Follow this article to do provisioning & registering the device on AWS.

    Example Setup

    1. Change the working directory to the Shadow Updates example.
    2. Copy the generated claim certificates from earlier example to
        ..\<example>\main\claimCerts  folder.
    3. Update the Wi-Fi and AWS parameters in app_config.h of the example.

    Building the project

      1. Open the ESP-IDF 4.2 CMD command prompt
      2. Navigate to ..\<example> folder
      3. Flash Command
        idf.py -p <SERIAL_PORT> flash monitor
        Note : Don’t erase-flash as device is already registered.

    Testing Shadow Updates

     

    Publish to shadow update topic

    1. Open the AWS IoT console
    2. In the left navigation pane, choose Manage, choose Things, your thing id, choose Device Shadows, and then click on Classic Shadow (shadow created by device).
    3. In MQTT topics, copy Update topic
    4. In the left navigation pane, Right click on Test & open link in a new tab
    5. Click Publish to a topic, paste the copied shadow update topic to Topic name
    6. Paste Device Shadow desired state to Message payload as shown in below image & change the LED state
    7. Click Publish
    8. Verify the state change on both device & Device Shadow document reported value

    The free usage of library is limited to 30 min. It is meant for testing and demonstration only. If you need access to the source code of the library or if you’re looking for a customized solution, reach out at hello@buildstorm.com