From eff83279713aeb8ab6b5e9c06d55be9b29cc21d7 Mon Sep 17 00:00:00 2001 From: Dave Conway-Jones Date: Wed, 2 Mar 2016 13:18:24 +0000 Subject: [PATCH] Info/Doc style updates to core/pi nodes --- README.md | 2 +- function/random/README.md | 2 +- function/random/package.json | 2 +- function/rbe/README.md | 15 ++++++++------- function/rbe/package.json | 2 +- function/smooth/README.md | 3 +-- function/smooth/package.json | 2 +- hardware/Arduino/README.md | 9 ++++----- hardware/Arduino/package.json | 2 +- hardware/BBB/README.md | 4 ++-- hardware/BBB/package.json | 2 +- hardware/LEDborg/README.md | 9 ++++----- hardware/LEDborg/package.json | 2 +- hardware/sensorTag/README.md | 15 +++++++++++++++ hardware/sensorTag/package.json | 2 +- io/ping/README.md | 2 +- io/ping/package.json | 2 +- io/serialport/README.md | 11 +++++------ io/serialport/package.json | 2 +- social/email/README.md | 27 +++++++++++++-------------- social/email/package.json | 2 +- social/feedparser/README.md | 10 ++-------- social/feedparser/package.json | 2 +- social/twitter/README.md | 22 +++++++++------------- social/twitter/package.json | 2 +- 25 files changed, 78 insertions(+), 77 deletions(-) diff --git a/README.md b/README.md index c9afca7e..21962e7d 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/function/random/README.md b/function/random/README.md index 2e358d46..e27fdef7 100644 --- a/function/random/README.md +++ b/function/random/README.md @@ -6,7 +6,7 @@ A Node-RED 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 diff --git a/function/random/package.json b/function/random/package.json index 9d652808..55f88a70 100644 --- a/function/random/package.json +++ b/function/random/package.json @@ -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" : { }, diff --git a/function/rbe/README.md b/function/rbe/README.md index 459b2aa6..1f38b036 100644 --- a/function/rbe/README.md +++ b/function/rbe/README.md @@ -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 diff --git a/function/rbe/package.json b/function/rbe/package.json index 377a7853..5dc0c999 100644 --- a/function/rbe/package.json +++ b/function/rbe/package.json @@ -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" : { }, diff --git a/function/smooth/README.md b/function/smooth/README.md index e93714c5..648d5f21 100644 --- a/function/smooth/README.md +++ b/function/smooth/README.md @@ -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 diff --git a/function/smooth/package.json b/function/smooth/package.json index 9954b46a..732ebd91 100644 --- a/function/smooth/package.json +++ b/function/smooth/package.json @@ -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" : { }, diff --git a/hardware/Arduino/README.md b/hardware/Arduino/README.md index 6bdb13a9..c08191f5 100644 --- a/hardware/Arduino/README.md +++ b/hardware/Arduino/README.md @@ -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. diff --git a/hardware/Arduino/package.json b/hardware/Arduino/package.json index ee90ea91..c93c9250 100644 --- a/hardware/Arduino/package.json +++ b/hardware/Arduino/package.json @@ -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" diff --git a/hardware/BBB/README.md b/hardware/BBB/README.md index ff43e246..2d2b2cc9 100644 --- a/hardware/BBB/README.md +++ b/hardware/BBB/README.md @@ -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 diff --git a/hardware/BBB/package.json b/hardware/BBB/package.json index 88caa240..f147cc31 100644 --- a/hardware/BBB/package.json +++ b/hardware/BBB/package.json @@ -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.*" diff --git a/hardware/LEDborg/README.md b/hardware/LEDborg/README.md index cadc3847..e439deff 100644 --- a/hardware/LEDborg/README.md +++ b/hardware/LEDborg/README.md @@ -6,8 +6,7 @@ A Node-RED node to control a msg.payload with a three digit rgb triple, from 000 to 222. 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 000 to 222. I.E. there are only 27 possible colours. See the PiBorg site for more information. -You can also now use a msg.payload 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 : >
0x00 - 0x57 = off
0x58 - 0xA7 = 50%
0xA8 - 0xFF = fully on
@@ -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. diff --git a/hardware/LEDborg/package.json b/hardware/LEDborg/package.json index e95db1c8..1569bf4a 100644 --- a/hardware/LEDborg/package.json +++ b/hardware/LEDborg/package.json @@ -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" : { }, diff --git a/hardware/sensorTag/README.md b/hardware/sensorTag/README.md index c5aa7cc7..1a484fe6 100644 --- a/hardware/sensorTag/README.md +++ b/hardware/sensorTag/README.md @@ -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 diff --git a/hardware/sensorTag/package.json b/hardware/sensorTag/package.json index 88be16af..7287aab6 100644 --- a/hardware/sensorTag/package.json +++ b/hardware/sensorTag/package.json @@ -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", diff --git a/io/ping/README.md b/io/ping/README.md index f4d38860..6c1ebbcb 100644 --- a/io/ping/README.md +++ b/io/ping/README.md @@ -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 diff --git a/io/ping/package.json b/io/ping/package.json index 58eeacf9..d6bcd09e 100644 --- a/io/ping/package.json +++ b/io/ping/package.json @@ -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" : { }, diff --git a/io/serialport/README.md b/io/serialport/README.md index 5112ea42..214192f4 100644 --- a/io/serialport/README.md +++ b/io/serialport/README.md @@ -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. diff --git a/io/serialport/package.json b/io/serialport/package.json index eef6878d..9f002a6e 100644 --- a/io/serialport/package.json +++ b/io/serialport/package.json @@ -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.*" diff --git a/social/email/README.md b/social/email/README.md index 3f37cf2d..029214f6 100644 --- a/social/email/README.md +++ b/social/email/README.md @@ -14,25 +14,24 @@ 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 ----- Nodes to send and receive simple emails. -###Input +### Input 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, @@ -40,21 +39,21 @@ so set the repeat (polling) time appropriately. Uses the *imap* npm module. -###Output +### 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 nodemailer format. Uses the *nodemailer* npm module. diff --git a/social/email/package.json b/social/email/package.json index c2735fe2..d5b0ea6e 100644 --- a/social/email/package.json +++ b/social/email/package.json @@ -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", diff --git a/social/feedparser/README.md b/social/feedparser/README.md index 109a92a6..7d0cedc0 100644 --- a/social/feedparser/README.md +++ b/social/feedparser/README.md @@ -3,23 +3,17 @@ node-red-node-feedparser A Node-RED 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 +### Input Monitors an RSS/atom feed for new entries. diff --git a/social/feedparser/package.json b/social/feedparser/package.json index b6fac8c2..1cc0b1e3 100644 --- a/social/feedparser/package.json +++ b/social/feedparser/package.json @@ -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", diff --git a/social/twitter/README.md b/social/twitter/README.md index b475769e..ed6e01b3 100644 --- a/social/twitter/README.md +++ b/social/twitter/README.md @@ -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 @@ -23,7 +19,7 @@ Usage Provides two nodes - one to receive messages, and one to send. -###Input +### Input Twitter input node. Can be used to search either: @@ -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 Twitter. +Sets `msg.tweet` to the full tweet object as documented by Twitter. **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 @@ -45,14 +41,14 @@ exceed the limit and will see errors from the node. These errors will clear when passes. -###Output +### 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. diff --git a/social/twitter/package.json b/social/twitter/package.json index 4b0430c3..69755008 100644 --- a/social/twitter/package.json +++ b/social/twitter/package.json @@ -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",