mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
84 lines
5.6 KiB
HTML
Executable File
84 lines
5.6 KiB
HTML
Executable File
<!--
|
|
Copyright JS Foundation and other contributors, http://js.foundation
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
-->
|
|
|
|
<script type="text/x-red" data-help-name="mqtt in">
|
|
<p> Stellt eine Verbindung zu einem MQTT-Broker her und subskribiert Nachrichten zu dem angegebenen Topic. </p>
|
|
<h3> Ausgaben </h3>
|
|
<dl class="message-properties">
|
|
<dt> payload <span class="property-type"> Zeichenfolge | Buffer </span> </dt>
|
|
<dd> eine Zeichenfolge, sofern sie nicht als binärer Buffer erkannt wird. </dd>
|
|
<dt> topic <span class="property-type"> Zeichenfolge </span> </dt>
|
|
<dd> Das MQTT-Topic verwendet <code>/</code> als Trennzeichen für die Hierarchie. </dd>
|
|
<dt> qos <span class="property-type"> Zahl </span> </dt>
|
|
<dd> 0: fire und forget 1: mindestens einmal 2: einmal und nur einmal. </dd>
|
|
<dt> retain <span class="property-type"> boolean </span> </dt>
|
|
<dd> true gibt an, dass die Nachricht beibehalten wurde und älter sein kann. </dd>
|
|
</dl>
|
|
<h3> Details </h3>
|
|
Das Subscribete Topic kann MQTT-Platzhalterzeichen, + für eine Ebene, # für mehrere Ebenen umfassen. </p>
|
|
<p> Dieser Node erfordert eine Verbindung zu einem MQTT-Broker, der über die Auswahlliste selektiert werden kann.
|
|
Eine neue Konfiguration wird durch Klicken auf das Stiftsymbol erstellt. </p>
|
|
<p> Mehrere MQTT-Nodes (in oder out) können bei Bedarf dieselbe Brokerverbindung nutzen. </p>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="mqtt out">
|
|
<p>Stellt eine Verbindung zu einem MQTT-Broker her und publiziert Nachrichten.</p>
|
|
<h3>Eingaben</h3>
|
|
<dl class="message-properties">
|
|
<dt>payload <span class="property-type">Zeichenfolge | Buffer</span></dt>
|
|
<dd>die meisten Benutzer präferieren einfach Textnachrichten aber es können auch binäre Buffer publiziert werden.</dd>
|
|
<dt class="optional">topic <span class="property-type">string</span></dt>
|
|
<dd> Das MQTT-Topic zu dem publiziert wird. Es verwendet <code>/</code> als Trennzeichen für die Hierarchie.</dd>
|
|
|
|
<dt class="optional">qos <span class="property-type">number</span></dt>
|
|
<dd>0: fire und forget 1: mindestens einmal 2: einmal und nur einmal. Default 0.</dd>
|
|
|
|
<dt class="optional">retain <span class="property-type">boolean</span></dt>
|
|
<dd>Wenn dieser Wert auf <code>true</code> gesetzt ist, wird die Nachricht auf dem Broker gehalten. Default false.</dd>
|
|
</dl>
|
|
<h3>Details</h3>
|
|
<code> msg.payload </code> wird als Nutzdaten der zu veröffentlichenden Nachricht verwendet.
|
|
Wenn er ein Objekt enthält, wird es in eine JSON-Zeichenfolge konvertiert, bevor es gesendet wird.
|
|
Wenn er einen binären Buffer enthält, wird die Nachricht unverändert veröffentlicht. </p>
|
|
<p> Das verwendete Topic kann im Node konfiguriert werden oder, falls es leer gelassen wird,
|
|
durch <code>msg.topic</code> festgelegt werden. </p>
|
|
<p> Ebenso können die QoS- und retain-Werte im Node konfiguriert werden oder, falls vorhanden,
|
|
durch <code>msg.qos</code> bzw. <code>msg.retain</code> festgelegt werden.
|
|
Sie können eine zuvor auf einem Topic auf dem Broker beibehalten Nachricht löschen,
|
|
indem eine leere Nachricht an dieses Topic gesendet wird und die Markierung 'retain' gesetzt ist.</p>
|
|
<p>Dieser Node erfordert eine Verbindung zu einem MQTT-Broker, der über die Auswahlliste selektiert werden kann.
|
|
Eine neue Konfiguration wird durch Klicken auf das Stiftsymbol erstellt.</p>
|
|
<p>Mehrere MQTT-Nodes (in oder out) können bei Bedarf dieselbe Brokerverbindung nutzen.</p>
|
|
</script>
|
|
|
|
<script type="text/x-red" data-help-name="mqtt-broker">
|
|
<p> Konfiguration für eine Verbindung zu einem MQTT-Broker. </p>
|
|
<p> Diese Konfiguration erstellt eine Verbindung zu einem Broker, die anschließend von den
|
|
Nodes <code>MQTT In</code> und <code>MQTT Out</code> verwendet werden. </p>
|
|
<p> Der Node generiert eine beliebige Client-ID, falls sie nicht definiert ist und der Node für die Verwendung
|
|
einer bereinigten Sitzung (Clean Session) konfiguriert ist. Wenn eine Client-ID festgelegt ist,
|
|
muss sie für den Broker, zu dem Sie eine Verbindung herstellen, eindeutig sein. </p>
|
|
<h3> Nachricht bei Verbindungsaufbau </h3>
|
|
<p> Dies ist eine Nachricht, die vom Broker in dem konfigurierten Topic veröffentlicht wird, wenn die Verbindung hergestellt wurde. </p>
|
|
<h3> Nachricht bei Verbindungsbeendigung </h3>
|
|
<p> Dies ist eine Nachricht, die vom Broker in dem konfigurierten Topic veröffentlicht wird, wenn die Verbindung normal geschlossen wird -
|
|
entweder durch erneute Implementierung des Nodes oder durch Herunterfahren von Node-RED. </p>
|
|
<h3> Nachricht bei unerwarteter Verbindungsbeendigung</h3>
|
|
<p> Dies ist eine Nachricht, die vom Broker in dem konfigurierten Topic veröffentlicht wird,
|
|
wenn die Verbindung unerwartet geschlossen wird
|
|
<h3> WebSockets </h3>
|
|
<p> Der Node kann für die Verwendung einer WebSocket-Verbindung konfiguriert werden.
|
|
Dazu wird im Server-Feld eine vollständigen URI für die Verbindung angegeben. Beispiel: </p>
|
|
<pre> ws://example.com:4000/mqtt </pre>
|
|
</script>
|