diff --git a/hardware/HummingboardGPIO/README.md b/hardware/HummingboardGPIO/README.md index b4b0ccab..cb367c40 100644 --- a/hardware/HummingboardGPIO/README.md +++ b/hardware/HummingboardGPIO/README.md @@ -8,14 +8,14 @@ Install **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 **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 chmod 4755 /usr/lcoal/bin/gpiohb + sudo chmod 4755 /usr/local/bin/gpiohb 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. -###Output node +### Output node -Expects a msg.payload 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. 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. diff --git a/hardware/HummingboardGPIO/hb-gpio.html b/hardware/HummingboardGPIO/hb-gpio.html index 6c4aa762..5ebcf972 100644 --- a/hardware/HummingboardGPIO/hb-gpio.html +++ b/hardware/HummingboardGPIO/hb-gpio.html @@ -52,9 +52,9 @@ @@ -120,7 +120,7 @@ diff --git a/hardware/PiFace/README.md b/hardware/PiFace/README.md index 6e475758..5aa363f3 100644 --- a/hardware/PiFace/README.md +++ b/hardware/PiFace/README.md @@ -12,7 +12,7 @@ We cannot automatically detect this so the user will have to apply some common s 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 @@ -46,19 +46,19 @@ add-on board. ### Output The PiFace output node will set the selected relay, LED, or pin on or off -depending on the value passed in. Expects a msg.payload with either a +depending on the value passed in. Expects a `msg.payload` with either a 1 or 0 (or true or false). Requires the WiringPi gpio command in order to work (see pre-reqs). ### Input -The PiFace input node generates a msg.payload 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. You may also enable the input pullup resistor if required. -The msg.topic is set to piface/{the pin number} +The `msg.topic` is set to piface/{the pin number} Requires the WiringPi gpio command in order to work (see pre-reqs). diff --git a/hardware/PiFace/package.json b/hardware/PiFace/package.json index 1894f119..1c58b9d3 100644 --- a/hardware/PiFace/package.json +++ b/hardware/PiFace/package.json @@ -1,6 +1,6 @@ { "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", "dependencies" : { }, diff --git a/hardware/PiLcd/README.md b/hardware/PiLcd/README.md index 385d75e7..0f8d5468 100644 --- a/hardware/PiLcd/README.md +++ b/hardware/PiLcd/README.md @@ -7,8 +7,7 @@ to write to a GPIO connected HD44780 style LCD panels. 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-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 -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 diff --git a/hardware/PiLcd/package.json b/hardware/PiLcd/package.json index 79b16929..5c373620 100644 --- a/hardware/PiLcd/package.json +++ b/hardware/PiLcd/package.json @@ -1,6 +1,6 @@ { "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.", "dependencies" : { }, diff --git a/hardware/PiLcd/pilcd.html b/hardware/PiLcd/pilcd.html index 87dab382..ffabd048 100644 --- a/hardware/PiLcd/pilcd.html +++ b/hardware/PiLcd/pilcd.html @@ -30,7 +30,7 @@ diff --git a/hardware/Pibrella/38-rpi-pibrella.html b/hardware/Pibrella/38-rpi-pibrella.html index 1aeea99c..4b388f2a 100644 --- a/hardware/Pibrella/38-rpi-pibrella.html +++ b/hardware/Pibrella/38-rpi-pibrella.html @@ -105,7 +105,7 @@ -
Buzzer expects msg.payload to be a number in Hz.
+
Buzzer expects msg.payload to be a number in Hz.
diff --git a/hardware/digiRGB/README.md b/hardware/digiRGB/README.md index 665a52d4..3735ea21 100644 --- a/hardware/digiRGB/README.md +++ b/hardware/digiRGB/README.md @@ -6,10 +6,9 @@ A Node-RED node to control a msg.payload 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. diff --git a/hardware/digiRGB/package.json b/hardware/digiRGB/package.json index fea47c25..98f90831 100644 --- a/hardware/digiRGB/package.json +++ b/hardware/digiRGB/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-digirgb", - "version" : "0.0.4", + "version" : "0.0.5", "description" : "A Node-RED node to control a Digispark RGB LED", "dependencies" : { "node-hid" : "0.4.*" diff --git a/hardware/heatmiser/README.md b/hardware/heatmiser/README.md index 7930c2fe..fdd3b51d 100644 --- a/hardware/heatmiser/README.md +++ b/hardware/heatmiser/README.md @@ -6,7 +6,7 @@ A Node-RED node to control and po 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 @@ -14,22 +14,22 @@ Run the following command in the root directory of your Node-RED install 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}} -####Run mode#### +#### Run mode {runmode:"frost"} {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. diff --git a/hardware/heatmiser/package.json b/hardware/heatmiser/package.json index eaa24d3c..1462fb10 100644 --- a/hardware/heatmiser/package.json +++ b/hardware/heatmiser/package.json @@ -1,6 +1,6 @@ { "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.", "dependencies" : { "heatmiser" : "2.0.0" diff --git a/hardware/intel/README.md b/hardware/intel/README.md index 46e92033..2d851289 100644 --- a/hardware/intel/README.md +++ b/hardware/intel/README.md @@ -7,10 +7,9 @@ Galileo or Edison running mraa. 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-intel-gpio + npm i node-red-node-intel-gpio 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 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 @@ -48,11 +47,11 @@ Monitors the selected pin for changes. It only outputs on a change of value. ### Digital Output Node 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 -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. You can set the overall period (mS) in the edit dialogue. diff --git a/hardware/intel/mraa-gpio-ain.html b/hardware/intel/mraa-gpio-ain.html index bba11073..5503021a 100644 --- a/hardware/intel/mraa-gpio-ain.html +++ b/hardware/intel/mraa-gpio-ain.html @@ -78,7 +78,7 @@ diff --git a/hardware/intel/mraa-gpio-din.html b/hardware/intel/mraa-gpio-din.html index 26865ae2..d12d0e37 100644 --- a/hardware/intel/mraa-gpio-din.html +++ b/hardware/intel/mraa-gpio-din.html @@ -94,6 +94,6 @@ diff --git a/hardware/intel/mraa-gpio-dout.html b/hardware/intel/mraa-gpio-dout.html index 34b5555f..9f1ab189 100644 --- a/hardware/intel/mraa-gpio-dout.html +++ b/hardware/intel/mraa-gpio-dout.html @@ -116,5 +116,5 @@ diff --git a/hardware/intel/mraa-gpio-pwm.html b/hardware/intel/mraa-gpio-pwm.html index 740e9cdc..076a4f3c 100644 --- a/hardware/intel/mraa-gpio-pwm.html +++ b/hardware/intel/mraa-gpio-pwm.html @@ -96,7 +96,7 @@ @@ -65,7 +65,7 @@ diff --git a/hardware/wemo/README.md b/hardware/wemo/README.md index 32214701..8b9b4ab2 100644 --- a/hardware/wemo/README.md +++ b/hardware/wemo/README.md @@ -6,7 +6,7 @@ A pair of Node-RED nodes to contr 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 @@ -16,11 +16,11 @@ Usage 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). diff --git a/hardware/wemo/package.json b/hardware/wemo/package.json index 34de53c9..5d31c60a 100644 --- a/hardware/wemo/package.json +++ b/hardware/wemo/package.json @@ -1,6 +1,6 @@ { "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.", "dependencies" : { "wemo" : "0.2.*"