Sun, 09 Sep 2018 18:31:38 +0200
Updated source docu.
diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html --- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html Sun Sep 09 18:27:24 2018 +0200 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html Sun Sep 09 18:31:38 2018 +0200 @@ -38,10 +38,13 @@ <table> <tr> <td><a href="#mqttConnackMessage">mqttConnackMessage</a></td> -<td>Public method to get the string associated with a CONNACK result.</td> +<td>Module function to get the string associated with a CONNACK result.</td> </tr><tr> <td><a href="#mqttErrorMessage">mqttErrorMessage</a></td> -<td>Public method to get the error string associated with an MQTT error number.</td> +<td>Module function to get the error string associated with an MQTT error number.</td> +</tr><tr> +<td><a href="#mqttLogLevelString">mqttLogLevelString</a></td> +<td>Module function to get the log level string associated with a log level.</td> </tr> </table> <hr /><hr /> @@ -59,6 +62,9 @@ <dd> emitted after the client has disconnected from the broker +</dd><dt>onLog(level, message)</dt> +<dd> +emitted to send client log data </dd><dt>onMessage(topic, payload, qos, retain)</dt> <dd> emitted after a message has @@ -80,7 +86,7 @@ QObject <h3>Class Attributes</h3> <table> -<tr><td>None</td></tr> +<tr><td>DefaultConnectTimeout</td></tr><tr><td>LogDebug</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> @@ -92,9 +98,15 @@ <td><a href="#MqttClient.__init__">MqttClient</a></td> <td>Constructor</td> </tr><tr> +<td><a href="#MqttClient.__connectTimeout">__connectTimeout</a></td> +<td>Privat slot handling a failed connection attempt.</td> +</tr><tr> <td><a href="#MqttClient.__initCallbacks">__initCallbacks</a></td> <td>Private method to initialize the MQTT callback methods.</td> </tr><tr> +<td><a href="#MqttClient.clearLastWill">clearLastWill</a></td> +<td>Public method to remove a will that was previously configured with setLastWill().</td> +</tr><tr> <td><a href="#MqttClient.connectToServer">connectToServer</a></td> <td>Public method to connect to a remote MQTT broker.</td> </tr><tr> @@ -116,6 +128,9 @@ <td><a href="#MqttClient.reinitialise">reinitialise</a></td> <td>Public method to reinitialize the client with given data.</td> </tr><tr> +<td><a href="#MqttClient.setConnectionTimeout">setConnectionTimeout</a></td> +<td>Public method to set the connection timeout value.</td> +</tr><tr> <td><a href="#MqttClient.setLastWill">setLastWill</a></td> <td>Public method to set the last will of the client.</td> </tr><tr> @@ -125,6 +140,9 @@ <td><a href="#MqttClient.setMaxQueuedMessages">setMaxQueuedMessages</a></td> <td>Public method to set the maximum number of messages with QoS > 0 that can be pending in the outgoing message queue.</td> </tr><tr> +<td><a href="#MqttClient.setTLS">setTLS</a></td> +<td>Public method to enable secure connections and set the TLS parameters.</td> +</tr><tr> <td><a href="#MqttClient.setUserCredentials">setUserCredentials</a></td> <td>Public method to set the user name and optionally the password.</td> </tr><tr> @@ -173,14 +191,25 @@ <dd> reference to the parent object </dd> -</dl><a NAME="MqttClient.__initCallbacks" ID="MqttClient.__initCallbacks"></a> +</dl><a NAME="MqttClient.__connectTimeout" ID="MqttClient.__connectTimeout"></a> +<h4>MqttClient.__connectTimeout</h4> +<b>__connectTimeout</b>(<i></i>) +<p> + Privat slot handling a failed connection attempt. +</p><a NAME="MqttClient.__initCallbacks" ID="MqttClient.__initCallbacks"></a> <h4>MqttClient.__initCallbacks</h4> <b>__initCallbacks</b>(<i></i>) <p> Private method to initialize the MQTT callback methods. +</p><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=""</i>) +<b>connectToServer</b>(<i>host, port=1883, keepalive=60, bindAddress="", reinit=True</i>) <p> Public method to connect to a remote MQTT broker. </p><dl> @@ -222,7 +251,8 @@ dictionary containing the connection options. This dictionary should contain the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", "WillTopic", "WillMessage", - "WillQos", "WillRetain" + "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", "TlsClientCert", + "TlsClientKey", "ConnectionTimeout" </dd> </dl><a NAME="MqttClient.defaultConnectionOptions" ID="MqttClient.defaultConnectionOptions"></a> <h4>MqttClient.defaultConnectionOptions</h4> @@ -235,7 +265,9 @@ <dd> dictionary containing the default connection options. It has the keys "ClientId", "Keepalive", "CleanSession", "Username", - "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain" + "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain", + "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey", + "ConnectionTimeout". </dd> </dl><dl> <dt>Return Type:</dt> @@ -298,6 +330,16 @@ <dd> user data </dd> +</dl><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> +<dd> +timeout value to be set in seconds +</dd> </dl><a NAME="MqttClient.setLastWill" ID="MqttClient.setLastWill"></a> <h4>MqttClient.setLastWill</h4> <b>setLastWill</b>(<i>topic, payload=None, qos=0, retain=False</i>) @@ -340,6 +382,33 @@ <dd> maximum number of queued messages (0 = unlimited) </dd> +</dl><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> +<dd> +path to the Certificate Authority certificates file +</dd><dt><i>certFile</i> (str)</dt> +<dd> +PEM encoded client certificate file +</dd><dt><i>keyFile</i> (str)</dt> +<dd> +PEM encoded private key file +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple containing a success flag and the error string of the + paho-mqtt library +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> </dl><a NAME="MqttClient.setUserCredentials" ID="MqttClient.setUserCredentials"></a> <h4>MqttClient.setUserCredentials</h4> <b>setUserCredentials</b>(<i>username, password=None</i>) @@ -424,7 +493,7 @@ <h2>mqttConnackMessage</h2> <b>mqttConnackMessage</b>(<i>connackCode</i>) <p> - Public method to get the string associated with a CONNACK result. + Module function to get the string associated with a CONNACK result. </p><dl> <dt><i>connackCode</i> (int)</dt> <dd> @@ -447,7 +516,7 @@ <h2>mqttErrorMessage</h2> <b>mqttErrorMessage</b>(<i>mqttErrno</i>) <p> - Public method to get the error string associated with an MQTT error + Module function to get the error string associated with an MQTT error number. </p><dl> <dt><i>mqttErrno</i> (int)</dt> @@ -466,5 +535,32 @@ </dd> </dl> <div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<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> +<dd> +log level of the paho-mqtt client +</dd><dt><i>isMqttLogLevel</i> (bool)</dt> +<dd> +flag indicating a MQTT log level is given (if + False it is the MqttClient variant, i.e. Debug being lowest) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +textual representation of the log level +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file
diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html --- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sun Sep 09 18:27:24 2018 +0200 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sun Sep 09 18:31:38 2018 +0200 @@ -63,12 +63,21 @@ <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> <td>Private method to populate the dialog.</td> </tr><tr> +<td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private method to update the enabled state of the OK button.</td> +</tr><tr> <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> <td>Public method get the entered connection options.</td> </tr><tr> <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot to handle the press of a button box button.</td> </tr><tr> +<td><a href="#MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked">on_cleanSessionCheckBox_clicked</a></td> +<td>Private slot to handle a change of the clean session selection.</td> +</tr><tr> +<td><a href="#MqttConnectionOptionsDialog.on_clientIdEdit_textChanged">on_clientIdEdit_textChanged</a></td> +<td>Private slot handling a change of the client ID string.</td> +</tr><tr> <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> <td>Private slot to generate a client ID.</td> </tr> @@ -86,13 +95,13 @@ <dt><i>client</i> (MqttClient)</dt> <dd> reference to the MQTT client object -</dd><dt><i>options</i></dt> +</dd><dt><i>options</i> (dict)</dt> <dd> dictionary containing the connection options to populate the dialog with. It must have the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", "WillTopic", - "WillMessage", "WillQos", "WillRetain". -@type dict + "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", + "ConnectionTimeout". </dd><dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget @@ -111,9 +120,15 @@ dictionary containing the connection options to populate the dialog with. It must have the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", "WillTopic", "WillMessage", - "WillQos", "WillRetain". + "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", + "ConnectionTimeout". </dd> -</dl><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> +</dl><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> @@ -123,7 +138,8 @@ <dd> dictionary containing the connection options. It has the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", - "WillTopic", "WillMessage", "WillQos", "WillRetain". + "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", + "TlsCaCert", "ConnectionTimeout". </dd> </dl><dl> <dt>Return Type:</dt> @@ -140,6 +156,26 @@ <dd> button that has been pressed </dd> +</dl><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> +<dd> +current state of the clean session selection +</dd> +</dl><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> +<dd> +client ID +</dd> </dl><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>)
diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html Sun Sep 09 18:31:38 2018 +0200 @@ -0,0 +1,466 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<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> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__applyProfile">__applyProfile</a></td> +<td>Private method to apply the entered data to the list of profiles.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__clearProfile">__clearProfile</a></td> +<td>Private method to clear the profile data entry fields.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__defaultProfile">__defaultProfile</a></td> +<td>Private method to populate non-existing profile items.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__isChangedProfile">__isChangedProfile</a></td> +<td>Private method to check, if the currently shown profile contains some changed data.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__populateProfile">__populateProfile</a></td> +<td>Private method to populate the profile data entry fields.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__populateProfileDefault">__populateProfileDefault</a></td> +<td>Private method to populate the profile data entry fields with default profile values.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__populateProfilesList">__populateProfilesList</a></td> +<td>Private method to populate the list of defined profiles.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__resetProfile">__resetProfile</a></td> +<td>Private method to reset the profile data entry fields to their stored values.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.__updateApplyButton">__updateApplyButton</a></td> +<td>Private method to set the state of the Apply button.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.accept">accept</a></td> +<td>Public slot to accept the dialog.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.getProfiles">getProfiles</a></td> +<td>Public method to return a dictionary of profiles.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged">on_brokerAddressEdit_textChanged</a></td> +<td>Private slot handling a change of the broker address.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_cleanSessionCheckBox_clicked">on_cleanSessionCheckBox_clicked</a></td> +<td>Private slot to handle a change of the clean session selection.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_clientIdEdit_textChanged">on_clientIdEdit_textChanged</a></td> +<td>Private slot handling a change of the client ID string.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> +<td>Private slot to copy the selected profile entry.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> +<td>Private slot to generate a client ID.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_minusButton_clicked">on_minusButton_clicked</a></td> +<td>Private slot to delete the selected entry.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_plusButton_clicked">on_plusButton_clicked</a></td> +<td>Private slot to add a new empty profile entry.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_profileButtonBox_clicked">on_profileButtonBox_clicked</a></td> +<td>Private slot handling presses of the profile buttons.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_profileEdit_textChanged">on_profileEdit_textChanged</a></td> +<td>Private slot to handle changes of the profile name.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_profilesList_currentItemChanged">on_profilesList_currentItemChanged</a></td> +<td>Private slot to handle a change of the current profile.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled">on_tlsCertsFileButton_toggled</a></td> +<td>Private slot handling the selection of using a non-default certificates file.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged">on_tlsCertsFilePicker_textChanged</a></td> +<td>Private slot handling a change of the TLS CA certificates file.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled">on_tlsDefaultCertsButton_toggled</a></td> +<td>Private slot handling the selection of using the default certificates file.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsGroupBox_toggled">on_tlsGroupBox_toggled</a></td> +<td>Private slot handling the selection of TLS mode.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled">on_tlsSelfSignedCertsButton_toggled</a></td> +<td>Private slot handling the selection of using self signed client certificate and key files.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged">on_tlsSelfSignedCertsFilePicker_textChanged</a></td> +<td>Private slot handling a change of the TLS CA certificates file.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged">on_tlsSelfSignedClientCertFilePicker_textChanged</a></td> +<td>Private slot handling a change of the TLS client certificate file.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged">on_tlsSelfSignedClientKeyFilePicker_textChanged</a></td> +<td>Private slot handling a change of the TLS client key file.</td> +</tr><tr> +<td><a href="#MqttConnectionProfilesDialog.reject">reject</a></td> +<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>client, profiles, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>client</i> (MqttClient)</dt> +<dd> +reference to the MQTT client object +</dd><dt><i>profiles</i> (dict)</dt> +<dd> +dictionary containing dictionaries containing the + connection parameters. Each entry must have the keys + "BrokerAddress", "BrokerPort", "ClientId", + "Keepalive", "CleanSession", "Username", "Password", "WillTopic", + "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", + "TlsClientCert", "TlsClientKey", "ConnectionTimeout". +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><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>Returns:</dt> +<dd> +name of the applied profile +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><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>Returns:</dt> +<dd> +default dictionary entry +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl><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>Returns:</dt> +<dd> +flag indicating changed data +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl><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> +<dd> +name of the profile to get data from +</dd> +</dl><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> +<dd> +name of the current profile +</dd> +</dl><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>Returns:</dt> +<dd> +dictionary containing dictionaries containing the defined + connection profiles. Each entry have the keys "BrokerAddress", + "BrokerPort", "ClientId", "Keepalive", "CleanSession", "Username", + "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain", + "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey", + "ConnectionTimeout". +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl><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> +<dd> +broker address +</dd> +</dl><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> +<dd> +current state of the clean session selection +</dd> +</dl><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> +<dd> +client ID +</dd> +</dl><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_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> +<dd> +reference to the pressed button +</dd> +</dl><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> +<dd> +name of the profile +</dd> +</dl><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> +<dd> +new current item +</dd><dt><i>previous</i> (QListWidgetItem)</dt> +<dd> +previous current item +</dd> +</dl><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> +<dd> +state of the selection +</dd> +</dl><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> +<dd> +file path +</dd> +</dl><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> +<dd> +state of the selection +</dd> +</dl><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> +<dd> +state of the selection +</dd> +</dl><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> +<dd> +state of the selection +</dd> +</dl><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> +<dd> +file path +</dd> +</dl><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> +<dd> +file path +</dd> +</dl><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> +<dd> +file path +</dd> +</dl><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
diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html --- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html Sun Sep 09 18:27:24 2018 +0200 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html Sun Sep 09 18:31:38 2018 +0200 @@ -75,6 +75,15 @@ <td><a href="#MqttMonitorWidget.__clearBrokerStatusLabels">__clearBrokerStatusLabels</a></td> <td>Private method to clear the broker status labels.</td> </tr><tr> +<td><a href="#MqttMonitorWidget.__clientLog">__clientLog</a></td> +<td>Private slot to handle the receipt of a log message.</td> +</tr><tr> +<td><a href="#MqttMonitorWidget.__connectTimeout">__connectTimeout</a></td> +<td>Private slot handling a timeout during a connection attempt.</td> +</tr><tr> +<td><a href="#MqttMonitorWidget.__directConnectToBroker">__directConnectToBroker</a></td> +<td>Private method to connect to the broker with entered data.</td> +</tr><tr> <td><a href="#MqttMonitorWidget.__flashBrokerStatusLabel">__flashBrokerStatusLabel</a></td> <td>Private slot to show the broker status label with some text for 5 seconds.</td> </tr><tr> @@ -96,9 +105,21 @@ <td><a href="#MqttMonitorWidget.__populateBrokerComboBoxes">__populateBrokerComboBoxes</a></td> <td>Private method to populate the broker name and port combo boxes.</td> </tr><tr> +<td><a href="#MqttMonitorWidget.__populateProfileComboBox">__populateProfileComboBox</a></td> +<td>Private method to populate the profiles selection box.</td> +</tr><tr> +<td><a href="#MqttMonitorWidget.__profileConnectToBroker">__profileConnectToBroker</a></td> +<td>Private method to connect to the broker with selected profile.</td> +</tr><tr> <td><a href="#MqttMonitorWidget.__setBrokerStatusSubscribed">__setBrokerStatusSubscribed</a></td> <td>Private method to set the subscription status for the broker status topics.</td> </tr><tr> +<td><a href="#MqttMonitorWidget.__setConnectButtonState">__setConnectButtonState</a></td> +<td>Private method to set the enabled state of the connect button.</td> +</tr><tr> +<td><a href="#MqttMonitorWidget.__setConnectionMode">__setConnectionMode</a></td> +<td>Private method to set the connection mode.</td> +</tr><tr> <td><a href="#MqttMonitorWidget.__topicSubscribed">__topicSubscribed</a></td> <td>Private slot to handle being subscribed to topics.</td> </tr><tr> @@ -115,7 +136,7 @@ <td>Private slot to handling entering or selecting a broker host name.</td> </tr><tr> <td><a href="#MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked">on_brokerConnectionOptionsButton_clicked</a></td> -<td>Private slot to show a dialog to modify connection options.</td> +<td>Private slot to show a dialog to modify connection options or a dialog to edit connection profiles.</td> </tr><tr> <td><a href="#MqttMonitorWidget.on_brokerStatusButton_clicked">on_brokerStatusButton_clicked</a></td> <td>Private slot to subscribe or unsubscribe the broker status topic.</td> @@ -123,6 +144,12 @@ <td><a href="#MqttMonitorWidget.on_connectButton_clicked">on_connectButton_clicked</a></td> <td>Private slot to handle a connect or disconnect request.</td> </tr><tr> +<td><a href="#MqttMonitorWidget.on_modeButton_clicked">on_modeButton_clicked</a></td> +<td>Private slot to switch between connection profiles and direct connection mode.</td> +</tr><tr> +<td><a href="#MqttMonitorWidget.on_profileComboBox_currentIndexChanged">on_profileComboBox_currentIndexChanged</a></td> +<td>Private slot handling the change of the selected profile.</td> +</tr><tr> <td><a href="#MqttMonitorWidget.on_publishButton_clicked">on_publishButton_clicked</a></td> <td>Private slot to publish the entered message.</td> </tr><tr> @@ -135,6 +162,9 @@ <td><a href="#MqttMonitorWidget.on_subscribeButton_clicked">on_subscribeButton_clicked</a></td> <td>Private slot to subscribe to the entered topic.</td> </tr><tr> +<td><a href="#MqttMonitorWidget.on_subscribeTopicEdit_returnPressed">on_subscribeTopicEdit_returnPressed</a></td> +<td>Private slot handling the user pressing the return button to subscribe a topic.</td> +</tr><tr> <td><a href="#MqttMonitorWidget.on_subscribeTopicEdit_textChanged">on_subscribeTopicEdit_textChanged</a></td> <td>Private slot to handle a change of the entered topic.</td> </tr><tr> @@ -217,6 +247,29 @@ <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> +<dd> +log level +</dd><dt><i>message</i> (str)</dt> +<dd> +log message +</dd> +</dl><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.__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.__flashBrokerStatusLabel" ID="MqttMonitorWidget.__flashBrokerStatusLabel"></a> <h4>MqttMonitorWidget.__flashBrokerStatusLabel</h4> <b>__flashBrokerStatusLabel</b>(<i>message</i>) @@ -304,6 +357,16 @@ <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.__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>) @@ -315,6 +378,21 @@ <dd> subscription status for the broker status topics </dd> +</dl><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> +<dd> +flag indicating the profile connection mode +</dd> </dl><a NAME="MqttMonitorWidget.__topicSubscribed" ID="MqttMonitorWidget.__topicSubscribed"></a> <h4>MqttMonitorWidget.__topicSubscribed</h4> <b>__topicSubscribed</b>(<i>mid, grantedQos</i>) @@ -340,10 +418,15 @@ </dd> </dl><a NAME="MqttMonitorWidget.__updatePublishTopicComboBox" ID="MqttMonitorWidget.__updatePublishTopicComboBox"></a> <h4>MqttMonitorWidget.__updatePublishTopicComboBox</h4> -<b>__updatePublishTopicComboBox</b>(<i></i>) +<b>__updatePublishTopicComboBox</b>(<i>resetTopic=True</i>) <p> Private method to update the publish topic combo box. -</p><a NAME="MqttMonitorWidget.__updateUnsubscribeTopicComboBox" ID="MqttMonitorWidget.__updateUnsubscribeTopicComboBox"></a> +</p><dl> +<dt><i>resetTopic</i> (bool)</dt> +<dd> +flag indicating to reset the topic +</dd> +</dl><a NAME="MqttMonitorWidget.__updateUnsubscribeTopicComboBox" ID="MqttMonitorWidget.__updateUnsubscribeTopicComboBox"></a> <h4>MqttMonitorWidget.__updateUnsubscribeTopicComboBox</h4> <b>__updateUnsubscribeTopicComboBox</b>(<i></i>) <p> @@ -362,7 +445,8 @@ <h4>MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked</h4> <b>on_brokerConnectionOptionsButton_clicked</b>(<i></i>) <p> - Private slot to show a dialog to modify connection options. + 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>) @@ -373,7 +457,23 @@ <b>on_connectButton_clicked</b>(<i></i>) <p> Private slot to handle a connect or disconnect request. -</p><a NAME="MqttMonitorWidget.on_publishButton_clicked" ID="MqttMonitorWidget.on_publishButton_clicked"></a> +</p><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> +<dd> +name of the selected profile +</dd> +</dl><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> @@ -398,6 +498,12 @@ <b>on_subscribeButton_clicked</b>(<i></i>) <p> Private slot to subscribe to the entered topic. +</p><a NAME="MqttMonitorWidget.on_subscribeTopicEdit_returnPressed" ID="MqttMonitorWidget.on_subscribeTopicEdit_returnPressed"></a> +<h4>MqttMonitorWidget.on_subscribeTopicEdit_returnPressed</h4> +<b>on_subscribeTopicEdit_returnPressed</b>(<i></i>) +<p> + Private slot handling the user pressing the return button to subscribe + a topic. </p><a NAME="MqttMonitorWidget.on_subscribeTopicEdit_textChanged" ID="MqttMonitorWidget.on_subscribeTopicEdit_textChanged"></a> <h4>MqttMonitorWidget.on_subscribeTopicEdit_textChanged</h4> <b>on_subscribeTopicEdit_textChanged</b>(<i>topic</i>)
diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html --- a/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html Sun Sep 09 18:27:24 2018 +0200 +++ b/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html Sun Sep 09 18:31:38 2018 +0200 @@ -34,6 +34,9 @@ <td><a href="Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html">MqttConnectionOptionsDialog</a></td> <td>Module implementing a dialog to enter MQTT connection options.</td> </tr><tr> +<td><a href="Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html">MqttConnectionProfilesDialog</a></td> +<td>Module implementing a dialog to edit the MQTT connection profiles.</td> +</tr><tr> <td><a href="Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html">MqttMonitorWidget</a></td> <td>Module implementing the MQTT Monitor widget.</td> </tr>
diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/MqttConnectionProfilesDialog.py --- a/MqttMonitor/MqttConnectionProfilesDialog.py Sun Sep 09 18:27:24 2018 +0200 +++ b/MqttMonitor/MqttConnectionProfilesDialog.py Sun Sep 09 18:31:38 2018 +0200 @@ -416,7 +416,7 @@ changed data. @return flag indicating changed data - @type bool + @rtype bool """ profileName = self.profileEdit.text() if profileName == "":