mirror of
https://github.com/node-red/node-red-nodes.git
synced 2023-10-10 13:36:58 +02:00
Info/Doc style updates to core/pi nodes
This commit is contained in:
parent
741c57e627
commit
eff8327971
@ -57,7 +57,7 @@ Copyright 2013, 2015 IBM Corp. under [the Apache 2.0 license](LICENSE).
|
||||
|
||||
**node-red-node-rbe** - *[rbe](function/rbe)* - A simple node to provide report by exception and deadband / bandgap capability for simple inputs.
|
||||
|
||||
**node-red-node-pidcontrol** - *[pidcontrol](function/pidcontrol)* - A PID control node for numeric inputs - provides simple contoll loop feedback capability.
|
||||
**node-red-node-pidcontrol** - *[pidcontrol](function/PID)* - A PID control node for numeric inputs - provides simple contoll loop feedback capability.
|
||||
|
||||
**node-red-node-random** - *[random](function/random)* - A simple random number generator - can generate integers for x to y - or floats between x and y.
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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" : {
|
||||
},
|
||||
|
@ -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
|
||||
|
||||
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
|
||||
|
@ -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" : {
|
||||
},
|
||||
|
@ -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
|
||||
|
||||
|
@ -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" : {
|
||||
},
|
||||
|
@ -7,10 +7,9 @@ Arduino running standard firmata 2.2 or better.
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install, usually
|
||||
this is `~/.node-red`
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-arduino
|
||||
npm i node-red-node-arduino
|
||||
|
||||
Usage
|
||||
-----
|
||||
@ -25,7 +24,7 @@ details and examples of how to use this node.
|
||||
Connects to local Arduino and monitors the selected pin for changes.
|
||||
|
||||
You can select either **Digital** or **Analogue** input type.
|
||||
Outputs the value read as **msg.payload** and the pin number as **msg.topic**.
|
||||
Outputs the value read as `msg.payload` and the pin number as `msg.topic`.
|
||||
|
||||
It only outputs on a change of value - fine for digital inputs, but you can get a lot of data from analogue pins which you must then handle.
|
||||
|
||||
@ -41,7 +40,7 @@ You can select
|
||||
- **Analogue** (PWM) - accepts Integer 0 to 255
|
||||
- **Servo** - accepts Integer 0 - 180
|
||||
|
||||
Expects a numeric value in **msg.payload**. The pin number is set in the properties panel.
|
||||
Expects a numeric value in `msg.payload`. The pin number is set in the properties panel.
|
||||
|
||||
*Note* - some servos will not travel a full 180 degree range so may only accept 30 - 150 degrees for example.
|
||||
Please use the `range` node to scale the input appropriately.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-arduino",
|
||||
"version" : "0.0.4",
|
||||
"version" : "0.0.5",
|
||||
"description" : "A Node-RED node to talk to an Arduino running firmata",
|
||||
"dependencies" : {
|
||||
"arduino-firmata" : "0.3.3"
|
||||
|
@ -13,8 +13,8 @@ images - as they have node.js v0.10.x preinstalled.
|
||||
Install
|
||||
-------
|
||||
|
||||
For Debian **Jessie** with kernel 4.1 run the following command in the root
|
||||
directory of your Node-RED install. This is usually `~/.node-red`
|
||||
For Debian **Jessie** with kernel 4.1 run the following command in your
|
||||
Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-beaglebone
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-beaglebone",
|
||||
"version" : "0.1.4",
|
||||
"version" : "0.1.5",
|
||||
"description" : "A set of Node-RED nodes to interface to the GPIO pins of a Beaglebone Black board",
|
||||
"dependencies" : {
|
||||
"octalbonescript":"^1.1.*"
|
||||
|
@ -6,8 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a <a h
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install,
|
||||
this is usually `~/.node-red`
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm i node-red-node-ledborg
|
||||
|
||||
@ -15,11 +14,11 @@ this is usually `~/.node-red`
|
||||
Usage
|
||||
-----
|
||||
|
||||
A PiBorg LedBorg LED output node that expects a <b>msg.payload</b> with a three digit rgb triple, from <b>000</b> to <b>222</b>. I.E. there are only 27 possible colours.
|
||||
A PiBorg LedBorg LED output node that expects a `msg.payload` with a three digit rgb triple, from <b>000</b> to <b>222</b>. I.E. there are only 27 possible colours.
|
||||
|
||||
See <i><a href="http://www.piborg.com/ledborg/install" target="_new">the PiBorg site</a></i> for more information.
|
||||
|
||||
You can also now use a <b>msg.payload</b> in the standard hex format "#rrggbb". The clip levels are :
|
||||
You can also now use a `msg.payload` in the standard hex format "#rrggbb". The clip levels are :
|
||||
|
||||
><pre>0x00 - 0x57 = off<br/>0x58 - 0xA7 = 50%<br/>0xA8 - 0xFF = fully on</pre>
|
||||
|
||||
@ -29,6 +28,6 @@ Notes
|
||||
-----
|
||||
|
||||
This node can only be used once per flow... as it uses physical pins 11, 13 and 15 on the Pi.
|
||||
Using it more than once will cause weird flashing and unpredictable behaviour.
|
||||
Using it more than once will cause weird flashing and unpredictable behavior.
|
||||
|
||||
You can of course wire up multiple things in your flow to the same LEDborg node.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-ledborg",
|
||||
"version" : "0.0.14",
|
||||
"version" : "0.0.15",
|
||||
"description" : "A Node-RED node to control a PiBorg LedBorg board for a Raspberry Pi.",
|
||||
"dependencies" : {
|
||||
},
|
||||
|
@ -3,6 +3,21 @@ node-red-node-sensortag
|
||||
|
||||
This node adds support to Node-RED to read from the Texas Instruments SensorTag.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm i node-red-node-sensortag
|
||||
|
||||
You will also need a suitable BLE dongle and an enabled Bluetooth stack - for example Bluez 5.2.x or better.
|
||||
On a Raspberry Pi this can be installed (as of Feb 2016) by
|
||||
|
||||
sudo apt-get install pi-bluetooth
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
The SensorTag is a Bluetooth LE device hosting the following sensors:
|
||||
|
||||
* Humidity and Temperature
|
||||
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "node-red-node-sensortag",
|
||||
"description": "A Node-RED node to read data from a TI SensorTag",
|
||||
"version": "0.0.9",
|
||||
"version": "0.0.10",
|
||||
"keywords": [
|
||||
"node-red",
|
||||
"sensortag",
|
||||
|
@ -7,7 +7,7 @@ remote server, for use as a keep-alive check.
|
||||
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-ping
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-ping",
|
||||
"version" : "0.0.11",
|
||||
"version" : "0.0.12",
|
||||
"description" : "A Node-RED node to ping a remote server, for use as a keep-alive check.",
|
||||
"dependencies" : {
|
||||
},
|
||||
|
@ -14,15 +14,14 @@ this node - node-red-node-serialport@0.0.5
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install, usually
|
||||
this is ~/.node-red .
|
||||
Run the following command in your Node-RED user directory (typically `~/.node-red`):
|
||||
|
||||
npm install node-red-node-serialport
|
||||
npm i node-red-node-serialport
|
||||
|
||||
For versions on node.js prior to 4.x (ie v0.10.x and v0.12.x) please install using
|
||||
|
||||
sudo npm i -g npm@2.x
|
||||
npm install node-red-node-serialport
|
||||
npm i node-red-node-serialport
|
||||
|
||||
You may also have to install or upgrade GCC to be version 4.8 or better.
|
||||
Alternatively you can simply install the older version of this node.
|
||||
@ -54,7 +53,7 @@ It can either
|
||||
- wait for a timeout in milliseconds for the first character received
|
||||
- wait to fill a fixed sized buffer
|
||||
|
||||
It then outputs **msg.payload** as either a UTF8 ascii string or a binary Buffer object.
|
||||
It then outputs `msg.payload` as either a UTF8 ascii string or a binary Buffer object.
|
||||
|
||||
If no split character is specified, or a timeout or buffer size of 0, then a stream
|
||||
of single characters is sent - again either as ascii chars or size 1 binary buffers.
|
||||
@ -63,6 +62,6 @@ of single characters is sent - again either as ascii chars or size 1 binary buff
|
||||
|
||||
Provides a connection to an outbound serial port.
|
||||
|
||||
Only the **msg.payload** is sent.
|
||||
Only the `msg.payload` is sent.
|
||||
|
||||
Optionally the new line character used to split the input can be appended to every message sent out to the serial port.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-serialport",
|
||||
"version" : "0.1.1",
|
||||
"version" : "0.1.2",
|
||||
"description" : "Node-RED nodes to talk to an serial port",
|
||||
"dependencies" : {
|
||||
"serialport" : "2.0.*"
|
||||
|
@ -14,10 +14,9 @@ You will need valid email credentials for your email server.
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install.
|
||||
Usually this is `~/.node-red` .
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-email
|
||||
npm i node-red-node-email
|
||||
|
||||
Usage
|
||||
-----
|
||||
@ -28,11 +27,11 @@ Nodes to send and receive simple emails.
|
||||
|
||||
Repeatedly gets a **single email** from an IMAP server and forwards on as a msg if not already seen.
|
||||
|
||||
The subject is loaded into **msg.topic** and **msg.payload** is the plain text body.
|
||||
If there is text/html then that is returned in **msg.html**. **msg.from** and
|
||||
**msg.date** are also set if you need them.
|
||||
The subject is loaded into `msg.topic` and `msg.payload` is the plain text body.
|
||||
If there is text/html then that is returned in `msg.html`. `msg.from` and
|
||||
`msg.date` are also set if you need them.
|
||||
|
||||
Additionally **msg.header** contains the complete header object including
|
||||
Additionally `msg.header` contains the complete header object including
|
||||
**to**, **cc** and other potentially useful properties.
|
||||
|
||||
**Note:** this node *only* gets the most recent single email from the inbox,
|
||||
@ -42,19 +41,19 @@ Uses the *imap* npm module.
|
||||
|
||||
### Output
|
||||
|
||||
Sends the **msg.payload** as an email, with a subject of **msg.topic**.
|
||||
Sends the `msg.payload` as an email, with a subject of `msg.topic`.
|
||||
|
||||
The default message recipient can be configured in the node, if it is left
|
||||
blank it should be set using the **msg.to** property of the incoming message.
|
||||
blank it should be set using the `msg.to` property of the incoming message.
|
||||
|
||||
The payload can be html format.
|
||||
|
||||
If the payload is a binary buffer then it will be converted to an attachment.
|
||||
|
||||
The filename should be set using **msg.filename**. Optionally
|
||||
**msg.description** can be added for the body text.
|
||||
The filename should be set using `msg.filename`. Optionally
|
||||
`msg.description` can be added for the body text.
|
||||
|
||||
Alternatively you may provide **msg.attachments** which should contain an array of one or
|
||||
Alternatively you may provide `msg.attachments` which should contain an array of one or
|
||||
more attachments in <a href="https://www.npmjs.com/package/nodemailer#attachments" target="_new">nodemailer</a> format.
|
||||
|
||||
Uses the *nodemailer* npm module.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-email",
|
||||
"version" : "0.1.2",
|
||||
"version" : "0.1.3",
|
||||
"description" : "Node-RED nodes to send and receive simple emails",
|
||||
"dependencies" : {
|
||||
"nodemailer" : "1.3.4",
|
||||
|
@ -3,22 +3,16 @@ node-red-node-feedparser
|
||||
|
||||
A <a href="http://nodered.org" target="_new">Node-RED</a> node to read RSS and Atom feeds.
|
||||
|
||||
**Note** : This is the same node as was in the core of Node-RED.
|
||||
As of v0.10.8 it will be installed from here instead.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the user directory of your Node-RED install.
|
||||
By default this is `.node-red`
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-feedparser
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Provides two nodes - one to receive messages, and one to send.
|
||||
|
||||
### Input
|
||||
|
||||
Monitors an RSS/atom feed for new entries.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "node-red-node-feedparser",
|
||||
"version": "0.1.4",
|
||||
"version": "0.1.5",
|
||||
"description": "A Node-RED node to get RSS Atom feeds.",
|
||||
"dependencies": {
|
||||
"feedparser": "1.1.3",
|
||||
|
@ -7,14 +7,10 @@ The Twitter API will **NOT** deliver 100% of all tweets. This does **NOT** give
|
||||
|
||||
Tweets of who you follow will include their retweets and favourites.
|
||||
|
||||
**Note** : This is the same node as was in the core of Node-RED.
|
||||
As of v0.10.8 it will be installed from here instead.
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
Run the following command in the root directory of your Node-RED install, usually
|
||||
this is ~/.node-red .
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
npm install node-red-node-twitter
|
||||
|
||||
@ -33,11 +29,11 @@ Twitter input node. Can be used to search either:
|
||||
|
||||
Use **space** for *and*, and **comma** , for *or* when searching for multiple terms.
|
||||
|
||||
Sets the **msg.topic** to *tweets/* and then appends the senders screen name.
|
||||
Sets the `msg.topic` to *tweets/* and then appends the senders screen name.
|
||||
|
||||
Sets **msg.location** to the tweeters location if known.
|
||||
Sets `msg.location` to the tweeters location if known.
|
||||
|
||||
Sets **msg.tweet** to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets">Twitter</a>.
|
||||
Sets `msg.tweet` to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets">Twitter</a>.
|
||||
|
||||
**Note:** when set to a specific user's tweets, or your direct messages, the node is subject to
|
||||
Twitter's API rate limiting. If you deploy the flows multiple times within a 15 minute window, you may
|
||||
@ -47,12 +43,12 @@ passes.
|
||||
|
||||
### Output
|
||||
|
||||
Tweets the **msg.payload**.
|
||||
Tweets the `msg.payload`.
|
||||
|
||||
To send a Direct Message (DM) - use a payload like.
|
||||
|
||||
D {username} {message}
|
||||
|
||||
If **msg.media** exists and is a Buffer object, this node will treat it as an image and attach it to the tweet.
|
||||
If `msg.media` exists and is a Buffer object, this node will treat it as an image and attach it to the tweet.
|
||||
|
||||
If **msg.params** exists and is an object of name:value pairs, this node will treat it as parameters for the update request.
|
||||
If `msg.params` exists and is an object of name:value pairs, this node will treat it as parameters for the update request.
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name" : "node-red-node-twitter",
|
||||
"version" : "0.1.5",
|
||||
"version" : "0.1.6",
|
||||
"description" : "A Node-RED node to talk to Twitter",
|
||||
"dependencies" : {
|
||||
"twitter-ng": "0.6.2",
|
||||
|
Loading…
Reference in New Issue
Block a user