Code Monkey home page Code Monkey logo

blinky's Introduction

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 © 2010 Perryn Fowler. See LICENSE for details.

blinky's People

Contributors

perryn avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.