|
AWS IoT Embedded C Device SDK
|
The AWS IoT device SDK for embedded C is a collection of C source files which can be used in embedded applications to securely connect to the AWS IoT platform. It includes transport clients MQTT, TLS implementations and examples for their use. It also supports AWS IoT specific features such as Thing Shadow. It is distributed in source form and intended to be built into customer firmware along with application code, other libraries and RTOS. For additional information about porting the Device SDK for embedded C onto additional platforms please refer to the PortingGuide.
The Device SDK simplifies access to the Pub/Sub functionality of the AWS IoT broker via MQTT and provide APIs to interact with Thing Shadows. The SDK has been tested to work with the AWS IoT platform to ensure best interoperability of a device with the AWS IoT platform.
The Device SDK provides functionality to create and maintain a mutually authenticated TLS connection over which it runs MQTT. This connection is used for any further publish operations and allow for subscribing to MQTT topics which will call a configurable callback function when these topics are received.
The Device SDK implements the specific protocol for Thing Shadows to retrieve, update and delete Thing Shadows adhering to the protocol that is implemented to ensure correct versioning and support for client tokens. It abstracts the necessary MQTT topic subscriptions by automatically subscribing to and unsubscribing from the reserved topics as needed for each API call. Inbound state change requests are automatically signalled via a configurable callback.
The embedded C SDK was specifically designed for resource constrained devices (running on micro-controllers and RTOS).
Primary aspects are:
For more information on the Architecture of the SDK refer here
Ensure you understand the AWS IoT platform and create the necessary certificates and policies. For more information on the AWS IoT platform please visit the AWS IoT developer guide.
In order to quickly get started with the AWS IoT platform, we have ported the SDK for POSIX type Operating Systems like Ubuntu, OS X and RHEL. The SDK is configured for the mbedTLS library and can be built out of the box with GCC using make utility. The tarball can be downloaded from the below link:
This section explains the individual steps to retrieve the necessary files and be able to build your first application using the AWS IoT device SDK for embedded C.
Steps:
certs - TLS certificates directorydocs - SDK API and file documentationexternal_libs - The mbedTLS and jsmn source filesinclude - The AWS IoT SDK header filesplatform - Platform specific files for timer, TLS and threading layerssamples - The sample applicationssrc - The AWS IoT SDK source filestests - Contains tests for verifying that the SDK is functioning as expected. More information can be found https://github.com/aws/aws-iot-device-sdk-embedded-c/blob/master/tests/README.md "here"Also, for a guided example on getting started with the Thing Shadow, visit the AWS IoT Console's Interactive Guide.
As Embedded devices run on different Real Time Operating Systems and TCP/IP stacks, it is one of the important design goals for the Device SDK to keep it portable. Please refer to the https://github.com/aws/aws-iot-device-sdk-embedded-C/blob/master/PortingGuide.md "porting guide" to get more information on how to make this SDK run on your devices (i.e. micro-controllers).
The 2.x branch makes several changes to the SDK. This section provides information on what changes will be required in the client application for migrating from v1.x to 2.x.
include folder. These need to be added to the makefile as include directoriessrc folder. These need to be added to the makefile as one of the source directoriesplatform/threading folder only needs to be added if multi-threading is required, and the _ENABLE_THREAD_SUPPORT_ macro is defined in configYou can find more information on how to use the new APIs in the Readme file for samples that can be found https://github.com/aws/aws-iot-device-sdk-embedded-c/blob/master/samples/README.md "here"
If you have any technical questions about AWS IoT Device SDK, use the AWS IoT forum. For any other questions on AWS IoT, contact AWS Support.
Connecting to the AWS IoT MQTT platform
Subscribe to a topic
Update Thing Shadow from a device
1.8.10