AWSIoTUpdateDeviceShadow (FB)¶
FUNCTION_BLOCK AWSIoTUpdateDeviceShadow EXTENDS CBML.ETrigTo
Function block to update the device shadow of the connected device.
- InOut:
Scope
Name
Type
Initial
Comment
Inherited from
Input
xExecuteBOOLRising edge: Starts defined operationFALSE: Resets the defined operation after ready condition was reachedETrigTo
udiTimeOutUDINTMax. operating time for executing [µs], 0: No operating time limit
ETrigTo
Output
xDoneBOOLReady condition reached
ETrigTo
xBusyBOOLOperation is running
ETrigTo
xErrorBOOLError condition reached
ETrigTo
Input
pbPayloadPOINTER TO BYTE
Pointer to the device shadow
udiPayloadSizeUDINTSize of the device shadow
pbResponseStatePOINTER TO BYTE
Pointer to the response state
udiMaxResposeStateSizeUDINTMaximum size of the response state
eQoSQuality of service level (QoS)
sClientIdREFERENCE TO STRING(255)
0
The name of another thing. The input sClientId can be used to access device shadows of other things. if 0, then the clientId from AWSIoTClient will be used.
mQTTPublishPropertiesREFERENCE TO MQTTPublishProperties
Optional publish properties (MQTT V5 only)
Inout
awsIoTClientReference to AWSIoTClient
Output
eErrorMQTT.MQTT_ERRORError code