Mercurial Repositories > MQTT Monitor / changeset

--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html	Thu Sep 20 19:19:31 2018 +0200
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html	Thu Sep 20 19:20:10 2018 +0200
@@ -54,7 +54,11 @@
     Class implementing a PyQt wrapper around the paho MQTT client.
 </p><h3>Signals</h3>
 <dl>
-<dt>onConnect(flags, rc)</dt>
+<dt>connectTimeout()</dt>
+<dd>
+emitted to indicate, that a connection attempt
+        timed out
+</dd><dt>onConnect(flags, rc)</dt>
 <dd>
 emitted after the client has connected to the
         broker
@@ -86,7 +90,7 @@
 QObject
 <h3>Class Attributes</h3>
 <table>
-<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>
+<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>
@@ -99,7 +103,7 @@
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#MqttClient.__connectTimeout">__connectTimeout</a></td>
-<td>Privat slot handling a failed connection attempt.</td>
+<td>Private 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>
@@ -195,7 +199,7 @@
 <h4>MqttClient.__connectTimeout</h4>
 <b>__connectTimeout</b>(<i></i>)
 <p>
-        Privat slot handling a failed connection attempt.
+        Private slot handling a failed connection attempt.
 </p><a NAME="MqttClient.__initCallbacks" ID="MqttClient.__initCallbacks"></a>
 <h4>MqttClient.__initCallbacks</h4>
 <b>__initCallbacks</b>(<i></i>)
@@ -228,6 +232,10 @@
 <dd>
 IP address of a local network interface to bind
             this client to
+</dd><dt><i>reinit</i> (bool)</dt>
+<dd>
+flag indicating to reinitialize the MQTT client before
+            trying to connect with the given parameters
 </dd>
 </dl><a NAME="MqttClient.connectToServerWithOptions" ID="MqttClient.connectToServerWithOptions"></a>
 <h4>MqttClient.connectToServerWithOptions</h4>

--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html	Thu Sep 20 19:19:31 2018 +0200
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html	Thu Sep 20 19:20:10 2018 +0200
@@ -144,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_logEdit_blockCountChanged">on_logEdit_blockCountChanged</a></td>
+<td>Private slot handling changes of received messages.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_messagesEdit_blockCountChanged">on_messagesEdit_blockCountChanged</a></td>
+<td>Private slot handling changes of received messages.</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>
@@ -156,9 +162,18 @@
 <td><a href="#MqttMonitorWidget.on_publishClearButton_clicked">on_publishClearButton_clicked</a></td>
 <td>Private slot to clear the publish data fields.</td>
 </tr><tr>
+<td><a href="#MqttMonitorWidget.on_publishPayloadFilePicker_textChanged">on_publishPayloadFilePicker_textChanged</a></td>
+<td>Private slot handling a change of path of the payload file.</td>
+</tr><tr>
 <td><a href="#MqttMonitorWidget.on_publishTopicComboBox_editTextChanged">on_publishTopicComboBox_editTextChanged</a></td>
 <td>Private slot to handle changes of the publish topic name.</td>
 </tr><tr>
+<td><a href="#MqttMonitorWidget.on_saveLogMessagesButton_clicked">on_saveLogMessagesButton_clicked</a></td>
+<td>Private slot to save the log messages.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_saveMessagesButton_clicked">on_saveMessagesButton_clicked</a></td>
+<td>Private slot to save the received messages.</td>
+</tr><tr>
 <td><a href="#MqttMonitorWidget.on_subscribeButton_clicked">on_subscribeButton_clicked</a></td>
 <td>Private slot to subscribe to the entered topic.</td>
 </tr><tr>
@@ -208,7 +223,7 @@
 </dd>
 </dl><a NAME="MqttMonitorWidget.__appendMessage" ID="MqttMonitorWidget.__appendMessage"></a>
 <h4>MqttMonitorWidget.__appendMessage</h4>
-<b>__appendMessage</b>(<i>topic, payload</i>)
+<b>__appendMessage</b>(<i>topic, payload, qos</i>)
 <p>
         Private method to append a received message to the output.
 </p><dl>
@@ -218,6 +233,9 @@
 </dd><dt><i>payload</i> (bytes)</dt>
 <dd>
 payload of the received message
+</dd><dt><i>qos</i> (int)</dt>
+<dd>
+quality of service indicator (0, 1, 2)
 </dd>
 </dl><a NAME="MqttMonitorWidget.__brokerConnected" ID="MqttMonitorWidget.__brokerConnected"></a>
 <h4>MqttMonitorWidget.__brokerConnected</h4>
@@ -457,7 +475,27 @@
 <b>on_connectButton_clicked</b>(<i></i>)
 <p>
         Private slot to handle a connect or disconnect request.
-</p><a NAME="MqttMonitorWidget.on_modeButton_clicked" ID="MqttMonitorWidget.on_modeButton_clicked"></a>
+</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>
+<dd>
+(ignored)
+</dd>
+</dl><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>
+<dd>
+(ignored)
+</dd>
+</dl><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>
@@ -483,7 +521,17 @@
 <b>on_publishClearButton_clicked</b>(<i></i>)
 <p>
         Private slot to clear the publish data fields.
-</p><a NAME="MqttMonitorWidget.on_publishTopicComboBox_editTextChanged" ID="MqttMonitorWidget.on_publishTopicComboBox_editTextChanged"></a>
+</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>
+<dd>
+path of the payload file
+</dd>
+</dl><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>
@@ -493,7 +541,17 @@
 <dd>
 topic text
 </dd>
-</dl><a NAME="MqttMonitorWidget.on_subscribeButton_clicked" ID="MqttMonitorWidget.on_subscribeButton_clicked"></a>
+</dl><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>