MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes.html

branch
eric7
changeset 108
d7808a71b234
child 115
357257ad48d2
equal deleted inserted replaced
107:639445679db1 108:d7808a71b234
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</h1>
24
25 <p>
26 Module implementing the translated MQTT v5 reason codes.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>MqttReasonCodeNames</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36 <tr><td>None</td></tr>
37 </table>
38 <h3>Functions</h3>
39
40 <table>
41
42 <tr>
43 <td><a href="#mqttReasonCode">mqttReasonCode</a></td>
44 <td>Function to get the readable reason code string given the result code and the packet type.</td>
45 </tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="mqttReasonCode" ID="mqttReasonCode"></a>
50 <h2>mqttReasonCode</h2>
51 <b>mqttReasonCode</b>(<i>rc, packetType</i>)
52
53 <p>
54 Function to get the readable reason code string given the result code and
55 the packet type.
56 </p>
57 <dl>
58
59 <dt><i>rc</i> (int)</dt>
60 <dd>
61 result code
62 </dd>
63 <dt><i>packetType</i> (PacketTypes (= int))</dt>
64 <dd>
65 packet type
66 </dd>
67 </dl>
68 <dl>
69 <dt>Return:</dt>
70 <dd>
71 message associated with the reason code and packet type
72 </dd>
73 </dl>
74 <dl>
75 <dt>Return Type:</dt>
76 <dd>
77 str
78 </dd>
79 </dl>
80 <div align="right"><a href="#top">Up</a></div>
81 <hr />
82 </body></html>

eric ide

mercurial