History

Dave Conway-Jones a9a4ef9bf9 bump rbe, email, twitter nodes		2018-10-24 15:31:11 +01:00
..
icons	fatten up rbe icon slightly	2015-08-11 19:56:23 +01:00
locales	Update Japanese messages (#499 )	2018-10-24 12:28:38 +01:00
LICENSE	Update licenses and packages for all nodes	2016-11-06 20:26:19 +00:00
README.md	Let rbe node compare to previous input OR output	2016-03-21 00:01:50 +00:00
package.json	bump rbe, email, twitter nodes	2018-10-24 15:31:11 +01:00
rbe.html	Make extra node names more consistent i18n wise	2018-03-30 14:50:51 +01:00
rbe.js	fix long standing rbe % change bug (should be abs change)	2018-02-08 15:51:57 +00:00

README.md

node-red-node-rbe

A Node-RED node that provides 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.

Install

Run the following command in your Node-RED user directory - typically ~/.node-red

npm i node-red-node-rbe

Usage

A simple node to provide report by exception (RBE) and deadband function

only passes on data if it has changed.

This works on a per msg.topic basis. This means that a single rbe node can handle multiple topics at the same time.

RBE mode

The node doesn't send any output until the msg.payload is different to the previous one. Works on numbers and strings. Useful for filtering out repeated messages of the same value. Saves bandwidth, etc...

Deadband modes

In deadband mode 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.

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 two "bad" readings in a row to reset the range based on those values. For example a valid step change.

The deadband value can be specified as a fixed number, or a percentage. E.g. 10 or 5% . If % mode is used then the output will only get sent if the input payload value is equal or more than the specified % away from the previously sent value.

For example - if last sent value was 100, and deadband is set to 10% - a value of 110 will pass - then the next value has to be 121 in order to pass (= 110 + 10% = 121).

This is mainly useful if you want to operate across multiple topics at the same time that may have widely differing input ranges.

Will only accept numbers, or parseable strings like "18.4 C" or "$500"