Module iot_device_bridge::device_shadow

DeviceShadow processing that is not device or shadow specific (see also the DeviceAdapter). The DeviceShadow concept includes the named shadows for device state and iot state..

Operations:

• Retrieving DeviceShadow:
  • device or cloud client => IoT : get message
• Updating DeviceShadow:
  • device => IoT : update message with state reported
  • cloud client => IoT : update message with state desired
• Deleting DeviceShadow:
  • device or cloud client => IoT :
    • a property : update message with property : null
    • entire shadow : delete message

To enable low coupling between adapting to the device specificity and the generic shadow, the device specific processing is defined in the device_adapter::DeviceState.

Structs

DeviceShadow

DeviceShadow holds the attributes for handling a shadow

DeviceShadowDescriptor

DeviceShadowDescriptor holds the easy accessible parameters of a DeviceShadow

ShadowDescriptors

Structure holding the DeviceShadowDescriptor for device and iot shadows

ShadowTopic

ShadowTopic holds pob/sub prefix and shadow name

Enums

ShadowType

Constants

GET

Device Shadow Publishing topics

GET_ACCEPTED

SHADOW_TOPICS_NUM

Device Shadow Subscribing topics

UPDATE

UPDATE_ACCEPTED

UPDATE_DELTA

UPDATE_DOCUMENTS

Functions

build_shadow_message_payload

A helper function for building JSON with desired and reported nodfes or reported only.