--- a/MqttMonitor/MqttClient.py Thu Dec 30 16:36:40 2021 +0100
+++ b/MqttMonitor/MqttClient.py Wed Sep 21 09:42:33 2022 +0200
@@ -7,9 +7,7 @@
Module implementing a PyQt wrapper around the paho MQTT client.
"""
-from PyQt6.QtCore import (
- pyqtSignal, pyqtSlot, QObject, QCoreApplication, QTimer
-)
+from PyQt6.QtCore import pyqtSignal, pyqtSlot, QObject, QCoreApplication, QTimer
import paho.mqtt.client as mqtt
from paho.mqtt.packettypes import PacketTypes
@@ -23,7 +21,7 @@
class MqttClient(QObject):
"""
Class implementing a PyQt wrapper around the paho MQTT client.
-
+
@signal onConnectV3(flags, rc) emitted after the client has connected to
the broker (MQTT v3)
@signal onConnectV5(flags, rc, packetType, properties emitted after the
@@ -49,6 +47,7 @@
@signal connectTimeout() emitted to indicate, that a connection attempt
timed out
"""
+
onConnectV3 = pyqtSignal(dict, int)
onConnectV5 = pyqtSignal(dict, int, int, dict)
onDisconnectedV3 = pyqtSignal(int)
@@ -61,30 +60,37 @@
onSubscribeV5 = pyqtSignal(int, list, dict)
onUnsubscribeV3 = pyqtSignal(int)
onUnsubscribeV5 = pyqtSignal(int, int, int, dict)
-
+
connectTimeout = pyqtSignal()
-
- DefaultConnectTimeout = 15 # connect timeout in seconds
-
+
+ DefaultConnectTimeout = 15 # connect timeout in seconds
+
LogDebug = 0x01
LogInfo = 0x02
LogNotice = 0x04
LogWarning = 0x08
LogError = 0x10
- LogDisabled = 0xff
+ LogDisabled = 0xFF
LogLevelMap = {
mqtt.MQTT_LOG_DEBUG: LogDebug,
mqtt.MQTT_LOG_INFO: LogInfo,
mqtt.MQTT_LOG_NOTICE: LogNotice,
- mqtt.MQTT_LOG_WARNING: LogWarning, # __NO-TASK__
+ mqtt.MQTT_LOG_WARNING: LogWarning, # __NO-TASK__
mqtt.MQTT_LOG_ERR: LogError,
}
-
- def __init__(self, clientId="", cleanSession=True, userdata=None,
- protocol=mqtt.MQTTv311, transport="tcp", parent=None):
+
+ def __init__(
+ self,
+ clientId="",
+ cleanSession=True,
+ userdata=None,
+ protocol=mqtt.MQTTv311,
+ transport="tcp",
+ parent=None,
+ ):
"""
Constructor
-
+
@param clientId ID to be used for the client
@type str
@param cleanSession flag indicating to start a clean session
@@ -99,109 +105,163 @@
@type QObject
"""
QObject.__init__(self, parent=parent)
-
+
self.__loopStarted = False
-
+
self.__connectTimeoutTimer = QTimer(self)
self.__connectTimeoutTimer.setSingleShot(True)
- self.__connectTimeoutTimer.setInterval(
- MqttClient.DefaultConnectTimeout * 1000)
+ self.__connectTimeoutTimer.setInterval(MqttClient.DefaultConnectTimeout * 1000)
self.__connectTimeoutTimer.timeout.connect(self.__connectTimeout)
-
+
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(
- client_id=clientId, clean_session=cleanSession, userdata=userdata,
- protocol=int(protocol), transport=transport)
-
+ client_id=clientId,
+ clean_session=cleanSession,
+ userdata=userdata,
+ protocol=int(protocol),
+ transport=transport,
+ )
+
self.__initCallbacks(protocol)
def __initCallbacks(self, protocol):
"""
Private method to initialize the MQTT callback methods.
-
+
@param protocol MQTT protocol version
@type MqttProtocols
"""
if protocol in (MqttProtocols.MQTTv31, MqttProtocols.MQTTv311):
- self.__mqttClient.on_connect = (
- lambda client, userdata, flags, rc, properties=None:
- self.onConnectV3.emit(flags, rc)
- )
- self.__mqttClient.on_disconnect = (
- lambda client, userdata, rc:
- self.onDisconnectedV3.emit(rc)
- )
- self.__mqttClient.on_subscribe = (
- lambda client, userdata, mid, grantedQos, properties=None:
- self.onSubscribeV3.emit(mid, grantedQos)
- )
- self.__mqttClient.on_unsubscribe = (
- lambda client, userdata, mid:
- self.onUnsubscribeV3.emit(mid)
- )
- self.__mqttClient.on_message = (
- lambda client, userdata, message:
- self.onMessageV3.emit(message.topic, message.payload,
- message.qos, message.retain)
- )
+ self.__mqttClient.on_connect = self.__onConnectV3
+ self.__mqttClient.on_disconnect = self.__onDisconnectedV3
+ self.__mqttClient.on_subscribe = self.__onSubscribeV3
+ self.__mqttClient.on_unsubscribe = self.__onUnsubscribeV3
+ self.__mqttClient.on_message = self.__onMessageV3
else:
- self.__mqttClient.on_connect = (
- lambda client, userdata, flags, rc, properties=None:
- self.onConnectV5.emit(
- flags, rc.value, rc.packetType,
- properties.json() if properties is not None else {}
- )
- )
+ self.__mqttClient.on_connect = self.__onConnectV5
self.__mqttClient.on_disconnect = self.__onDisconnectedV5
- self.__mqttClient.on_subscribe = (
- lambda client, userdata, mid, reasonCodes, properties=None:
- self.onSubscribeV5.emit(
- mid, reasonCodes,
- properties.json() if properties is not None else {}
- )
- )
- self.__mqttClient.on_unsubscribe = (
- lambda client, userdata, mid, properties, rc:
- self.onUnsubscribeV5.emit(
- mid, rc.value, rc.packetType,
- properties.json() if properties is not None else {}
- )
- )
- self.__mqttClient.on_message = (
- lambda client, userdata, message:
- self.onMessageV5.emit(
- message.topic, message.payload, message.qos,
- message.retain, message.properties.json()
- )
- )
- self.__mqttClient.on_log = (
- lambda client, userdata, level, buf:
- self.onLog.emit(level, buf)
+ self.__mqttClient.on_subscribe = self.__onSubscribeV5
+ self.__mqttClient.on_unsubscribe = self.__onUnsubscribeV5
+ self.__mqttClient.on_message = self.__onMessageV5
+
+ self.__mqttClient.on_log = self.__onLog
+ self.__mqttClient.on_publish = self.__onPublish
+
+ def __onConnectV3(self, client, userdata, flags, rc, properties=None):
+ """
+ Private method to handle the connect to the broker (MQTT v3.1 and v3.1.1).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param flags dictionary containing the response flags sent by the broker
+ @type dict
+ @param rc result code
+ @type int
+ @param properties optional properties (defaults to None)
+ @type dict (optional)
+ """
+ self.onConnectV3.emit(flags, rc)
+
+ def __onDisconnectedV3(self, client, userdata, rc):
+ """
+ Private method to handle the disconnect from the broker (MQTT v3.1 and v3.1.1).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param rc result code
+ @type int
+ """
+ self.onDisconnectedV3.emit(rc)
+
+ def __onSubscribeV3(self, client, userdata, mid, grantedQos):
+ """
+ Private method to handle a subscribe event (MQTT v3.1 and v3.1.1).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param mid message ID
+ @type int
+ @param grantedQos list of granted QoS for each subscription request
+ @type list of int
+ """
+ self.onSubscribeV3.emit(mid, grantedQos)
+
+ def __onUnsubscribeV3(self, client, userdata, mid):
+ """
+ Private method to handle an unsubscribe event (MQTT v3.1 and v3.1.1).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param mid message ID
+ @type int
+ """
+ self.onUnsubscribeV3.emit(mid)
+
+ def __onMessageV3(self, client, userdata, message):
+ """
+ Private method to handle a new message received from the broker (MQTT v3.1
+ and v3.1.1).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param message received message object
+ @type paho.mqtt.MQTTMessage
+ """
+ self.onMessageV3.emit(
+ message.topic, message.payload, message.qos, message.retain
)
- self.__mqttClient.on_publish = (
- lambda client, userdata, mid:
- self.onPublish.emit(mid)
+
+ def __onConnectV5(self, client, userdata, flags, rc, properties=None):
+ """
+ Private method to handle the connect to the broker (MQTT v5.0).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param flags dictionary containing the response flags sent by the broker
+ @type dict
+ @param rc reason code
+ @type paho.mqtt.ReasonCodes
+ @param properties optional properties (defaults to None)
+ @type dict (optional)
+ """
+ self.onConnectV5.emit(
+ flags,
+ rc.value,
+ rc.packetType,
+ properties.json() if properties is not None else {},
)
-
+
def __onDisconnectedV5(self, client, userdata, rc, properties=None):
"""
- Private method to handle the disconnect from the broker.
-
+ Private method to handle the disconnect from the broker (MQTT v5.0).
+
@param client reference to the client object
@type paho.mqtt.Client
@param userdata user data
@type Any
@param rc result code or reason code
- @type int or ReasonCodes
+ @type int or paho.mqtt.ReasonCodes
@param properties optional properties (defaults to None)
@type dict (optional)
"""
@@ -212,7 +272,98 @@
packetType = rc.packetType
resultCode = rc.value
self.onDisconnectedV5.emit(resultCode, packetType)
-
+
+ def __onSubscribeV5(self, client, userdata, mid, reasonCodes, properties=None):
+ """
+ Private method to handle a subscribe event (MQTT v5.0).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param mid message ID
+ @type int
+ @param reasonCodes list of reason code for each subscribed topic
+ @type list of paho.mqtt.ReasonCodes
+ @param properties optional properties (defaults to None)
+ @type dict (optional)
+ """
+ self.onSubscribeV5.emit(
+ mid,
+ reasonCodes,
+ properties.json() if properties is not None else {},
+ )
+
+ def __onUnsubscribeV5(self, client, userdata, mid, properties, reasonCodes):
+ """
+ Private method to handle an unsubscribe event (MQTT v5.0).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param mid message ID
+ @type int
+ @param properties optional properties (defaults to None)
+ @type dict (optional)
+ @param reasonCodes list of reason code for each unsubscribed topic
+ @type list of paho.mqtt.ReasonCodes
+ """
+ self.onUnsubscribeV5.emit(
+ mid,
+ reasonCodes.value,
+ reasonCodes.packetType,
+ properties.json() if properties is not None else {},
+ )
+
+ def __onMessageV5(self, client, userdata, message):
+ """
+ Private method to handle a new message received from the broker (MQTT v5.0).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param message received message object
+ @type paho.mqtt.MQTTMessage
+ """
+ self.onMessageV5.emit(
+ message.topic,
+ message.payload,
+ message.qos,
+ message.retain,
+ message.properties.json(),
+ )
+
+ def __onLog(self, client, userdata, level, buf):
+ """
+ Private method to handle a log event (MQTT v3.1, v3.1.1 and v5.0).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param level severity of the log message
+ @type int
+ @param buf log message
+ @type str
+ """
+ self.onLog.emit(level, buf)
+
+ def __onPublish(self, client, userdata, mid):
+ """
+ Private method to handle the publishing of a message (MQTT v3.1, v3.1.1
+ and v5.0).
+
+ @param client reference to the client object
+ @type paho.mqtt.Client
+ @param userdata user data
+ @type Any
+ @param mid message ID
+ @type int
+ """
+ self.onPublish.emit(mid)
+
@pyqtSlot()
def __connectTimeout(self):
"""
@@ -220,61 +371,60 @@
"""
self.stopLoop()
self.connectTimeout.emit()
-
+
def setConnectionTimeout(self, timeout):
"""
Public method to set the connection timeout value.
-
+
@param timeout timeout value to be set in seconds
@type int
"""
self.__connectTimeoutTimer.setInterval(timeout * 1000)
-
+
def setMaxInflightMessages(self, inflight=20):
"""
Public method to set the maximum number of messages with QoS > 0 that
can be part way through their network flow at once.
-
+
@param inflight maximum number of messages in flight
@type int
"""
self.__mqttClient.max_inflight_messages_set(inflight)
-
+
def setMaxQueuedMessages(self, queueSize=0):
"""
Public method to set the maximum number of messages with QoS > 0 that
can be pending in the outgoing message queue.
-
+
@param queueSize maximum number of queued messages (0 = unlimited)
@type int
"""
self.__mqttClient.max_queued_messages_set(queueSize)
-
+
def setUserCredentials(self, username, password=None):
"""
Public method to set the user name and optionally the password.
-
+
@param username user name to be set
@type str
@param password optional password
@type str
"""
self.__mqttClient.username_pw_set(username, password=password)
-
+
def setUserData(self, userdata):
"""
Public method to set the user data.
-
+
@param userdata user data
@type any
"""
self.__mqttClient.user_data_set(userdata)
-
- def setLastWill(self, topic, payload=None, qos=0, retain=False,
- properties=None):
+
+ 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 payload message to send as a will
@@ -288,20 +438,21 @@
last will message
@type list of tuple of (str, str)
"""
- self.__mqttClient.will_set(topic, payload=payload, qos=qos,
- retain=retain, properties=properties)
-
+ self.__mqttClient.will_set(
+ topic, payload=payload, qos=qos, retain=retain, properties=properties
+ )
+
def clearLastWill(self):
"""
Public method to remove a will that was previously configured with
setLastWill().
"""
self.__mqttClient.will_clear()
-
+
def setTLS(self, caCerts=None, certFile=None, keyFile=None):
"""
Public method to enable secure connections and set the TLS parameters.
-
+
@param caCerts path to the Certificate Authority certificates file
@type str
@param certFile PEM encoded client certificate file
@@ -313,42 +464,50 @@
@rtype tuple of (bool, str)
"""
try:
- self.__mqttClient.tls_set(ca_certs=caCerts, certfile=certFile,
- keyfile=keyFile)
+ self.__mqttClient.tls_set(
+ ca_certs=caCerts, certfile=certFile, keyfile=keyFile
+ )
return True, ""
except (ValueError, FileNotFoundError) as err:
return False, str(err)
-
+
return False, "unspecific error occurred"
-
+
def getProtocol(self):
"""
Public method to get the MQTT protocol version.
-
+
@return MQTT protocol version in use
@rtype int
"""
return self.__protocol
-
+
def startLoop(self):
"""
Public method to start the MQTT client loop.
"""
self.__mqttClient.loop_start()
self.__loopStarted = True
-
+
def stopLoop(self):
"""
Public method to stop the MQTT client loop.
"""
self.__mqttClient.loop_stop()
self.__loopStarted = False
-
- def connectToServer(self, host, port=1883, keepalive=60, bindAddress="",
- properties=None, clearWill=False):
+
+ def connectToServer(
+ self,
+ host,
+ port=1883,
+ keepalive=60,
+ bindAddress="",
+ 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
@param port network port of the server host to connect to (default:
@@ -368,26 +527,32 @@
"""
if clearWill:
self.clearLastWill()
-
+
props = (
self.__createPropertiesObject(PacketTypes.CONNECT, properties)
- if properties else
- None
+ if properties
+ else None
)
self.__mqttClient.connect_async(
- host, port=port, keepalive=keepalive, bind_address=bindAddress,
- clean_start=self.__cleanSession, properties=props)
-
+ host,
+ port=port,
+ keepalive=keepalive,
+ bind_address=bindAddress,
+ clean_start=self.__cleanSession,
+ properties=props,
+ )
+
self.__connectTimeoutTimer.start()
-
+
if not self.__loopStarted:
self.startLoop()
-
- def connectToServerWithOptions(self, host, port=1883, bindAddress="",
- options=None, clearWill=False):
+
+ def connectToServerWithOptions(
+ self, host, port=1883, bindAddress="", 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
@param port network port of the server host to connect to (default:
@@ -409,18 +574,19 @@
if options:
parametersDict = self.defaultConnectionOptions()
parametersDict.update(options)
-
+
self.setConnectionTimeout(parametersDict["ConnectionTimeout"])
-
+
# step 1: set username and password
if parametersDict["Username"]:
if parametersDict["Password"]:
self.setUserCredentials(
parametersDict["Username"],
- pwConvert(parametersDict["Password"], encode=False))
+ pwConvert(parametersDict["Password"], encode=False),
+ )
else:
self.setUserCredentials(parametersDict["Username"])
-
+
# step 2: set last will data
if not clearWill and parametersDict["WillTopic"]:
if parametersDict["WillMessage"]:
@@ -430,35 +596,38 @@
willMessage = None
props = (
self.__createPropertiesObject(
- PacketTypes.WILLMESSAGE,
- parametersDict["WillProperties"])
- if (parametersDict["WillProperties"] and
- self.__protocol == MqttProtocols.MQTTv5) else
- None
+ PacketTypes.WILLMESSAGE, parametersDict["WillProperties"]
+ )
+ if (
+ parametersDict["WillProperties"]
+ and self.__protocol == MqttProtocols.MQTTv5
+ )
+ else None
)
- self.setLastWill(parametersDict["WillTopic"],
- payload=willMessage,
- qos=parametersDict["WillQos"],
- retain=parametersDict["WillRetain"],
- properties=props)
-
+ self.setLastWill(
+ parametersDict["WillTopic"],
+ payload=willMessage,
+ qos=parametersDict["WillQos"],
+ retain=parametersDict["WillRetain"],
+ properties=props,
+ )
+
# step 3: set TLS parameters
if parametersDict["TlsEnable"]:
- if (
- parametersDict["TlsCaCert"] and
- parametersDict["TlsClientCert"]
- ):
+ if parametersDict["TlsCaCert"] and parametersDict["TlsClientCert"]:
# use self signed client certificate
- self.setTLS(caCerts=parametersDict["TlsCaCert"],
- certFile=parametersDict["TlsClientCert"],
- keyFile=parametersDict["TlsClientKey"])
+ self.setTLS(
+ caCerts=parametersDict["TlsCaCert"],
+ certFile=parametersDict["TlsClientCert"],
+ keyFile=parametersDict["TlsClientKey"],
+ )
elif parametersDict["TlsCaCert"]:
# use CA certificate file
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:
@@ -466,8 +635,8 @@
properties = userProperties["connect"][:]
self.__disconnectUserProperties = (
userProperties["connect"][:]
- if userProperties["use_connect"] else
- userProperties["disconnect"][:]
+ if userProperties["use_connect"]
+ else userProperties["disconnect"][:]
)
except KeyError:
properties = None
@@ -475,22 +644,29 @@
properties = None
# step 4: connect to server
self.__cleanSession = parametersDict["CleanSession"]
- self.connectToServer(host, port=port,
- keepalive=parametersDict["Keepalive"],
- properties=properties,
- clearWill=clearWill)
+ self.connectToServer(
+ host,
+ port=port,
+ keepalive=parametersDict["Keepalive"],
+ properties=properties,
+ clearWill=clearWill,
+ )
else:
keepalive = self.defaultConnectionOptions()["Keepalive"]
- self.connectToServer(host, port=port, keepalive=keepalive,
- bindAddress=bindAddress,
- clearWill=clearWill)
-
+ self.connectToServer(
+ host,
+ port=port,
+ keepalive=keepalive,
+ 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",
@@ -499,7 +675,7 @@
@rtype dict
"""
from PluginMqttMonitor import mqttPluginObject
-
+
return {
"ClientId": "ERIC7_MQTT_MONITOR_CLIENT",
"Protocol": mqttPluginObject.getPreferences("DefaultProtocol"),
@@ -523,36 +699,37 @@
"use_connect": True,
},
}
-
+
def reconnectToServer(self):
"""
Public method to reconnect the client with the same parameters.
"""
self.__connectTimeoutTimer.start()
-
+
self.__mqttClient.reconnect()
-
+
if not self.__loopStarted:
self.startLoop()
-
+
def disconnectFromServer(self):
"""
Public method to disconnect the client from the remote broker.
"""
self.__connectTimeoutTimer.stop()
-
+
props = (
self.__createPropertiesObject(
- PacketTypes.DISCONNECT, self.__disconnectUserProperties)
- if self.__disconnectUserProperties else
- None
+ 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.
-
+
@param topic single topic to subscribe to or a tuple with a topic
and a QoS or a list of tuples with a topic and a QoS each
@type str or tuple of (str, int) or list of tuple of (str, int)
@@ -566,15 +743,15 @@
"""
props = (
self.__createPropertiesObject(PacketTypes.SUBSCRIBE, properties)
- if properties else
- None
+ if properties
+ else None
)
return self.__mqttClient.subscribe(topic, qos=qos, properties=props)
-
+
def unsubscribe(self, topic, properties=None):
"""
Public method to unsubscribe topics.
-
+
@param topic topic or list of topics to unsubscribe
@type str or list of str
@param properties list of user properties to be sent with the
@@ -585,16 +762,15 @@
"""
props = (
self.__createPropertiesObject(PacketTypes.UNSUBSCRIBE, properties)
- if properties else
- None
+ if properties
+ else None
)
return self.__mqttClient.unsubscribe(topic, properties=props)
-
- def publish(self, topic, payload=None, qos=0, retain=False,
- properties=None):
+
+ 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 payload data to be published
@@ -612,16 +788,17 @@
"""
props = (
self.__createPropertiesObject(PacketTypes.PUBLISH, properties)
- if properties else
- None
+ if properties
+ else None
)
- return self.__mqttClient.publish(topic, payload=payload, qos=qos,
- retain=retain, properties=props)
-
+ return self.__mqttClient.publish(
+ topic, payload=payload, qos=qos, retain=retain, properties=props
+ )
+
def __createPropertiesObject(self, packetType, properties):
"""
Private method to assemble the MQTT v5 properties object.
-
+
@param packetType type of the MQTT packet
@type PacketTypes (= int)
@param properties list of user properties
@@ -637,127 +814,105 @@
def mqttConnackMessage(connackCode):
"""
Module function to get the string associated with a CONNACK result.
-
+
@param connackCode result code of the connection request
@type int
@return textual representation for the result code
@rtype str
"""
if connackCode == mqtt.CONNACK_ACCEPTED:
- return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Accepted.")
+ return QCoreApplication.translate("MqttConnackMessage", "Connection Accepted.")
elif connackCode == mqtt.CONNACK_REFUSED_PROTOCOL_VERSION:
return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Refused: unacceptable protocol version.")
+ "MqttConnackMessage", "Connection Refused: unacceptable protocol version."
+ )
elif connackCode == mqtt.CONNACK_REFUSED_IDENTIFIER_REJECTED:
return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Refused: identifier rejected.")
+ "MqttConnackMessage", "Connection Refused: identifier rejected."
+ )
elif connackCode == mqtt.CONNACK_REFUSED_SERVER_UNAVAILABLE:
return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Refused: broker unavailable.")
+ "MqttConnackMessage", "Connection Refused: broker unavailable."
+ )
elif connackCode == mqtt.CONNACK_REFUSED_BAD_USERNAME_PASSWORD:
return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Refused: bad user name or password.")
+ "MqttConnackMessage", "Connection Refused: bad user name or password."
+ )
elif connackCode == mqtt.CONNACK_REFUSED_NOT_AUTHORIZED:
return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Refused: not authorised.")
+ "MqttConnackMessage", "Connection Refused: not authorised."
+ )
else:
return QCoreApplication.translate(
- "MqttConnackMessage",
- "Connection Refused: unknown reason.")
+ "MqttConnackMessage", "Connection Refused: unknown reason."
+ )
def mqttErrorMessage(mqttErrno):
"""
Module function to get the error string associated with an MQTT error
number.
-
+
@param mqttErrno result code of a MQTT request
@type int
@return textual representation of the result code
@rtype str
"""
if mqttErrno == mqtt.MQTT_ERR_SUCCESS:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "No error.")
+ return QCoreApplication.translate("MqttErrorMessage", "No error.")
elif mqttErrno == mqtt.MQTT_ERR_NOMEM:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Out of memory.")
+ return QCoreApplication.translate("MqttErrorMessage", "Out of memory.")
elif mqttErrno == mqtt.MQTT_ERR_PROTOCOL:
return QCoreApplication.translate(
"MqttErrorMessage",
- "A network protocol error occurred when communicating with"
- " the broker.")
+ "A network protocol error occurred when communicating with" " the broker.",
+ )
elif mqttErrno == mqtt.MQTT_ERR_INVAL:
return QCoreApplication.translate(
- "MqttErrorMessage",
- "Invalid function arguments provided.")
+ "MqttErrorMessage", "Invalid function arguments provided."
+ )
elif mqttErrno == mqtt.MQTT_ERR_NO_CONN:
return QCoreApplication.translate(
- "MqttErrorMessage",
- "The client is not currently connected.")
+ "MqttErrorMessage", "The client is not currently connected."
+ )
elif mqttErrno == mqtt.MQTT_ERR_CONN_REFUSED:
return QCoreApplication.translate(
- "MqttErrorMessage",
- "The connection was refused.")
+ "MqttErrorMessage", "The connection was refused."
+ )
elif mqttErrno == mqtt.MQTT_ERR_NOT_FOUND:
return QCoreApplication.translate(
- "MqttErrorMessage",
- "Message not found (internal error).")
+ "MqttErrorMessage", "Message not found (internal error)."
+ )
elif mqttErrno == mqtt.MQTT_ERR_CONN_LOST:
return QCoreApplication.translate(
- "MqttErrorMessage",
- "The connection was lost.")
+ "MqttErrorMessage", "The connection was lost."
+ )
elif mqttErrno == mqtt.MQTT_ERR_TLS:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "A TLS error occurred.")
+ return QCoreApplication.translate("MqttErrorMessage", "A TLS error occurred.")
elif mqttErrno == mqtt.MQTT_ERR_PAYLOAD_SIZE:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Payload too large.")
+ return QCoreApplication.translate("MqttErrorMessage", "Payload too large.")
elif mqttErrno == mqtt.MQTT_ERR_NOT_SUPPORTED:
return QCoreApplication.translate(
- "MqttErrorMessage",
- "This feature is not supported.")
+ "MqttErrorMessage", "This feature is not supported."
+ )
elif mqttErrno == mqtt.MQTT_ERR_AUTH:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Authorisation failed.")
+ return QCoreApplication.translate("MqttErrorMessage", "Authorisation failed.")
elif mqttErrno == mqtt.MQTT_ERR_ACL_DENIED:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Access denied by ACL.")
+ return QCoreApplication.translate("MqttErrorMessage", "Access denied by ACL.")
elif mqttErrno == mqtt.MQTT_ERR_UNKNOWN:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Unknown error.")
+ return QCoreApplication.translate("MqttErrorMessage", "Unknown error.")
elif mqttErrno == mqtt.MQTT_ERR_ERRNO:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Error defined by errno.")
+ return QCoreApplication.translate("MqttErrorMessage", "Error defined by errno.")
elif mqttErrno == mqtt.MQTT_ERR_QUEUE_SIZE:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Message queue full.")
+ return QCoreApplication.translate("MqttErrorMessage", "Message queue full.")
else:
- return QCoreApplication.translate(
- "MqttErrorMessage",
- "Unknown error.")
+ return QCoreApplication.translate("MqttErrorMessage", "Unknown error.")
def mqttLogLevelString(mqttLogLevel, isMqttLogLevel=True):
"""
Module function to get the log level string associated with a log level.
-
+
@param mqttLogLevel log level of the paho-mqtt client
@type int
@param isMqttLogLevel flag indicating a MQTT log level is given (if
@@ -773,7 +928,7 @@
return QCoreApplication.translate("MqttLogLevelString", "Unknown")
else:
logLevel = mqttLogLevel
-
+
if logLevel == MqttClient.LogInfo:
return QCoreApplication.translate("MqttLogLevelString", "Info")
elif logLevel == MqttClient.LogNotice:
@@ -785,7 +940,6 @@
elif logLevel == MqttClient.LogDebug:
return QCoreApplication.translate("MqttLogLevelString", "Debug")
elif logLevel == MqttClient.LogDisabled:
- return QCoreApplication.translate("MqttLogLevelString",
- "Logging Disabled")
+ return QCoreApplication.translate("MqttLogLevelString", "Logging Disabled")
else:
return QCoreApplication.translate("MqttLogLevelString", "Unknown")
