Info/Doc style updates to core/pi nodes

This commit is contained in:
Dave Conway-Jones
2016-03-02 13:18:24 +00:00
parent 741c57e627
commit eff8327971
25 changed files with 78 additions and 77 deletions

View File

@@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node that when trigger
Install
-------
Run the following command in the root directory of your Node-RED install
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-random

View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-random",
"version" : "0.0.5",
"version" : "0.0.6",
"description" : "A Node-RED node that when triggered generates a random number between two values.",
"dependencies" : {
},

View File

@@ -11,10 +11,9 @@ mode.
Install
-------
Run the following command in your Node-RED install directory, usually
`~/.node-red`
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-rbe
npm i node-red-node-rbe
Usage
@@ -23,19 +22,21 @@ 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
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
### RBE mode
The node doesn't send any output until the **msg.payload** is different to the previous one.
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 mode
### 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.
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

View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-rbe",
"version" : "0.1.3",
"version" : "0.1.4",
"description" : "A Node-RED node that provides report-by-exception (RBE) and deadband capability.",
"dependencies" : {
},

View File

@@ -14,8 +14,7 @@ several simple smoothing algorithms for incoming data values. These include
Install
-------
Run the following command in the root directory of your Node-RED install. This
is normally `~/.node-red`
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-smooth

View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-smooth",
"version" : "0.0.6",
"version" : "0.0.7",
"description" : "A Node-RED node that provides several simple smoothing algorithms for incoming data values.",
"dependencies" : {
},