MQTT Monitor: comparison MqttMonitor/MqttClient.py

-:70b8858199f5
+:5fe4f179975f
 self.onConnectV3.connect(self.__connectTimeoutTimer.stop)
 self.onConnectV5.connect(self.__connectTimeoutTimer.stop)
 self.__cleanSession = cleanSession
 self.__protocol = protocol
+self.__disconnectUserProperties = []
 if protocol == MqttProtocols.MQTTv5:
 cleanSession = None
 self.__mqttClient = mqtt.Client(
 @param userdata user data
 @type any
 """
 self.__mqttClient.user_data_set(userdata)
-# TODO: MQTTv5: add support for properties
+# TODO: MQTTv5: add support for WILL properties
 def setLastWill(self, topic, payload=None, qos=0, retain=False):
 """
 Public method to set the last will of the client.
 @param topic topic the will message should be published on
 """
 self.__mqttClient.loop_stop()
 self.__loopStarted = False
 def connectToServer(self, host, port=1883, keepalive=60, bindAddress="",
-reinit=True):
+properties=None):
 """
 Public method to connect to a remote MQTT broker.
 @param host host name or IP address of the remote broker
 @type str
 communications with the broker
 @type int
 @param bindAddress IP address of a local network interface to bind
 this client to
 @type str
-@param reinit flag indicating to reinitialize the MQTT client before
+@param properties list of user properties to be sent with the
-trying to connect with the given parameters
+subscription
-@type bool
+@type list of tuple of (str, str)
 """
-# TODO: MQTTv5: add support for MQTTv5 properties
+props = (
+self.__createPropertiesObject(PacketTypes.CONNECT, properties)
+if properties else
+None
+)
 self.__mqttClient.connect_async(
 host, port=port, keepalive=keepalive, bind_address=bindAddress,
-clean_start=self.__cleanSession)
+clean_start=self.__cleanSession, properties=props)
 self.__connectTimeoutTimer.start()
 if not self.__loopStarted:
 self.startLoop()
 @type int
 @param bindAddress IP address of a local network interface to bind
 this client to
 @type str
 @param options dictionary containing the connection options. This
-dictionary should contain the keys "ClientId", "Keepalive",
+dictionary should contain the keys "ClientId", "ConnectionTimeout",
-"CleanSession", "Username", "Password", "WillTopic", "WillMessage",
+"Keepalive", "CleanSession", "Username", "Password", "WillTopic",
-"WillQos", "WillRetain", "TlsEnable", "TlsCaCert", "TlsClientCert",
+"WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert",
-"TlsClientKey", "ConnectionTimeout"
+"TlsClientCert", "TlsClientKey", "UserProperties".
 @type dict
 """
 if options:
 parametersDict = self.defaultConnectionOptions()
 parametersDict.update(options)
 self.setTLS(caCerts=parametersDict["TlsCaCert"])
 else:
 # use default TLS configuration
 self.setTLS()
+# step 4: get the connect user properties
+if self.__protocol == MqttProtocols.MQTTv5:
+try:
+userProperties = parametersDict["UserProperties"]
+properties = userProperties["connect"][:]
+self.__disconnectUserProperties = (
+userProperties["connect"][:]
+if userProperties["use_connect"] else
+userProperties["disconnect"][:]
+)
+except KeyError:
+properties = None
+else:
+properties = None
 # step 4: connect to server
 self.__cleanSession = parametersDict["CleanSession"]
 self.connectToServer(host, port=port,
-keepalive=parametersDict["Keepalive"])
+keepalive=parametersDict["Keepalive"],
+properties=properties)
 else:
 keepalive = self.defaultConnectionOptions["Keepalive"]
 self.connectToServer(host, port=port, keepalive=keepalive,
 bindAddress=bindAddress)
 @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",
-"TlsClientKey".
+"TlsClientKey", "UserProperties".
 @rtype dict
 """
 return {
 "ClientId": "ERIC7_MQTT_MONITOR_CLIENT",
 "Protocol": MqttProtocols.MQTTv311,
 "WillRetain": False,
 "TlsEnable": False,
 "TlsCaCert": "",
 "TlsClientCert": "",
 "TlsClientKey": "",
+"UserProperties": {
+"connect": [],
+"disconnect": [],
+"use_connect": True,
+},
 }
 def reconnectToServer(self):
 """
 Public method to reconnect the client with the same parameters.
 """
 Public method to disconnect the client from the remote broker.
 """
 self.__connectTimeoutTimer.stop()
-# TODO: MQTTv5: add support for properties (?)
+props = (
-# TODO: MQTTv5: add support for reason code
+self.__createPropertiesObject(
-self.__mqttClient.disconnect()
+PacketTypes.DISCONNECT, self.__disconnectUserProperties)
+if self.__disconnectUserProperties else
+None
+)
+self.__mqttClient.disconnect(properties=props)
 def subscribe(self, topic, qos=0, properties=None):
 """
 Public method to subscribe to topics with quality of service.
 @type list of tuple of (str, str)
 @return tuple containing the result code and the message ID
 @rtype tuple of (int, int)
 """
 props = (
-self.__createPropertiesObject(PacketTypes.SUBSCRIBE, properties)
+self.__createPropertiesObject(PacketTypes.UNSUBSCRIBE, properties)
 if properties else
 None
 )
 return self.__mqttClient.unsubscribe(topic, properties=props)
-# TODO: MQTTv5: add support for properties
+def publish(self, topic, payload=None, qos=0, retain=False,
-def publish(self, topic, payload=None, qos=0, retain=False):
+properties=None):
 """
 Public method to publish to a topic.
 @param topic topic to publish to
 @type str
 @param qos quality of service
 @type int, one of 0, 1 or 2
 @param retain flag indicating to set as the "last known good"/retained
 message for the topic
 @type bool
+@param properties list of user properties to be sent with the
+subscription
+@type list of tuple of (str, str)
 @return message info object
 @rtype mqtt.MQTTMessageInfo
 """
+props = (
+self.__createPropertiesObject(PacketTypes.PUBLISH, properties)
+if properties else
+None
+)
 return self.__mqttClient.publish(topic, payload=payload, qos=qos,
-retain=retain)
+retain=retain, properties=props)
 def __createPropertiesObject(self, packetType, properties):
 """
 Private method to assemble the MQTT v5 properties object.
 @type list of tuple of (str, str)
 @return MQTT v5 properties object
 @rtype Properties
 """
 props = Properties(packetType)
-for userProperty in properties:
+props.UserProperty = properties
-props.UserProperty = tuple(userProperty)
 return props
 def mqttConnackMessage(connackCode):
 """

Mercurial Repositories > MQTT Monitor / file comparison

comparison: MqttMonitor/MqttClient.py

MqttMonitor/MqttClient.py