faderuby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23c53f19b60b9058f0a4509ae4f0713a2c4c0edc
+  data.tar.gz: 59a51ab8dc1fe5f98f0588a6e104dc9af4e6898f
+SHA512:
+  metadata.gz: 1abab48874ca8ccfc0136d6fa835ec875efbc01502dd8578ec4c41e43c4120d956e579b9a766e9e647769970182399e49e5f7ac2fff44964c1c7dfa52dcefef1
+  data.tar.gz: 06e7acd7e1d3518c35cbe75e307120cc7cc91ce709cddb5c81bea3e142805cffa25e50e841ad22d85e18975ab07a0f9cd77e4644e5cb8b78342325d44d4925d8

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+bin/*
+bin
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faderuby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Harrison
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,75 @@
+# FadeRuby
+
+Ruby interface for Fadecandy LED control servers using the Open Pixel Control protocol.
+
+## Requirements
+
+* Ruby 2.x, 2.1 or higher recommended - Faderuby does make use of named parameters
+* Faderuby server (fcserver)
+* Some cool LEDs
+* Nothing better to do with your life
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faderuby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faderuby
+
+## Usage
+
+We use a client to talk to the device; you can specify a host and port for the fadecandy server, the defaults are localhost/7890.
+```ruby
+client = FadeRuby::Client.new([host], [port])
+```
+
+The client can be used to directly write pixel data:
+
+```ruby
+# Set the first connected pixel on channel 0 to blue
+client.set_pixels([0,0,255], 0)
+# Set the first pixel to green and the second pixel to red
+client.set_pixels([0,255,0,255,0,0], 0)
+```
+There are also convenience classes - subclasses of DisplaySurface like Strip can be used to manage collections of Pixels.
+
+```ruby
+# 30 LED strip
+strip = FadeRuby::Strip.new(30)
+# Set the whole strip to green
+strip.set_all(r: 0, g: 255, b: 0)
+client.write(strip)
+# Set the first 10 LEDs to blue
+strip.pixels[0..10].each{|pix| pix.set(r: 0, g: 0, b: 255) }
+client.write(strip)
+```
+
+Fadecandy will do temporal dithering (fades) for you, so you can do smooth fades by simply waiting between commands. The following example smoothly rolls a new colour onto the strip at random:
+
+```ruby
+next_color = [rand(255), rand(255), rand(255)]
+while true
+  strip.pixels.each do |pix|
+    pix.set(r: next_color[0], g: next_color[1], b: next_color[2])
+    client.write(strip)
+    sleep 0.2
+  end
+  sleep 0.2
+  next_color = [rand(255), rand(255), rand(255)]
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/JamesHarrison/faderuby/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/faderuby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faderuby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faderuby"
+  spec.version       = FadeRuby::VERSION
+  spec.authors       = ["James Harrison"]
+  spec.email         = ["james@talkunafraid.co.uk"]
+  spec.summary       = %q{Fadecandy LED driver client}
+  spec.description   = %q{Fadecandy LED driver client using the OpenPixelControl protocol}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/faderuby.rb

@@ -0,0 +1,8 @@
+require "faderuby/version"
+require "faderuby/client"
+require "faderuby/pixel"
+require "faderuby/display_surface"
+require "faderuby/strip"
+module FadeRuby
+  # Your code goes here...
+end

data/lib/faderuby/client.rb

@@ -0,0 +1,59 @@
+require 'socket'
+
+#
+# The FadeRuby::Client class handles low-level communication with the server
+#
+# @author James Harrison <james@talkunafraid.co.uk>
+#
+class FadeRuby::Client
+
+  #
+  # Get a socket to talk to the Fadecandy server with
+  #
+  # @return [TCPSocket] Socket configured to talk to the server with TCP_NODELAY
+  # 
+  def socket
+    return @s if @s
+    @s = TCPSocket.new(@host, @port)
+    @s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+    return @s
+  end
+
+  # Set up a new client
+  #
+  # @param [String] host Fadecandy server host
+  # @param [Integer] port Fadecandy server port
+  # 
+  def initialize(host='localhost', port=7890)
+    @host = host
+    @port = port
+    socket
+  end
+
+  #
+  # Send a new frame of video
+  #
+  # @param [[Integer]] colors Pixel values to set as [r,g,b,r,g,b,r,g,b...]
+  #                           where r,g,b are three ints between 0 and 65535
+  # @param [Integer] channel Channel to send to, default 0
+  # 
+  def set_pixels(colors, channel=0)
+    size = (colors.length * 8)
+    data = colors.pack('C*')
+    header = [channel, 0, data.length].pack('CCS>')
+    socket.send header+data, 0
+  end
+
+  #
+  # Write a display surface to this client
+  #
+  # @param [<type>] disp_surf <description>
+  #
+  # @return [<type>] <description>
+  # 
+  def write(disp_surf, channel=0)
+    set_pixels(disp_surf.pixels.map(&:to_a).flatten, channel)
+  end
+
+end
+

data/lib/faderuby/display_surface.rb

@@ -0,0 +1,17 @@
+#
+# DisplaySurface represents a display and is subclassed by geometry specific
+# classes
+#
+# @author James Harrison <james@talkunafraid.co.uk>
+#
+class FadeRuby::DisplaySurface
+  def pixels
+    @pixels ||= []
+  end
+
+  def set_all(r: nil, g: nil, b: nil)
+    pixels.each do |pix|
+      pix.set(r: r, g: g, b: b)
+    end
+  end
+end

data/lib/faderuby/pixel.rb

@@ -0,0 +1,24 @@
+class FadeRuby::Pixel
+  attr_reader :r, :g, :b
+  def initialize(r=0,g=0,b=0)
+    @r = r
+    @g = g
+    @b = b
+  end
+
+  def to_a
+    [r,g,b]
+  end
+
+  def set(r: nil, g: nil, b: nil)
+    @r = r if r
+    @g = g if g
+    @b = b if b
+  end
+
+  def set_random
+    @r = rand(255)
+    @g = rand(255-@r)
+    @b = rand(255-@r-@g)
+  end
+end

data/lib/faderuby/strip.rb

@@ -0,0 +1,15 @@
+class FadeRuby::Strip < FadeRuby::DisplaySurface
+  
+  #
+  # Set up a new strip, giving the length in LEDs
+  #
+  # @param [Fixnum] length number of LEDs
+  # 
+  def initialize(length)
+    length.times do
+      pixels.push(FadeRuby::Pixel.new)
+    end
+  end
+
+
+end

data/lib/faderuby/version.rb

@@ -0,0 +1,3 @@
+module FadeRuby
+  VERSION = "0.0.1"
+end

data/spec/lib/client_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe(FadeRuby::Client) do
+  context 'creating a new client' do
+    it 'should open a socket' do
+      expect_any_instance_of(FadeRuby::Client).to receive(:socket)
+      described_class.new
+    end
+  end
+  context 'given a mock socket' do
+    let(:client) { described_class.new }
+    let(:socket_mock) { double('socket') }
+    # Mock the socket
+    before(:each) do
+      allow_any_instance_of(FadeRuby::Client).to receive(:socket).and_return(socket_mock)
+    end
+    describe '#set_pixels' do
+      context 'setting 1 pixel on channel 0 to 128, 128, 128' do
+        after(:each) do
+          client.set_pixels([128,128,128], 0)
+        end
+        it 'should send the right message' do
+          expect(socket_mock).to receive(:send).with([0, 0, 3, 128, 128, 128].pack('CCS>CCC'), 0)
+        end
+      end
+      context 'setting 2 pixels on channel 1 to 256, 128, 0' do
+        after(:each) do
+          client.set_pixels([256, 128, 0, 256, 128, 0], 1)
+        end
+        it 'should send the right message' do
+          expect(socket_mock).to receive(:send).with([1, 0, 6, 256, 128, 0, 256, 128, 0].pack('CCS>CCCCCC'), 0)
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'faderuby'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: faderuby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fadecandy LED driver client using the OpenPixelControl protocol
+email:
+- james@talkunafraid.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faderuby.gemspec
+- lib/faderuby.rb
+- lib/faderuby/client.rb
+- lib/faderuby/display_surface.rb
+- lib/faderuby/pixel.rb
+- lib/faderuby/strip.rb
+- lib/faderuby/version.rb
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fadecandy LED driver client
+test_files:
+- spec/lib/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: