blinky helps you see the light - plug and play set up for build lights
Switch branches/tags
Pull request Compare This branch is 43 commits behind perryn:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.document
.gitignore
LICENSE
README.rdoc
Rakefile
VERSION
blinky.gemspec
notes.txt

README.rdoc

blinky

blinky helps you see the light - plug and play set up for build lights - get a build light up and running in a few minutes.

Why blinky?

Setting up a build light on a new project always seems to be more of a hassle than it should be. Somehow it always seems that no one else has ever dealt with the exact combination of OS, CI Server and build light that you have in your sweaty little hands, and you have to write something from scratch. Again.

blinky is an attempt to fix that.

blinky aims to supply plug and play support for all combinations of

  • USB Light Model (or any other USB Device used to indicate build status)

  • Operating System

How do I use blinky?

Plug in your USB light, and then do something like this

require 'rubygems'
require 'blinky'

blinky = Blinky.new.light  
light.success!
light.failure!
light.building!
light.warning!
light.off!

What if I have more than one light?

Want to plug in more than one light on the same machine?

require 'rubygems'
require 'blinky'

blinky = Blinky.new
light_one = blinky.lights[0]
light_two = blinky.lights[1]

Not sure which light is which?

# make light_one flash
light_one.where_are_you?

What is currently supported?

Lights/ Build Indicators

  • Delcom Engineering USB Visual Indicator Generation I

  • Delcom Engineering USB Visual Indicator Generation II

Operating Systems

  • OSX

  • Linux

  • Windows (Theoretically)

NOTE: I haven't been able to test fully on Windows yet. Any assistance with doing so, and/or providing more complete installation instructions would be gratefully received.

How Do I install blinky?

1) Install support for lib-usb-0.1 (www.libusb.org)

OSX and Linux

Install lib-usb-1.0 and the lib-usb-compat-0.1 layer with your favourite package manager.

For example, on OSX

brew install libusb-compat

Windows

install lib-usb-win32. See www.libusb.org/wiki/libusb-win32

(Despite the name, this apparently supports both win-32 and win-64)

2) Install the blinky gem

gem install blinky

NOTE: on OSX will probably need to provide your machine architecture. For example:

ARCHFLAGS="-arch x86_64" gem install blinky

3) Test your installation

Plug in your light and then do this:

require 'rubygems'
require 'blinky'

blinky = Blinky.new
blinky.light.watch_test_server

Watch the pretty lights!

How do I contribute support for more lights

COMING SOON

Copyright

Copyright © 2010 Perryn Fowler. See LICENSE for details.