frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2025-03-01 10:37:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved en-US help of rbe node

Browse Source
This commit is contained in:
Heiko 2021-03-20 11:17:24 +01:00
parent ef5b577f7f
commit 4aeb728f48
1 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
function/rbe/locales/en-US/rbe.html
View File

@ -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.</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 than + or - 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 than + or - the band gap away from the previous value.
It is useful for ignoring outliers from a faulty sensor for example.</p>
<p>Both Deadband and Narrowband 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>