Mercurial Repositories > MQTT Monitor / changeset
changeset
Adapted code to eric 24.2 and newer.
Sat, 06 Jan 2024 13:10:46 +0100
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sat, 06 Jan 2024 13:10:46 +0100
- branch
- eric7
- changeset 141
- 864edfb1bb63
- parent 140
- 853ffd248dda
- child 142
- cf158867ed89
Adapted code to eric 24.2 and newer.
--- a/ChangeLog Sat Dec 23 19:45:41 2023 +0100 +++ b/ChangeLog Sat Jan 06 13:10:46 2024 +0100 @@ -1,5 +1,8 @@ ChangeLog --------- +Version 10.5.0 +- adapted code to eric 24.2 and newer + Version 10.4.2 - updated Spanish translations
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.ConfigurationPage.MqttPage.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.ConfigurationPage.MqttPage.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,53 +7,50 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.ConfigurationPage.MqttPage</h1> - <p> Module implementing the MQTT Monitor configuration page. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttPage">MqttPage</a></td> <td>Class implementing the MQTT Monitor configuration page.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="MqttPage" ID="MqttPage"></a> <h2>MqttPage</h2> - <p> Class implementing the MQTT Monitor configuration page. </p> + <h3>Derived from</h3> ConfigurationPageBase, Ui_MqttPage <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttPage.__init__">MqttPage</a></td> <td>Constructor</td> @@ -63,19 +60,20 @@ <td>Public slot to save the Rope Autocompletion configuration.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttPage.__init__" ID="MqttPage.__init__"></a> <h4>MqttPage (Constructor)</h4> <b>MqttPage</b>(<i>plugin</i>) - <p> Constructor </p> + <dl> <dt><i>plugin</i> (RefactoringRopePlugin)</dt> @@ -86,10 +84,10 @@ <a NAME="MqttPage.save" ID="MqttPage.save"></a> <h4>MqttPage.save</h4> <b>save</b>(<i></i>) - <p> Public slot to save the Rope Autocompletion configuration. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,28 +7,25 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttClient</h1> - <p> Module implementing a PyQt wrapper around the paho MQTT client. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttClient">MqttClient</a></td> <td>Class implementing a PyQt wrapper around the paho MQTT client.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#mqttConnackMessage">mqttConnackMessage</a></td> <td>Module function to get the string associated with a CONNACK result.</td> @@ -42,14 +39,15 @@ <td>Module function to get the log level string associated with a log level.</td> </tr> </table> + <hr /> <hr /> <a NAME="MqttClient" ID="MqttClient"></a> <h2>MqttClient</h2> - <p> Class implementing a PyQt wrapper around the paho MQTT client. </p> + <h3>Signals</h3> <dl> @@ -119,23 +117,27 @@ <h3>Derived from</h3> QObject <h3>Class Attributes</h3> - <table> -<tr><td>DefaultConnectTimeout</td></tr><tr><td>LogDebug</td></tr><tr><td>LogDisabled</td></tr><tr><td>LogError</td></tr><tr><td>LogInfo</td></tr><tr><td>LogLevelMap</td></tr><tr><td>LogNotice</td></tr><tr><td>LogWarning</td></tr> +<tr><td>DefaultConnectTimeout</td></tr> +<tr><td>LogDebug</td></tr> +<tr><td>LogDisabled</td></tr> +<tr><td>LogError</td></tr> +<tr><td>LogInfo</td></tr> +<tr><td>LogLevelMap</td></tr> +<tr><td>LogNotice</td></tr> +<tr><td>LogWarning</td></tr> </table> + <h3>Class Methods</h3> - <table> - <tr> <td><a href="#MqttClient.defaultConnectionOptions">defaultConnectionOptions</a></td> <td>Class method to get a connection options dictionary with default values.</td> </tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttClient.__init__">MqttClient</a></td> <td>Constructor</td> @@ -273,20 +275,21 @@ <td>Public method to unsubscribe topics.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttClient.defaultConnectionOptions" ID="MqttClient.defaultConnectionOptions"></a> <h4>MqttClient.defaultConnectionOptions (class method)</h4> <b>defaultConnectionOptions</b>(<i></i>) - <p> Class method to get a connection options dictionary with default values. </p> + <dl> <dt>Return:</dt> <dd> @@ -306,10 +309,10 @@ <a NAME="MqttClient.__init__" ID="MqttClient.__init__"></a> <h4>MqttClient (Constructor)</h4> <b>MqttClient</b>(<i>clientId="", cleanSession=True, userdata=None, protocol=mqtt.MQTTv311, transport="tcp", parent=None, </i>) - <p> Constructor </p> + <dl> <dt><i>clientId</i> (str)</dt> @@ -340,17 +343,17 @@ <a NAME="MqttClient.__connectTimeout" ID="MqttClient.__connectTimeout"></a> <h4>MqttClient.__connectTimeout</h4> <b>__connectTimeout</b>(<i></i>) - <p> Private slot handling a failed connection attempt. </p> + <a NAME="MqttClient.__createPropertiesObject" ID="MqttClient.__createPropertiesObject"></a> <h4>MqttClient.__createPropertiesObject</h4> <b>__createPropertiesObject</b>(<i>packetType, properties</i>) - <p> Private method to assemble the MQTT v5 properties object. </p> + <dl> <dt><i>packetType</i> (PacketTypes (= int))</dt> @@ -377,10 +380,10 @@ <a NAME="MqttClient.__initCallbacks" ID="MqttClient.__initCallbacks"></a> <h4>MqttClient.__initCallbacks</h4> <b>__initCallbacks</b>(<i>protocol</i>) - <p> Private method to initialize the MQTT callback methods. </p> + <dl> <dt><i>protocol</i> (MqttProtocols)</dt> @@ -391,10 +394,10 @@ <a NAME="MqttClient.__onConnectV3" ID="MqttClient.__onConnectV3"></a> <h4>MqttClient.__onConnectV3</h4> <b>__onConnectV3</b>(<i>client, userdata, flags, rc, properties=None, </i>) - <p> Private method to handle the connect to the broker (MQTT v3.1 and v3.1.1). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -421,10 +424,10 @@ <a NAME="MqttClient.__onConnectV5" ID="MqttClient.__onConnectV5"></a> <h4>MqttClient.__onConnectV5</h4> <b>__onConnectV5</b>(<i>client, userdata, flags, rc, properties=None, </i>) - <p> Private method to handle the connect to the broker (MQTT v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -451,10 +454,10 @@ <a NAME="MqttClient.__onDisconnectedV3" ID="MqttClient.__onDisconnectedV3"></a> <h4>MqttClient.__onDisconnectedV3</h4> <b>__onDisconnectedV3</b>(<i>client, userdata, rc, </i>) - <p> Private method to handle the disconnect from the broker (MQTT v3.1 and v3.1.1). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -473,10 +476,10 @@ <a NAME="MqttClient.__onDisconnectedV5" ID="MqttClient.__onDisconnectedV5"></a> <h4>MqttClient.__onDisconnectedV5</h4> <b>__onDisconnectedV5</b>(<i>client, userdata, rc, properties=None, </i>) - <p> Private method to handle the disconnect from the broker (MQTT v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -499,10 +502,10 @@ <a NAME="MqttClient.__onLog" ID="MqttClient.__onLog"></a> <h4>MqttClient.__onLog</h4> <b>__onLog</b>(<i>client, userdata, level, buf, </i>) - <p> Private method to handle a log event (MQTT v3.1, v3.1.1 and v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -525,11 +528,11 @@ <a NAME="MqttClient.__onMessageV3" ID="MqttClient.__onMessageV3"></a> <h4>MqttClient.__onMessageV3</h4> <b>__onMessageV3</b>(<i>client, userdata, message, </i>) - <p> Private method to handle a new message received from the broker (MQTT v3.1 and v3.1.1). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -548,10 +551,10 @@ <a NAME="MqttClient.__onMessageV5" ID="MqttClient.__onMessageV5"></a> <h4>MqttClient.__onMessageV5</h4> <b>__onMessageV5</b>(<i>client, userdata, message, </i>) - <p> Private method to handle a new message received from the broker (MQTT v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -570,11 +573,11 @@ <a NAME="MqttClient.__onPublish" ID="MqttClient.__onPublish"></a> <h4>MqttClient.__onPublish</h4> <b>__onPublish</b>(<i>client, userdata, mid, </i>) - <p> Private method to handle the publishing of a message (MQTT v3.1, v3.1.1 and v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -593,10 +596,10 @@ <a NAME="MqttClient.__onSubscribeV3" ID="MqttClient.__onSubscribeV3"></a> <h4>MqttClient.__onSubscribeV3</h4> <b>__onSubscribeV3</b>(<i>client, userdata, mid, grantedQos, </i>) - <p> Private method to handle a subscribe event (MQTT v3.1 and v3.1.1). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -619,10 +622,10 @@ <a NAME="MqttClient.__onSubscribeV5" ID="MqttClient.__onSubscribeV5"></a> <h4>MqttClient.__onSubscribeV5</h4> <b>__onSubscribeV5</b>(<i>client, userdata, mid, reasonCodes, properties=None, </i>) - <p> Private method to handle a subscribe event (MQTT v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -649,10 +652,10 @@ <a NAME="MqttClient.__onUnsubscribeV3" ID="MqttClient.__onUnsubscribeV3"></a> <h4>MqttClient.__onUnsubscribeV3</h4> <b>__onUnsubscribeV3</b>(<i>client, userdata, mid, </i>) - <p> Private method to handle an unsubscribe event (MQTT v3.1 and v3.1.1). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -671,10 +674,10 @@ <a NAME="MqttClient.__onUnsubscribeV5" ID="MqttClient.__onUnsubscribeV5"></a> <h4>MqttClient.__onUnsubscribeV5</h4> <b>__onUnsubscribeV5</b>(<i>client, userdata, mid, properties, reasonCodes, </i>) - <p> Private method to handle an unsubscribe event (MQTT v5.0). </p> + <dl> <dt><i>client</i> (paho.mqtt.Client)</dt> @@ -701,18 +704,18 @@ <a NAME="MqttClient.clearLastWill" ID="MqttClient.clearLastWill"></a> <h4>MqttClient.clearLastWill</h4> <b>clearLastWill</b>(<i></i>) - <p> Public method to remove a will that was previously configured with setLastWill(). </p> + <a NAME="MqttClient.connectToServer" ID="MqttClient.connectToServer"></a> <h4>MqttClient.connectToServer</h4> <b>connectToServer</b>(<i>host, port=1883, keepalive=60, bindAddress="", properties=None, clearWill=False, </i>) - <p> Public method to connect to a remote MQTT broker. </p> + <dl> <dt><i>host</i> (str)</dt> @@ -747,10 +750,10 @@ <a NAME="MqttClient.connectToServerWithOptions" ID="MqttClient.connectToServerWithOptions"></a> <h4>MqttClient.connectToServerWithOptions</h4> <b>connectToServerWithOptions</b>(<i>host, port=1883, bindAddress="", options=None, clearWill=False</i>) - <p> Public method to connect to a remote MQTT broker. </p> + <dl> <dt><i>host</i> (str)</dt> @@ -784,17 +787,17 @@ <a NAME="MqttClient.disconnectFromServer" ID="MqttClient.disconnectFromServer"></a> <h4>MqttClient.disconnectFromServer</h4> <b>disconnectFromServer</b>(<i></i>) - <p> Public method to disconnect the client from the remote broker. </p> + <a NAME="MqttClient.getProtocol" ID="MqttClient.getProtocol"></a> <h4>MqttClient.getProtocol</h4> <b>getProtocol</b>(<i></i>) - <p> Public method to get the MQTT protocol version. </p> + <dl> <dt>Return:</dt> <dd> @@ -810,10 +813,10 @@ <a NAME="MqttClient.publish" ID="MqttClient.publish"></a> <h4>MqttClient.publish</h4> <b>publish</b>(<i>topic, payload=None, qos=0, retain=False, properties=None</i>) - <p> Public method to publish to a topic. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -854,17 +857,17 @@ <a NAME="MqttClient.reconnectToServer" ID="MqttClient.reconnectToServer"></a> <h4>MqttClient.reconnectToServer</h4> <b>reconnectToServer</b>(<i></i>) - <p> Public method to reconnect the client with the same parameters. </p> + <a NAME="MqttClient.setConnectionTimeout" ID="MqttClient.setConnectionTimeout"></a> <h4>MqttClient.setConnectionTimeout</h4> <b>setConnectionTimeout</b>(<i>timeout</i>) - <p> Public method to set the connection timeout value. </p> + <dl> <dt><i>timeout</i> (int)</dt> @@ -875,10 +878,10 @@ <a NAME="MqttClient.setLastWill" ID="MqttClient.setLastWill"></a> <h4>MqttClient.setLastWill</h4> <b>setLastWill</b>(<i>topic, payload=None, qos=0, retain=False, properties=None</i>) - <p> Public method to set the last will of the client. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -907,11 +910,11 @@ <a NAME="MqttClient.setMaxInflightMessages" ID="MqttClient.setMaxInflightMessages"></a> <h4>MqttClient.setMaxInflightMessages</h4> <b>setMaxInflightMessages</b>(<i>inflight=20</i>) - <p> Public method to set the maximum number of messages with QoS > 0 that can be part way through their network flow at once. </p> + <dl> <dt><i>inflight</i> (int)</dt> @@ -922,11 +925,11 @@ <a NAME="MqttClient.setMaxQueuedMessages" ID="MqttClient.setMaxQueuedMessages"></a> <h4>MqttClient.setMaxQueuedMessages</h4> <b>setMaxQueuedMessages</b>(<i>queueSize=0</i>) - <p> Public method to set the maximum number of messages with QoS > 0 that can be pending in the outgoing message queue. </p> + <dl> <dt><i>queueSize</i> (int)</dt> @@ -937,10 +940,10 @@ <a NAME="MqttClient.setTLS" ID="MqttClient.setTLS"></a> <h4>MqttClient.setTLS</h4> <b>setTLS</b>(<i>caCerts=None, certFile=None, keyFile=None</i>) - <p> Public method to enable secure connections and set the TLS parameters. </p> + <dl> <dt><i>caCerts</i> (str)</dt> @@ -972,10 +975,10 @@ <a NAME="MqttClient.setUserCredentials" ID="MqttClient.setUserCredentials"></a> <h4>MqttClient.setUserCredentials</h4> <b>setUserCredentials</b>(<i>username, password=None</i>) - <p> Public method to set the user name and optionally the password. </p> + <dl> <dt><i>username</i> (str)</dt> @@ -990,10 +993,10 @@ <a NAME="MqttClient.setUserData" ID="MqttClient.setUserData"></a> <h4>MqttClient.setUserData</h4> <b>setUserData</b>(<i>userdata</i>) - <p> Public method to set the user data. </p> + <dl> <dt><i>userdata</i> (any)</dt> @@ -1004,24 +1007,24 @@ <a NAME="MqttClient.startLoop" ID="MqttClient.startLoop"></a> <h4>MqttClient.startLoop</h4> <b>startLoop</b>(<i></i>) - <p> Public method to start the MQTT client loop. </p> + <a NAME="MqttClient.stopLoop" ID="MqttClient.stopLoop"></a> <h4>MqttClient.stopLoop</h4> <b>stopLoop</b>(<i></i>) - <p> Public method to stop the MQTT client loop. </p> + <a NAME="MqttClient.subscribe" ID="MqttClient.subscribe"></a> <h4>MqttClient.subscribe</h4> <b>subscribe</b>(<i>topic, qos=0, properties=None</i>) - <p> Public method to subscribe to topics with quality of service. </p> + <dl> <dt><i>topic</i> (str or tuple of (str, int) or list of tuple of (str, int))</dt> @@ -1054,10 +1057,10 @@ <a NAME="MqttClient.unsubscribe" ID="MqttClient.unsubscribe"></a> <h4>MqttClient.unsubscribe</h4> <b>unsubscribe</b>(<i>topic, properties=None</i>) - <p> Public method to unsubscribe topics. </p> + <dl> <dt><i>topic</i> (str or list of str)</dt> @@ -1088,10 +1091,10 @@ <a NAME="mqttConnackMessage" ID="mqttConnackMessage"></a> <h2>mqttConnackMessage</h2> <b>mqttConnackMessage</b>(<i>connackCode</i>) - <p> Module function to get the string associated with a CONNACK result. </p> + <dl> <dt><i>connackCode</i> (int)</dt> @@ -1117,11 +1120,11 @@ <a NAME="mqttErrorMessage" ID="mqttErrorMessage"></a> <h2>mqttErrorMessage</h2> <b>mqttErrorMessage</b>(<i>mqttErrno</i>) - <p> Module function to get the error string associated with an MQTT error number. </p> + <dl> <dt><i>mqttErrno</i> (int)</dt> @@ -1147,10 +1150,10 @@ <a NAME="mqttLogLevelString" ID="mqttLogLevelString"></a> <h2>mqttLogLevelString</h2> <b>mqttLogLevelString</b>(<i>mqttLogLevel, isMqttLogLevel=True</i>) - <p> Module function to get the log level string associated with a log level. </p> + <dl> <dt><i>mqttLogLevel</i> (int)</dt> @@ -1177,4 +1180,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,53 +7,50 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1> - <p> Module implementing a dialog to enter MQTT connection options. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td> <td>Class implementing a dialog to enter MQTT connection options.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a> <h2>MqttConnectionOptionsDialog</h2> - <p> Class implementing a dialog to enter MQTT connection options. </p> + <h3>Derived from</h3> QDialog, Ui_MqttConnectionOptionsDialog <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td> <td>Constructor</td> @@ -103,19 +100,20 @@ <td>Private slot to edit the last will user properties.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> <h4>MqttConnectionOptionsDialog (Constructor)</h4> <b>MqttConnectionOptionsDialog</b>(<i>options=None, parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>options</i> (dict)</dt> @@ -135,7 +133,6 @@ <a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> <h4>MqttConnectionOptionsDialog.__populateDefaults</h4> <b>__populateDefaults</b>(<i>options=None</i>) - <p> Private method to populate the dialog. </p> @@ -143,6 +140,7 @@ If no options dictionary is given, the dialog will be populated with default values. </p> + <dl> <dt><i>options</i> (dict)</dt> @@ -157,10 +155,10 @@ <a NAME="MqttConnectionOptionsDialog.__propertiesTypeSelected" ID="MqttConnectionOptionsDialog.__propertiesTypeSelected"></a> <h4>MqttConnectionOptionsDialog.__propertiesTypeSelected</h4> <b>__propertiesTypeSelected</b>(<i>checked</i>) - <p> Private slot to handle the switching of the user properties type. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -171,17 +169,17 @@ <a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> <b>__updateOkButton</b>(<i></i>) - <p> Private method to update the enabled state of the OK button. </p> + <a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> <b>getConnectionOptions</b>(<i></i>) - <p> Public method get the entered connection options. </p> + <dl> <dt>Return:</dt> <dd> @@ -201,10 +199,10 @@ <a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> <h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) - <p> Private slot to handle the press of a button box button. </p> + <dl> <dt><i>button</i> (QAbstractButton)</dt> @@ -215,10 +213,10 @@ <a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> <h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) - <p> Private slot to handle a change of the clean session selection. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -229,10 +227,10 @@ <a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> <h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) - <p> Private slot handling a change of the client ID string. </p> + <dl> <dt><i>clientId</i> (str)</dt> @@ -243,17 +241,17 @@ <a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> <b>on_generateIdButton_clicked</b>(<i></i>) - <p> Private slot to generate a client ID. </p> + <a NAME="MqttConnectionOptionsDialog.on_mqttv5Button_toggled" ID="MqttConnectionOptionsDialog.on_mqttv5Button_toggled"></a> <h4>MqttConnectionOptionsDialog.on_mqttv5Button_toggled</h4> <b>on_mqttv5Button_toggled</b>(<i>checked</i>) - <p> Private slot to handle the selection of the MQTT protocol. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -264,10 +262,10 @@ <a NAME="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled"></a> <h4>MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled</h4> <b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>) - <p> Private slot to handle a change of the properties usage. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -279,10 +277,10 @@ <a NAME="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked" ID="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked"></a> <h4>MqttConnectionOptionsDialog.on_willPropertiesButton_clicked</h4> <b>on_willPropertiesButton_clicked</b>(<i></i>) - <p> Private slot to edit the last will user properties. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,53 +7,50 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog</h1> - <p> Module implementing a dialog to edit the MQTT connection profiles. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttConnectionProfilesDialog">MqttConnectionProfilesDialog</a></td> <td>Class implementing a dialog to edit the MQTT connection profiles.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="MqttConnectionProfilesDialog" ID="MqttConnectionProfilesDialog"></a> <h2>MqttConnectionProfilesDialog</h2> - <p> Class implementing a dialog to edit the MQTT connection profiles. </p> + <h3>Derived from</h3> QDialog, Ui_MqttConnectionProfilesDialog <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttConnectionProfilesDialog.__init__">MqttConnectionProfilesDialog</a></td> <td>Constructor</td> @@ -199,19 +196,20 @@ <td>Public slot to reject the dialog changes.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttConnectionProfilesDialog.__init__" ID="MqttConnectionProfilesDialog.__init__"></a> <h4>MqttConnectionProfilesDialog (Constructor)</h4> <b>MqttConnectionProfilesDialog</b>(<i>profiles, currentProfile="", parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>profiles</i> (dict)</dt> @@ -236,10 +234,10 @@ <a NAME="MqttConnectionProfilesDialog.__applyProfile" ID="MqttConnectionProfilesDialog.__applyProfile"></a> <h4>MqttConnectionProfilesDialog.__applyProfile</h4> <b>__applyProfile</b>(<i></i>) - <p> Private method to apply the entered data to the list of profiles. </p> + <dl> <dt>Return:</dt> <dd> @@ -255,17 +253,17 @@ <a NAME="MqttConnectionProfilesDialog.__clearProfile" ID="MqttConnectionProfilesDialog.__clearProfile"></a> <h4>MqttConnectionProfilesDialog.__clearProfile</h4> <b>__clearProfile</b>(<i></i>) - <p> Private method to clear the profile data entry fields. </p> + <a NAME="MqttConnectionProfilesDialog.__defaultProfile" ID="MqttConnectionProfilesDialog.__defaultProfile"></a> <h4>MqttConnectionProfilesDialog.__defaultProfile</h4> <b>__defaultProfile</b>(<i></i>) - <p> Private method to populate non-existing profile items. </p> + <dl> <dt>Return:</dt> <dd> @@ -281,11 +279,11 @@ <a NAME="MqttConnectionProfilesDialog.__isChangedProfile" ID="MqttConnectionProfilesDialog.__isChangedProfile"></a> <h4>MqttConnectionProfilesDialog.__isChangedProfile</h4> <b>__isChangedProfile</b>(<i></i>) - <p> Private method to check, if the currently shown profile contains some changed data. </p> + <dl> <dt>Return:</dt> <dd> @@ -301,10 +299,10 @@ <a NAME="MqttConnectionProfilesDialog.__populateProfile" ID="MqttConnectionProfilesDialog.__populateProfile"></a> <h4>MqttConnectionProfilesDialog.__populateProfile</h4> <b>__populateProfile</b>(<i>profileName</i>) - <p> Private method to populate the profile data entry fields. </p> + <dl> <dt><i>profileName</i> (str)</dt> @@ -315,18 +313,18 @@ <a NAME="MqttConnectionProfilesDialog.__populateProfileDefault" ID="MqttConnectionProfilesDialog.__populateProfileDefault"></a> <h4>MqttConnectionProfilesDialog.__populateProfileDefault</h4> <b>__populateProfileDefault</b>(<i></i>) - <p> Private method to populate the profile data entry fields with default profile values. </p> + <a NAME="MqttConnectionProfilesDialog.__populateProfilesList" ID="MqttConnectionProfilesDialog.__populateProfilesList"></a> <h4>MqttConnectionProfilesDialog.__populateProfilesList</h4> <b>__populateProfilesList</b>(<i>currentProfile=""</i>) - <p> Private method to populate the list of defined profiles. </p> + <dl> <dt><i>currentProfile</i> (str)</dt> @@ -337,10 +335,10 @@ <a NAME="MqttConnectionProfilesDialog.__propertiesTypeSelected" ID="MqttConnectionProfilesDialog.__propertiesTypeSelected"></a> <h4>MqttConnectionProfilesDialog.__propertiesTypeSelected</h4> <b>__propertiesTypeSelected</b>(<i>checked</i>) - <p> Private slot to handle the switching of the user properties type. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -351,32 +349,32 @@ <a NAME="MqttConnectionProfilesDialog.__resetProfile" ID="MqttConnectionProfilesDialog.__resetProfile"></a> <h4>MqttConnectionProfilesDialog.__resetProfile</h4> <b>__resetProfile</b>(<i></i>) - <p> Private method to reset the profile data entry fields to their stored values. </p> + <a NAME="MqttConnectionProfilesDialog.__updateApplyButton" ID="MqttConnectionProfilesDialog.__updateApplyButton"></a> <h4>MqttConnectionProfilesDialog.__updateApplyButton</h4> <b>__updateApplyButton</b>(<i></i>) - <p> Private method to set the state of the Apply button. </p> + <a NAME="MqttConnectionProfilesDialog.accept" ID="MqttConnectionProfilesDialog.accept"></a> <h4>MqttConnectionProfilesDialog.accept</h4> <b>accept</b>(<i></i>) - <p> Public slot to accept the dialog. </p> + <a NAME="MqttConnectionProfilesDialog.getProfiles" ID="MqttConnectionProfilesDialog.getProfiles"></a> <h4>MqttConnectionProfilesDialog.getProfiles</h4> <b>getProfiles</b>(<i></i>) - <p> Public method to return a dictionary of profiles. </p> + <dl> <dt>Return:</dt> <dd> @@ -398,10 +396,10 @@ <a NAME="MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged" ID="MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged</h4> <b>on_brokerAddressEdit_textChanged</b>(<i>address</i>) - <p> Private slot handling a change of the broker address. </p> + <dl> <dt><i>address</i> (str)</dt> @@ -412,10 +410,10 @@ <a NAME="MqttConnectionProfilesDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionProfilesDialog.on_cleanSessionCheckBox_clicked"></a> <h4>MqttConnectionProfilesDialog.on_cleanSessionCheckBox_clicked</h4> <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) - <p> Private slot to handle a change of the clean session selection. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -426,10 +424,10 @@ <a NAME="MqttConnectionProfilesDialog.on_clientIdEdit_textChanged" ID="MqttConnectionProfilesDialog.on_clientIdEdit_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_clientIdEdit_textChanged</h4> <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) - <p> Private slot handling a change of the client ID string. </p> + <dl> <dt><i>clientId</i> (str)</dt> @@ -440,31 +438,31 @@ <a NAME="MqttConnectionProfilesDialog.on_copyButton_clicked" ID="MqttConnectionProfilesDialog.on_copyButton_clicked"></a> <h4>MqttConnectionProfilesDialog.on_copyButton_clicked</h4> <b>on_copyButton_clicked</b>(<i></i>) - <p> Private slot to copy the selected profile entry. </p> + <a NAME="MqttConnectionProfilesDialog.on_generateIdButton_clicked" ID="MqttConnectionProfilesDialog.on_generateIdButton_clicked"></a> <h4>MqttConnectionProfilesDialog.on_generateIdButton_clicked</h4> <b>on_generateIdButton_clicked</b>(<i></i>) - <p> Private slot to generate a client ID. </p> + <a NAME="MqttConnectionProfilesDialog.on_minusButton_clicked" ID="MqttConnectionProfilesDialog.on_minusButton_clicked"></a> <h4>MqttConnectionProfilesDialog.on_minusButton_clicked</h4> <b>on_minusButton_clicked</b>(<i></i>) - <p> Private slot to delete the selected entry. </p> + <a NAME="MqttConnectionProfilesDialog.on_mqttv5Button_toggled" ID="MqttConnectionProfilesDialog.on_mqttv5Button_toggled"></a> <h4>MqttConnectionProfilesDialog.on_mqttv5Button_toggled</h4> <b>on_mqttv5Button_toggled</b>(<i>checked</i>) - <p> Private slot to handle the selection of the MQTT protocol. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -475,17 +473,17 @@ <a NAME="MqttConnectionProfilesDialog.on_plusButton_clicked" ID="MqttConnectionProfilesDialog.on_plusButton_clicked"></a> <h4>MqttConnectionProfilesDialog.on_plusButton_clicked</h4> <b>on_plusButton_clicked</b>(<i></i>) - <p> Private slot to add a new empty profile entry. </p> + <a NAME="MqttConnectionProfilesDialog.on_profileButtonBox_clicked" ID="MqttConnectionProfilesDialog.on_profileButtonBox_clicked"></a> <h4>MqttConnectionProfilesDialog.on_profileButtonBox_clicked</h4> <b>on_profileButtonBox_clicked</b>(<i>button</i>) - <p> Private slot handling presses of the profile buttons. </p> + <dl> <dt><i>button</i> (QAbstractButton)</dt> @@ -496,10 +494,10 @@ <a NAME="MqttConnectionProfilesDialog.on_profileEdit_textChanged" ID="MqttConnectionProfilesDialog.on_profileEdit_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_profileEdit_textChanged</h4> <b>on_profileEdit_textChanged</b>(<i>name</i>) - <p> Private slot to handle changes of the profile name. </p> + <dl> <dt><i>name</i> (str)</dt> @@ -510,10 +508,10 @@ <a NAME="MqttConnectionProfilesDialog.on_profilesList_currentItemChanged" ID="MqttConnectionProfilesDialog.on_profilesList_currentItemChanged"></a> <h4>MqttConnectionProfilesDialog.on_profilesList_currentItemChanged</h4> <b>on_profilesList_currentItemChanged</b>(<i>current, previous</i>) - <p> Private slot to handle a change of the current profile. </p> + <dl> <dt><i>current</i> (QListWidgetItem)</dt> @@ -528,10 +526,10 @@ <a NAME="MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled"></a> <h4>MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled</h4> <b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>) - <p> Private slot to handle a change of the properties usage. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -543,10 +541,10 @@ <a NAME="MqttConnectionProfilesDialog.on_showPasswordButton_toggled" ID="MqttConnectionProfilesDialog.on_showPasswordButton_toggled"></a> <h4>MqttConnectionProfilesDialog.on_showPasswordButton_toggled</h4> <b>on_showPasswordButton_toggled</b>(<i>checked</i>) - <p> Private slot to show or hide the password. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -557,11 +555,11 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled" ID="MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled"></a> <h4>MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled</h4> <b>on_tlsCertsFileButton_toggled</b>(<i>checked</i>) - <p> Private slot handling the selection of using a non-default certificates file. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -572,10 +570,10 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged</h4> <b>on_tlsCertsFilePicker_textChanged</b>(<i>path</i>) - <p> Private slot handling a change of the TLS CA certificates file. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -586,11 +584,11 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled" ID="MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled"></a> <h4>MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled</h4> <b>on_tlsDefaultCertsButton_toggled</b>(<i>checked</i>) - <p> Private slot handling the selection of using the default certificates file. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -601,10 +599,10 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsGroupBox_toggled" ID="MqttConnectionProfilesDialog.on_tlsGroupBox_toggled"></a> <h4>MqttConnectionProfilesDialog.on_tlsGroupBox_toggled</h4> <b>on_tlsGroupBox_toggled</b>(<i>checked</i>) - <p> Private slot handling the selection of TLS mode. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -615,11 +613,11 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled"></a> <h4>MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled</h4> <b>on_tlsSelfSignedCertsButton_toggled</b>(<i>checked</i>) - <p> Private slot handling the selection of using self signed client certificate and key files. </p> + <dl> <dt><i>checked</i> (bool)</dt> @@ -630,10 +628,10 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged</h4> <b>on_tlsSelfSignedCertsFilePicker_textChanged</b>(<i>path</i>) - <p> Private slot handling a change of the TLS CA certificates file. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -644,10 +642,10 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged</h4> <b>on_tlsSelfSignedClientCertFilePicker_textChanged</b>(<i>path</i>) - <p> Private slot handling a change of the TLS client certificate file. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -658,10 +656,10 @@ <a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged"></a> <h4>MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged</h4> <b>on_tlsSelfSignedClientKeyFilePicker_textChanged</b>(<i>path</i>) - <p> Private slot handling a change of the TLS client key file. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -672,17 +670,17 @@ <a NAME="MqttConnectionProfilesDialog.on_willPropertiesButton_clicked" ID="MqttConnectionProfilesDialog.on_willPropertiesButton_clicked"></a> <h4>MqttConnectionProfilesDialog.on_willPropertiesButton_clicked</h4> <b>on_willPropertiesButton_clicked</b>(<i></i>) - <p> Private slot to edit the last will user properties. </p> + <a NAME="MqttConnectionProfilesDialog.reject" ID="MqttConnectionProfilesDialog.reject"></a> <h4>MqttConnectionProfilesDialog.reject</h4> <b>reject</b>(<i></i>) - <p> Public slot to reject the dialog changes. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,53 +7,52 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget</h1> - <p> Module implementing the MQTT Monitor widget. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttMonitorWidget">MqttMonitorWidget</a></td> <td>Class implementing the MQTT Monitor widget.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="MqttMonitorWidget" ID="MqttMonitorWidget"></a> <h2>MqttMonitorWidget</h2> - <p> Class implementing the MQTT Monitor widget. </p> + <h3>Derived from</h3> QWidget, Ui_MqttMonitorWidget <h3>Class Attributes</h3> +<table> +<tr><td>BrokerStatusTopic</td></tr> +<tr><td>BrokerStatusTopicLoadPrefix</td></tr> +<tr><td>BrokerStatusTopicPrefix</td></tr> +</table> -<table> -<tr><td>BrokerStatusTopic</td></tr><tr><td>BrokerStatusTopicLoadPrefix</td></tr><tr><td>BrokerStatusTopicPrefix</td></tr> -</table> <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttMonitorWidget.__init__">MqttMonitorWidget</a></td> <td>Constructor</td> @@ -299,19 +298,20 @@ <td>Private slot to handle the selection of a topic to unsubscribe from.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttMonitorWidget.__init__" ID="MqttMonitorWidget.__init__"></a> <h4>MqttMonitorWidget (Constructor)</h4> <b>MqttMonitorWidget</b>(<i>plugin, usesDarkPalette, parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>plugin</i> (MqttMonitorPlugin)</dt> @@ -331,11 +331,11 @@ <a NAME="MqttMonitorWidget.__addBrokerToRecent" ID="MqttMonitorWidget.__addBrokerToRecent"></a> <h4>MqttMonitorWidget.__addBrokerToRecent</h4> <b>__addBrokerToRecent</b>(<i>host, port</i>) - <p> Private method to add a host name to the list of recently connected brokers. </p> + <dl> <dt><i>host</i> (str)</dt> @@ -350,11 +350,11 @@ <a NAME="MqttMonitorWidget.__addTopicToRecent" ID="MqttMonitorWidget.__addTopicToRecent"></a> <h4>MqttMonitorWidget.__addTopicToRecent</h4> <b>__addTopicToRecent</b>(<i>topic</i>) - <p> Private method to add a topic to the list of recently subscribed topics. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -365,10 +365,10 @@ <a NAME="MqttMonitorWidget.__appendMessage" ID="MqttMonitorWidget.__appendMessage"></a> <h4>MqttMonitorWidget.__appendMessage</h4> <b>__appendMessage</b>(<i>topic, payload, qos, retain, properties=None</i>) - <p> Private method to append a received message to the output. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -395,10 +395,10 @@ <a NAME="MqttMonitorWidget.__brokerConnected" ID="MqttMonitorWidget.__brokerConnected"></a> <h4>MqttMonitorWidget.__brokerConnected</h4> <b>__brokerConnected</b>(<i>flags, rc, packetType=None, properties=None</i>) - <p> Private slot to handle being connected to a broker. </p> + <dl> <dt><i>flags</i> (dict)</dt> @@ -422,10 +422,10 @@ <a NAME="MqttMonitorWidget.__brokerDisconnected" ID="MqttMonitorWidget.__brokerDisconnected"></a> <h4>MqttMonitorWidget.__brokerDisconnected</h4> <b>__brokerDisconnected</b>(<i>rc, packetType=None</i>) - <p> Private slot to handle a disconnection from the broker. </p> + <dl> <dt><i>rc</i> (int)</dt> @@ -440,17 +440,17 @@ <a NAME="MqttMonitorWidget.__clearBrokerStatusLabels" ID="MqttMonitorWidget.__clearBrokerStatusLabels"></a> <h4>MqttMonitorWidget.__clearBrokerStatusLabels</h4> <b>__clearBrokerStatusLabels</b>(<i></i>) - <p> Private method to clear the broker status labels. </p> + <a NAME="MqttMonitorWidget.__clientLog" ID="MqttMonitorWidget.__clientLog"></a> <h4>MqttMonitorWidget.__clientLog</h4> <b>__clientLog</b>(<i>level, message</i>) - <p> Private slot to handle the receipt of a log message. </p> + <dl> <dt><i>level</i> (int)</dt> @@ -465,17 +465,17 @@ <a NAME="MqttMonitorWidget.__connectTimeout" ID="MqttMonitorWidget.__connectTimeout"></a> <h4>MqttMonitorWidget.__connectTimeout</h4> <b>__connectTimeout</b>(<i></i>) - <p> Private slot handling a timeout during a connection attempt. </p> + <a NAME="MqttMonitorWidget.__createClient" ID="MqttMonitorWidget.__createClient"></a> <h4>MqttMonitorWidget.__createClient</h4> <b>__createClient</b>(<i>clientId="", cleanSession=None, protocol=None</i>) - <p> Private method to instantiate a MQTT client for a given protocol. </p> + <dl> <dt><i>clientId</i> (str)</dt> @@ -506,17 +506,17 @@ <a NAME="MqttMonitorWidget.__directConnectToBroker" ID="MqttMonitorWidget.__directConnectToBroker"></a> <h4>MqttMonitorWidget.__directConnectToBroker</h4> <b>__directConnectToBroker</b>(<i></i>) - <p> Private method to connect to the broker with entered data. </p> + <a NAME="MqttMonitorWidget.__editProperties" ID="MqttMonitorWidget.__editProperties"></a> <h4>MqttMonitorWidget.__editProperties</h4> <b>__editProperties</b>(<i>propertiesType, header, key</i>) - <p> Private method to edit user properties of a given type. </p> + <dl> <dt><i>propertiesType</i> (str)</dt> @@ -536,11 +536,11 @@ <a NAME="MqttMonitorWidget.__flashBrokerStatusLabel" ID="MqttMonitorWidget.__flashBrokerStatusLabel"></a> <h4>MqttMonitorWidget.__flashBrokerStatusLabel</h4> <b>__flashBrokerStatusLabel</b>(<i>message</i>) - <p> Private slot to show the broker status label with some text for 5 seconds. </p> + <dl> <dt><i>message</i> (str)</dt> @@ -551,10 +551,10 @@ <a NAME="MqttMonitorWidget.__formatBrokerStatusValue" ID="MqttMonitorWidget.__formatBrokerStatusValue"></a> <h4>MqttMonitorWidget.__formatBrokerStatusValue</h4> <b>__formatBrokerStatusValue</b>(<i>topic, value</i>) - <p> Private method to format the value reported for a topic. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -581,10 +581,10 @@ <a NAME="MqttMonitorWidget.__formatData" ID="MqttMonitorWidget.__formatData"></a> <h4>MqttMonitorWidget.__formatData</h4> <b>__formatData</b>(<i>valStr</i>) - <p> Private method to format the uptime string. </p> + <dl> <dt><i>valStr</i> (str)</dt> @@ -607,10 +607,10 @@ <a NAME="MqttMonitorWidget.__formatFloat" ID="MqttMonitorWidget.__formatFloat"></a> <h4>MqttMonitorWidget.__formatFloat</h4> <b>__formatFloat</b>(<i>valStr</i>) - <p> Private method to format the uptime string. </p> + <dl> <dt><i>valStr</i> (str)</dt> @@ -633,10 +633,10 @@ <a NAME="MqttMonitorWidget.__formatInt" ID="MqttMonitorWidget.__formatInt"></a> <h4>MqttMonitorWidget.__formatInt</h4> <b>__formatInt</b>(<i>valStr</i>) - <p> Private method to format the uptime string. </p> + <dl> <dt><i>valStr</i> (str)</dt> @@ -659,10 +659,10 @@ <a NAME="MqttMonitorWidget.__formatUptime" ID="MqttMonitorWidget.__formatUptime"></a> <h4>MqttMonitorWidget.__formatUptime</h4> <b>__formatUptime</b>(<i>valStr</i>) - <p> Private method to format the uptime string. </p> + <dl> <dt><i>valStr</i> (str)</dt> @@ -685,10 +685,10 @@ <a NAME="MqttMonitorWidget.__handleBrokerLoadStatusMessage" ID="MqttMonitorWidget.__handleBrokerLoadStatusMessage"></a> <h4>MqttMonitorWidget.__handleBrokerLoadStatusMessage</h4> <b>__handleBrokerLoadStatusMessage</b>(<i>topic, payloadStr</i>) - <p> Private method to append a received message to the output. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -704,10 +704,10 @@ <a NAME="MqttMonitorWidget.__handleBrokerStatusMessage" ID="MqttMonitorWidget.__handleBrokerStatusMessage"></a> <h4>MqttMonitorWidget.__handleBrokerStatusMessage</h4> <b>__handleBrokerStatusMessage</b>(<i>topic, payload</i>) - <p> Private method to handle a status message of the broker. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -722,17 +722,17 @@ <a NAME="MqttMonitorWidget.__initPropertiesEditMenu" ID="MqttMonitorWidget.__initPropertiesEditMenu"></a> <h4>MqttMonitorWidget.__initPropertiesEditMenu</h4> <b>__initPropertiesEditMenu</b>(<i></i>) - <p> Private method to create the properties output context menu. </p> + <a NAME="MqttMonitorWidget.__loadDefaultDictFactory" ID="MqttMonitorWidget.__loadDefaultDictFactory"></a> <h4>MqttMonitorWidget.__loadDefaultDictFactory</h4> <b>__loadDefaultDictFactory</b>(<i></i>) - <p> Private method to populate non-existing load items. </p> + <dl> <dt>Return:</dt> <dd> @@ -748,10 +748,10 @@ <a NAME="MqttMonitorWidget.__messagePublished" ID="MqttMonitorWidget.__messagePublished"></a> <h4>MqttMonitorWidget.__messagePublished</h4> <b>__messagePublished</b>(<i>mid</i>) - <p> Private slot to handle a message being published. </p> + <dl> <dt><i>mid</i> (int)</dt> @@ -762,10 +762,10 @@ <a NAME="MqttMonitorWidget.__messageReceived" ID="MqttMonitorWidget.__messageReceived"></a> <h4>MqttMonitorWidget.__messageReceived</h4> <b>__messageReceived</b>(<i>topic, payload, qos, retain, properties=None</i>) - <p> Private slot to handle the receipt of a message. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -792,39 +792,39 @@ <a NAME="MqttMonitorWidget.__populateBrokerComboBoxes" ID="MqttMonitorWidget.__populateBrokerComboBoxes"></a> <h4>MqttMonitorWidget.__populateBrokerComboBoxes</h4> <b>__populateBrokerComboBoxes</b>(<i></i>) - <p> Private method to populate the broker name and port combo boxes. </p> + <a NAME="MqttMonitorWidget.__populateProfileComboBox" ID="MqttMonitorWidget.__populateProfileComboBox"></a> <h4>MqttMonitorWidget.__populateProfileComboBox</h4> <b>__populateProfileComboBox</b>(<i></i>) - <p> Private method to populate the profiles selection box. </p> + <a NAME="MqttMonitorWidget.__populateSubscribeTopicComboBox" ID="MqttMonitorWidget.__populateSubscribeTopicComboBox"></a> <h4>MqttMonitorWidget.__populateSubscribeTopicComboBox</h4> <b>__populateSubscribeTopicComboBox</b>(<i></i>) - <p> Private method to populate the subscribe topic combo box. </p> + <a NAME="MqttMonitorWidget.__profileConnectToBroker" ID="MqttMonitorWidget.__profileConnectToBroker"></a> <h4>MqttMonitorWidget.__profileConnectToBroker</h4> <b>__profileConnectToBroker</b>(<i></i>) - <p> Private method to connect to the broker with selected profile. </p> + <a NAME="MqttMonitorWidget.__setBrokerStatusSubscribed" ID="MqttMonitorWidget.__setBrokerStatusSubscribed"></a> <h4>MqttMonitorWidget.__setBrokerStatusSubscribed</h4> <b>__setBrokerStatusSubscribed</b>(<i>subscribed</i>) - <p> Private method to set the subscription status for the broker status topics. </p> + <dl> <dt><i>subscribed</i> (bool)</dt> @@ -835,17 +835,17 @@ <a NAME="MqttMonitorWidget.__setConnectButtonState" ID="MqttMonitorWidget.__setConnectButtonState"></a> <h4>MqttMonitorWidget.__setConnectButtonState</h4> <b>__setConnectButtonState</b>(<i></i>) - <p> Private method to set the enabled state of the connect button. </p> + <a NAME="MqttMonitorWidget.__setConnectionMode" ID="MqttMonitorWidget.__setConnectionMode"></a> <h4>MqttMonitorWidget.__setConnectionMode</h4> <b>__setConnectionMode</b>(<i>profileMode</i>) - <p> Private method to set the connection mode. </p> + <dl> <dt><i>profileMode</i> (bool)</dt> @@ -856,11 +856,11 @@ <a NAME="MqttMonitorWidget.__showProperties" ID="MqttMonitorWidget.__showProperties"></a> <h4>MqttMonitorWidget.__showProperties</h4> <b>__showProperties</b>(<i>typeStr, properties</i>) - <p> Private method to display the received properties in the properties pane. </p> + <dl> <dt><i>typeStr</i> (str)</dt> @@ -875,11 +875,11 @@ <a NAME="MqttMonitorWidget.__topicSubscribed" ID="MqttMonitorWidget.__topicSubscribed"></a> <h4>MqttMonitorWidget.__topicSubscribed</h4> <b>__topicSubscribed</b>(<i>mid</i>) - <p> Private slot to handle being subscribed to topics (MQTT v3.1, MQTT v3.1.1). </p> + <dl> <dt><i>mid</i> (int)</dt> @@ -890,10 +890,10 @@ <a NAME="MqttMonitorWidget.__topicSubscribedV5" ID="MqttMonitorWidget.__topicSubscribedV5"></a> <h4>MqttMonitorWidget.__topicSubscribedV5</h4> <b>__topicSubscribedV5</b>(<i>mid, reasonCodes, properties</i>) - <p> Private slot to handle being subscribed to topics (MQTT v5). </p> + <dl> <dt><i>mid</i> (int)</dt> @@ -913,11 +913,11 @@ <a NAME="MqttMonitorWidget.__topicUnsubscribed" ID="MqttMonitorWidget.__topicUnsubscribed"></a> <h4>MqttMonitorWidget.__topicUnsubscribed</h4> <b>__topicUnsubscribed</b>(<i>mid</i>) - <p> Private slot to handle being unsubcribed from a topic (MQTT v3.1, MQTT v3.1.1). </p> + <dl> <dt><i>mid</i> (int)</dt> @@ -928,10 +928,10 @@ <a NAME="MqttMonitorWidget.__topicUnsubscribedV5" ID="MqttMonitorWidget.__topicUnsubscribedV5"></a> <h4>MqttMonitorWidget.__topicUnsubscribedV5</h4> <b>__topicUnsubscribedV5</b>(<i>mid, rc, packetType, properties</i>) - <p> Private slot to handle being unsubscribed to topics (MQTT v5). </p> + <dl> <dt><i>mid</i> (int)</dt> @@ -955,10 +955,10 @@ <a NAME="MqttMonitorWidget.__updatePublishTopicComboBox" ID="MqttMonitorWidget.__updatePublishTopicComboBox"></a> <h4>MqttMonitorWidget.__updatePublishTopicComboBox</h4> <b>__updatePublishTopicComboBox</b>(<i>resetTopic=True</i>) - <p> Private method to update the publish topic combo box. </p> + <dl> <dt><i>resetTopic</i> (bool)</dt> @@ -969,17 +969,17 @@ <a NAME="MqttMonitorWidget.__updateUnsubscribeTopicComboBox" ID="MqttMonitorWidget.__updateUnsubscribeTopicComboBox"></a> <h4>MqttMonitorWidget.__updateUnsubscribeTopicComboBox</h4> <b>__updateUnsubscribeTopicComboBox</b>(<i></i>) - <p> Private method to update the unsubcribe topic combo box. </p> + <a NAME="MqttMonitorWidget.on_brokerComboBox_editTextChanged" ID="MqttMonitorWidget.on_brokerComboBox_editTextChanged"></a> <h4>MqttMonitorWidget.on_brokerComboBox_editTextChanged</h4> <b>on_brokerComboBox_editTextChanged</b>(<i>host</i>) - <p> Private slot to handling entering or selecting a broker host name. </p> + <dl> <dt><i>host</i> (str)</dt> @@ -990,32 +990,32 @@ <a NAME="MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked" ID="MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked"></a> <h4>MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked</h4> <b>on_brokerConnectionOptionsButton_clicked</b>(<i></i>) - <p> Private slot to show a dialog to modify connection options or a dialog to edit connection profiles. </p> + <a NAME="MqttMonitorWidget.on_brokerStatusButton_clicked" ID="MqttMonitorWidget.on_brokerStatusButton_clicked"></a> <h4>MqttMonitorWidget.on_brokerStatusButton_clicked</h4> <b>on_brokerStatusButton_clicked</b>(<i></i>) - <p> Private slot to subscribe or unsubscribe the broker status topic. </p> + <a NAME="MqttMonitorWidget.on_connectButton_clicked" ID="MqttMonitorWidget.on_connectButton_clicked"></a> <h4>MqttMonitorWidget.on_connectButton_clicked</h4> <b>on_connectButton_clicked</b>(<i></i>) - <p> Private slot to handle a connect or disconnect request. </p> + <a NAME="MqttMonitorWidget.on_logEdit_blockCountChanged" ID="MqttMonitorWidget.on_logEdit_blockCountChanged"></a> <h4>MqttMonitorWidget.on_logEdit_blockCountChanged</h4> <b>on_logEdit_blockCountChanged</b>(<i>newBlockCount</i>) - <p> Private slot handling changes of received messages. </p> + <dl> <dt><i>newBlockCount</i> (int)</dt> @@ -1026,10 +1026,10 @@ <a NAME="MqttMonitorWidget.on_messagesEdit_blockCountChanged" ID="MqttMonitorWidget.on_messagesEdit_blockCountChanged"></a> <h4>MqttMonitorWidget.on_messagesEdit_blockCountChanged</h4> <b>on_messagesEdit_blockCountChanged</b>(<i>newBlockCount</i>) - <p> Private slot handling changes of received messages. </p> + <dl> <dt><i>newBlockCount</i> (int)</dt> @@ -1040,18 +1040,18 @@ <a NAME="MqttMonitorWidget.on_modeButton_clicked" ID="MqttMonitorWidget.on_modeButton_clicked"></a> <h4>MqttMonitorWidget.on_modeButton_clicked</h4> <b>on_modeButton_clicked</b>(<i></i>) - <p> Private slot to switch between connection profiles and direct connection mode. </p> + <a NAME="MqttMonitorWidget.on_profileComboBox_currentIndexChanged" ID="MqttMonitorWidget.on_profileComboBox_currentIndexChanged"></a> <h4>MqttMonitorWidget.on_profileComboBox_currentIndexChanged</h4> <b>on_profileComboBox_currentIndexChanged</b>(<i>profileName</i>) - <p> Private slot handling the change of the selected profile. </p> + <dl> <dt><i>profileName</i> (str)</dt> @@ -1062,10 +1062,10 @@ <a NAME="MqttMonitorWidget.on_propertiesEdit_customContextMenuRequested" ID="MqttMonitorWidget.on_propertiesEdit_customContextMenuRequested"></a> <h4>MqttMonitorWidget.on_propertiesEdit_customContextMenuRequested</h4> <b>on_propertiesEdit_customContextMenuRequested</b>(<i>pos</i>) - <p> Private slot to show the context menu for the properties output. </p> + <dl> <dt><i>pos</i> (QPoint)</dt> @@ -1076,31 +1076,31 @@ <a NAME="MqttMonitorWidget.on_publishButton_clicked" ID="MqttMonitorWidget.on_publishButton_clicked"></a> <h4>MqttMonitorWidget.on_publishButton_clicked</h4> <b>on_publishButton_clicked</b>(<i></i>) - <p> Private slot to publish the entered message. </p> + <a NAME="MqttMonitorWidget.on_publishClearButton_clicked" ID="MqttMonitorWidget.on_publishClearButton_clicked"></a> <h4>MqttMonitorWidget.on_publishClearButton_clicked</h4> <b>on_publishClearButton_clicked</b>(<i></i>) - <p> Private slot to clear the publish data fields. </p> + <a NAME="MqttMonitorWidget.on_publishClearRetainedButton_clicked" ID="MqttMonitorWidget.on_publishClearRetainedButton_clicked"></a> <h4>MqttMonitorWidget.on_publishClearRetainedButton_clicked</h4> <b>on_publishClearRetainedButton_clicked</b>(<i></i>) - <p> Private slot to clear the retained messages for the topic. </p> + <a NAME="MqttMonitorWidget.on_publishPayloadFilePicker_textChanged" ID="MqttMonitorWidget.on_publishPayloadFilePicker_textChanged"></a> <h4>MqttMonitorWidget.on_publishPayloadFilePicker_textChanged</h4> <b>on_publishPayloadFilePicker_textChanged</b>(<i>path</i>) - <p> Private slot handling a change of path of the payload file. </p> + <dl> <dt><i>path</i> (str)</dt> @@ -1111,17 +1111,17 @@ <a NAME="MqttMonitorWidget.on_publishPropertiesButton_clicked" ID="MqttMonitorWidget.on_publishPropertiesButton_clicked"></a> <h4>MqttMonitorWidget.on_publishPropertiesButton_clicked</h4> <b>on_publishPropertiesButton_clicked</b>(<i></i>) - <p> Private slot to edit the publish user properties. </p> + <a NAME="MqttMonitorWidget.on_publishTopicComboBox_editTextChanged" ID="MqttMonitorWidget.on_publishTopicComboBox_editTextChanged"></a> <h4>MqttMonitorWidget.on_publishTopicComboBox_editTextChanged</h4> <b>on_publishTopicComboBox_editTextChanged</b>(<i>topic</i>) - <p> Private slot to handle changes of the publish topic name. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -1132,38 +1132,38 @@ <a NAME="MqttMonitorWidget.on_saveLogMessagesButton_clicked" ID="MqttMonitorWidget.on_saveLogMessagesButton_clicked"></a> <h4>MqttMonitorWidget.on_saveLogMessagesButton_clicked</h4> <b>on_saveLogMessagesButton_clicked</b>(<i></i>) - <p> Private slot to save the log messages. </p> + <a NAME="MqttMonitorWidget.on_saveMessagesButton_clicked" ID="MqttMonitorWidget.on_saveMessagesButton_clicked"></a> <h4>MqttMonitorWidget.on_saveMessagesButton_clicked</h4> <b>on_saveMessagesButton_clicked</b>(<i></i>) - <p> Private slot to save the received messages. </p> + <a NAME="MqttMonitorWidget.on_subscribeButton_clicked" ID="MqttMonitorWidget.on_subscribeButton_clicked"></a> <h4>MqttMonitorWidget.on_subscribeButton_clicked</h4> <b>on_subscribeButton_clicked</b>(<i></i>) - <p> Private slot to subscribe to the entered topic. </p> + <a NAME="MqttMonitorWidget.on_subscribePropertiesButton_clicked" ID="MqttMonitorWidget.on_subscribePropertiesButton_clicked"></a> <h4>MqttMonitorWidget.on_subscribePropertiesButton_clicked</h4> <b>on_subscribePropertiesButton_clicked</b>(<i></i>) - <p> Private slot to edit the subscribe user properties. </p> + <a NAME="MqttMonitorWidget.on_subscribeTopicComboBox_editTextChanged" ID="MqttMonitorWidget.on_subscribeTopicComboBox_editTextChanged"></a> <h4>MqttMonitorWidget.on_subscribeTopicComboBox_editTextChanged</h4> <b>on_subscribeTopicComboBox_editTextChanged</b>(<i>topic</i>) - <p> Private slot to handle a change of the entered topic. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -1174,24 +1174,24 @@ <a NAME="MqttMonitorWidget.on_unsubscribeButton_clicked" ID="MqttMonitorWidget.on_unsubscribeButton_clicked"></a> <h4>MqttMonitorWidget.on_unsubscribeButton_clicked</h4> <b>on_unsubscribeButton_clicked</b>(<i></i>) - <p> Private slot to unsubscribe from the selected topic. </p> + <a NAME="MqttMonitorWidget.on_unsubscribePropertiesButton_clicked" ID="MqttMonitorWidget.on_unsubscribePropertiesButton_clicked"></a> <h4>MqttMonitorWidget.on_unsubscribePropertiesButton_clicked</h4> <b>on_unsubscribePropertiesButton_clicked</b>(<i></i>) - <p> Private slot to edit the unsubscribe user properties. </p> + <a NAME="MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged" ID="MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged"></a> <h4>MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged</h4> <b>on_unsubscribeTopicComboBox_currentIndexChanged</b>(<i>topic</i>) - <p> Private slot to handle the selection of a topic to unsubscribe from. </p> + <dl> <dt><i>topic</i> (str)</dt> @@ -1201,4 +1201,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttProtocols.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttProtocols.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,19 +7,17 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttProtocols</h1> - <p> Module implementing an enum defining the supported MQTT protocol versions. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttProtocols">MqttProtocols</a></td> <td>Class defining the supported MQTT protocol versions.</td> @@ -29,74 +27,79 @@ <td>Class defining the supported MQTT protocol versions.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="MqttProtocols" ID="MqttProtocols"></a> <h2>MqttProtocols</h2> - <p> Class defining the supported MQTT protocol versions. </p> + <h3>Derived from</h3> enum.IntEnum <h3>Class Attributes</h3> +<table> +<tr><td>MQTTv31</td></tr> +<tr><td>MQTTv311</td></tr> +<tr><td>MQTTv5</td></tr> +</table> -<table> -<tr><td>MQTTv31</td></tr><tr><td>MQTTv311</td></tr><tr><td>MQTTv5</td></tr> -</table> <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="MqttProtocols_1" ID="MqttProtocols_1"></a> <h2>MqttProtocols</h2> - <p> Class defining the supported MQTT protocol versions. </p> + <h3>Derived from</h3> enum.IntEnum <h3>Class Attributes</h3> - <table> -<tr><td>MQTTv31</td></tr><tr><td>MQTTv311</td></tr><tr><td>MQTTv5</td></tr> +<tr><td>MQTTv31</td></tr> +<tr><td>MQTTv311</td></tr> +<tr><td>MQTTv5</td></tr> </table> -<h3>Class Methods</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Static Methods</h3> - +<h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> +<h3>Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,39 +7,38 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</h1> - <p> Module implementing the translated MQTT v5 reason codes. </p> + <h3>Global Attributes</h3> - <table> <tr><td>MqttReasonCodeNames</td></tr> </table> + <h3>Classes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#mqttReasonCode">mqttReasonCode</a></td> <td>Function to get the readable reason code string given the result code and the packet type.</td> </tr> </table> + <hr /> <hr /> <a NAME="mqttReasonCode" ID="mqttReasonCode"></a> <h2>mqttReasonCode</h2> <b>mqttReasonCode</b>(<i>rc, packetType</i>) - <p> Function to get the readable reason code string given the result code and the packet type. </p> + <dl> <dt><i>rc</i> (int)</dt> @@ -65,4 +64,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttUserPropertiesEditor.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttUserPropertiesEditor.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,19 +7,17 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttUserPropertiesEditor</h1> - <p> Module implementing an editor for MQTT v5 user properties. </p> + <h3>Global Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttUserPropertiesEditor">MqttUserPropertiesEditor</a></td> <td>Class implementing an editor for MQTT v5 user properties.</td> @@ -29,35 +27,34 @@ <td>Class implementing an editor dialog for MQTT v5 user properties.</td> </tr> </table> + <h3>Functions</h3> - <table> <tr><td>None</td></tr> </table> + <hr /> <hr /> <a NAME="MqttUserPropertiesEditor" ID="MqttUserPropertiesEditor"></a> <h2>MqttUserPropertiesEditor</h2> - <p> Class implementing an editor for MQTT v5 user properties. </p> + <h3>Derived from</h3> QWidget, Ui_MqttUserPropertiesEditor <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttUserPropertiesEditor.__init__">MqttUserPropertiesEditor</a></td> <td>Constructor</td> @@ -87,19 +84,20 @@ <td>Public method to populate the editor with a list of user properties.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttUserPropertiesEditor.__init__" ID="MqttUserPropertiesEditor.__init__"></a> <h4>MqttUserPropertiesEditor (Constructor)</h4> <b>MqttUserPropertiesEditor</b>(<i>parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>parent</i> (QWidget (optional))</dt> @@ -110,17 +108,17 @@ <a NAME="MqttUserPropertiesEditor.clear" ID="MqttUserPropertiesEditor.clear"></a> <h4>MqttUserPropertiesEditor.clear</h4> <b>clear</b>(<i></i>) - <p> Public slot to delete all properties. </p> + <a NAME="MqttUserPropertiesEditor.getProperties" ID="MqttUserPropertiesEditor.getProperties"></a> <h4>MqttUserPropertiesEditor.getProperties</h4> <b>getProperties</b>(<i></i>) - <p> Public method to get the list of defined user properties. </p> + <dl> <dt>Return:</dt> <dd> @@ -136,31 +134,31 @@ <a NAME="MqttUserPropertiesEditor.on_addButton_clicked" ID="MqttUserPropertiesEditor.on_addButton_clicked"></a> <h4>MqttUserPropertiesEditor.on_addButton_clicked</h4> <b>on_addButton_clicked</b>(<i></i>) - <p> Private slot to add a row to the table. </p> + <a NAME="MqttUserPropertiesEditor.on_deleteButton_clicked" ID="MqttUserPropertiesEditor.on_deleteButton_clicked"></a> <h4>MqttUserPropertiesEditor.on_deleteButton_clicked</h4> <b>on_deleteButton_clicked</b>(<i></i>) - <p> Private slot to delete the selected rows. </p> + <a NAME="MqttUserPropertiesEditor.on_propertiesTable_itemSelectionChanged" ID="MqttUserPropertiesEditor.on_propertiesTable_itemSelectionChanged"></a> <h4>MqttUserPropertiesEditor.on_propertiesTable_itemSelectionChanged</h4> <b>on_propertiesTable_itemSelectionChanged</b>(<i></i>) - <p> Private slot to handle the selection of rows. </p> + <a NAME="MqttUserPropertiesEditor.setProperties" ID="MqttUserPropertiesEditor.setProperties"></a> <h4>MqttUserPropertiesEditor.setProperties</h4> <b>setProperties</b>(<i>properties</i>) - <p> Public method to populate the editor with a list of user properties. </p> + <dl> <dt><i>properties</i> (list of tuple of (str, str))</dt> @@ -173,26 +171,24 @@ <hr /> <a NAME="MqttUserPropertiesEditorDialog" ID="MqttUserPropertiesEditorDialog"></a> <h2>MqttUserPropertiesEditorDialog</h2> - <p> Class implementing an editor dialog for MQTT v5 user properties. </p> + <h3>Derived from</h3> QDialog <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttUserPropertiesEditorDialog.__init__">MqttUserPropertiesEditorDialog</a></td> <td>Constructor</td> @@ -202,19 +198,20 @@ <td>Public method to get the list of defined user properties.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttUserPropertiesEditorDialog.__init__" ID="MqttUserPropertiesEditorDialog.__init__"></a> <h4>MqttUserPropertiesEditorDialog (Constructor)</h4> <b>MqttUserPropertiesEditorDialog</b>(<i>header, properties, parent=None</i>) - <p> Constructor </p> + <dl> <dt><i>header</i> (str)</dt> @@ -233,10 +230,10 @@ <a NAME="MqttUserPropertiesEditorDialog.getProperties" ID="MqttUserPropertiesEditorDialog.getProperties"></a> <h4>MqttUserPropertiesEditorDialog.getProperties</h4> <b>getProperties</b>(<i></i>) - <p> Public method to get the list of defined user properties. </p> + <dl> <dt>Return:</dt> <dd> @@ -251,4 +248,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,28 +7,38 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1> - <p> Module implementing the MQTT Monitor plug-in. </p> + <h3>Global Attributes</h3> - <table> -<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>mqttPluginObject</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +<tr><td>_Side</td></tr> +<tr><td>author</td></tr> +<tr><td>autoactivate</td></tr> +<tr><td>className</td></tr> +<tr><td>deactivateable</td></tr> +<tr><td>error</td></tr> +<tr><td>longDescription</td></tr> +<tr><td>mqttPluginObject</td></tr> +<tr><td>name</td></tr> +<tr><td>needsRestart</td></tr> +<tr><td>packageName</td></tr> +<tr><td>pyqtApi</td></tr> +<tr><td>shortDescription</td></tr> +<tr><td>version</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td> <td>Class implementing the MQTT Monitor plug-in.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#createMqttPage">createMqttPage</a></td> <td>Module function to create the autocompletion configuration page.</td> @@ -50,30 +60,29 @@ <td>Module function to prepare for an uninstallation.</td> </tr> </table> + <hr /> <hr /> <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a> <h2>MqttMonitorPlugin</h2> - <p> Class implementing the MQTT Monitor plug-in. </p> + <h3>Derived from</h3> QObject <h3>Class Attributes</h3> - <table> <tr><td>PreferencesKey</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td> <td>Constructor</td> @@ -107,19 +116,20 @@ <td>Public method to store the various settings.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a> <h4>MqttMonitorPlugin (Constructor)</h4> <b>MqttMonitorPlugin</b>(<i>ui</i>) - <p> Constructor </p> + <dl> <dt><i>ui</i> (UI.UserInterface)</dt> @@ -130,31 +140,31 @@ <a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a> <h4>MqttMonitorPlugin.__activateWidget</h4> <b>__activateWidget</b>(<i></i>) - <p> Private slot to handle the activation of the MQTT Monitor. </p> + <a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a> <h4>MqttMonitorPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) - <p> Private slot to (re)initialize the plugin. </p> + <a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a> <h4>MqttMonitorPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) - <p> Private method to load the translation file. </p> + <a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a> <h4>MqttMonitorPlugin.activate</h4> <b>activate</b>(<i></i>) - <p> Public method to activate this plug-in. </p> + <dl> <dt>Return:</dt> <dd> @@ -170,17 +180,17 @@ <a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a> <h4>MqttMonitorPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) - <p> Public method to deactivate this plug-in. </p> + <a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a> <h4>MqttMonitorPlugin.getPreferences</h4> <b>getPreferences</b>(<i>key</i>) - <p> Public method to retrieve the various settings. </p> + <dl> <dt><i>key</i> (str)</dt> @@ -203,10 +213,10 @@ <a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a> <h4>MqttMonitorPlugin.setPreferences</h4> <b>setPreferences</b>(<i>key, value</i>) - <p> Public method to store the various settings. </p> + <dl> <dt><i>key</i> (str)</dt> @@ -224,10 +234,10 @@ <a NAME="createMqttPage" ID="createMqttPage"></a> <h2>createMqttPage</h2> <b>createMqttPage</b>(<i>configDlg, </i>) - <p> Module function to create the autocompletion configuration page. </p> + <dl> <dt><i>configDlg</i> (ConfigurationWidget)</dt> @@ -253,10 +263,10 @@ <a NAME="exeDisplayData" ID="exeDisplayData"></a> <h2>exeDisplayData</h2> <b>exeDisplayData</b>(<i></i>) - <p> Module function to support the display of some executable info. </p> + <dl> <dt>Return:</dt> <dd> @@ -276,10 +286,10 @@ <a NAME="getConfigData" ID="getConfigData"></a> <h2>getConfigData</h2> <b>getConfigData</b>(<i></i>) - <p> Module function returning data as required by the configuration dialog. </p> + <dl> <dt>Return:</dt> <dd> @@ -298,10 +308,10 @@ <a NAME="installDependencies" ID="installDependencies"></a> <h2>installDependencies</h2> <b>installDependencies</b>(<i>pipInstall</i>) - <p> Function to install dependencies of this plug-in. </p> + <dl> <dt><i>pipInstall</i> (function)</dt> @@ -315,10 +325,10 @@ <a NAME="prepareUninstall" ID="prepareUninstall"></a> <h2>prepareUninstall</h2> <b>prepareUninstall</b>(<i></i>) - <p> Module function to prepare for an uninstallation. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.ConfigurationPage.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.ConfigurationPage.html Sat Jan 06 13:10:46 2024 +0100 @@ -6,12 +6,12 @@ </head> <body> <h1>Plugin_Mqtt_Monitor.MqttMonitor.ConfigurationPage</h1> - <p> Package implementing the MQTT Monitor page of the configuration dialog. </p> + <h3>Modules</h3> <table> @@ -20,4 +20,4 @@ <td>Module implementing the MQTT Monitor configuration page.</td> </tr> </table> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html Sat Jan 06 13:10:46 2024 +0100 @@ -6,11 +6,11 @@ </head> <body> <h1>Plugin_Mqtt_Monitor.MqttMonitor</h1> - <p> Package containing the MQTT Monitor modules and data files. </p> + <h3>Packages</h3> <table> @@ -52,4 +52,4 @@ <td>Module implementing an editor for MQTT v5 user properties.</td> </tr> </table> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.html Sat Jan 06 13:10:46 2024 +0100 @@ -6,11 +6,11 @@ </head> <body> <h1>Plugin_Mqtt_Monitor</h1> - <p> Package implementing the MQTT Monitor plug-in. </p> + <h3>Packages</h3> <table> @@ -28,4 +28,4 @@ <td>Module implementing the MQTT Monitor plug-in.</td> </tr> </table> -</body></html> \ No newline at end of file +</body></html>
--- a/MqttMonitor/Documentation/source/index.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/index.html Sat Jan 06 13:10:46 2024 +0100 @@ -17,4 +17,4 @@ </tr> </table> -</body></html> \ No newline at end of file +</body></html>
--- a/PluginMqttMonitor.py Sat Dec 23 19:45:41 2023 +0100 +++ b/PluginMqttMonitor.py Sat Jan 06 13:10:46 2024 +0100 @@ -22,6 +22,16 @@ except ImportError: from UI import PixmapCache as EricPixmapCache +try: + from eric7.UI.UserInterface import UserInterfaceSide + + _Side = UserInterfaceSide.Right +except ImportError: + # backward compatibility for eric < 24.2 + from eric7.UI.UserInterface import UserInterface + + _Side = UserInterface.RightSide + from MqttMonitor.MqttProtocols import MqttProtocols # Start-Of-Header @@ -29,7 +39,7 @@ author = "Detlev Offenbach <detlev@die-offenbachs.de>" autoactivate = True deactivateable = True -version = "10.4.2" +version = "10.5.0" className = "MqttMonitorPlugin" packageName = "MqttMonitor" shortDescription = "Plug-in implementing a tool to connect to a MQTT broker" @@ -194,7 +204,7 @@ else "mqtt22-{0}".format(iconSuffix) ) self.__ui.addSideWidget( - self.__ui.RightSide, + _Side, self.__widget, EricPixmapCache.getIcon(os.path.join("MqttMonitor", "icons", iconName)), self.tr("MQTT Monitor"),
