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

node-red-node-ledborg
=====================

A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a <a href="https://www.piborg.org/ledborg" target="_new">PiBorg LedBorg</a> board for a Raspberry Pi.

Install
-------

Run the following command in the root directory of your Node-RED install,
this is usually `~/.node-red`

    npm i node-red-node-ledborg


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.

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 :

><pre>0x00 - 0x57 = off<br/>0x58 - 0xA7 = 50%<br/>0xA8 - 0xFF = fully on</pre>

You can also use the @cheerlight colour names - red, amber, green, blue, cyan, magenta, yellow, orange, pink, purple, white, warmwhite, black

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.

You can of course wire up multiple things in your flow to the same LEDborg node.
Add npms for various hardware nodes, Blink1, DigiRGB, LEDBorg, PiFace 2014-07-08 23:57:42 +02:00			`node-red-node-ledborg`
			`=====================`

Make LEDborg use more clear, warn if more than one deployed at a time. 2015-11-21 17:36:27 +01:00			`A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a <a href="https://www.piborg.org/ledborg" target="_new">PiBorg LedBorg</a> board for a Raspberry Pi.`
Add npms for various hardware nodes, Blink1, DigiRGB, LEDBorg, PiFace 2014-07-08 23:57:42 +02:00
			`Install`
			`-------`

Make LEDborg use more clear, warn if more than one deployed at a time. 2015-11-21 17:36:27 +01:00			`Run the following command in the root directory of your Node-RED install,`
			this is usually `~/.node-red`
Add npms for various hardware nodes, Blink1, DigiRGB, LEDBorg, PiFace 2014-07-08 23:57:42 +02:00
Make LEDborg use more clear, warn if more than one deployed at a time. 2015-11-21 17:36:27 +01:00			`npm i node-red-node-ledborg`
Add npms for various hardware nodes, Blink1, DigiRGB, LEDBorg, PiFace 2014-07-08 23:57:42 +02:00

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

			`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 :`

			`><pre>0x00 - 0x57 = off<br/>0x58 - 0xA7 = 50%<br/>0xA8 - 0xFF = fully on</pre>`

			`You can also use the @cheerlight colour names - red, amber, green, blue, cyan, magenta, yellow, orange, pink, purple, white, warmwhite, black`
Make LEDborg use more clear, warn if more than one deployed at a time. 2015-11-21 17:36:27 +01:00
			`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.`

			`You can of course wire up multiple things in your flow to the same LEDborg node.`