Info/Doc style updates to core/pi nodes

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

View File

@@ -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.

View File

@@ -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"

View File

@@ -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

View File

@@ -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.*"

View File

@@ -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.

View File

@@ -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" : {
},

View File

@@ -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

View File

@@ -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",