blinkstick

Blickstick API for Node.js

npm install blinkstick
2 downloads in the last day
11 downloads in the last week
36 downloads in the last month

BlinkStick Node

BlinkStick Node provides an interface to control Blinkstick devices connected to your computer.

What is BlinkStick? It's a DIY USB RGB LED device. More info about it here:

http://www.blinkstick.com

Prerequisites

Node & npm

Using Homebrew:

$> brew install node

libusb

Using Homebrew:

$> brew install libusb

Install

Install using npm:

$> npm install blinkstick

API

var blinkstick = require('blinkstick');

To get the first blinkstick on your system:

led = new blinkstick.findFirst();

To get all the serial numbers for blinkstick(s) on your system:

serials = blinkstick.FindAllSerials();

To get all the blinkstick(s) on your system:

leds = blinkstick.findAll();

To get the serial number, manufacturer, or description associated with a blinkstick:

led.getSerial()
led.getManufacturer()
led.getDescription()

To set the color:

// rgb is a '#RRGGBB' string
// red/green/blue are each numbers in [0..255]
// function is optional
led.setColor(rgb, function() { /* called when color is changed */ });
led.setColor(red, green, blue, function() { /* called when color is changed */ });

led.setRandomColor();

led.turnOff();    // i.e., setColor(0, 0, 0)

To get the color:

led.getColor(function(red, green, blue) { ... });
led.getColorString(function(rgb) { ... });

Running the example

Navigate the the example directory, install dependencies and run the server:

$> cd node_modules/blinkstick/example
$> npm install
$> node server

Then, in a browser, navigate to the url given in the console.

Maintainers

npm loves you