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"