def __init__(self, clientID, protocolType=MQTTv3_1_1, useWebsocket=False, cleanSession=True):
"""
The client class that manages device shadow and accesses its functionality in AWS IoT over MQTT v3.1/3.1.1.
It is built on top of the AWS IoT MQTT Client and exposes devive shadow related operations.
It shares the same connection types, synchronous MQTT operations and partial on-top features
with the AWS IoT MQTT Client:
- Auto reconnect/resubscribe
Same as AWS IoT MQTT Client.
- Progressive reconnect backoff
Same as AWS IoT MQTT Client.
- Offline publish requests queueing with draining
Disabled by default. Queueing is not allowed for time-sensitive shadow requests/messages.
**Syntax**
.. code:: python
import AWSIoTPythonSDK.MQTTLib as AWSIoTPyMQTT
# Create an AWS IoT MQTT Shadow Client using TLSv1.2 Mutual Authentication
myAWSIoTMQTTShadowClient = AWSIoTPyMQTT.AWSIoTMQTTShadowClient("testIoTPySDK")
# Create an AWS IoT MQTT Shadow Client using Websocket SigV4
myAWSIoTMQTTShadowClient = AWSIoTPyMQTT.AWSIoTMQTTShadowClient("testIoTPySDK", useWebsocket=True)
**Parameters**
*clientID* - String that denotes the client identifier used to connect to AWS IoT.
If empty string were provided, client id for this connection will be randomly generated
n server side.
*protocolType* - MQTT version in use for this connection. Could be :code:`AWSIoTPythonSDK.MQTTLib.MQTTv3_1` or :code:`AWSIoTPythonSDK.MQTTLib.MQTTv3_1_1`
*useWebsocket* - Boolean that denotes enabling MQTT over Websocket SigV4 or not.
**Returns**
AWSIoTPythonSDK.MQTTLib.AWSIoTMQTTShadowClient object
"""
# AWSIOTMQTTClient instance
self._AWSIoTMQTTClient = AWSIoTMQTTClient(clientID, protocolType, useWebsocket, cleanSession)
# Configure it to disable offline Publish Queueing
self._AWSIoTMQTTClient.configureOfflinePublishQueueing(0) # Disable queueing, no queueing for time-sentive shadow messages
self._AWSIoTMQTTClient.configureDrainingFrequency(10)
# Now retrieve the configured mqttCore and init a shadowManager instance
self._shadowManager = shadowManager.shadowManager(self._AWSIoTMQTTClient._mqttCore)
def __init__(self,
clientID,
protocolType=MQTTv3_1_1,
useWebsocket=False,
cleanSession=True):
"""
The client class that manages device shadow and accesses its functionality in AWS IoT over MQTT v3.1/3.1.1.
It is built on top of the AWS IoT MQTT Client and exposes devive shadow related operations.
It shares the same connection types, synchronous MQTT operations and partial on-top features
with the AWS IoT MQTT Client:
- Auto reconnect/resubscribe
Same as AWS IoT MQTT Client.
- Progressive reconnect backoff
Same as AWS IoT MQTT Client.
- Offline publish requests queueing with draining
Disabled by default. Queueing is not allowed for time-sensitive shadow requests/messages.
**Syntax**
.. code:: python
import AWSIoTPythonSDK.MQTTLib as AWSIoTPyMQTT
# Create an AWS IoT MQTT Shadow Client using TLSv1.2 Mutual Authentication
myAWSIoTMQTTShadowClient = AWSIoTPyMQTT.AWSIoTMQTTShadowClient("testIoTPySDK")
# Create an AWS IoT MQTT Shadow Client using Websocket SigV4
myAWSIoTMQTTShadowClient = AWSIoTPyMQTT.AWSIoTMQTTShadowClient("testIoTPySDK", useWebsocket=True)
**Parameters**
*clientID* - String that denotes the client identifier used to connect to AWS IoT.
If empty string were provided, client id for this connection will be randomly generated
n server side.
*protocolType* - MQTT version in use for this connection. Could be :code:`AWSIoTPythonSDK.MQTTLib.MQTTv3_1` or :code:`AWSIoTPythonSDK.MQTTLib.MQTTv3_1_1`
*useWebsocket* - Boolean that denotes enabling MQTT over Websocket SigV4 or not.
**Returns**
AWSIoTPythonSDK.MQTTLib.AWSIoTMQTTShadowClient object
"""
# AWSIOTMQTTClient instance
self._AWSIoTMQTTClient = AWSIoTMQTTClient(clientID, protocolType,
useWebsocket, cleanSession)
# Configure it to disable offline Publish Queueing
self._AWSIoTMQTTClient.configureOfflinePublishQueueing(
0
) # Disable queueing, no queueing for time-sensitive shadow messages
self._AWSIoTMQTTClient.configureDrainingFrequency(10)
# Now retrieve the configured mqttCore and init a shadowManager instance
self._shadowManager = shadowManager.shadowManager(
self._AWSIoTMQTTClient._mqtt_core)