MQTT Monitor: comparison MqttMonitor/MqttClient.py

-:5fe4f179975f
+:9a4c9b7f078c
 @param userdata user data
 @type any
 """
 self.__mqttClient.user_data_set(userdata)
-# TODO: MQTTv5: add support for WILL properties
+def setLastWill(self, topic, payload=None, qos=0, retain=False,
-def setLastWill(self, topic, payload=None, qos=0, retain=False):
+properties=None):
 """
 Public method to set the last will of the client.
 @param topic topic the will message should be published on
 @type str
 @param qos quality of service level to use for the will
 @type int, one of 0, 1 or 2
 @param retain flag indicating to set as the "last known good"/retained
 message for the will topic
 @type bool
+@param properties list of user properties to be sent with the
+last will message
+@type list of tuple of (str, str)
 """
 self.__mqttClient.will_set(topic, payload=payload, qos=qos,
-retain=retain)
+retain=retain, properties=properties)
 def clearLastWill(self):
 """
 Public method to remove a will that was previously configured with
 setLastWill().
 """
 self.__mqttClient.loop_stop()
 self.__loopStarted = False
 def connectToServer(self, host, port=1883, keepalive=60, bindAddress="",
-properties=None):
+properties=None, clearWill=False):
 """
 Public method to connect to a remote MQTT broker.
 @param host host name or IP address of the remote broker
 @type str
 this client to
 @type str
 @param properties list of user properties to be sent with the
 subscription
 @type list of tuple of (str, str)
-"""
+@param clearWill flag indicating to clear the last will previously set
+@type bool
+"""
+if clearWill:
+self.clearLastWill()
 props = (
 self.__createPropertiesObject(PacketTypes.CONNECT, properties)
 if properties else
 None
 )
 if not self.__loopStarted:
 self.startLoop()
 def connectToServerWithOptions(self, host, port=1883, bindAddress="",
-options=None):
+options=None, clearWill=False):
 """
 Public method to connect to a remote MQTT broker.
 @param host host name or IP address of the remote broker
 @type str
 this client to
 @type str
 @param options dictionary containing the connection options. This
 dictionary should contain the keys "ClientId", "ConnectionTimeout",
 "Keepalive", "CleanSession", "Username", "Password", "WillTopic",
-"WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert",
+"WillMessage", "WillQos", "WillRetain", "WillProperties",
-"TlsClientCert", "TlsClientKey", "UserProperties".
+"TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey",
+"UserProperties".
 @type dict
+@param clearWill flag indicating to clear the last will previously set
+@type bool
 """
 if options:
 parametersDict = self.defaultConnectionOptions()
 parametersDict.update(options)
 pwConvert(parametersDict["Password"], encode=False))
 else:
 self.setUserCredentials(parametersDict["Username"])
 # step 2: set last will data
-if parametersDict["WillTopic"]:
+if not clearWill and parametersDict["WillTopic"]:
 if parametersDict["WillMessage"]:
 willMessage = parametersDict["WillMessage"]
 else:
 # empty message to clear the will
 willMessage = None
+props = (
+self.__createPropertiesObject(
+PacketTypes.WILLMESSAGE,
+parametersDict["WillProperties"])
+if (parametersDict["WillProperties"] and
+self.__protocol == MqttProtocols.MQTTv5) else
+None
+)
 self.setLastWill(parametersDict["WillTopic"],
-willMessage,
+payload=willMessage,
-parametersDict["WillQos"],
+qos=parametersDict["WillQos"],
-parametersDict["WillRetain"])
+retain=parametersDict["WillRetain"],
+properties=props)
 # step 3: set TLS parameters
 if parametersDict["TlsEnable"]:
 if (
 parametersDict["TlsCaCert"] and
 properties = None
 # step 4: connect to server
 self.__cleanSession = parametersDict["CleanSession"]
 self.connectToServer(host, port=port,
 keepalive=parametersDict["Keepalive"],
-properties=properties)
+properties=properties,
+clearWill=clearWill)
 else:
 keepalive = self.defaultConnectionOptions["Keepalive"]
 self.connectToServer(host, port=port, keepalive=keepalive,
-bindAddress=bindAddress)
+bindAddress=bindAddress,
+clearWill=clearWill)
 @classmethod
 def defaultConnectionOptions(cls):
 """
 Class method to get a connection options dictionary with default
 values.
 @return dictionary containing the default connection options. It has
 the keys "ClientId", "Protocol", "ConnectionTimeout", "Keepalive",
 "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
-"WillQos", "WillRetain", "TlsEnable", "TlsCaCert", "TlsClientCert",
+"WillQos", "WillRetain", "WillProperties", "TlsEnable",
-"TlsClientKey", "UserProperties".
+"TlsCaCert", "TlsClientCert", "TlsClientKey", "UserProperties".
 @rtype dict
 """
 return {
 "ClientId": "ERIC7_MQTT_MONITOR_CLIENT",
 "Protocol": MqttProtocols.MQTTv311,
 "Password": "",
 "WillTopic": "",
 "WillMessage": "",
 "WillQos": 0,
 "WillRetain": False,
+"WillProperties": [],
 "TlsEnable": False,
 "TlsCaCert": "",
 "TlsClientCert": "",
 "TlsClientKey": "",
 "UserProperties": {

Mercurial Repositories > MQTT Monitor / file comparison

comparison: MqttMonitor/MqttClient.py

MqttMonitor/MqttClient.py