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

<!DOCTYPE html>
<html><head>
<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttReasonCodes</h1>

<p>
Module implementing the translated MQTT v5 reason codes.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>MqttReasonCodeNames</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#mqttReasonCode">mqttReasonCode</a></td>
<td>Function to get the readable reason code string given the result code and the packet type.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="mqttReasonCode" ID="mqttReasonCode"></a>
<h2>mqttReasonCode</h2>
<b>mqttReasonCode</b>(<i>rc, packetType</i>)

<p>
    Function to get the readable reason code string given the result code and
    the packet type.
</p>
<dl>

<dt><i>rc</i> (int)</dt>
<dd>
result code
</dd>
<dt><i>packetType</i> (PacketTypes (= int))</dt>
<dd>
packet type
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
message associated with the reason code and packet type
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>