node-red-nodes/hardware/Arduino/README.md

node-red-node-arduino
=====================

A <a href="http://nodered.org" target="_new">Node-RED</a> node to talk to an
Arduino running standard firmata 2.2 or better.

Install
-------

Run the following command in your Node-RED user directory - typically `~/.node-red`

        npm i --unsafe-perm node-red-node-arduino

Usage
-----

The Firmata firmware must be loaded into the Arduino.

See the [main documentation](http://nodered.org/docs/hardware/arduino.html) for
details and examples of how to use this node.

### Input Node

Connects to local Arduino and monitors the selected pin for changes.

You can select either **Digital**, **Analogue**, or **String** input type.
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.

You can set the sample rate from `20` to `65535` mS.

### Output Node

Connects to local Arduino and writes to the selected pin.

You can select

 - **Digital** - accepts 0, 1, true, false, on, off
 - **Analogue** (PWM) - accepts Integer 0 to 255
 - **Servo** - accepts Integer 0 - 180
 - **String** - to send a *String* to the Arduino

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.

### Example

Simple flow to blink Pin 13

        [{"id":"d7663aaf.47194","type":"arduino-board","device":""},{"id":"dae8234f.2517e","type":"inject","name":"0.5s tick","topic":"","payload":"","payloadType":"date","repeat":"0.5","crontab":"","once":false,"x":150,"y":100,"z":"359a4b52.ca65b4","wires":[["56a6f8f2.a95908"]]},{"id":"2db61802.d249e8","type":"arduino out","name":"","pin":"13","state":"OUTPUT","arduino":"d7663aaf.47194","x":570.5,"y":100,"z":"359a4b52.ca65b4","wires":[]},{"id":"56a6f8f2.a95908","type":"function","name":"Toggle output on input","func":"\n// If it does exist make it the inverse of what it was or else initialise it to false\n// (context variables persist between calls to the function)\ncontext.level = !context.level || false;\n\n// set the payload to the level and return\nmsg.payload = context.level;\nreturn msg;","outputs":1,"noerr":0,"x":358,"y":100,"z":"359a4b52.ca65b4","wires":[["2db61802.d249e8"]]}]
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00			`node-red-node-arduino`
			`=====================`

Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00			`A <a href="http://nodered.org" target="_new">Node-RED</a> node to talk to an`
			`Arduino running standard firmata 2.2 or better.`
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
			`Install`
			`-------`

Info/Doc style updates to core/pi nodes 2016-03-02 14:18:24 +01:00			Run the following command in your Node-RED user directory - typically `~/.node-red`
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
bump package versions (heatmiser, arduino, pushover) 2016-11-26 22:22:18 +01:00			`npm i --unsafe-perm node-red-node-arduino`
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
			`Usage`
			`-----`

			`The Firmata firmware must be loaded into the Arduino.`

			`See the [main documentation](http://nodered.org/docs/hardware/arduino.html) for`
			`details and examples of how to use this node.`

Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00			`### Input Node`
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
			`Connects to local Arduino and monitors the selected pin for changes.`

slight tidy to Arduino and bump version 2016-03-02 15:22:16 +01:00			`You can select either Digital, Analogue, or String input type.`
Info/Doc style updates to core/pi nodes 2016-03-02 14:18:24 +01:00			Outputs the value read as `msg.payload` and the pin number as `msg.topic`.
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
			`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.`

Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00			You can set the sample rate from `20` to `65535` mS.
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00			`### Output Node`
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
			`Connects to local Arduino and writes to the selected pin.`

Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00			`You can select`

			`- Digital - accepts 0, 1, true, false, on, off`
			`- Analogue (PWM) - accepts Integer 0 to 255`
			`- Servo - accepts Integer 0 - 180`
slight tidy to Arduino and bump version 2016-03-02 15:22:16 +01:00			`- String - to send a String to the Arduino`
Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00
Info/Doc style updates to core/pi nodes 2016-03-02 14:18:24 +01:00			Expects a numeric value in `msg.payload`. The pin number is set in the properties panel.
Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00
			`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.
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
Tidy Arduino - make it use integers. plus slight tidy of docs 2016-02-01 00:27:10 +01:00			`### Example`
Move Arduino node from core to external 2015-06-06 19:13:53 +02:00
			`Simple flow to blink Pin 13`

			[{"id":"d7663aaf.47194","type":"arduino-board","device":""},{"id":"dae8234f.2517e","type":"inject","name":"0.5s tick","topic":"","payload":"","payloadType":"date","repeat":"0.5","crontab":"","once":false,"x":150,"y":100,"z":"359a4b52.ca65b4","wires":[["56a6f8f2.a95908"]]},{"id":"2db61802.d249e8","type":"arduino out","name":"","pin":"13","state":"OUTPUT","arduino":"d7663aaf.47194","x":570.5,"y":100,"z":"359a4b52.ca65b4","wires":[]},{"id":"56a6f8f2.a95908","type":"function","name":"Toggle output on input","func":"\n// If it does exist make it the inverse of what it was or else initialise it to false\n// (context variables persist between calls to the function)\ncontext.level = !context.level \|\| false;\n\n// set the payload to the level and return\nmsg.payload = context.level;\nreturn msg;","outputs":1,"noerr":0,"x":358,"y":100,"z":"359a4b52.ca65b4","wires":[["2db61802.d249e8"]]}]