MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html

Sat, 24 Jul 2021 16:51:29 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 24 Jul 2021 16:51:29 +0200
branch
eric7
changeset 108
d7808a71b234
parent 92
2fb5c08019fd
child 115
357257ad48d2
permissions
-rw-r--r--

Updated source code documentation.

12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>Plugin_Mqtt_Monitor.MqttMonitor.MqttClient</title>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
21 <body>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
22 <a NAME="top" ID="top"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttClient</h1>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
24
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing a PyQt wrapper around the paho MQTT client.
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
29
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
34
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
36
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#MqttClient">MqttClient</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class implementing a PyQt wrapper around the paho MQTT client.</td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
43
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
45
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <td><a href="#mqttConnackMessage">mqttConnackMessage</a></td>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
48 <td>Module function to get the string associated with a CONNACK result.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
49 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
50 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <td><a href="#mqttErrorMessage">mqttErrorMessage</a></td>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
52 <td>Module function to get the error string associated with an MQTT error number.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
53 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
54 <tr>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
55 <td><a href="#mqttLogLevelString">mqttLogLevelString</a></td>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
56 <td>Module function to get the log level string associated with a log level.</td>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 </tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 </table>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
59 <hr />
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
60 <hr />
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <a NAME="MqttClient" ID="MqttClient"></a>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <h2>MqttClient</h2>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
63
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 Class implementing a PyQt wrapper around the paho MQTT client.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
66 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
67 <h3>Signals</h3>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <dl>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
69
58
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
70 <dt>connectTimeout()</dt>
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
71 <dd>
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
72 emitted to indicate, that a connection attempt
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
73 timed out
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
74 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
75 <dt>onConnectV3(flags, rc)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
77 emitted after the client has connected to
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
78 the broker (MQTT v3)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
79 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
80 <dt>onConnectV5(flags, rc, packetType, properties emitted after theclient has connected to the broker (MQTT v5)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
81 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
82
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
83 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
84 <dt>onDisconnectedV3(rc)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 emitted after the client has disconnected from
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
87 the broker (MQTT v3)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
88 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
89 <dt>onDisconnectedV5(rc, packetType)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
90 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
91 emitted after the client has
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
92 disconnected from the broker (MQTT v5)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
93 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
94 <dt>onLog(level, message)</dt>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
95 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
96 emitted to send client log data
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
97 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
98 <dt>onMessageV3(topic, payload, qos, retain)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
100 emitted after a message
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
101 has been received by the client (MQTT v3)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
102 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
103 <dt>onMessageV5(topic, payload, qos, retain, properties)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
104 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
105 emitted after
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
106 a message has been received by the client (MQTT v5)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
107 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
108 <dt>onPublish(mid)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 emitted after a message has been published
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
111 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
112 <dt>onSubscribeV3(mid, grantedQos)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 emitted after the client has
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
115 subscribed to some topics (MQTT v3)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
116 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
117 <dt>onSubscribeV5(mid, reasonCodes, properties)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
118 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
119 emitted after the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
120 client has subscribed to some topics (MQTT v5)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
121 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
122 <dt>onUnsubscribeV3(mid)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 emitted after the client has unsubscribed from
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
125 some topics (MQTT v3)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
126 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
127 <dt>onUnsubscribeV5(mid, rc, packetType, properties)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
128 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
129 emitted after the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
130 client has unsubscribed from some topics (MQTT v5)
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 </dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 </dl>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 <h3>Derived from</h3>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 QObject
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <h3>Class Attributes</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
136
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 <table>
58
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
138 <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>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
139 </table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 <h3>Class Methods</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
141
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 <table>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
143
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
144 <tr>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
145 <td><a href="#MqttClient.defaultConnectionOptions">defaultConnectionOptions</a></td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
146 <td>Class method to get a connection options dictionary with default values.</td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
147 </tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 </table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 <h3>Methods</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
150
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 <table>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
152
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 <tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 <td><a href="#MqttClient.__init__">MqttClient</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 <td>Constructor</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
156 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
157 <tr>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
158 <td><a href="#MqttClient.__connectTimeout">__connectTimeout</a></td>
58
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
159 <td>Private slot handling a failed connection attempt.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
160 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
161 <tr>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
162 <td><a href="#MqttClient.__createPropertiesObject">__createPropertiesObject</a></td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
163 <td>Private method to assemble the MQTT v5 properties object.</td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
164 </tr>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
165 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 <td><a href="#MqttClient.__initCallbacks">__initCallbacks</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 <td>Private method to initialize the MQTT callback methods.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
168 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
169 <tr>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
170 <td><a href="#MqttClient.__onDisconnectedV5">__onDisconnectedV5</a></td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
171 <td>Private method to handle the disconnect from the broker.</td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
172 </tr>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
173 <tr>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
174 <td><a href="#MqttClient.clearLastWill">clearLastWill</a></td>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
175 <td>Public method to remove a will that was previously configured with setLastWill().</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
176 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
177 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
178 <td><a href="#MqttClient.connectToServer">connectToServer</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 <td>Public method to connect to a remote MQTT broker.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
180 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
181 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
182 <td><a href="#MqttClient.connectToServerWithOptions">connectToServerWithOptions</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 <td>Public method to connect to a remote MQTT broker.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
184 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
185 <tr>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
186 <td><a href="#MqttClient.disconnectFromServer">disconnectFromServer</a></td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
187 <td>Public method to disconnect the client from the remote broker.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
188 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
189 <tr>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
190 <td><a href="#MqttClient.getProtocol">getProtocol</a></td>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
191 <td>Public method to get the MQTT protocol version.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
192 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
193 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
194 <td><a href="#MqttClient.publish">publish</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 <td>Public method to publish to a topic.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
196 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
197 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
198 <td><a href="#MqttClient.reconnectToServer">reconnectToServer</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199 <td>Public method to reconnect the client with the same parameters.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
200 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
201 <tr>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
202 <td><a href="#MqttClient.setConnectionTimeout">setConnectionTimeout</a></td>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
203 <td>Public method to set the connection timeout value.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
204 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
205 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
206 <td><a href="#MqttClient.setLastWill">setLastWill</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 <td>Public method to set the last will of the client.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
208 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
209 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
210 <td><a href="#MqttClient.setMaxInflightMessages">setMaxInflightMessages</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
211 <td>Public method to set the maximum number of messages with QoS > 0 that can be part way through their network flow at once.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
212 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
213 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
214 <td><a href="#MqttClient.setMaxQueuedMessages">setMaxQueuedMessages</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
215 <td>Public method to set the maximum number of messages with QoS > 0 that can be pending in the outgoing message queue.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
216 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
217 <tr>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
218 <td><a href="#MqttClient.setTLS">setTLS</a></td>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
219 <td>Public method to enable secure connections and set the TLS parameters.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
220 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
221 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
222 <td><a href="#MqttClient.setUserCredentials">setUserCredentials</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
223 <td>Public method to set the user name and optionally the password.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
224 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
225 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
226 <td><a href="#MqttClient.setUserData">setUserData</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
227 <td>Public method to set the user data.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
228 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
229 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
230 <td><a href="#MqttClient.startLoop">startLoop</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
231 <td>Public method to start the MQTT client loop.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
232 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
233 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
234 <td><a href="#MqttClient.stopLoop">stopLoop</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
235 <td>Public method to stop the MQTT client loop.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
236 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
237 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
238 <td><a href="#MqttClient.subscribe">subscribe</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
239 <td>Public method to subscribe to topics with quality of service.</td>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
240 </tr>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
241 <tr>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
242 <td><a href="#MqttClient.unsubscribe">unsubscribe</a></td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
243 <td>Public method to unsubscribe topics.</td>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
244 </tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
245 </table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
246 <h3>Static Methods</h3>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
247
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
248 <table>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
249 <tr><td>None</td></tr>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
250 </table>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
251
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
252 <a NAME="MqttClient.defaultConnectionOptions" ID="MqttClient.defaultConnectionOptions"></a>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
253 <h4>MqttClient.defaultConnectionOptions (class method)</h4>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
254 <b>defaultConnectionOptions</b>(<i></i>)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
255
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
256 <p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
257 Class method to get a connection options dictionary with default
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
258 values.
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
259 </p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
260 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
261 <dt>Return:</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
262 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
263 dictionary containing the default connection options. It has
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
264 the keys "ClientId", "Protocol", "ConnectionTimeout", "Keepalive",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
265 "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
266 "WillQos", "WillRetain", "WillProperties", "TlsEnable",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
267 "TlsCaCert", "TlsClientCert", "TlsClientKey", "UserProperties".
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
268 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
269 </dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
270 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
271 <dt>Return Type:</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
272 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
273 dict
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
274 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
275 </dl>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
276 <a NAME="MqttClient.__init__" ID="MqttClient.__init__"></a>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
277 <h4>MqttClient (Constructor)</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
278 <b>MqttClient</b>(<i>clientId="", cleanSession=True, userdata=None, protocol=mqtt.MQTTv311, transport="tcp", parent=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
279
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
280 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
281 Constructor
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
282 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
283 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
284
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
285 <dt><i>clientId</i> (str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
286 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
287 ID to be used for the client
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
288 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
289 <dt><i>cleanSession</i> (bool)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
290 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
291 flag indicating to start a clean session
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
292 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
293 <dt><i>userdata</i> (any)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
294 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
295 user data
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
296 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
297 <dt><i>protocol</i> (int, one of mqtt.MQTTv31, mqtt.MQTTv311 or mqtt.MQTTv5)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
298 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
299 version of the MQTT protocol to use
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
300 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
301 <dt><i>transport</i> (str, one of "tcp" or "websockets")</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
302 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
303 transport to be used
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
304 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
305 <dt><i>parent</i> (QObject)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
306 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
307 reference to the parent object
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
308 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
309 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
310 <a NAME="MqttClient.__connectTimeout" ID="MqttClient.__connectTimeout"></a>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
311 <h4>MqttClient.__connectTimeout</h4>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
312 <b>__connectTimeout</b>(<i></i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
313
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
314 <p>
58
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
315 Private slot handling a failed connection attempt.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
316 </p>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
317 <a NAME="MqttClient.__createPropertiesObject" ID="MqttClient.__createPropertiesObject"></a>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
318 <h4>MqttClient.__createPropertiesObject</h4>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
319 <b>__createPropertiesObject</b>(<i>packetType, properties</i>)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
320
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
321 <p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
322 Private method to assemble the MQTT v5 properties object.
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
323 </p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
324 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
325
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
326 <dt><i>packetType</i> (PacketTypes (= int))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
327 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
328 type of the MQTT packet
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
329 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
330 <dt><i>properties</i> (list of tuple of (str, str))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
331 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
332 list of user properties
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
333 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
334 </dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
335 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
336 <dt>Return:</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
337 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
338 MQTT v5 properties object
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
339 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
340 </dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
341 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
342 <dt>Return Type:</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
343 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
344 Properties
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
345 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
346 </dl>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
347 <a NAME="MqttClient.__initCallbacks" ID="MqttClient.__initCallbacks"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
348 <h4>MqttClient.__initCallbacks</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
349 <b>__initCallbacks</b>(<i>protocol</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
350
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
351 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
352 Private method to initialize the MQTT callback methods.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
353 </p>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
354 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
355
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
356 <dt><i>protocol</i> (MqttProtocols)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
357 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
358 MQTT protocol version
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
359 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
360 </dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
361 <a NAME="MqttClient.__onDisconnectedV5" ID="MqttClient.__onDisconnectedV5"></a>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
362 <h4>MqttClient.__onDisconnectedV5</h4>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
363 <b>__onDisconnectedV5</b>(<i>client, userdata, rc, properties=None</i>)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
364
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
365 <p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
366 Private method to handle the disconnect from the broker.
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
367 </p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
368 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
369
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
370 <dt><i>client</i> (paho.mqtt.Client)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
371 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
372 reference to the client object
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
373 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
374 <dt><i>userdata</i> (Any)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
375 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
376 user data
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
377 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
378 <dt><i>rc</i> (int or ReasonCodes)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
379 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
380 result code or reason code
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
381 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
382 <dt><i>properties</i> (dict (optional))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
383 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
384 optional properties (defaults to None)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
385 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
386 </dl>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
387 <a NAME="MqttClient.clearLastWill" ID="MqttClient.clearLastWill"></a>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
388 <h4>MqttClient.clearLastWill</h4>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
389 <b>clearLastWill</b>(<i></i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
390
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
391 <p>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
392 Public method to remove a will that was previously configured with
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
393 setLastWill().
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
394 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
395 <a NAME="MqttClient.connectToServer" ID="MqttClient.connectToServer"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
396 <h4>MqttClient.connectToServer</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
397 <b>connectToServer</b>(<i>host, port=1883, keepalive=60, bindAddress="", properties=None, clearWill=False</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
398
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
399 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
400 Public method to connect to a remote MQTT broker.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
401 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
402 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
403
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
404 <dt><i>host</i> (str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
405 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
406 host name or IP address of the remote broker
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
407 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
408 <dt><i>port</i> (int)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
409 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
410 network port of the server host to connect to (default:
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
411 1883, using TLS: 8883)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
412 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
413 <dt><i>keepalive</i> (int)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
414 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
415 maximum period in seconds allowed between
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
416 communications with the broker
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
417 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
418 <dt><i>bindAddress</i> (str)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
419 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
420 IP address of a local network interface to bind
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
421 this client to
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
422 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
423 <dt><i>properties</i> (list of tuple of (str, str))</dt>
58
6c84ba9a9fcd Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 37
diff changeset
424 <dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
425 list of user properties to be sent with the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
426 subscription
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
427 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
428 <dt><i>clearWill</i> (bool)</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
429 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
430 flag indicating to clear the last will previously set
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
431 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
432 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
433 <a NAME="MqttClient.connectToServerWithOptions" ID="MqttClient.connectToServerWithOptions"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
434 <h4>MqttClient.connectToServerWithOptions</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
435 <b>connectToServerWithOptions</b>(<i>host, port=1883, bindAddress="", options=None, clearWill=False</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
436
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
437 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
438 Public method to connect to a remote MQTT broker.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
439 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
440 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
441
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
442 <dt><i>host</i> (str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
443 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
444 host name or IP address of the remote broker
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
445 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
446 <dt><i>port</i> (int)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
447 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
448 network port of the server host to connect to (default:
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
449 1883, using TLS: 8883)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
450 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
451 <dt><i>bindAddress</i> (str)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
452 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
453 IP address of a local network interface to bind
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
454 this client to
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
455 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
456 <dt><i>options</i> (dict)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
457 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
458 dictionary containing the connection options. This
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
459 dictionary should contain the keys "ClientId", "ConnectionTimeout",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
460 "Keepalive", "CleanSession", "Username", "Password", "WillTopic",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
461 "WillMessage", "WillQos", "WillRetain", "WillProperties",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
462 "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey",
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
463 "UserProperties".
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
464 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
465 <dt><i>clearWill</i> (bool)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
466 <dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
467 flag indicating to clear the last will previously set
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
468 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
469 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
470 <a NAME="MqttClient.disconnectFromServer" ID="MqttClient.disconnectFromServer"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
471 <h4>MqttClient.disconnectFromServer</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
472 <b>disconnectFromServer</b>(<i></i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
473
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
474 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
475 Public method to disconnect the client from the remote broker.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
476 </p>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
477 <a NAME="MqttClient.getProtocol" ID="MqttClient.getProtocol"></a>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
478 <h4>MqttClient.getProtocol</h4>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
479 <b>getProtocol</b>(<i></i>)
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
480
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
481 <p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
482 Public method to get the MQTT protocol version.
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
483 </p>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
484 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
485 <dt>Return:</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
486 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
487 MQTT protocol version in use
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
488 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
489 </dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
490 <dl>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
491 <dt>Return Type:</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
492 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
493 int
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
494 </dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
495 </dl>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
496 <a NAME="MqttClient.publish" ID="MqttClient.publish"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
497 <h4>MqttClient.publish</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
498 <b>publish</b>(<i>topic, payload=None, qos=0, retain=False, properties=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
499
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
500 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
501 Public method to publish to a topic.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
502 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
503 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
504
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
505 <dt><i>topic</i> (str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
506 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
507 topic to publish to
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
508 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
509 <dt><i>payload</i> (str, bytes, int or float)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
510 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
511 data to be published
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
512 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
513 <dt><i>qos</i> (int, one of 0, 1 or 2)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
514 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
515 quality of service
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
516 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
517 <dt><i>retain</i> (bool)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
518 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
519 flag indicating to set as the "last known good"/retained
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
520 message for the topic
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
521 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
522 <dt><i>properties</i> (list of tuple of (str, str))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
523 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
524 list of user properties to be sent with the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
525 subscription
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
526 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
527 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
528 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
529 <dt>Return:</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
530 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
531 message info object
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
532 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
533 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
534 <dl>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
535 <dt>Return Type:</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
536 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
537 mqtt.MQTTMessageInfo
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
538 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
539 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
540 <a NAME="MqttClient.reconnectToServer" ID="MqttClient.reconnectToServer"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
541 <h4>MqttClient.reconnectToServer</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
542 <b>reconnectToServer</b>(<i></i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
543
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
544 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
545 Public method to reconnect the client with the same parameters.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
546 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
547 <a NAME="MqttClient.setConnectionTimeout" ID="MqttClient.setConnectionTimeout"></a>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
548 <h4>MqttClient.setConnectionTimeout</h4>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
549 <b>setConnectionTimeout</b>(<i>timeout</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
550
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
551 <p>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
552 Public method to set the connection timeout value.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
553 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
554 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
555
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
556 <dt><i>timeout</i> (int)</dt>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
557 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
558 timeout value to be set in seconds
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
559 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
560 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
561 <a NAME="MqttClient.setLastWill" ID="MqttClient.setLastWill"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
562 <h4>MqttClient.setLastWill</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
563 <b>setLastWill</b>(<i>topic, payload=None, qos=0, retain=False, properties=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
564
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
565 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
566 Public method to set the last will of the client.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
567 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
568 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
569
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
570 <dt><i>topic</i> (str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
571 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
572 topic the will message should be published on
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
573 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
574 <dt><i>payload</i> (str, bytes, int or float)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
575 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
576 message to send as a will
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
577 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
578 <dt><i>qos</i> (int, one of 0, 1 or 2)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
579 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
580 quality of service level to use for the will
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
581 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
582 <dt><i>retain</i> (bool)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
583 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
584 flag indicating to set as the "last known good"/retained
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
585 message for the will topic
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
586 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
587 <dt><i>properties</i> (list of tuple of (str, str))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
588 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
589 list of user properties to be sent with the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
590 last will message
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
591 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
592 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
593 <a NAME="MqttClient.setMaxInflightMessages" ID="MqttClient.setMaxInflightMessages"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
594 <h4>MqttClient.setMaxInflightMessages</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
595 <b>setMaxInflightMessages</b>(<i>inflight=20</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
596
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
597 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
598 Public method to set the maximum number of messages with QoS > 0 that
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
599 can be part way through their network flow at once.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
600 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
601 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
602
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
603 <dt><i>inflight</i> (int)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
604 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
605 maximum number of messages in flight
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
606 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
607 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
608 <a NAME="MqttClient.setMaxQueuedMessages" ID="MqttClient.setMaxQueuedMessages"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
609 <h4>MqttClient.setMaxQueuedMessages</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
610 <b>setMaxQueuedMessages</b>(<i>queueSize=0</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
611
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
612 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
613 Public method to set the maximum number of messages with QoS > 0 that
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
614 can be pending in the outgoing message queue.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
615 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
616 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
617
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
618 <dt><i>queueSize</i> (int)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
619 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
620 maximum number of queued messages (0 = unlimited)
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
621 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
622 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
623 <a NAME="MqttClient.setTLS" ID="MqttClient.setTLS"></a>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
624 <h4>MqttClient.setTLS</h4>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
625 <b>setTLS</b>(<i>caCerts=None, certFile=None, keyFile=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
626
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
627 <p>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
628 Public method to enable secure connections and set the TLS parameters.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
629 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
630 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
631
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
632 <dt><i>caCerts</i> (str)</dt>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
633 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
634 path to the Certificate Authority certificates file
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
635 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
636 <dt><i>certFile</i> (str)</dt>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
637 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
638 PEM encoded client certificate file
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
639 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
640 <dt><i>keyFile</i> (str)</dt>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
641 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
642 PEM encoded private key file
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
643 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
644 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
645 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
646 <dt>Return:</dt>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
647 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
648 tuple containing a success flag and the error string of the
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
649 paho-mqtt library
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
650 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
651 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
652 <dl>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
653 <dt>Return Type:</dt>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
654 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
655 tuple of (bool, str)
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
656 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
657 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
658 <a NAME="MqttClient.setUserCredentials" ID="MqttClient.setUserCredentials"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
659 <h4>MqttClient.setUserCredentials</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
660 <b>setUserCredentials</b>(<i>username, password=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
661
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
662 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
663 Public method to set the user name and optionally the password.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
664 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
665 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
666
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
667 <dt><i>username</i> (str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
668 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
669 user name to be set
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
670 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
671 <dt><i>password</i> (str)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
672 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
673 optional password
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
674 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
675 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
676 <a NAME="MqttClient.setUserData" ID="MqttClient.setUserData"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
677 <h4>MqttClient.setUserData</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
678 <b>setUserData</b>(<i>userdata</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
679
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
680 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
681 Public method to set the user data.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
682 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
683 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
684
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
685 <dt><i>userdata</i> (any)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
686 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
687 user data
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
688 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
689 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
690 <a NAME="MqttClient.startLoop" ID="MqttClient.startLoop"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
691 <h4>MqttClient.startLoop</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
692 <b>startLoop</b>(<i></i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
693
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
694 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
695 Public method to start the MQTT client loop.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
696 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
697 <a NAME="MqttClient.stopLoop" ID="MqttClient.stopLoop"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
698 <h4>MqttClient.stopLoop</h4>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
699 <b>stopLoop</b>(<i></i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
700
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
701 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
702 Public method to stop the MQTT client loop.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
703 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
704 <a NAME="MqttClient.subscribe" ID="MqttClient.subscribe"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
705 <h4>MqttClient.subscribe</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
706 <b>subscribe</b>(<i>topic, qos=0, properties=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
707
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
708 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
709 Public method to subscribe to topics with quality of service.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
710 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
711 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
712
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
713 <dt><i>topic</i> (str or tuple of (str, int) or list of tuple of (str, int))</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
714 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
715 single topic to subscribe to or a tuple with a topic
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
716 and a QoS or a list of tuples with a topic and a QoS each
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
717 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
718 <dt><i>qos</i> (int, one of 0, 1 or 2)</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
719 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
720 quality of service
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
721 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
722 <dt><i>properties</i> (list of tuple of (str, str))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
723 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
724 list of user properties to be sent with the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
725 subscription
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
726 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
727 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
728 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
729 <dt>Return:</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
730 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
731 tuple containing the result code and the message ID
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
732 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
733 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
734 <dl>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
735 <dt>Return Type:</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
736 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
737 tuple of (int, int)
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
738 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
739 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
740 <a NAME="MqttClient.unsubscribe" ID="MqttClient.unsubscribe"></a>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
741 <h4>MqttClient.unsubscribe</h4>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
742 <b>unsubscribe</b>(<i>topic, properties=None</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
743
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
744 <p>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
745 Public method to unsubscribe topics.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
746 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
747 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
748
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
749 <dt><i>topic</i> (str or list of str)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
750 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
751 topic or list of topics to unsubscribe
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
752 </dd>
108
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
753 <dt><i>properties</i> (list of tuple of (str, str))</dt>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
754 <dd>
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
755 list of user properties to be sent with the
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
756 subscription
d7808a71b234 Updated source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 92
diff changeset
757 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
758 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
759 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
760 <dt>Return:</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
761 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
762 tuple containing the result code and the message ID
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
763 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
764 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
765 <dl>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
766 <dt>Return Type:</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
767 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
768 tuple of (int, int)
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
769 </dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
770 </dl>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
771 <div align="right"><a href="#top">Up</a></div>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
772 <hr />
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
773 <hr />
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
774 <a NAME="mqttConnackMessage" ID="mqttConnackMessage"></a>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
775 <h2>mqttConnackMessage</h2>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
776 <b>mqttConnackMessage</b>(<i>connackCode</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
777
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
778 <p>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
779 Module function to get the string associated with a CONNACK result.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
780 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
781 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
782
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
783 <dt><i>connackCode</i> (int)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
784 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
785 result code of the connection request
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
786 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
787 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
788 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
789 <dt>Return:</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
790 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
791 textual representation for the result code
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
792 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
793 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
794 <dl>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
795 <dt>Return Type:</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
796 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
797 str
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
798 </dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
799 </dl>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
800 <div align="right"><a href="#top">Up</a></div>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
801 <hr />
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
802 <hr />
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
803 <a NAME="mqttErrorMessage" ID="mqttErrorMessage"></a>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
804 <h2>mqttErrorMessage</h2>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
805 <b>mqttErrorMessage</b>(<i>mqttErrno</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
806
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
807 <p>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
808 Module function to get the error string associated with an MQTT error
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
809 number.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
810 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
811 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
812
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
813 <dt><i>mqttErrno</i> (int)</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
814 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
815 result code of a MQTT request
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
816 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
817 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
818 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
819 <dt>Return:</dt>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
820 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
821 textual representation of the result code
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
822 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
823 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
824 <dl>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
825 <dt>Return Type:</dt>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
826 <dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
827 str
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
828 </dd>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
829 </dl>
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
830 <div align="right"><a href="#top">Up</a></div>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
831 <hr />
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
832 <hr />
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
833 <a NAME="mqttLogLevelString" ID="mqttLogLevelString"></a>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
834 <h2>mqttLogLevelString</h2>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
835 <b>mqttLogLevelString</b>(<i>mqttLogLevel, isMqttLogLevel=True</i>)
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
836
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
837 <p>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
838 Module function to get the log level string associated with a log level.
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
839 </p>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
840 <dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
841
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
842 <dt><i>mqttLogLevel</i> (int)</dt>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
843 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
844 log level of the paho-mqtt client
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
845 </dd>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
846 <dt><i>isMqttLogLevel</i> (bool)</dt>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
847 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
848 flag indicating a MQTT log level is given (if
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
849 False it is the MqttClient variant, i.e. Debug being lowest)
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
850 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
851 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
852 <dl>
87
fe391e485681 Prepared new release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 78
diff changeset
853 <dt>Return:</dt>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
854 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
855 textual representation of the log level
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
856 </dd>
78
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
857 </dl>
a22328182bc2 Removed support for Python2.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
858 <dl>
37
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
859 <dt>Return Type:</dt>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
860 <dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
861 str
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
862 </dd>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
863 </dl>
8bc357057af3 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 12
diff changeset
864 <div align="right"><a href="#top">Up</a></div>
12
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
865 <hr />
e0175cb7c5d5 Added source docu, license and changelog files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
866 </body></html>

eric ide

mercurial