node-red
This commit is contained in:
@@ -0,0 +1,19 @@
|
||||
<!--
|
||||
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/html" data-help-name="tls-config">
|
||||
<p>Konfigurationsoptionen für TLS-Verbindungen.</p>
|
||||
</script>
|
||||
@@ -0,0 +1,22 @@
|
||||
<!--
|
||||
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/html" data-help-name="http proxy">
|
||||
<p>Konfigurationsoptionen für HTTP-Proxy.</p>
|
||||
<h3>Details</h3>
|
||||
<p>Wenn auf einen Host zugegriffen wird, der auf der Liste der zu ignorierenden Hosts steht,
|
||||
wird kein Proxy benutzt.</p>
|
||||
</script>
|
||||
@@ -0,0 +1,140 @@
|
||||
<!--
|
||||
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/html" data-help-name="mqtt in">
|
||||
<p>Verbindungsherstellung zu einem MQTT-Broker und Abonnement von Topic-Nachrichten.</p>
|
||||
<h3>Ausgangsdaten</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string | buffer</span></dt>
|
||||
<dd>Zeichenfolge, sofern sie nicht als binärer Puffer (buffer) erkannt wurde.</dd>
|
||||
<dt>topic <span class="property-type">string</span></dt>
|
||||
<dd>MQTT-Topic mit / (Schrägstrich) als Hierarchie-Trennzeichen.</dd>
|
||||
<dt>qos <span class="property-type">number</span></dt>
|
||||
<dd>QoS (Quality of Service)<br/>
|
||||
0: Einmal gesendet ohne Empfangsgarantie (fire und forget)<br/>
|
||||
1: Garantiert mindestens einmal empfangen (at least once)<br/>
|
||||
2: Garantiert exakt einmal empfangen (once and once only).</dd>
|
||||
<dt>retain <span class="property-type">boolean</span></dt>
|
||||
<dd>Bei <code>true</code> kann es eine aufbewahrte ältere Nachricht sein.</dd>
|
||||
|
||||
<dt class="optional">responseTopic <span class="property-type">string</span></dt>
|
||||
<dd><b>MQTTv5</b>: MQTT-Antwort-Topic der Nachricht.</dd>
|
||||
<dt class="optional">correlationData <span class="property-type">buffer</span></dt>
|
||||
<dd><b>MQTTv5</b>: Korrelationsdaten der Nachricht.</dd>
|
||||
<dt class="optional">contentType <span class="property-type">string</span></dt>
|
||||
<dd><b>MQTTv5</b>: Inhaltstyp der Nutzdaten (Payload).</dd>
|
||||
<dt class="optional">userProperties <span class="property-type">object</span></dt>
|
||||
<dd><b>MQTTv5</b>: Alle Benutzer-Eigenschaften der Nachricht.</dd>
|
||||
<dt class="optional">messageExpiryInterval <span class="property-type">number</span></dt>
|
||||
<dd><b>MQTTv5</b>: Ablaufzeit der Nachricht in Sekunden.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>Das abonnierte Topic darf MQTT-Platzhalterzeichen (wildcards) enthalten (+ für eine Ebene und # für mehrere Ebenen).</p>
|
||||
<p>Diese Node erfordert eine Verbindung zu einem MQTT-Broker, der über die Auswahlliste selektiert werden kann. Eine neue Verbindung wird durch Klicken auf das Stiftsymbol erstellt.</p>
|
||||
<p>Mehrere MQTT-Nodes (in oder out) können bei Bedarf dieselbe Broker-Verbindung nutzen.</p>
|
||||
<h4>Dynamische Steuerung</h4>
|
||||
Die von der Node genutzte Verbindung kann dynamisch gesteuert werden, wenn die MQTT-Node eine der folgenden Nachrichten erhält. Die Payload dieser Nachrichten werden nicht veröffentlicht.
|
||||
<h4>Eingangsdaten</h4>
|
||||
<p>Nur Verfügbar, wenn die Node für dynamische Abonnements konfiguriert wurde.</p>
|
||||
<dl class="message-properties">
|
||||
<dt>action <span class="property-type">string</span></dt>
|
||||
<dd>Der Name der Aktion, die die MQTT-Node ausführen soll. Verfügbare Aktionen sind: <code>"connect"</code>, <code>"disconnect"</code>, <code>"getSubscriptions"</code>, <code>"subscribe"</code> und <code>"unsubscribe"</code>.</dd>
|
||||
<dt class="optional">topic <span class="property-type">string|object|array</span></dt>
|
||||
<dd>Bei den Aktionen <code>"subscribe"</code> und <code>"unsubscribe"</code> gibt diese Eigenschaft die MQTT-Topic an. Dabei kann es sich um Folgendes handeln:
|
||||
<ul>
|
||||
<li>eine Zeichenfolge, die den Topic-Filter enthält</li>
|
||||
<li>ein Objekt mit den Eigenschaften <code>topic</code> und <code>qos</code></li>
|
||||
<li>ein Array aus Zeichenfolgen oder Objekten, um mehrere Topics gleichzeitig zu verwalten</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="optional">broker <span class="property-type">broker</span> </dt>
|
||||
<dd>Für die Aktion <code>"connect"</code> kann diese Eigenschaft jede der einzelnen Broker-Konfigurationseinstellungen überschreiben, einschließlich: <ul>
|
||||
<li><code>broker</code></li>
|
||||
<li><code>port</code></li>
|
||||
<li><code>url</code> - überschreibt Broker/Port, um eine vollständige Verbindungs-URL bereitzustellen</li>
|
||||
<li><code>username</code></li>
|
||||
<li><code>password</code></li>
|
||||
</ul>
|
||||
<p>Wenn diese Eigenschaft gesetzt ist und der Broker bereits verbunden ist, wird ein Fehler protokolliert, es sei denn, die Eigenschaft <code>force</code> gesetzt - in diesem Fall wird die Verbindung zum Broker getrennt, die neuen Einstellungen angewendet und erneut verbunden.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="mqtt out">
|
||||
<p>Verbindungsherstellung zu einem MQTT-Broker und publizieren von Topic-Nachrichten.</p>
|
||||
<h3>Eingangsdaten</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string | buffer</span></dt>
|
||||
<dd>Zu publiziernde Nutzdaten.<br/>
|
||||
Wenn nicht gesetzt wird keine Nachricht gesendet.
|
||||
Um eine leere Nachricht zu senden, muss eine leere Zeichenfolge (string) übergeben werden.</dd>
|
||||
<dt class="optional">topic <span class="property-type">string</span></dt>
|
||||
<dd>MQTT-Topic mit / (Schrägstrich) als Hierarchie-Trennzeichen.</dd>
|
||||
<dt class="optional">qos <span class="property-type">number</span></dt>
|
||||
<dd>QoS (Quality of Service)<br/>
|
||||
0: Einmal gesendet ohne Empfangsgarantie (fire und forget)<br/>
|
||||
1: Garantiert mindestens einmal empfangen (at least once)<br/>
|
||||
2: Garantiert exakt einmal empfangen (once and once only).</dd>
|
||||
<dt class="optional">retain <span class="property-type">boolean</span></dt>
|
||||
<dd>Bei <code>true</code> wird die Nachricht beim Broker aufbewahrt.
|
||||
Standard (default) ist <code>false</code>.</dd>
|
||||
<dt class="optional">responseTopic <span class="property-type">string</span></dt>
|
||||
<dd><b>MQTTv5</b>: MQTT-Antwort-Topic für die Nachricht.</dd>
|
||||
<dt class="optional">correlationData <span class="property-type">buffer</span></dt>
|
||||
<dd><b>MQTTv5</b>: Korrelationsdaten für die Nachricht.</dd>
|
||||
<dt class="optional">contentType <span class="property-type">string</span></dt>
|
||||
<dd><b>MQTTv5</b>: Inhaltstyp der Nutzdaten (Payload).</dd>
|
||||
<dt class="optional">userProperties <span class="property-type">object</span></dt>
|
||||
<dd><b>MQTTv5</b>: Alle Benutzer-Eigenschaften der Nachricht.</dd>
|
||||
<dt class="optional">messageExpiryInterval <span class="property-type">number</span></dt>
|
||||
<dd><b>MQTTv5</b>: Ablaufzeit der Nachricht in Sekunden.</dd>
|
||||
<dt class="optional">topicAlias <span class="property-type">number</span></dt>
|
||||
<dd><b>MQTTv5</b>: Der zu benutzende MQTT-Topic-Alias.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p><code>msg.payload</code> wird als Nutzdaten (Payload) der zu publizierenden Nachricht verwendet.
|
||||
Wenn es ein Objekt enthält, wird es vorm Senden in eine JSON-Zeichenfolge (string) konvertiert.
|
||||
Wenn es einen binären Puffer (buffer) enthält, wird die Nachricht unverändert gesendet.</p>
|
||||
<p>Das Topic kann im Node eingestellt werden oder, falls leer gelassen,
|
||||
durch <code>msg.topic</code> vorgegeben werden.</p>
|
||||
<p>Ebenso können die QoS- und Retain-Werte im Node eingestellt werden oder, falls leer gelassen,
|
||||
durch <code>msg.qos</code> bzw. <code>msg.retain</code> vorgegeben werden.
|
||||
Um ein beim Broker vorgehaltenes Topic zu löschen,
|
||||
kann eine leere Nachricht mit dem Topic und Retain gleich <code>true</code> gesendet werden.</p>
|
||||
<p>Dieser Node erfordert eine Verbindung zu einem MQTT-Broker, der über die Auswahlliste selektiert werden kann.
|
||||
Eine neue Verbindung wird durch Klicken auf das Stiftsymbol erstellt.</p>
|
||||
<p>Mehrere MQTT-Nodes (in oder out) können bei Bedarf dieselbe Broker-Verbindung nutzen.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="mqtt-broker">
|
||||
<p>Konfiguration der Verbindung zu einem MQTT-Broker.</p>
|
||||
<p>Diese Konfiguration erstellt eine einzelne Verbindung zu einem Broker,
|
||||
welche anschließend von den mqtt in- und
|
||||
mqtt out-Nodes verwendet werden.</p>
|
||||
<p>Der Node generiert eine beliebige Client-ID, falls sie nicht vorgegeben ist und der
|
||||
Node eine bereinigte Sitzung (clean session) verwenden soll.
|
||||
Wenn eine Client-ID vorgegeben wird, muss sie für den Broker eindeutig sein, zu dem die Verbindung hergestellt werden soll.</p>
|
||||
<h3>Nachricht bei Verbindungsaufbau</h3>
|
||||
<p>Diese Nachricht wird vom Broker mit dem eingestellten Topic publiziert, wenn die Verbindung hergestellt wurde.</p>
|
||||
<h3>Nachricht vor Verbindungsabbau</h3>
|
||||
<p>Diese Nachricht wird vom Broker mit dem eingestellten Topic publiziert, bevor die Verbindung normal abgebaut wird,
|
||||
egal ob durch erneute Übernahme (deploy) des Nodes oder durch Herunterfahren von Node-RED.</p>
|
||||
<h3>Nachricht bei unerwarteten Verbindungsabbruch</h3>
|
||||
<p>Diese Nachricht wird vom Broker mit dem eingestellten Topic veröffentlicht,
|
||||
wenn die Verbindung unerwartet abgebrochen ist.</p>
|
||||
<h3>WebSockets</h3>
|
||||
<p>Der Node kann für die Verwendung einer WebSocket-Verbindung eingestellt werden.
|
||||
Dazu ist im Server-Feld die vollständige URI für die Verbindung vorzugeben. Beispiel:</p>
|
||||
<pre>ws://example.com:4000/mqtt</pre>
|
||||
</script>
|
||||
@@ -0,0 +1,98 @@
|
||||
<!--
|
||||
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/html" data-help-name="http in">
|
||||
<p>Erstellung eines HTTP-Endpunktes zur Erzeugung von Web-Diensten.</p>
|
||||
<h3>Ausgangsdaten</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload</dt>
|
||||
<dd>Für eine GET-Anforderung enthält es ein Objekt aller Abfrage-Parameter (query string parameters).
|
||||
Ansonsten enthält es den Hauptteil (Body) der HTTP-Anforderung.</dd>
|
||||
<dt>req <span class="property-type">object</span></dt>
|
||||
<dd>HTTP Anforderungsobjekt.<br/>
|
||||
Es enthält mehrere Eigenschaften, die Informationen zu der Anforderung bereitstellen.
|
||||
<ul>
|
||||
<li><code>body</code>: Hauptteil der eingehenden Anforderung. Das Format hängt von der Anforderung ab.</li>
|
||||
<li><code>headers</code>: Objekt mit HTTP-Request-Header</li>
|
||||
<li><code>query</code>: Objekt mit Anfrage-Parametern (query string parameters)</li>
|
||||
<li><code>params</code>: Objekt mit den Routing-Parametern</li>
|
||||
<li><code>cookies</code>: Objekt mit den Cookies der Anfrage</li>
|
||||
<li><code>files</code>: Objekt mit allen Dateien, die mit der POST-Anforderung gesendet wurden, sofern im Node aktiviert</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt>res <span class="property-type">object</span></dt>
|
||||
<dd>HTTP-Antwortobjekt.<br/>
|
||||
Diese Eigenschaft sollte nicht direkt verwendet werden.
|
||||
Im http response-Node ist dokumentiert, wie auf eine Anforderung reagiert wird.
|
||||
Diese Eigenschaft muss an der Nachricht angehängt bleiben, die an den Antwort-Node übergeben wird.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>Der Node ist auf dem eingestellten Pfad für Anforderungen eines bestimmten Typs empfangsbereit.
|
||||
Der Pfad kann vollständig angegeben werden, z.B. <code>/user</code> oder benannte Parameter beinhalten,
|
||||
die einen beliebigen Wert akzeptieren, z.B. <code>/user/:name</code>.
|
||||
Wenn benannte Parameter verwendet werden, kann auf ihren aktuellen Wert über <code>msg.req.params</code>
|
||||
zugegriffen werden.</p>
|
||||
<p>Für Anforderungen, die einen Hauptteil (Body) enthalten, wie z.B. POST oder PUT, wird der Inhalt der
|
||||
Anforderung über <code>msg.payload</code> verfügbar gemacht.</p>
|
||||
<p>Wenn der Inhaltstyp der Anforderung ermittelt werden kann, wird der Hauptteil als passender Typ analysiert.
|
||||
Z.B. <code>application/json</code> wird zu einem JavaScript-Objekt analysiert.</p>
|
||||
<p><b>Hinweis</b>: Dieser Node sendet keine Antwort an die Anforderung.
|
||||
Der Flow muss einen http response-Node enthalten,
|
||||
um die Anforderung zu vervollständigen.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="http response">
|
||||
<p>Senden von Antworten auf Anforderungen, die von einem http in-Node empfangen wurden.</p>
|
||||
<h3>Eingangsdaten</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string</span></dt>
|
||||
<dd>Hauptteil (Body) der Antwort.</dd>
|
||||
<dt class="optional">statusCode <span class="property-type">number</span></dt>
|
||||
<dd>Wenn gesetzt, wird diese als Antwort-Statuscode verwendet. Standardwert: 200.</dd>
|
||||
<dt class="optional">headers <span class="property-type">object</span></dt>
|
||||
<dd>Wenn gesetzt, enthält es die HTTP-Header für die Antwort.</dd>
|
||||
<dt class="optional">cookies <span class="property-type">object</span></dt>
|
||||
<dd>Wenn gesetzt, kann es zum Setzen oder Löschen von Cookies verwendet werden.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>Der <code>statusCode</code> und die <code>headers</code> können auch innerhalb des Node angegeben werden.
|
||||
Wenn eine Eigenschaft innerhalb des Nodes angegeben ist,
|
||||
kann sie nicht durch die entsprechende Nachrichteneigenschaft überschrieben werden.</p>
|
||||
<h4><b>Cookie-Behandlung</b></h4>
|
||||
<p>Die <code>cookies</code>-Eigenschaft muss ein Objekt mit Name/Wert-Paaren sein.
|
||||
Bei dem Wert kann es sich entweder um eine Zeichenfolge (string) zur Festlegung des Cookies mit Standardwerten handeln
|
||||
oder es kann ein Objekt mit Optionen sein.</p>
|
||||
<p>Im folgenden Beispiel werden zwei Cookies festgelegt - einer mit dem Namen <code>name</code> und dem
|
||||
Wert <code>nick</code> und der andere <code>session</code> mit dem Wert
|
||||
<code>1234</code> und einer festgelegten Ablaufzeit von 15 Minuten.</p>
|
||||
<pre>
|
||||
msg.cookies = {
|
||||
name: 'nick',
|
||||
session: {
|
||||
value: '1234',
|
||||
maxAge: 900000
|
||||
}
|
||||
}</pre>
|
||||
<p>Die gültigen Optionen sind:</p>
|
||||
<ul>
|
||||
<li><code>domain</code>: Domänenname für das Cookie, angegeben als Zeichenfolge (string)</li>
|
||||
<li><code>expires</code>: Ablaufzeit in GMT. Wenn nicht vorgeben oder Null (0), wird ein Sitzungscookie erstellt.</li>
|
||||
<li><code>maxAge</code>: Ablaufzeit in Bezug auf die aktuelle Zeit in Millisekunden, angegeben als Zeichenfolge (string)</li>
|
||||
<li><code>path</code>: Pfad für das Cookie. Standardwert: / (Schrägstrich), angegeben als Zeichenfolge (string)</li>
|
||||
<li><code>value</code>: Wert, der für das Cookie verwendet werden soll, angegeben als Zeichenfolge (string)</li>
|
||||
</ul>
|
||||
<p>Um ein Cookie zu löschen, ist sein <code>value</code> auf <code>null</code> zu setzen.</p>
|
||||
</script>
|
||||
@@ -0,0 +1,98 @@
|
||||
<!--
|
||||
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/html" data-help-name="http request">
|
||||
<p>Senden von HTTP-Anforderungen und Rückgabe der Antwort.</p>
|
||||
<h3>Eingangsdaten</h3>
|
||||
<dl class="message-properties">
|
||||
<dt class="optional">url <span class="property-type">string</span></dt>
|
||||
<dd>Wenn nicht im Node eingestellt, setzt diese optionale Eigenschaft die URL der Anforderung.</dd>
|
||||
<dt class="optional">method <span class="property-type">string</span></dt>
|
||||
<dd>Wenn nicht im Node eingestellt, setzt diese optionale Eigenschaft die HTTP-Methode der Anforderung
|
||||
(<code>GET</code>, <code>PUT</code>, <code>POST</code>, <code>PATCH</code> oder <code>DELETE</code>).</dd>
|
||||
<dt class="optional">headers <span class="property-type">object</span></dt>
|
||||
<dd>HTTP-Header der Anforderung.</dd>
|
||||
<dt class="optional">cookies <span class="property-type">object</span></dt>
|
||||
<dd>Wenn gesetzt, kann es verwendet werden, um Cookies mit der Anforderung zu senden.</dd>
|
||||
<dt class="optional">payload</dt>
|
||||
<dd>Hauptteil der Anforderung.</dd>
|
||||
<dt class="optional">rejectUnauthorized</dt>
|
||||
<dd>Wenn auf <code>false</code> gesetzt, können Anforderungen an https-Sites gesendet werden, die selbst signierte Zertifikate verwenden.</dd>
|
||||
<dt class="optional">followRedirects</dt>
|
||||
<dd>Wenn auf <code>false</code> gesetzt, wird ein nachfolgendes Redirect (HTTP 301) verhindert.
|
||||
Standard ist <code>true</code>.</dd>
|
||||
<dt class="optional">requestTimeout</dt>
|
||||
<dd>Wenn dieser Wert auf eine positive Zahl eingestellt ist,
|
||||
wird damit der global eingestellte Parameter <code>httpRequestTimeout</code> überschrieben.</dd>
|
||||
</dl>
|
||||
<h3>Ausgangsdaten</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string | object | buffer</span></dt>
|
||||
<dd>Hauptteil der Antwort.<br/>
|
||||
Der Node kann eingestellt werden, um den Hauptteil als String zurückzugeben,
|
||||
zu versuchen, ihn als JSON-String zu analysieren oder ihn als binären Puffer (buffer) zu belassen.</dd>
|
||||
<dt>statusCode <span class="property-type">number</span></dt>
|
||||
<dd>Statuscode der Antwort oder der Fehlercode, wenn die Anforderung nicht abgeschlossen werden konnte.</dd>
|
||||
<dt>headers <span class="property-type">object</span></dt>
|
||||
<dd>Objekt mit dem HTTP-Header der Antwort.</dd>
|
||||
<dt>responseUrl <span class="property-type">string</span></dt>
|
||||
<dd>Falls während der Bearbeitung der Anforderung Umleitungen aufgetreten sind, ist diese Eigenschaft die letzte umgelenkte URL.
|
||||
Andernfalls die URL der ursprünglichen Anforderung.</dd>
|
||||
<dt>responseCookies <span class="property-type">object</span></dt>
|
||||
<dd>Wenn die Antwort Cookies enthält, ist dieses Element ein Objekt von Name/Wert-Paaren für jedes Cookie.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>Wenn innerhalb des Nodes eingestellt, kann die URL-Eigenschaft
|
||||
<a href="http://mustache.github.io/mustache.5.html" target="_blank">mustache-style</a>-Tags enthalten.
|
||||
Diese ermöglichen es, die URL aus den Werten der eingehenden Nachricht aufzubauen.
|
||||
Wenn die URL beispielsweise <code>example.com/{{{topic}}}</code> lautet,
|
||||
wird der Wert von <code>msg.topic</code> automatisch eingefügt.
|
||||
Die Verwendung von {{{...}} hindert Mustache am Escaping von Zeichen wie z.B. / & usw.</p>
|
||||
<p><b>Hinweis</b>: Wenn Node-RED hinter einem Proxy läuft, sollte die Umgebungsvariable <code>http_proxy=...</code>
|
||||
gesetzt und Node-RED neu gestartet werden.
|
||||
Alternativ kann eine Proxy-Konfiguration verwendet werden, die dann Vorrang vor der Umgebungsvariable hat.</p>
|
||||
<h4><b>Verwendung mehrerer HTTP-Anforderungs-Nodes</b></h4>
|
||||
<p>Um mehr als einen dieser Nodes im gleichen Flow verwenden zu können,
|
||||
ist Aufmerksamkeit bei der Verwendung der <code>msg.headers</code>-Eigenschaft gefordert.
|
||||
Der erste Node setzt diese Eigenschaft mit dem Antwort-Header.
|
||||
Der nächste Node verwendet dann diesen Header für seine Anfrage, was aber nicht die richtige Art und Weise ist.
|
||||
Wenn die <code>msg.headers</code>-Eigenschaft zwischen den Nodes unverändert bleibt, wird sie vom zweiten Node ignoriert.
|
||||
Um benutzerdefinierte Header festzulegen, sollte <code>msg.headers</code> zuerst gelöscht oder
|
||||
auf ein leeres Objekt gesetzt werden: <code>{}</code></p>
|
||||
<h4><b>Behandlung von Cookies</b></h4>
|
||||
<p>Die an den Node übergebene <code>cookies</code>-Eigenschaft muss ein Objekt von Name/Wert-Paaren sein.
|
||||
Der Wert kann entweder ein String sein, um den Wert des Cookies zu setzen,
|
||||
oder es kann ein Objekt mit einer einzigen <code>value</code>-Eigenschaft sein.<p>
|
||||
<p>Alle auf Anforderung zurückgegebene Cookies werden über die <code>responseCookies</code>-Eigenschaft zurückgegeben.</p>
|
||||
<h4><b>Behandlung von Content-Typen</b></h4>
|
||||
<p>Wenn <code>msg.payload</code> ein Objekt ist, setzt der Node automatisch den Inhaltstyp der Anforderung
|
||||
auf <code>application/json</code> und kodiert den Hauptteil als solchen.</p>
|
||||
<p>Um die Anforderung als Formulardaten zu kodieren, sollte <code>msg.headers["content-type"]</code> auf
|
||||
<code>application/x-www-form-urlencoded</code> gesetzt werden.</p>
|
||||
<h4><b>Datei-Upload</b></h4>
|
||||
<p>Um einen Datei-Upload umzusetzen, sollte <code>msg.headers["content-type"]</code> auf <code>multipart/form-data</code>
|
||||
gesetzt werden und das an den Node zu sendende <code>msg.payload</code> muss ein Objekt mit folgender Struktur sein:</p>
|
||||
<pre><code>{
|
||||
"KEY": {
|
||||
"value": FILE_CONTENTS,
|
||||
"options": {
|
||||
"filename": "FILENAME"
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
<p>Die Inhalte von <code>KEY</code>, <code>FILE_CONTENTS</code> und <code>FILENAME</code>
|
||||
sollten auf passende Werte gesetzt sein.</p>
|
||||
</script>
|
||||
@@ -0,0 +1,42 @@
|
||||
<!--
|
||||
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/html" data-help-name="websocket in">
|
||||
<p>WebSocket-Eingangs-Node.</p>
|
||||
<p>Standardmäßig befinden sich die vom WebSocket empfangenen Daten in <code>msg.payload</code>.
|
||||
Der Socket kann eingestellt werden, einen korrekt gebildeten JSON-Zeichenfolge (string) zu erwarten.
|
||||
In diesem Fall wird das JSON analysiert (parse) und das resultierende Objekt als gesamte Nachricht gesendet.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="websocket out">
|
||||
<p>WebSocket-Ausgang-Node.</p>
|
||||
<p>Standardmäßig wird <code>msg.payload</code> über den WebSocket gesendet.
|
||||
Der Socket kann eingestellt werden, das gesamte <code>msg</code>-Objekt als JSON-Zeichenfolge (string) zu kodieren und
|
||||
über den WebSocket zu senden.</p>
|
||||
<p>Wenn die an diesem Node ankommende Nachricht von einem WebSocket-Eingangs-Node ausgeht,
|
||||
wird die Nachricht an den Client zurückgesendet, der den Flow ausgelöst hat.
|
||||
Andernfalls wird die Nachricht an alle verbundenen Clients gesendet.</p>
|
||||
<p>Wenn eine von einem WebSocket-Eingangs-Node ausgehende Nachricht an alle verbundenen Clients gesendet werden soll,
|
||||
muss die <code>msg._session</code>-Eigenschaft im Flow gelöscht werden.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="websocket-listener">
|
||||
<p>Konfigurations-Node zur Erstellung eines WebSocket-Server-Endpunktes mit vorgegebenen Pfad.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="websocket-client">
|
||||
<p>Konfigurations-Node zur Verbindung eines WebSocket-Clients mit vorgegebener URL.</p>
|
||||
</script>
|
||||
@@ -0,0 +1,47 @@
|
||||
<!--
|
||||
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/html" data-help-name="tcp in">
|
||||
<p>TCP-Eingang zur Verbindung mit einem entfernten TCP-Port oder Akzeptanz eingehender Verbindungen.</p>
|
||||
<p><b>Hinweis</b>: Auf einigen Systemen benötigen Sie möglicherweise Root- oder Administrator-Zugriffsrechte,
|
||||
um Ports unter 1024 und/oder Broadcast nutzen zu können.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="tcp out">
|
||||
<p>TCP-Ausgang zur Verbindung mit einem entfernten TCP-Port, Akzeptanz eingehender Verbindungen oder
|
||||
Antwort auf Nachrichten, die von einem <b>tcp in</b>-Node empfangen werden.</p>
|
||||
<p>Nur der <code>msg.payload</code>-Inhalt wird gesendet.</p>
|
||||
<p>Wenn <code>msg.payload</code> einen String mit Base64-Kodierung von binären Daten beinhaltet,
|
||||
bewirkt die Option <i>Base64-Nachricht dekodieren</i>,
|
||||
dass sie vorm Senden wieder in Binärdaten umgewandelt wird.</p>
|
||||
<p>Wenn <code>msg._session</code> nicht vorhanden ist,
|
||||
werden die Nutzdaten (Payload) an <b>alle</b> verbundenen Clients gesendet.</p>
|
||||
<p><b>Hinweis</b>: Auf einigen Systemen benötigen Sie möglicherweise Root- oder Administrator-Zugriffsrechte,
|
||||
um Ports unter 1024 und/oder Broadcast nutzen zu können.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="tcp request">
|
||||
<p>Einfacher TCP-Anforderungs-Node zum
|
||||
Senden von <code>msg.payload</code> an einen Server-TCP-Port und erwarten einer Antwort.</p>
|
||||
<p>Der Node verbindet sich, sendet einen <i>request</i> (Anfrage) und liest den <i>response</i> (Antwort).
|
||||
Er kann entweder eine vorgegebene Zeichenanzahl in einem festen Puffer abzählen,
|
||||
auf ein passendes Zeichen zur Rückkehr reagieren, ein festes Zeitlimit ab der ersten Antwort abwarten und dann rückkehren,
|
||||
endlos auf Daten warten oder sofort die Verbindug schliessen, ohne auf Antwort zu warten.</p>
|
||||
<p>Die Antwort wird in <code>msg.payload</code> als binärer Puffer (buffer) ausgegeben,
|
||||
sodass sie ggf. mit der <code>.toString()</code>-Funktion umgewandelt werden kann.</p>
|
||||
<p>Wenn <i>Server</i> oder <i>Port</code> nicht vorgegeben werden,
|
||||
müssen diese mit den <code>msg.host</code>- und <code>msg.port</code>-Eigenschaften übergeben werden.</p>
|
||||
</script>
|
||||
@@ -0,0 +1,35 @@
|
||||
<!--
|
||||
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/html" data-help-name="udp in">
|
||||
<p>UDP-Eingangs-Node zur Erzeugung einer <code>msg.payload</code> mit Buffer, String oder base64-kodierten String.
|
||||
Multicast wird unterstützt.</p>
|
||||
<p>Über die Eigenschaften <code>msg.ip</code> und <code>msg.port</code> können IP-Addresse und Port vorgeben werden,
|
||||
von dem die Nachtrichten empfangen werden.</p>
|
||||
<p><b>Hinweis</b>: Auf einigen Systemen benötigen Sie möglicherweise Root- oder Administrator-Zugriffsrechte,
|
||||
um Ports unter 1024 und/oder Broadcast nutzen zu können.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="udp out">
|
||||
<p>UDP-Ausgangs-Node zum Senden von <code>msg.payload</code> an vorgegebenen UDP-Host und -Port.
|
||||
Multicast wird unterstützt.</p>
|
||||
<p>Über die Eigenschaften <code>msg.ip</code> und <code>msg.port</code> können IP-Addresse und Port vorgeben werden,
|
||||
an den die Nachtrichten gesendet werden. Statisch im Node vorgebene Werte haben aber Vorrang.</p>
|
||||
<p>Bei Verwendung von Broadcast sollte die Adresse auf die lokale Broadcast-IP-Adresse oder
|
||||
auf 255.255.255.255 (globale Broadcast-Adresse) eingestellt werden.</p>
|
||||
<p><b>Hinweis</b>: Auf einigen Systemen benötigen Sie möglicherweise Root- oder Administrator-Zugriffsrechte,
|
||||
um Ports unter 1024 und/oder Broadcast nutzen zu können.</p>
|
||||
</script>
|
||||
Reference in New Issue
Block a user