node-blink1
A node.js library for the
blink(1)
by ThingM.
For for info. on the blink(1), see todbot/blink1
Install
npm install node-blink1
Windows Users
node-blink1
depends on node-hid
, a native module that uses node-gyp
to
build. node-gyp
requires Python 2.7.3 in the PATH, and if you have Python 3
installed, you may have to modify your PATH for node-gyp
to locate it.
See issue #3 for
details.
Linux Users
If you encounter the following error while installing, you'll need new install
of libusb
.
libusb.h: No such file or directory compilation terminated.
For Debian and Ubuntu, install the package libusb-1.0-0.dev
.
See issue #4 for
details.
Usage
var Blink1 = require('node-blink1');
Get list of blink(1) devices connected:
Blink1.devices(); // returns array of serial numbers
Create blink(1) object without serial number, uses first device:
var blink1 = new Blink1();
Create blink(1) object with serial number, to get list of serial numbers use
Blink1.devices()
:
var blink1 = new Blink1(serialNumber);
Get version:
blink1.version(callback(version))
Set colors
Fade to RGB, optional callback called after fadeMillis
ms:
blink1.fadeToRGB(fadeMillis, r, g, b, [callback]) // r, g, b: 0 - 255
Set RGB:
blink1.setRGB(r, g, b, [callback]) // r, g, b: 0 - 255
Other methods
Set server down (enable, disable), optional callback called after millis
ms:
blink1.enableServerDown(millis, [callback]) // tickle
blink1.disableServerDown(millis, [callback]) // off
Play (start playing the pattern lines at the specified position):
blink1.play = function(position, [callback])
Pause (stop playing the pattern line):
blink1.pause = function([callback])
Write pattern line (set the parameters for a pattern line, at the specified position):
blink1.writePatternLine(fadeMillis, r, g, b, position, [callback]) // r, g, b: 0 - 255
Read pattern line (at the position):
blink1.readPatternLine(position, [callback])
Close (the underlying HID device):
blink1.close([callback]);
License
Copyright (C) 2013 Sandeep Mistry sandeep.mistry@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.