AWS IoT ExpressLink programmer's guide v1.1.2

This document defines the Application Programming Interface (API) that all AWS IoT ExpressLink compliant connectivity modules are required to implement to connect any host processor to the AWS cloud.

If you have questions or issues that are not answered here, please visit the AWS re:Post for AWS IoT ExpressLink page.

See the Document history for changes in this version.

Topics

• 1 Overview
• 2 Hardware
• 3 Run states
• 4 ExpressLink commands
• 5 Messaging
• 6 Configuration Dictionary
• 7 Event handling
• 8 ExpressLink module updates
• 9 AWS IoT Services
• 10 Additional services
• 11 Provisioning
• 12 Testing and qualification
• Document history
• Archive

 

AWS IoT ExpressLink commands

• AT   »Communication test«

• CONF KEY={value}   »Assignment«

• CONF {certificate}=pem   »Special certificate input formatting option«

• CONF? key   »Read the value of a configuration parameter«

• CONF? {certificate} pem   »Special certificate output formatting option«

• CONFMODE [parameter]   »Activate modal credential entry«

• CONNECT   »Establish a connection to an AWS IoT Core Endpoint«

• CONNECT!   »Non-blocking request to connect to IoT Core«

• CONNECT?   »Request the connection status«

• DIAG {command} [optional parameters]   »Perform a diagnostic command«

• DISCONNECT   »Leave the connected state and enter the active state«

• EVENT?   »Request the next event in the queue«

• FACTORY_RESET   »Request a factory reset of the ExpressLink module«

• GET   »Request next message pending on any topic«

• GET0   »Request next message pending on an unassigned topic«

• GET[#]   »Request next message pending on the indicated topic«

• OTA ACCEPT   »Allow the OTA operation to proceed«

• OTA APPLY   »Authorize the ExpressLink module to apply the new image.«

• OTA CLOSE   »The host OTA operation is completed«

• OTA FLUSH   »The contents of the OTA buffer are emptied«

• OTA READ #bytes   »Requests the next # bytes from the OTA buffer«

• OTA SEEK {address}   »Moves the read pointer to an absolute address«

• OTA?   »Fetches the current state of the OTA process«

• OTW   »Enter firmware update mode«

• RESET   »Request a full reset of the ExpressLink internal state«

• SEND[#] message   »Publish msg on a topic selected from topic list«

• SHADOW[#] DELETE   »Request the deletion of a Shadow document«

• SHADOW[#] DOC   »Request a Device Shadow document«

• SHADOW[#] GET DELETE   »Request a Shadow delete response«

• SHADOW[#] GET DELTA   »Retrieve a Shadow Delta message«

• SHADOW[#] GET DOC   »Retrieve a device shadow document«

• SHADOW[#] GET UPDATE   »Retrieve a device shadow update response«

• SHADOW[#] INIT   »Initialize communication with the Device Shadow service«

• SHADOW[#] SUBSCRIBE   »Subscribe to a device shadow document«

• SHADOW[#] UNSUBSCRIBE   »Unsubscribe to a device shadow document«

• SHADOW[#] UPDATE {new state}   »Request a device shadow document update«

• SLEEP[#] [duration]   »Request to enter a low power mode«

• SUBSCRIBE[#]   »Subscribe to Topic#

• TIME?   »Request current time information«

• UNSUBSCRIBE[#]   »Unsubscribe from Topic#«

• WHERE?   »Request location information«

Tables

• Table 1 - Error codes

• Table 2 - Configuration Dictionary Persistent Keys

• Table 3 - Configuration dictionary non-persistent keys

• Table 4 - ExpressLink event codes

• Table 5 - Reserved OTA file type codes (0-255)

• Table 6 - ExpressLink Defender metrics

• Table 7 - Test I/O pin assignments