# ExtremeFeedbackDevice

[![Gem Version](https://badge.fury.io/rb/extreme_feedback_device.png)](http://badge.fury.io/rb/extreme_feedback_device)
[![Dependency Status](https://gemnasium.com/taktsoft/extreme_feedback_device.png)](https://gemnasium.com/taktsoft/extreme_feedback_device)
[![Build Status](https://travis-ci.org/taktsoft/extreme_feedback_device.png)](https://travis-ci.org/taktsoft/extreme_feedback_device)

TODO: Write a gem description

Fetches Jobs from a Jenkins CI via the REST JSON API and sets LEDs of an Extreme Feedback Device to the status of the corresponding Job.

Tested with Ruby v2.0.0p247 running on Raspberry Pi with Raspbian "wheezy" / Debian GNU/Linux 7 "wheezy".

## Prepare

To get read-write permissions for the SPI-Device with udev you can add the following rule:

    # /etc/udev/rules.d/99-spidev.rules
    SUBSYSTEM=="spidev", GROUP="spidev", MODE="0660"

For this you first need to create a group spidev _(as root)_:

    $ groupadd spidev

Add your user to the new group _(as root)_:

    $ adduser foo spidev

After this, do a restart or run the following commands _(as root)_:

    $ udevadm control --reload-rules
    $ udevadm trigger --subsystem-match=spidev

## Installation

Add this line to your application's Gemfile:

    gem 'extreme_feedback_device'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install extreme_feedback_device

## Settings

TODO: Write configuration instruction here

The default location for the settings file is: `$HOME/.extreme_feedback_device.yml`

* `jenkins.*`: ...
* `infinite_loop.sleep`: the time _(in seconds)_ to sleep between each request.
* `pi.num_leds`: the number of LEDs on your attached Extreme Feedback Device.
* `pi.map_leds`: the mapping of LEDs _(with LED's index)_ to Jenkins Jobs _(with Job's name)_.
* `spi.devive`: the SPI Device to write on.

### Example

    default:
      jenkins:
        user: api
        token: 0123456789ABCDEF
        url: http://jenkins.example.com/
      infinite_loop:
        sleep: 5
      pi:
        num_leds: 2
        map_leds:
          i_1: Jenkins - Master
          i_0: Jenkins - Production
      spi:
        device: /dev/spidev0.0

## Usage

Output of `extreme_feedback_device --help`:

    extreme_feedback_device [OPTION] ...

    -h, --help:
      show help.

    -m, --mode [run]:
      set mode 'run' for a single run or 'loop' for infinite loop.

    -n, --namespace [default]:
      settings namespace.

    -p, --pid [~/.extreme_feedback_device.pid]:
      pid file.

    -s, --settings [~/.extreme_feedback_device.yml]:
      settings file.

    -v, --version:
      show version.

## Daemon

Copy the example init.d script and change it for your needs _(as root)_:

    $ cp `gem contents extreme_feedback_device | grep vendor/init.d/extreme_feedback_device` /etc/init.d/extreme_feedback_device
    $ chmod u+x /etc/init.d/extreme_feedback_device
    $ vim /etc/init.d/extreme_feedback_device

If you want to start the daemon automatically on boot _(as root)_:

    $ update-rc.d extreme_feedback_device defaults

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request