From 534be72c3699c4b15df3a21315df62f445fc2f3e Mon Sep 17 00:00:00 2001
From: heikokue <74769863+heikokue@users.noreply.github.com>
Date: Thu, 25 Mar 2021 10:51:16 +0100
Subject: [PATCH] rbe node: improved EN help and added DE help (#776)

---
 function/rbe/locales/de/rbe.html    | 40 +++++++++++++++++++++++++++++
 function/rbe/locales/de/rbe.json    |  2 +-
 function/rbe/locales/en-US/rbe.html | 31 ++++++++++++----------
 3 files changed, 58 insertions(+), 15 deletions(-)
 create mode 100644 function/rbe/locales/de/rbe.html

diff --git a/function/rbe/locales/de/rbe.html b/function/rbe/locales/de/rbe.html
new file mode 100644
index 00000000..99fcd318
--- /dev/null
+++ b/function/rbe/locales/de/rbe.html
@@ -0,0 +1,40 @@
+<script type="text/html" data-help-name="rbe">
+    <p>Report by Exception (RBE) - Daten-Weiterleitung nur bei Änderung der Nutzdaten (Payload).
+       Der Node kann auch blockieren oder weiterleiten, wenn die Wertänderung eine Grenze überschreitet (Totband- und Nahband-Modus).</p>
+    <h3>Eingangsdaten</h3>
+    <dl class="message-properties">
+        <dt>payload
+            <span class="property-type">number | string | (object)</span>
+        </dt>
+        <dd>Der RBE-Modus mit Prüfung auf Wertänderung akzeptiert Zahlen (numbers), Zeichenfolgen (string) und einfache Objekte (object).
+            Bei den anderen wertvergleichenden Modies müssen analysierbare (parseable) Zahlenwerte übergeben werden.</dd>
+        <dt class="optional">topic <span class="property-type">string</span>
+        </dt>
+        <dd>Wenn vorgegeben erfolgt die Auswertung separat für jedes Topic</dd>
+        <dt class="optional">reset<span class="property-type">any</span></dt>
+        <dd>Wenn gesetzt wird/werden der/die gespeicherte(n) Wert(e) rückgesetzt</dd>
+    </dl>
+    <h3>Ausgangsdaten</h3>
+    <dl class="message-properties">
+        <dt>payload
+            <span class="property-type">wie Eingangsdaten</span>
+        </dt>
+        <dd>Wenn Bedingung erfüllt, sind die Ausgangsdaten gleich den Eingangsdaten</dd>
+    </dl>
+    <h3>Details</h3>
+    <p>Im <i>RBE</i>-Modus mit Prüfung auf Wertänderung blockiert dieser Node die Datenweitergabe bis
+       <code>msg.payload</code> (oder die eingestellte Eigenschaft) verändert ist gegenüber dessen vorherigen Wert.
+       Wenn benötigt, wird der Anfangswert ignoriert, sodass beim Start nichts gesendet wird.</p>
+    <p>In den <i>Totband</i>-Modies werden die Eingangswerte geblockt,
+       <i>bis</i> die Wertänderung größer oder größer-gleich ist als &plusmn; des Bandes um den voherigen Wert.</p>
+    <p>In den <i>Nahband</i>-Modies werden die Eingangswerte geblockt,
+       <i>wenn</i> die Wertänderung größer oder größer-gleich ist als &plusmn; des Bandes um den voherigen Wert.
+       Dies ist beispielsweise nützlich, um Ausreißer eines fehlerhaften Sensors zu ignorieren.</p>
+    <p>In den Totband und Nahband-Modies müssen die Eingangswerte analysierbare (parseable) Zahlenwerte sein und
+       beide unterstützen auch % (prozentuale Angabe), d.h. der Node sendet nur, wenn der Eingangswert mehr als x% vom vorherigen Wert abweicht.</p>
+    <p>Die Totband- und Nahband-Modies erlauben den Vergleich entweder gegen den letzten gültigen Ausgangswert,
+       dieses zum Ignorieren von Werten außerhalb des gültigen Bereichs, oder gegen den des vorherigen Eingangswertes,
+       welches den Sollwert rücksetzt, was einen allmähligen Drift (Totband) oder einen eine schrittweise Veränderung (Nahband) ermöglicht.</p>
+    <p><b>Hinweis</b>: Dieser Node arbeitet auf per-<code>msg.topic</code>-Basis.
+       Dies bedeutet, dass ein einzelner rbe-Node mehrere verschiedene Topics parallel bearbeiten kann.</p>
+</script>
diff --git a/function/rbe/locales/de/rbe.json b/function/rbe/locales/de/rbe.json
index afd3f688..dcdded6b 100644
--- a/function/rbe/locales/de/rbe.json
+++ b/function/rbe/locales/de/rbe.json
@@ -9,7 +9,7 @@
             "septopics": "Modus für jedes msg.topic separat anwenden"
         },
         "placeholder":{
-            "bandgap": "z. B. 10% oder 5%",
+            "bandgap": "z.B. 10 oder 5%",
             "start": "Leer lassen, um erste empfangenen Daten zu nutzen"
         },
         "opts": {
diff --git a/function/rbe/locales/en-US/rbe.html b/function/rbe/locales/en-US/rbe.html
index 44d2068d..0bca2cf0 100644
--- a/function/rbe/locales/en-US/rbe.html
+++ b/function/rbe/locales/en-US/rbe.html
@@ -1,18 +1,19 @@
 <script type="text/html" data-help-name="rbe">
-    <p>Report by Exception node - only passes on data if the payload has changed.</p>
-    <p>It can also block unless, or ignore if the value changes by a specified amount.</p>
+    <p>Report by Exception (RBE) node - only passes on data if the payload has changed.
+       It can also block unless, or ignore if the value changes by a specified amount (Dead- and Narrowband mode).</p>
     <h3>Inputs</h3>
     <dl class="message-properties">
         <dt>payload
             <span class="property-type">number | string | (object)</span>
         </dt>
-        <dd>RBE mode will accept numbers, strings, and simple objects. Other modes must provide a parseable number.</dd>
+        <dd>RBE mode will accept numbers, strings, and simple objects.
+            Other modes must provide a parseable number.</dd>
         <dt class="optional">topic <span class="property-type">string</span>
         </dt>
         <dd>if specified the function will work on a per topic basis.</dd>
         <dt class="optional">reset<span class="property-type">any</span></dt>
         <dd>if set clears the stored value for the specified msg.topic, or
-        all topics if msg.topic is not specified.</dd>
+            all topics if msg.topic is not specified.</dd>
     </dl>
     <h3>Outputs</h3>
     <dl class="message-properties">
@@ -23,16 +24,18 @@
     </dl>
     <h3>Details</h3>
     <p>In RBE mode this node will block until the <code>msg.payload</code>,
-    (or selected property) value is different to the previous one. If required 
-    it can ignore the intial value, so as not to send anything at start.</p>
-    <p>In the Deadband modes the incoming value must contain a parseable number and will block
-    unless the change is greater than + or - the band gap away from a previous value.</p>
-    <p>Deadband also supports % - only sends if the input differs by more than x% of the original value.</p>
-    <p>The Narrowband modes will block if the incoming value change is greater than + or - the band gap
-    away from the previous value. Useful for ignoring outliers from a faulty sensor for example.</p>
+       (or selected property) value is different to the previous one.
+       If required it can ignore the intial value, so as not to send anything at start.</p>
+    <p>The <a href="https://en.wikipedia.org/wiki/Deadband" target="_blank">Deadband</a> modes will block the incoming value 
+       <i>unless</i> its change is greater or greater-equal than &plusmn; the band gap away from a previous value.</p>
+    <p>The Narrowband modes will block the incoming value,
+       <i>if</i> its change is greater or greater-equal than &plusmn; the band gap away from the previous value.
+       It is useful for ignoring outliers from a faulty sensor for example.</p>
+    <p>Both in Deadband and Narrowband modes the incoming value must contain a parseable number and
+       both also supports % - only sends if/unless the input differs by more than x% of the original value.</p>
     <p>Both Deadband and Narrowband allow comparison against either the previous valid output value, thus
-    ignoring any values out of range; or the previous input value, which resets the set point, thus allowing
+    ignoring any values out of range, or the previous input value, which resets the set point, thus allowing
     gradual drift (deadband), or a step change (narrowband).</p>
-    <p><b>Note:</b> This works on a per <code>msg.topic</code> basis. This means that a single rbe node can
-    handle multiple different topics at the same time.</p>
+    <p><b>Note:</b> This works on a per <code>msg.topic</code> basis.
+       This means that a single rbe node can handle multiple different topics at the same time.</p>
 </script>