MQTT Monitor: comparison MqttMonitor/MqttMonitorWidget.py

-:420cb8adbf7e
+:9c29cfbd96c3
 client.onConnectV3.connect(self.__brokerConnected)
 client.onConnectV5.connect(self.__brokerConnected)
 client.onDisconnectedV3.connect(self.__brokerDisconnected)
 client.onDisconnectedV5.connect(self.__brokerDisconnected)
 client.onLog.connect(self.__clientLog)
-client.onMessage.connect(self.__messageReceived)
+client.onMessageV3.connect(self.__messageReceived)
+client.onMessageV5.connect(self.__messageReceived)
 client.onPublish.connect(self.__messagePublished)
 client.onSubscribeV3.connect(self.__topicSubscribed)
 client.onSubscribeV5.connect(self.__topicSubscribedV5)
-client.onUnsubscribe.connect(self.__topicUnsubscribed)
+client.onUnsubscribeV3.connect(self.__topicUnsubscribed)
+client.onUnsubscribeV5.connect(self.__topicUnsubscribedV5)
 client.connectTimeout.connect(self.__connectTimeout)
 return client
 #######################################################################
 ## Slots handling MQTT related signals
 #######################################################################
-# TODO: change to accept ReasonCode for rc
 @pyqtSlot(dict, int)
 @pyqtSlot(dict, int, int)
 def __brokerConnected(self, flags, rc, packetType=None):
 """
 Private slot to handle being connected to a broker.
 @param flags flags set for the connection
 @type dict
-@param rc CONNACK result code or tuple containing the result code and
+@param rc CONNACK result code or MQTTv5 reason code
-the packet type of the MQTTv5 reason code
+@type int
-@type int or tuple of (int, int)
+@param packetType packet type as reported by the client
+@type int
 """
 self.brokerStatusLabel.hide()
 # TODO: add support for flags[‘session present’]
 if rc == 0:
 if self.followLogMessagesCheckBox.isChecked():
 self.logEdit.ensureCursorVisible()
 else:
 self.logEdit.verticalScrollBar().setValue(scrollbarValue)
+# TODO: add support for MQTT v5 properties
 @pyqtSlot(str, bytes, int, bool)
-def __messageReceived(self, topic, payload, qos, retain):
+def __messageReceived(self, topic, payload, qos, retain, properties=None):
 """
 Private slot to handle the receipt of a message.
 @param topic topic of the message
 @type str
 @type bytes
 @param qos quality of service indicator
 @type int
 @param retain flag indicating a retained message
 @type bool
+@param properties properties sent with the message (MQTT v5)
+@type Properties
 """
 if topic.startswith(MqttMonitorWidget.BrokerStatusTopicPrefix):
 # handle broker status messages
 self.__handleBrokerStatusMessage(topic, payload)
 else:
-self.__appendMessage(topic, payload, qos)
+self.__appendMessage(topic, payload, qos, retain,
+properties=properties)
 @pyqtSlot(int)
 def __messagePublished(self, mid):
 """
 Private slot to handle a message being published.
 """
 Private slot to handle being subscribed to topics (MQTT v5).
 @param mid ID of the subscribe request
 @type int
-@param grantedQos tuple of granted quality of service
+@param reasonCodes list of reason codes, one for each topic
-@type tuple of int
+@type list of ReasonCodes
 """
 msg = mqttReasonCode(reasonCodes[0].value, reasonCodes[0].packetType)
 self.__flashBrokerStatusLabel(msg)
 self.__topicSubscribed(mid)
 @pyqtSlot(int)
 def __topicUnsubscribed(self, mid):
 """
-Private slot to handle being unsubcribed from a topic.
+Private slot to handle being unsubcribed from a topic (MQTT v3.1,
+MQTT v3.1.1).
 @param mid ID of the unsubscribe request
 @type int
 """
 if mid in self.__topicQueue:
 topic = self.__topicQueue.pop(mid)
 with contextlib.suppress(ValueError):
 self.__subscribedTopics.remove(topic)
 self.__updateUnsubscribeTopicComboBox()
 self.__updatePublishTopicComboBox()
+@pyqtSlot(int, int, int)
+def __topicUnsubscribedV5(self, mid, rc, packetType):
+"""
+Private slot to handle being unsubscribed to topics (MQTT v5).
+@param mid ID of the subscribe request
+@type int
+@param rc MQTTv5 reason code
+@type int
+@param packetType packet type as reported by the client
+@type int
+"""
+msg = mqttReasonCode(rc, packetType)
+self.__flashBrokerStatusLabel(msg)
+self.__topicUnsubscribed(mid)
 #######################################################################
 ## Slots handling UI interactions
 #######################################################################
 self.publishTopicComboBox.clearEditText()
 else:
 topicIndex = self.publishTopicComboBox.findText(currentTopic)
 self.publishTopicComboBox.setCurrentIndex(topicIndex)
-def __appendMessage(self, topic, payload, qos):
+def __appendMessage(self, topic, payload, qos, retain, properties=None):
 """
 Private method to append a received message to the output.
 @param topic topic of the received message
 @type str
 @param payload payload of the received message
 @type bytes
 @param qos quality of service indicator (0, 1, 2)
 @type int
-"""
+@param retain flag indicating a retained message
+@type bool
+@param properties properties sent with the message (MQTT v5)
+@type Properties
+"""
+# TODO: add Output for retain and properties
 scrollbarValue = self.messagesEdit.verticalScrollBar().value()
 textCursor = self.messagesEdit.textCursor()
 if not self.messagesEdit.document().isEmpty():
 textCursor.movePosition(QTextCursor.MoveOperation.End)
 self.messagesEdit.setCurrentCharFormat(self.__messagesTopicFormat)
 self.messagesEdit.insertPlainText(topic + "\n")
 self.messagesEdit.setCurrentCharFormat(self.__messagesQosFormat)
 self.messagesEdit.insertPlainText(self.tr("QoS: {0}\n").format(qos))
+if retain:
+self.messagesEdit.setCurrentCharFormat(self.__messagesQosFormat)
+self.messagesEdit.insertPlainText(self.tr("Retained Message\n"))
 payloadStr = str(payload, encoding="utf-8", errors="replace")
 self.messagesEdit.setCurrentCharFormat(self.__messagesFormat)
 self.messagesEdit.insertPlainText(
 Utilities.filterAnsiSequences(payloadStr))

Mercurial Repositories > MQTT Monitor / file comparison

comparison: MqttMonitor/MqttMonitorWidget.py

MqttMonitor/MqttMonitorWidget.py