frodovdr
/
node-red-nodes
mirror of https://github.com/node-red/node-red-nodes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

update hardware nodes info style

This commit is contained in:
Dave Conway-Jones 2016-03-02 13:25:52 +00:00
parent 88985f4fe7
commit 81c532fdce
42 changed files with 130 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hardware/HummingboardGPIO/README.md
View File

@ -8,14 +8,14 @@ Install
**This install is for Debian based OS on Hummingboard.** **This install is for Debian based OS on Hummingboard.**
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-hpgpio npm install node-red-node-hpgpio
**Note :** This **should** be run as root in order to move and set SUID permissions on a script to talk to the gpio pins. Alternatively you can run as a normal user and then move the file and change permissions manually. **Note :** This **should** be run as root in order to move and set SUID permissions on a script to talk to the gpio pins. Alternatively you can run as a normal user and then move the file and change permissions manually.
sudo cp node_modules/node-red-node-hpgpio/gpiohb /usr/local/bin/ sudo cp node_modules/node-red-node-hpgpio/gpiohb /usr/local/bin/
sudo chmod 4755 /usr/lcoal/bin/gpiohb sudo chmod 4755 /usr/local/bin/gpiohb
Usage Usage
@ -27,19 +27,19 @@ This requires a small script (gpiohb) to run as root in order to work. It should
**Note:** We are using the actual physical pin numbers as they are easier to locate. **Note:** We are using the actual physical pin numbers as they are easier to locate.
###Output node ### Output node
Expects a <b>msg.payload</b> with either a 0 or 1 (or true or false). Expects a `msg.payload` with either a 0 or 1 (or true or false).
Will set the selected physical pin high or low depending on the value passed in. Will set the selected physical pin high or low depending on the value passed in.
The initial value of the pin at deploy time can also be set to 0 or 1. The initial value of the pin at deploy time can also be set to 0 or 1.
###Input node ### Input node
Generates a **msg.payload** with either a 0 or 1 depending on the state of the input pin. Generates a `msg.payload` with either a 0 or 1 depending on the state of the input pin.
The **msg.topic** is set to **pin/{the pin number}** The `msg.topic` is set to *pin/{the pin number}*
**Note:** The input node waits for a change on the level of the pin before reading the value - and then resets to wait for the next interrupt - so it is possible to miss very fast changes as we may still be reading the value when the second edge occurs. **Note:** The input node waits for a change on the level of the pin before reading the value - and then resets to wait for the next interrupt - so it is possible to miss very fast changes as we may still be reading the value when the second edge occurs.

6
hardware/HummingboardGPIO/hb-gpio.html
View File

@ -52,9 +52,9 @@
</script> </script>
<script type="text/x-red" data-help-name="hb-gpio in"> <script type="text/x-red" data-help-name="hb-gpio in">
<p>Hummingboard GPIO input pin node. Generates a <b>msg.payload</b> with either a 0 or 1 depending on the state of the input pin.</p> <p>Hummingboard GPIO input pin node. Generates a <code>msg.payload</code> with either a 0 or 1 depending on the state of the input pin.</p>
<p>You may also enable the input pullup resitor or the pulldown resistor.</p> <p>You may also enable the input pullup resitor or the pulldown resistor.</p>
<p>The <b>msg.topic</b> is set to <i>pi/{the pin number}</i></p> <p>The <code>msg.topic</code> is set to <i>pi/{the pin number}</i></p>
<p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p> <p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p>
<p><b>Note:</b> requires the gpiohb command to be executeable as root in order to work.</p> <p><b>Note:</b> requires the gpiohb command to be executeable as root in order to work.</p>
</script> </script>
@ -120,7 +120,7 @@
</script> </script>
<script type="text/x-red" data-help-name="hb-gpio out"> <script type="text/x-red" data-help-name="hb-gpio out">
<p>Hummingboard GPIO output pin node. Expects a <b>msg.payload</b> with either a 0 or 1 (or true or false).</p> <p>Hummingboard GPIO output pin node. Expects a <code>msg.payload</code> with either a 0 or 1 (or true or false).</p>
<p>Will set the selected physical pin high or low depending on the value passed in.</p> <p>Will set the selected physical pin high or low depending on the value passed in.</p>
<p>The initial value of the pin at deploy time can also be set to 0 or 1.</p> <p>The initial value of the pin at deploy time can also be set to 0 or 1.</p>
<p><b>Note:</b> we are using the actual physical pin numbers as they are easier to locate.</p> <p><b>Note:</b> we are using the actual physical pin numbers as they are easier to locate.</p>

2
hardware/HummingboardGPIO/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-hbgpio", "name" : "node-red-node-hbgpio",
"version" : "0.0.3", "version" : "0.0.4",
"description" : "A Node-RED node for the GPIO of the Hummingboard", "description" : "A Node-RED node for the GPIO of the Hummingboard",
"dependencies": { "dependencies": {
}, },

7
hardware/PiFace/37-rpi-piface.html
View File

@ -58,9 +58,10 @@
</script> </script>
<script type="text/x-red" data-help-name="rpi-piface in"> <script type="text/x-red" data-help-name="rpi-piface in">
<p>Raspberry Pi PiFace input node. Generates a <b>msg.payload</b> with either a 0 or 1 depending on the state of the input pin.</p> <p>Raspberry Pi PiFace input node. Generates a <code>msg.payload</code> with either a 0 or 1 depending
on the state of the input pin.</p>
<p>You may also enable the input pullup resistor if required.</p> <p>You may also enable the input pullup resistor if required.</p>
<p>The <b>msg.topic</b> is set to <i>piface/{the pin number}</i></p> <p>The <code>msg.topic</code> is set to <i>piface/{the pin number}</i></p>
<p>Requires the WiringPi gpio command in order to work.</p> <p>Requires the WiringPi gpio command in order to work.</p>
<p><b>Note:</b> This node currently polls the pin every 250mS. This is not ideal as it loads the cpu.</p> <p><b>Note:</b> This node currently polls the pin every 250mS. This is not ideal as it loads the cpu.</p>
<p><b>Note:</b> Some versions of the PiFace relabelled the switch inputs to be 0 - 7 instead of 1 - 8. <p><b>Note:</b> Some versions of the PiFace relabelled the switch inputs to be 0 - 7 instead of 1 - 8.
@ -127,7 +128,7 @@
<script type="text/x-red" data-help-name="rpi-piface out"> <script type="text/x-red" data-help-name="rpi-piface out">
<p>Raspberry Pi PiFace output node. The PiFace board must be fitted.</p> <p>Raspberry Pi PiFace output node. The PiFace board must be fitted.</p>
<p>Will set the selected relay, LED, or pin on or off depending on the value passed in. Expects a <b>msg.payload</b> with either a 1 or 0 (or true or false).</p> <p>Will set the selected relay, LED, or pin on or off depending on the value passed in. Expects a <code>msg.payload</code> with either a 1 or 0 (or true or false).</p>
<p>Requires the WiringPi gpio command in order to work.</p> <p>Requires the WiringPi gpio command in order to work.</p>
</script> </script>

8
hardware/PiFace/README.md
View File

@ -12,7 +12,7 @@ We cannot automatically detect this so the user will have to apply some common s
Install 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-piface npm install node-red-node-piface
@ -46,19 +46,19 @@ add-on board.
### Output ### Output
The PiFace output node will set the selected relay, LED, or pin on or off The PiFace output node will set the selected relay, LED, or pin on or off
depending on the value passed in. Expects a <b>msg.payload</b> with either a depending on the value passed in. Expects a `msg.payload` with either a
1 or 0 (or true or false). 1 or 0 (or true or false).
Requires the WiringPi gpio command in order to work (see pre-reqs). Requires the WiringPi gpio command in order to work (see pre-reqs).
### Input ### Input
The PiFace input node generates a <b>msg.payload</b> with either a 0 or 1 The PiFace input node generates a `msg.payload` with either a 0 or 1
depending on the state of the input pin. depending on the state of the input pin.
You may also enable the input pullup resistor if required. You may also enable the input pullup resistor if required.
The <b>msg.topic</b> is set to <i>piface/{the pin number}</i> The `msg.topic` is set to <i>piface/{the pin number}</i>
Requires the WiringPi gpio command in order to work (see pre-reqs). Requires the WiringPi gpio command in order to work (see pre-reqs).

2
hardware/PiFace/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-piface", "name" : "node-red-node-piface",
"version" : "0.0.6", "version" : "0.0.7",
"description" : "Node-RED nodes to read from and write to a PiFace Digital Raspberry Pi add-on board", "description" : "Node-RED nodes to read from and write to a PiFace Digital Raspberry Pi add-on board",
"dependencies" : { "dependencies" : {
}, },

5
hardware/PiLcd/README.md
View File

@ -7,8 +7,7 @@ to write to a GPIO connected HD44780 style LCD panels.
Install 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`
This is normally `~/.node-red`
npm install node-red-node-pilcd npm install node-red-node-pilcd
@ -23,7 +22,7 @@ pin numbers that are connected to the RS, E, D4, D5, D6 and D7 pins of the LCD.
26,24,22,18,16,12 26,24,22,18,16,12
Send the node a **msg.payload** with a string in it. Send the node a `msg.payload` with a string in it.
Strings for the 2nd line of the display must start **2:** - the third start **3:** - and the fourth **4:** - For example Strings for the 2nd line of the display must start **2:** - the third start **3:** - and the fourth **4:** - For example

2
hardware/PiLcd/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-pilcd", "name" : "node-red-node-pilcd",
"version" : "0.0.3", "version" : "0.0.4",
"description" : "A Node-RED node for Raspberry Pi to write to HD44780 style LCD panels.", "description" : "A Node-RED node for Raspberry Pi to write to HD44780 style LCD panels.",
"dependencies" : { "dependencies" : {
}, },

2
hardware/PiLcd/pilcd.html
View File

@ -30,7 +30,7 @@
<script type="text/x-red" data-help-name="rpi-lcd"> <script type="text/x-red" data-help-name="rpi-lcd">
<p>Raspberry Pi output to a HD44780 style LCD. Usually 1, 2, or 4 lines of characters.</p> <p>Raspberry Pi output to a HD44780 style LCD. Usually 1, 2, or 4 lines of characters.</p>
<p>Expects a <b>msg.payload</b> with a string in it.</p> <p>Expects a <code>msg.payload</code> with a string in it.</p>
<p>Strings for the second line of the display must start <b>2:</b> - the third start <b>3:</b> - and the fourth <b>4:</b></p> <p>Strings for the second line of the display must start <b>2:</b> - the third start <b>3:</b> - and the fourth <b>4:</b></p>
<p>To clear the display send the string <b>clr:</b></p> <p>To clear the display send the string <b>clr:</b></p>
<p>It is up to you to manage string lengths to suit the display.</p> <p>It is up to you to manage string lengths to suit the display.</p>

2
hardware/PiLiter/README.md
View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a Pimo
Install 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-piliter npm install node-red-node-piliter

2
hardware/PiLiter/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-piliter", "name" : "node-red-node-piliter",
"version" : "0.0.8", "version" : "0.0.9",
"description" : "A Node-RED node to drive a Raspberry Pi Pi-LITEr 8 LED board.", "description" : "A Node-RED node to drive a Raspberry Pi Pi-LITEr 8 LED board.",
"dependencies" : { "dependencies" : {
}, },

7
hardware/PiSrf/README.md
View File

@ -9,8 +9,7 @@ to read range from an SRF05 Ultrasonic range sensor.
Install 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`
This is usually `~/.node-red`
npm install node-red-node-pisrf npm install node-red-node-pisrf
@ -19,12 +18,12 @@ Usage
Raspberry Pi input from an SRF04 or SRF05 ultrasonic range finder. Raspberry Pi input from an SRF04 or SRF05 ultrasonic range finder.
The configuartion requires two GPIO pin numbers, the trigger pin and the echo pin. The configuration requires two GPIO pin numbers, the trigger pin and the echo pin.
These can be any spare valid Pi GPIO pins. e.g. These can be any spare valid Pi GPIO pins. e.g.
7,11 7,11
Outputs a <b>msg.payload</b> with a number representing the range in cm. Outputs a `msg.payload` with a number representing the range in cm.
Produces one measure every 0.5s - but only if the distance is different from the previous reading. Produces one measure every 0.5s - but only if the distance is different from the previous reading.

2
hardware/PiSrf/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-pisrf", "name" : "node-red-node-pisrf",
"version" : "0.0.1", "version" : "0.0.2",
"description" : "A Node-RED node for a Raspberry Pi to use a SRF04 or SRF05 range finder", "description" : "A Node-RED node for a Raspberry Pi to use a SRF04 or SRF05 range finder",
"dependencies" : { "dependencies" : {
}, },

2
hardware/PiSrf/pisrf.html
View File

@ -30,7 +30,7 @@
<script type="text/x-red" data-help-name="rpi-srf"> <script type="text/x-red" data-help-name="rpi-srf">
<p>Raspberry Pi input from an SRF04 or SRF05 ultrasonic range finder.</p> <p>Raspberry Pi input from an SRF04 or SRF05 ultrasonic range finder.</p>
<p>Outputs a <b>msg.payload</b> with a number representing the range in cm.</p> <p>Outputs a <code>msg.payload</code> with a number representing the range in cm.</p>
<p>Produces one measure every 0.5s - but only if the distance is different from the previous reading.</p> <p>Produces one measure every 0.5s - but only if the distance is different from the previous reading.</p>
<p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p> <p><b>Note:</b> we are using the actual physical pin numbers on connector P1 as they are easier to locate.</p>
</script> </script>

2
hardware/Pibrella/38-rpi-pibrella.html
View File

@ -105,7 +105,7 @@
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<div class="form-tips" id="node-buzz-tip">Buzzer expects <b>msg.payload</b> to be a number in Hz.</div> <div class="form-tips" id="node-buzz-tip">Buzzer expects <code>msg.payload</code> to be a number in Hz.</div>
</script> </script>
<script type="text/x-red" data-help-name="rpi-pibrella out"> <script type="text/x-red" data-help-name="rpi-pibrella out">

12
hardware/Pibrella/README.md
View File

@ -5,7 +5,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a <a h
Install 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-pibrella npm install node-red-node-pibrella
@ -22,16 +22,16 @@ Usage
A pair of input and output Node-RED nodes for the Raspberry Pi Pibrella from Pimoroni. A pair of input and output Node-RED nodes for the Raspberry Pi Pibrella from Pimoroni.
###Output ### Output
The output node will set the selected output high (on) or low (off) depending on the value passed in. Expects a <b>msg.payload</b> with either a 0 or 1 (or true or false). The output node will set the selected output high (on) or low (off) depending on the value passed in. Expects a `msg.payload` with either a 0 or 1 (or true or false).
You may also select PWM mode to dim the on board LEDs if you wish. Expects a value from 0 to 100. You may also select PWM mode to dim the on board LEDs if you wish. Expects a value from 0 to 100.
The Buzzer expects a number representing the frequency in Hz. 0 is off and 1 is a tone - so you can use 0/1 type inputs as well. The Buzzer expects a number representing the frequency in Hz. 0 is off and 1 is a tone - so you can use 0/1 type inputs as well.
###Input ### Input
The input node generates a <b>msg.payload</b> with either a 0 or 1 depending on the state of the input pin. The input node generates a `msg.payload` with either a 0 or 1 depending on the state of the input pin.
The <b>msg.topic</b> is set to <i>pibrella/{the pin id}</i> - which will be A, B, C, D or R. The `msg.topic` is set to <i>pibrella/{the pin id}</i> - which will be A, B, C, D or R.

2
hardware/Pibrella/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-pibrella", "name" : "node-red-node-pibrella",
"version" : "0.0.10", "version" : "0.0.11",
"description" : "A Node-RED node to read from and write to a Pibrella Raspberry Pi add-on board", "description" : "A Node-RED node to read from and write to a Pibrella Raspberry Pi add-on board",
"dependencies" : { "dependencies" : {
}, },

7
hardware/blink1/README.md
View File

@ -22,18 +22,17 @@ and also setup these udev rules in `/etc/udev/rules.d/51-blink1.rules`
Install Install
------- -------
Run the following command in the user directory of your Node-RED install. Run the following command in your Node-RED user directory - typically `~/.node-red`
This is usually `~/.node-red`
npm i node-red-node-blink1 npm i node-red-node-blink1
Usage Usage
----- -----
Sends the <b>msg.payload</b> to a Thingm Blink(1) LED device. The payload can be any of the following: Sends the `msg.payload` to a Thingm Blink(1) LED device. The payload can be any of the following:
- a three part csv string of r,g,b - e.g. red is 255,0,0 - a three part csv string of r,g,b - e.g. red is 255,0,0
- a hex colour #rrggbb - e.g. green is #00FF00 - a hex colour #rrggbb - e.g. green is #00FF00
- a <a href="http://www.cheerlights.com/control-cheerlights">@cheerlights</a> colour name - e.g. blue - a <a href="http://www.cheerlights.com/control-cheerlights">@cheerlights</a> colour name - e.g. blue
The colours it accepts are - red, amber, green, blue, cyan, magenta, yellow, orange, pink, purple, white, warmwhite (or oldlace), black, (or off) The colours it accepts are - red, amber, green, blue, cyan, magenta, yellow, orange, pink, purple, white, warmwhite (or oldlace), black, (and off)

10
hardware/blinkstick/README.md
View File

@ -23,15 +23,15 @@ and either reload the udev rules or reboot.
Install Install
------- -------
Run the following command in the user directory of your Node-RED install. Run the following command in your Node-RED user directory - typically `~/.node-red`
Usually this is `~/.node-red`
npm install node-red-node-blinkstick npm i node-red-node-blinkstick
Usage Usage
----- -----
<i><a href="http://www.blinkstick.com" target="_new">BlinkStick</a></i> output node. Expects a <b>msg.payload</b> with one of: <i><a href="http://www.blinkstick.com" target="_new">BlinkStick</a></i> output node.
Expects a `msg.payload` with one of:
* A hex string <b>"#rrggbb"</b> triple * A hex string <b>"#rrggbb"</b> triple
* <b>"red,green,blue"</b> three 0-255 values as a string * <b>"red,green,blue"</b> three 0-255 values as a string
@ -43,5 +43,5 @@ An object payload can override any of the settings on the node. Omitted paramete
{ 'color': 'blue' } { 'color': 'blue' }
{ 'task': 'blink', 'color': 'red' } { 'task': 'blink', 'color': 'red' }
{ 'task': 'pulse', 'color': 'gree', 'duration': 500 } { 'task': 'pulse', 'color': 'green', 'duration': 500 }
{ 'task': 'morph', 'color': 'orange', 'duration': 500, 'steps': 20 } { 'task': 'morph', 'color': 'orange', 'duration': 500, 'steps': 20 }

2
hardware/blinkstick/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-blinkstick", "name" : "node-red-node-blinkstick",
"version" : "0.1.11", "version" : "0.1.12",
"description" : "A Node-RED node to control a Blinkstick", "description" : "A Node-RED node to control a Blinkstick",
"dependencies" : { "dependencies" : {
"blinkstick" : "1.1.3" "blinkstick" : "1.1.3"

4
hardware/digiRGB/78-digiRGB.html
View File

@ -19,12 +19,12 @@
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="DigiSpark"> <input type="text" id="node-input-name" placeholder="DigiSpark">
</div> </div>
<div class="form-tips">Expects a msg.payload with three part csv string of r,g,b.</div> <div class="form-tips">Expects a <code>msg.payload</code> with three part csv string of r,g,b.</div>
</script> </script>
<script type="text/x-red" data-help-name="digiRGB"> <script type="text/x-red" data-help-name="digiRGB">
<p>Simple output node to drive digispark RGB</p> <p>Simple output node to drive digispark RGB</p>
<p>Requires <b>msg.payload</b> to be of the form 'r,g,b' decimals 0-255, or a hex string "#rrggbb". For example:</p> <p>Requires <code>msg.payload</code> to be of the form 'r,g,b' decimals 0-255, or a hex string "#rrggbb". For example:</p>
<ul><li>Red : "255,0,0"</li><li>Green : "#00FF00"</li></ul> <ul><li>Red : "255,0,0"</li><li>Green : "#00FF00"</li></ul>
</script> </script>

7
hardware/digiRGB/README.md
View File

@ -6,10 +6,9 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a <a h
Install Install
------- -------
Run the following command in the home directory of your Node-RED install. Run the following command in your Node-RED user directory - typically `~/.node-red`
This is usually `~/.node-red`
npm install node-red-node-digirgb npm i node-red-node-digirgb
Usage Usage
@ -17,4 +16,4 @@ Usage
Simple output node to drive a Digispark RGB LED. Simple output node to drive a Digispark RGB LED.
Requires a <b>msg.payload</b> to be of the form 'r,g,b' - for example 255,0,0 for red. Requires a `msg.payload` to be of the form 'r,g,b' - for example 255,0,0 for red.

2
hardware/digiRGB/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-digirgb", "name" : "node-red-node-digirgb",
"version" : "0.0.4", "version" : "0.0.5",
"description" : "A Node-RED node to control a Digispark RGB LED", "description" : "A Node-RED node to control a Digispark RGB LED",
"dependencies" : { "dependencies" : {
"node-hid" : "0.4.*" "node-hid" : "0.4.*"

14
hardware/heatmiser/README.md
View File

@ -6,7 +6,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to control and po
Install 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-contrib-heatmiser npm install node-red-contrib-heatmiser
@ -14,22 +14,22 @@ Run the following command in the root directory of your Node-RED install
Usage Usage
----- -----
###Input node### ### Input node
Expects a **msg.payload** with a JSON object that contains settings for the Heatmiser thermostat Expects a `msg.payload` with a JSON object that contains settings for the Heatmiser thermostat
**msg.payload** can currently be either a heating boost option, or a run mode, as below: `msg.payload` can currently be either a heating boost option, or a run mode, as below:
####Heating boost#### #### Heating boost
{heating: {target: TARGET_TEMPERATURE, hold: MINUTES_TO_STAY_ON_FOR}} {heating: {target: TARGET_TEMPERATURE, hold: MINUTES_TO_STAY_ON_FOR}}
####Run mode#### #### Run mode
{runmode:"frost"} {runmode:"frost"}
{runmode:"heating"} {runmode:"heating"}
###Output node.### ### Output node
Will read and send a status update at a configurable time interval. This is set to every 30 minutes by default. Will read and send a status update at a configurable time interval. This is set to every 30 minutes by default.

2
hardware/heatmiser/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-contrib-heatmiser", "name" : "node-red-contrib-heatmiser",
"version" : "0.0.2", "version" : "0.0.3",
"description" : "A Node-RED node to control and poll a HeatMiser thermostat.", "description" : "A Node-RED node to control and poll a HeatMiser thermostat.",
"dependencies" : { "dependencies" : {
"heatmiser" : "2.0.0" "heatmiser" : "2.0.0"

11
hardware/intel/README.md
View File

@ -7,10 +7,9 @@ Galileo or Edison running mraa.
Install Install
------- -------
Run the following command in the root directory of your Node-RED install, usually Run the following command in your Node-RED user directory - typically `~/.node-red`
this is ~/.node-red .
npm install node-red-node-intel-gpio npm i node-red-node-intel-gpio
Usage Usage
----- -----
@ -39,7 +38,7 @@ If you do need to install Node-RED, you can do this as follows from the home dir
### Analogue Input Node ### Analogue Input Node
Monitors the selected pin for changes. It outputs on a change of value. Monitors the selected pin for changes. It outputs on a change of value.
As analogue inputs are continously changing you can set the sample rate in ms from 20 to 65535. As analogue inputs are continuously changing you can set the sample rate in ms from 20 to 65535.
### Digital Input Node ### Digital Input Node
@ -48,11 +47,11 @@ Monitors the selected pin for changes. It only outputs on a change of value.
### Digital Output Node ### Digital Output Node
Sets the selected digital pin output high or low depending on the value of Sets the selected digital pin output high or low depending on the value of
**msg.payload** - expects a number or string 0 or 1. `msg.payload` - expects a number or string 0 or 1.
### Pulse Width Modulation (PWM) Node ### Pulse Width Modulation (PWM) Node
The **msg.payload** should contain a floating point number value The `msg.payload` should contain a floating point number value
between 0 (off) and 1 (fully on), or a string representation thereof. between 0 (off) and 1 (fully on), or a string representation thereof.
You can set the overall period (mS) in the edit dialogue. You can set the overall period (mS) in the edit dialogue.

2
hardware/intel/mraa-gpio-ain.html
View File

@ -78,7 +78,7 @@
<script type="text/x-red" data-help-name="mraa-gpio-ain"> <script type="text/x-red" data-help-name="mraa-gpio-ain">
<p>An analogue input pin for an Intel Galileo or Edison board that is read every <i>interval</i> milliseconds.</p> <p>An analogue input pin for an Intel Galileo or Edison board that is read every <i>interval</i> milliseconds.</p>
<p>The <b>msg.payload</b> will contain the value, and <b>msg.topic</b> <p>The <code>msg.payload</code> will contain the value, and <code>msg.topic</code>
contains "{the_board_name}/A{the pin number}".</p> contains "{the_board_name}/A{the pin number}".</p>
<p>The value is only sent if it is different from the previously read value.</p> <p>The value is only sent if it is different from the previously read value.</p>
</script> </script>

2
hardware/intel/mraa-gpio-din.html
View File

@ -94,6 +94,6 @@
<script type="text/x-red" data-help-name="mraa-gpio-din"> <script type="text/x-red" data-help-name="mraa-gpio-din">
<p>A digital input pin for an Intel Galileo or Edison board.</p> <p>A digital input pin for an Intel Galileo or Edison board.</p>
<p>The <b>msg.payload</b> contains the value (0 or 1), and <b>msg.topic</b> <p>The <code>msg.payload</code> contains the value (0 or 1), and <code>msg.topic</code>
contains "{the_board_name}/D{the pin number}".</p> contains "{the_board_name}/D{the pin number}".</p>
</script> </script>

2
hardware/intel/mraa-gpio-dout.html
View File

@ -116,5 +116,5 @@
<script type="text/x-red" data-help-name="mraa-gpio-dout"> <script type="text/x-red" data-help-name="mraa-gpio-dout">
<p>A digital output pin for an Intel Galileo or Edison board.</p> <p>A digital output pin for an Intel Galileo or Edison board.</p>
<p>The <b>msg.payload</b> should contain the value 0 or 1.</p> <p>The <code>msg.payload</code> should contain the value 0 or 1.</p>
</script> </script>

2
hardware/intel/mraa-gpio-pwm.html
View File

@ -96,7 +96,7 @@
<script type="text/x-red" data-help-name="mraa-gpio-pwm"> <script type="text/x-red" data-help-name="mraa-gpio-pwm">
<p>A pulse width modulation (PWM) output pin for an Intel Galileo or Edison board.</p> <p>A pulse width modulation (PWM) output pin for an Intel Galileo or Edison board.</p>
<p>The <b>msg.payload</b> should contain a floating point number value <p>The <code>msg.payload</code> should contain a floating point number value
between 0 and 1, (or a string representation thereof.)</p> between 0 and 1, (or a string representation thereof.)</p>
<p>For servo control set the period to 20mS and vary the input between 0.05 and 0.10</p> <p>For servo control set the period to 20mS and vary the input between 0.05 and 0.10</p>
<p><b>Note</b> : Only pins 3, 5, 6, 9, 10 & 11 support PWM output.</p> <p><b>Note</b> : Only pins 3, 5, 6, 9, 10 & 11 support PWM output.</p>

2
hardware/intel/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-intel-gpio", "name" : "node-red-node-intel-gpio",
"version" : "0.0.3", "version" : "0.0.4",
"description" : "A Node-RED node to talk to an Intel Galileo or Edison using mraa", "description" : "A Node-RED node to talk to an Intel Galileo or Edison using mraa",
"dependencies" : { "dependencies" : {
}, },

2
hardware/makey/README.md
View File

@ -5,7 +5,7 @@ A <a href="http://nodered.org" target="_new">Node-RED</a> node to read from a Ma
Install 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-makeymakey npm install node-red-node-makeymakey

2
hardware/makey/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-makeymakey", "name" : "node-red-node-makeymakey",
"version" : "0.0.2", "version" : "0.0.3",
"description" : "A Node-RED node to read from a MakeyMakey input device.", "description" : "A Node-RED node to read from a MakeyMakey input device.",
"dependencies" : { "dependencies" : {
"hidstream": "2.0.*" "hidstream": "2.0.*"

24
hardware/neopixel/README.md
View File

@ -17,8 +17,7 @@ Pimoroni Getting Started with Unicorn HAT</a> page.
Install 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`
Usually this is `~/.node-red`
npm install node-red-node-pi-neopixel npm install node-red-node-pi-neopixel
@ -28,7 +27,7 @@ The data pin of the pixels should be connected to physical pin 12 - GPIO 18 of t
Usage Usage
----- -----
To set the background just set **msg.payload** to an `html_colour` name. To set the background just set `msg.payload` to an `html_colour` name.
<a href="http://html-color-codes.info/color-names/" target="_top">Here <a href="http://html-color-codes.info/color-names/" target="_top">Here
is a list</a> of html_colour names. is a list</a> of html_colour names.
@ -36,31 +35,34 @@ It also accepts a string triple `rrr,ggg,bbb` or `#rrggbb`
#### Bar Chart #### Bar Chart
Defaults style mode using configured foreground and background colours. The foreground colour is used to indicate the number of pixels or length required. Defaults style mode using configured foreground and background colours. The
foreground colour is used to indicate the number of pixels or length required.
It accepts a number in **msg.payload** that can be either the number of pixels, It accepts a number in `msg.payload` that can be either the number of pixels,
or a percentage of the total length. or a percentage of the total length.
If you want to change the foreground colour, you can set **msg.payload** to a If you want to change the foreground colour, you can set `msg.payload` to a
comma separated string of `html_colour,length` or `length,html_colour`. The foreground will then remain that colour until changed again. comma separated string of `html_colour,length` or `length,html_colour`. The
foreground will then remain that colour until changed again.
#### Needle #### Needle
It can also display a needle (single pixel) type gauge. It can also display a needle (single pixel) type gauge.
The rest of the pixels are set to the background colour on one side, and the foreground colour on the other side of the indicated pixel. The rest of the pixels are set to the background colour on one side, and the foreground colour on the other side of the indicated pixel.
If you want to change the needle colour, you can set **msg.payload** to a If you want to change the needle colour, you can set `msg.payload` to a
comma separated string of `html_colour,length` or `length,html_colour`. comma separated string of `html_colour,length` or `length,html_colour`.
#### Shift left and Shift right #### Shift left and Shift right
You can also select shift modes where a single colour pixel is added to either You can also select shift modes where a single colour pixel is added to either
the start or the end of the strip, shifting all the others along by one. In this mode the `msg.payload` can be specified as either an html colour name, an r,g,b triple or #rrggbb. the start or the end of the strip, shifting all the others along by one. In this
mode the `msg.payload` can be specified as either an html colour name, an r,g,b triple or #rrggbb.
#### Low level "API" #### Low level "API"
The `nth` pixel of the string can be set by **msg.payload** with a CSV string `n,r,g,b` , The `nth` pixel of the string can be set by `msg.payload` with a CSV string `n,r,g,b` ,
where r, g and b are 0-255. where r, g and b are 0-255.
A range of pixels from position `x` to `y` can be set by **msg.payload** A range of pixels from position `x` to `y` can be set by `msg.payload`
with a CSV string `x,y,r,g,b` with a CSV string `x,y,r,g,b`

2
hardware/neopixel/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-pi-neopixel", "name" : "node-red-node-pi-neopixel",
"version" : "0.0.10", "version" : "0.0.11",
"description" : "A Node-RED node to output to a neopixel (ws2812) string of LEDS from a Raspberry Pi.", "description" : "A Node-RED node to output to a neopixel (ws2812) string of LEDS from a Raspberry Pi.",
"dependencies" : { "dependencies" : {
}, },

36
hardware/physical-web/README.md
View File

@ -1,49 +1,57 @@
# node-red-node-physical-web node-red-node-physical-web
==========================
install with Nodes to allow Node-RED to act as an Eddystone BLE beacon.
npm install node-red-node-physical-web Install
-------
Then on Linux follow these instrucations: Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-physical-web
Then on Linux follow these instructions:
https://github.com/sandeepmistry/bleno#running-on-linux https://github.com/sandeepmistry/bleno#running-on-linux
## Physical-Web out Usage
-----
### Physical-Web Out
A node to allow Node-RED to act as an Eddystone beacon broadcasting URLs A node to allow Node-RED to act as an Eddystone beacon broadcasting URLs
### Config The config window lets you set the initial URL, announcement power and period for the Eddystone.
The config window lets you set the inital URL, anouncement power and period for the Eddystone.
Any messages received will update the advertised URL from the msg.payload Any messages received will update the advertised URL from the msg.payload
## Physical-Web in ## Physical-Web In
A node to scan for local Eddystones and output information about discovered URLs and TLM data. A node to scan for local Eddystones and output information about discovered URLs and TLM data.
Two types of messages will be emitted: Two types of messages will be emitted:
- **URL** - - **URL**
- *type* - Eddystone type - *type* - Eddystone type
- *txPower* - Received power at 0m in dBm - *txPower* - Received power at 0m in dBm
- *url* - The URL the beacon is broadcasting - *url* - The URL the beacon is broadcasting
- *tlm* - TLM data, if the device is interleaving broadcasts - *tlm* - TLM data, if the device is interleaving broadcasts
- *rssi* - RSSI of the beacon - *rssi* - RSSI of the beacon
- *distance* - Estimated distance to the beacon - *distance* - Estimated distance to the beacon
- **UID** -
- **UID**
- *type* - Eddystone type - *type* - Eddystone type
- *txPower* - Received power at 0m in dBm - *txPower* - Received power at 0m in dBm
- *namespace* - 10-byte ID of namspace - *namespace* - 10-byte ID of namespace
- *instance* - 6-byte ID insance - *instance* - 6-byte ID instance
- *tlm* - TLM data, if the device is interleaving broadcasts - *tlm* - TLM data, if the device is interleaving broadcasts
- *rssi* - RSSI of the beacon - *rssi* - RSSI of the beacon
- *distance* - Estimated distance to the beacon - *distance* - Estimated distance to the beacon
Where the tlm data will be in the following format Where the tlm data will be in the following format
- **tlm** - - **tlm**
- *version* - TLM version - *version* - TLM version
- *vbatt* - Battery Voltage - *vbatt* - Battery Voltage
- *temp* - Temperature - *temp* - Temperature

2
hardware/physical-web/package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "node-red-node-physical-web", "name": "node-red-node-physical-web",
"version": "0.0.4", "version": "0.0.5",
"description": "A set of nodes to interact with the Phyical Web", "description": "A set of nodes to interact with the Phyical Web",
"main": "physical-web.js", "main": "physical-web.js",
"scripts": { "scripts": {

21
hardware/unicorn/README.md
View File

@ -16,10 +16,9 @@ Pimoroni Getting Started with Unicorn HAT</a> page.
Install 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`
Usually this is `~/.node-red`
npm install node-red-node-pi-unicorn-hat npm i node-red-node-pi-unicorn-hat
Usage Usage
----- -----
@ -30,23 +29,23 @@ png image, or by specifying a single colour using an r,g,b triple.
The brightness can also be set in the configuration. Defaults to 20% so as not The brightness can also be set in the configuration. Defaults to 20% so as not
to blind you. to blind you.
A pixel is set by **msg.payload** with a CSV string `x,y,r,g,b` , where x and y A pixel is set by `msg.payload` with a CSV string `x,y,r,g,b` , where x and y
are 0 to 7, and r, g and b are 0 - 255. are 0 to 7, and r, g and b are 0 - 255.
If `x` or `y` are set to `*` then the complete row or column can be set. If `x` or `y` are set to `*` then the complete row or column can be set.
Setting both `x` and `y` to `*` fills the background. Setting both `x` and `y` to `*` fills the background.
Multiple pixels can be specified at once by using `x1,y1,r1,g1,b1,x2,y2,r2,g2,b2,...` etc Multiple pixels can be specified at once by using `x1,y1,r1,g1,b1,x2,y2,r2,g2,b2,...` etc
The background can also be set to a colour by setting **msg.payload** to an r,g,b triple. The background can also be set to a colour by setting `msg.payload` to an r,g,b triple.
Any msg with a **msg.topic** identifies a 'sprite', which can then be moved Any msg with a `msg.topic` identifies a 'sprite', which can then be moved
independently of the background. A 'sprite' can be a single pixel, or a group of pixels. independently of the background. A 'sprite' can be a single pixel, or a group of pixels.
Setting **msg.payload** to `0` will delete the sprite from the list identified by **msg.topic**. Setting `msg.payload` to `0` will delete the sprite from the list identified by `msg.topic`.
Setting **msg.payload** to `DEL` delete any sprites - leaving the background. Setting `msg.payload` to `DEL` delete any sprites - leaving the background.
Setting **msg.payload** to `CLS` will clear the display to off and delete any sprites. Setting `msg.payload` to `CLS` will clear the display to off and delete any sprites.
The overall brightness may be set by setting **msg.payload** to `brightness,nn`, where `nn` is 0 to 100. The overall brightness may be set by setting `msg.payload` to `brightness,nn`, where `nn` is 0 to 100.
The rotation may be set by setting ••msg.payload•• to 'rotate,rr', where 'rr' is 0, 90, 180 or 270. The rotation may be set by setting `msg.payload` to 'rotate,rr', where 'rr' is 0, 90, 180 or 270.

2
hardware/unicorn/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-pi-unicorn-hat", "name" : "node-red-node-pi-unicorn-hat",
"version" : "0.0.5", "version" : "0.0.6",
"description" : "A Node-RED node to output to a Raspberry Pi Unicorn HAT from Pimorini.", "description" : "A Node-RED node to output to a Raspberry Pi Unicorn HAT from Pimorini.",
"dependencies" : { "dependencies" : {
"pngjs": "2.2.*" "pngjs": "2.2.*"

4
hardware/wemo/60-wemo.html
View File

@ -27,7 +27,7 @@
</script> </script>
<script type="text/x-red" data-help-name="wemo out"> <script type="text/x-red" data-help-name="wemo out">
<p>Wemo output node. Expects a <b>msg.payload</b> with either 1/0, on/off or true/false.</p> <p>Wemo output node. Expects a <code>msg.payload</code> with either 1/0, on/off or true/false.</p>
<p>It doesn't yet do any ip address discovery of the wemo devices.</p> <p>It doesn't yet do any ip address discovery of the wemo devices.</p>
</script> </script>
@ -65,7 +65,7 @@
</script> </script>
<script type="text/x-red" data-help-name="wemo in"> <script type="text/x-red" data-help-name="wemo in">
<p>Wemo input node. Creates a <b>msg.payload</b> with either 1, 0, nc (no change), or na (not available).</p> <p>Wemo input node. Creates a <code>msg.payload</code> with either 1, 0, nc (no change), or na (not available).</p>
<p>It doesn't yet do any ip address discovery of the wemo devices.</p> <p>It doesn't yet do any ip address discovery of the wemo devices.</p>
</script> </script>

10
hardware/wemo/README.md
View File

@ -6,7 +6,7 @@ A pair of <a href="http://nodered.org" target="_new">Node-RED</a> nodes to contr
Install 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-wemo npm install node-red-node-wemo
@ -16,11 +16,11 @@ Usage
It doesn't yet do any ip address discovery of the wemo devices. It doesn't yet do any ip address discovery of the wemo devices.
###Wemo output node. ### Wemo output node.
Expects a **msg.payload** with either 1/0, on/off or true/false. Expects a `msg.payload` with either 1/0, on/off or true/false.
###Wemo input node. ### Wemo input node.
Creates a **msg.payload** with either 1, 0, nc (no change), or na (not available). Creates a `msg.payload` with either 1, 0, nc (no change), or na (not available).

2
hardware/wemo/package.json
View File

@ -1,6 +1,6 @@
{ {
"name" : "node-red-node-wemo", "name" : "node-red-node-wemo",
"version" : "0.0.2", "version" : "0.0.3",
"description" : "A Node-RED node to control a Belkin Wemo set of devices.", "description" : "A Node-RED node to control a Belkin Wemo set of devices.",
"dependencies" : { "dependencies" : {
"wemo" : "0.2.*" "wemo" : "0.2.*"