Update mqtt nodes for v5

This commit is contained in:
Nick O'Leary
2021-02-25 15:49:56 +00:00
parent 16088b8a08
commit 255b8f2005
4 changed files with 586 additions and 449 deletions

View File

@@ -350,8 +350,9 @@
"retain": "Retain",
"clientid": "Client ID",
"port": "Port",
"keepalive": "Keepalive time(s)",
"keepalive": "Keep Alive",
"cleansession": "Use clean session",
"cleanstart": "Use clean start",
"use-tls": "Enable secure (SSL/TLS) connection",
"tls-config":"TLS Configuration",
"verify-server-cert":"Verify server certificate",
@@ -361,23 +362,23 @@
"flags": "Flags",
"nl": "Do not receive messages published by this client",
"rap": "Keep retain flag of original publish",
"rh": "Retain Handling",
"rh0": "0, Always send retained messages",
"rh1": "1, Send retained messages for new subscription",
"rh2": "2, Never send retained messages",
"rh": "Retained message handling ",
"rh0": "Send retained messages",
"rh1": "Only send for new subscriptions",
"rh2": "Do not send",
"responseTopic": "Response topic",
"contentType": "Content Type",
"correlationData": "Correlation Data",
"messageExpiryInterval": "Expiry (secs)",
"expiry": "Expiry (secs)",
"sessionExpiry": "Session Expiry (secs)",
"topicAlias": "Alias",
"payloadFormatIndicator": "Format",
"payloadFormatIndicatorFalse": "unspecified bytes (Default)",
"payloadFormatIndicatorTrue": "UTF-8 encoded payload",
"protocolVersion": "Protocol Version",
"protocolVersion": "Protocol",
"protocolVersion3": "MQTT V3.1 (legacy)",
"protocolVersion4": "MQTT V3.1.1",
"protocolVersion5": "MQTT V5",
"sessionExpiryInterval": "Expiry(s)",
"topicAliasMaximum": "Alias Max",
"maximumPacketSize": "Max Packet Size",
"receiveMaximum": "Receive Max"
@@ -988,4 +989,4 @@
"unexpected" : "unexpected mode",
"no-parts" : "no parts property in message"
}
}
}

View File

@@ -23,6 +23,17 @@
<dd>0, fire and forget - 1, at least once - 2, once and once only.</dd>
<dt>retain <span class="property-type">boolean</span></dt>
<dd>true indicates the message was retained and may be old.</dd>
<dt class="optional">responseTopic <span class="property-type">string</span></dt>
<dd><b>MQTTv5</b>: the MQTT response topic for the message</dd>
<dt class="optional">correlationData <span class="property-type">Buffer</span></dt>
<dd><b>MQTTv5</b>: the correlation data for the message</dd>
<dt class="optional">contentType <span class="property-type">string</span></dt>
<dd><b>MQTTv5</b>: the content-type of the payload</dd>
<dt class="optional">userProperties <span class="property-type">object</span></dt>
<dd><b>MQTTv5</b>: any user properties of the message</dd>
<dt class="optional">messageExpiryInterval <span class="property-type">number</span></dt>
<dd><b>MQTTv5</b>: the expiry time, in seconds, of the message</dd>
</dl>
<h3>Details</h3>
The subscription topic can include MQTT wildcards, + for one level, # for multiple levels.</p>
@@ -37,15 +48,24 @@
<dl class="message-properties">
<dt>payload <span class="property-type">string | buffer</span></dt>
<dd> the payload to publish. If this property is not set, no message will be sent. To send a blank message, set this property to an empty String.</dd>
<dt class="optional">topic <span class="property-type">string</span></dt>
<dd> the MQTT topic to publish to.</dd>
<dt class="optional">qos <span class="property-type">number</span></dt>
<dd>0, fire and forget - 1, at least once - 2, once and once only. Default 0.</dd>
<dt class="optional">retain <span class="property-type">boolean</span></dt>
<dd>set to true to retain the message on the broker. Default false.</dd>
<dt class="optional">responseTopic <span class="property-type">string</span></dt>
<dd><b>MQTTv5</b>: the MQTT response topic for the message</dd>
<dt class="optional">correlationData <span class="property-type">Buffer</span></dt>
<dd><b>MQTTv5</b>: the correlation data for the message</dd>
<dt class="optional">contentType <span class="property-type">string</span></dt>
<dd><b>MQTTv5</b>: the content-type of the payload</dd>
<dt class="optional">userProperties <span class="property-type">object</span></dt>
<dd><b>MQTTv5</b>: any user properties of the message</dd>
<dt class="optional">messageExpiryInterval <span class="property-type">number</span></dt>
<dd><b>MQTTv5</b>: the expiry time, in seconds, of the message</dd>
<dt class="optional">topicAlias <span class="property-type">number</span></dt>
<dd><b>MQTTv5</b>: the MQTT topic alias to use</dd>
</dl>
<h3>Details</h3>
<code>msg.payload</code> is used as the payload of the published message.