make RBE info consistent with menu options

to close #620
This commit is contained in:
Dave Conway-Jones 2020-01-12 16:45:37 +00:00
parent d30ed78cb7
commit c8370e6da5
No known key found for this signature in database
GPG Key ID: 302A6725C594817F
3 changed files with 16 additions and 15 deletions

View File

@ -5,8 +5,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node that
provides report-by-exception (RBE) and deadband capability.
The node blocks unless the incoming value changes - RBE mode, or
changes by more than a certain amount (absolute value or percentage) - deadband
mode.
changes by more than a certain amount (absolute value or percentage) - bandgap modes.
Install
-------
@ -19,7 +18,7 @@ Run the following command in your Node-RED user directory - typically `~/.node-r
Usage
-----
A simple node to provide report by exception (RBE) and deadband function
A simple node to provide report by exception (RBE) and bandgap functions
- only passes on data if it has changed.
This works on a per `msg.topic` basis. This means that a single rbe node can
@ -31,12 +30,13 @@ The node doesn't send any output until the `msg.payload` is different to the pre
Works on numbers and strings. Useful for filtering out repeated messages of the
same value. Saves bandwidth, etc...
### Deadband modes
### Deadband and Narrowband modes
In deadband mode the incoming payload should contain a parseable *number* and is
In deadband modes the incoming payload should contain a parseable *number* and is
output only if greater than + or - the *band gap* away from the previous output.
It can also be set to block values more than a certain distance away from the present value.
This can be used to remove outliers or unexpected readings.
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.
You can specify compare with *previous valid output value* or *previous input value*.
The former ignores any values outside the valid range, whereas the latter allows

View File

@ -1,6 +1,6 @@
<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 until the value changes by a specified amount - deadband modes.</p>
<p>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
@ -22,12 +22,13 @@
<dd>If triggered the output will be the same as the input.</dd>
</dl>
<h3>Details</h3>
<p>In RBE mode this node will block until the <code>msg.payload</code> is
different to the previous one. </p>
<p>In Deadband modes the incoming payload must contain a parseable number and is
output only if greater than + or - the band gap away from a previous value.</p>
<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>In Narrowband mode the incoming payload is blocked if it is more than + or - the band gap
<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>
<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

View File

@ -1,7 +1,7 @@
{
"name" : "node-red-node-rbe",
"version" : "0.2.6",
"description" : "A Node-RED node that provides report-by-exception (RBE) and deadband capability.",
"version" : "0.2.7",
"description" : "A Node-RED node that provides report-by-exception (RBE) and deadband capabilities.",
"dependencies" : {
},
"repository" : {