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

36 lines
1.2 KiB
Markdown
Raw Normal View History

node-red-node-blink1
====================
A <a href="http://nodered.org" target="_new">Node-RED</a> node to control a <a href="http://thingm.com/products/blink-1/" target="_new">Thingm Blink(1)</a> LED.
Pre-requisites
--------------
As the blink1 is a USB HID device you may need some extra hardware libraries as
documented <a href="https://www.npmjs.com/package/node-blink1" target="_new">here</a>
and <a href="https://github.com/todbot/blink1/blob/master/linux/51-blink1.rules" target="_new">here</a>.
Specifically Ubuntu/Debian/Raspbian user may need to
sudo apt-get install libusb-1.0-0.dev.
Install
-------
Run the following command in the user directory of your Node-RED install.
This is usually `~/.node-red`
npm install node-red-node-blink1
Usage
-----
Sends the <b>msg.payload</b> to a Thingm Blink(1) LED device. The payload can be any of the following:
- a three part csv string of r,g,b - e.g. red is 255,0,0
- a hex colour #rrggbb - e.g. green is #00FF00
- a <a href="http://www.cheerlights.com/control-cheerlights">@cheerlights</a> colour name - e.g. blue
The @cheerlights colours are - red, amber, green, blue, cyan, magenta, yellow, orange, pink, purple, white, warmwhite, black