mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
Update 10-mqtt.html
This commit is contained in:
xuyu0v0
GitHub
parent
b705b456ff
commit
38c09ada39
@ -11,7 +11,7 @@
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
<script type="text/x-red" data-help-name="mqtt in">
|
||||
<script type="text/html" data-help-name="mqtt in">
|
||||
<p>连接到MQTT代理并订阅来自指定主题的消息。</p>
|
||||
<h3>输出</h3>
|
||||
<dl class="message-properties">
|
||||
@ -23,14 +23,51 @@
|
||||
<dd>QoS服务质量：0, 最多一次； 1, 最少一次； 2, 只一次。</dd>
|
||||
<dt>retain <span class="property-type">布尔值</span></dt>
|
||||
<dd>值为true时表示消息已保留且可能是旧的。</dd>
|
||||
<dt class="optional">responseTopic <span class="property-type">字符串</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的 MQTT 响应主题</dd>
|
||||
<dt class="optional">correlationData <span class="property-type">Buffer</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的关联数据</dd>
|
||||
<dt class="optional">contentType <span class="property-type">字符串</span></dt>
|
||||
<dd><b>MQTTv5</b>: 有效负载的内容类型</dd>
|
||||
<dt class="optional">userProperties <span class="property-type">object</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的任何用户属性</dd>
|
||||
<dt class="optional">messageExpiryInterval <span class="property-type">数值</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的过期时间，以秒为单位</dd>
|
||||
</dl>
|
||||
<h3>详细</h3>
|
||||
<p>订阅主题可以包括MQTT通配符（+：一个级别，＃：多个级别）。</p>
|
||||
<p>使用该节点您首先需要建立与MQTT代理的连接。通过单击铅笔图标来进行配置。</p>
|
||||
<p>如有需要，几个MQTT节点（输入或输出）可以共享相同的代理连接。</p>
|
||||
<h4>动态订阅</h4>
|
||||
可以将节点配置为动态控制 MQTT 连接及其订阅。 启用后，节点将有一个输入，并且可以通过向其传递消息来控制。
|
||||
<h3>输入</h3>
|
||||
<p>这些仅在节点配置为动态订阅时适用。</p>
|
||||
<dl class="message-properties">
|
||||
<dt>action <span class="property-type">字符串</span></dt>
|
||||
<dd>节点应执行的操作的名称。 可用的操作有: <code>"connect"</code>,
|
||||
<code>"disconnect"</code>, <code>"subscribe"</code>和<code>"unsubscribe"</code>.</dd>
|
||||
<dt class="optional">topic <span class="property-type">字符串|object|数组</span></dt>
|
||||
<dd>对于<code>"subscribe"</code>和<code>"unsubscribe"</code> 操作,该属性提供了主题。 它可以设置为:<ul>
|
||||
<li>包含主题过滤器的字符串</li>
|
||||
<li>包含<code>topic</code>和<code>qos</code>属性的对象</li>
|
||||
<li>用于处理多个主题的字符串或对象数组</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="optional">broker <span class="property-type">broker</span> </dt>
|
||||
<dd>对于<code>"connect"</code> 操作,此属性可以覆盖任何单独的代理配置设置，包括: <ul>
|
||||
<li><code>broker</code></li>
|
||||
<li><code>port</code></li>
|
||||
<li><code>url</code> - 覆盖代理/端口以提供完整的连接url</li>
|
||||
<li><code>username</code></li>
|
||||
<li><code>password</code></li>
|
||||
</ul>
|
||||
<p>如果设置了此属性并且代理已连接，则会记录错误，除非它设置了 <code>force</code> 属性 - 在这种情况下，它将与代理断开连接，应用新设置并重新连接。</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="mqtt out">
|
||||
<script type="text/html" data-help-name="mqtt out">
|
||||
<p>连接到MQTT代理并发布消息。</p>
|
||||
<h3>输入</h3>
|
||||
<dl class="message-properties">
|
||||
@ -42,9 +79,20 @@
|
||||
|
||||
<dt class="optional">qos <span class="property-type">number</span></dt>
|
||||
<dd>QoS服务质量：0, 最多一次； 1, 最少一次； 2, 只一次。默认值为0。</dd>
|
||||
|
||||
<dt class="optional">retain <span class="property-type">布尔值</span></dt>
|
||||
<dd>设置为<code>true</code>来将消息保留在代理上。默认值为<code>false</code>。</dd>
|
||||
<dd>设置为true来将消息保留在代理上。默认值为false。</dd>
|
||||
<dt class="optional">responseTopic <span class="property-type">字符串</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的 MQTT 响应主题</dd>
|
||||
<dt class="optional">correlationData <span class="property-type">Buffer</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的关联数据</dd>
|
||||
<dt class="optional">contentType <span class="property-type">字符串</span></dt>
|
||||
<dd><b>MQTTv5</b>: 有效负载的内容类型</dd>
|
||||
<dt class="optional">userProperties <span class="property-type">object</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的任何用户属性</dd>
|
||||
<dt class="optional">messageExpiryInterval <span class="property-type">数值</span></dt>
|
||||
<dd><b>MQTTv5</b>: 消息的过期时间，以秒为单位</dd>
|
||||
<dt class="optional">topicAlias <span class="property-type">数值</span></dt>
|
||||
<dd><b>MQTTv5</b>: 要使用的 MQTT 主题别名</dd>
|
||||
</dl>
|
||||
<h3>详细</h3>
|
||||
<p><code>msg.payload</code>用作已发布消息的有效载荷。如果包含Object，则会在发送之前将其转换为JSON字符串。如果它包含二进制buffer，则消息将按原样发布。</p>
|
||||
@ -52,9 +100,28 @@
|
||||
<p>同样，可以在节点中配置QoS和保留值，或者如果保留空白，则分别由<code>msg.qos</code>和<code>msg.retain</code>设置。要清除先前存储在代理中的主题，请设置保留标志并向该主题发布空消息。</p>
|
||||
<p>该节点需要与要配置的MQTT代理的连接。通过单击铅笔图标进行配置。</p>
|
||||
<p>如果需要，几个MQTT节点（输入或输出）可以共享相同的代理连接。</p>
|
||||
|
||||
<h4>动态控制</h4>
|
||||
节点共享的连接可以动态控制。 如果节点收到以下控制消息之一，它也不会发布消息负载。
|
||||
<h3>输入</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>action <span class="property-type">字符串</span></dt>
|
||||
<dd>节点应执行的操作的名称。 可用的操作有：<code>"connect"</code>和<code>"disconnect"</code>.</dd>
|
||||
<dt class="optional">broker <span class="property-type">broker</span> </dt>
|
||||
<dd>对于<code>"connect"</code>操作, 此属性可以覆盖任何单独的代理配置设置，包括: <ul>
|
||||
<li><code>broker</code></li>
|
||||
<li><code>port</code></li>
|
||||
<li><code>url</code> - 覆盖代理/端口以提供完整的连接url</li>
|
||||
<li><code>username</code></li>
|
||||
<li><code>password</code></li>
|
||||
</ul>
|
||||
<p>如果设置了此属性并且代理已连接，则会记录错误，除非它设置了 <code>force</code> 属性 - 在这种情况下，它将与代理断开连接，应用新设置并重新连接。</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="mqtt-broker">
|
||||
<script type="text/html" data-help-name="mqtt-broker">
|
||||
<p>与MQTT代理的连接设置。</p>
|
||||
<p>创建与代理的连接设置。可以在<code>MQTT In</code>和<code>MQTT Out</code>节点中重复利用这些设置。</p>
|
||||
<p>如果未为该节点设置客户端ID，并且设置了会话初始化，则将生成一个随机客户端ID。设置客户端ID时，请确保它对于连接目标处的代理是唯一的。</p>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user