open_lighting 0.0.2 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor

data/lib/open_lighting/devices/comscan_led.rb

@@ -7,13 +7,17 @@ module OpenLighting
       def initialize(options = {})
         options[:points] ||= {}
         options[:points][:center] ||= {:pan => 127, :tilt => 127}
+        options[:points][:origin] ||= {:pan => 127, :tilt => 127, :strobe => 8, :gobo => 0, :dimmer => 0}
 
+        options[:points][:strobe_blackout]  ||= {:strobe => 0}
+        options[:points][:strobe_open]      ||= {:strobe => 8}
         options[:points][:strobe_slow]      ||= {:strobe => 16}
         options[:points][:strobe_fast]      ||= {:strobe => 131}
         options[:points][:strobe_slow_fast] ||= {:strobe => 140}
         options[:points][:strobe_fast_slow] ||= {:strobe => 190}
         options[:points][:strobe_random]    ||= {:strobe => 247}
 
+        options[:points][:nocolor]  ||= {:gobo => 0}
         options[:points][:yellow]   ||= {:gobo => 8}
         options[:points][:red]      ||= {:gobo => 15}
         options[:points][:green]    ||= {:gobo => 22}
@@ -23,7 +27,11 @@ module OpenLighting
         options[:points][:teal]     ||= {:gobo => 50}
         options[:points][:rings]    ||= {:gobo => 57}
 
+        options[:points][:on]       ||= {:dimmer => 255}
+        options[:points][:off]      ||= {:dimmer => 0}
+
         options[:capabilities] ||= [:pan, :tilt, :strobe, :gobo, :dimmer]
+        options[:defaults]     ||= {:pan => 127, :tilt => 127, :strobe => 8, :gobo => 0, :dimmer => 0}
 
         super(options)
       end

data/lib/open_lighting/dmx_controller.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module OpenLighting
   # The DmxController class is responsible for sending control messages across
   # the DMX bus.
@@ -7,7 +9,7 @@ module OpenLighting
   # control signal. The DmxController class is responsible for aggregating this
   # information from the DmxDevice instances and sending it down the bus.
   class DmxController
-    attr_accessor :fps, :devices, :universe, :cmd, :read_pipe, :write_pipe, :test_mode
+    attr_accessor :fps, :devices, :universe, :cmd, :read_pipe, :write_pipe, :do_not_sleep
     def initialize(options = {})
       @devices = []
       (options[:devices] || []).each {|dev| @devices << dev}
@@ -16,11 +18,15 @@ module OpenLighting
       self.cmd = options[:cmd] || "ola_streaming_client -u #{universe}"
 
       if options[:test]
-        self.test_mode = true
-        self.read_pipe, self.write_pipe = IO.pipe
+        self.do_not_sleep = true
+        self.connect_test_pipe
       end
     end
 
+    def connect_test_pipe
+      self.read_pipe, self.write_pipe = IO.pipe
+    end
+
     def devices
       @devices
     end
@@ -32,7 +38,11 @@ module OpenLighting
     end
 
     def set(options = {})
-      @devices.each {|device| device.set(options.dup)}
+      warn "[DEPRECATION] `set` is deprecated. Use `buffer` instead."
+    end
+
+    def buffer(options = {})
+      @devices.each {|device| device.buffer(options.dup)}
     end
 
     def write!(values=current_values)
@@ -51,7 +61,7 @@ module OpenLighting
     end
 
     def instant!(options = {})
-      set(options)
+      buffer(options)
       write!
     end
 
@@ -77,15 +87,21 @@ module OpenLighting
       1.0 / self.fps.to_f
     end
 
-    def transition!(options = {})
+    def transition!(options = {}, &block)
+      warn "[DEPRECATION] `transition!` is deprecated. Use `begin_animation!` instead."
+    end
+
+    def begin_animation!(options = {}, &block)
       previous = current_values
-      set(options)
-      count = ticks(options[:seconds])
+      buffer(options)
+
+      block.call(@devices) if block
 
+      count = ticks(options[:seconds])
       count.times do |i|
         # interpolate previous to current
         write! interpolate(previous, current_values, count, i+1)
-        sleep(wait_time) unless self.test_mode==true
+        sleep(wait_time) unless self.do_not_sleep
       end
     end
 
@@ -98,12 +114,25 @@ module OpenLighting
     end
 
     def capabilities
-      @devices.map{|device| device.capabilities + device.points.keys}.flatten.uniq
+      @devices.map{|device| device.capabilities}.flatten.uniq
+    end
+
+    def points
+      @devices.map{|device| device.points.keys}.flatten.uniq
     end
 
     def method_missing(meth, *args, &block)
-      if capabilities.include? meth.to_sym
-        set :point => meth.to_sym
+      meth_without_bang = meth.to_s.gsub(/!\Z/, "").to_sym
+
+      if points.include? meth
+        buffer :point => meth
+      elsif points.include? meth_without_bang
+        # causes controller.center! to convert to controller.instant!(:point => :center)
+        instant! :point => meth_without_bang
+      elsif capabilities.include? meth
+        buffer meth => args
+      elsif capabilities.include? meth_without_bang
+        instant! meth_without_bang => args.first
       else
         super # You *must* call super if you don't handle the
               # method, otherwise you'll mess up Ruby's method

data/lib/open_lighting/dmx_device.rb

@@ -9,17 +9,22 @@ module OpenLighting
     attr_accessor :controller, :start_address, :capabilities, :points, :current_values, :defaults
     def initialize(options = {})
       self.start_address = options[:start_address]
-      self.capabilities = options[:capabilities] || []
+      self.capabilities = (options[:capabilities]  || []).map{|i| i.to_sym}
       self.defaults = options[:defaults] || {}
       self.current_values = capabilities.map{|c| defaults[c] || 0 }
       self.points = options[:points] || {}
     end
 
     def set(options)
+      warn "[DEPRECATION] `set` is deprecated. Use `buffer` instead."
+      buffer(options)
+    end
+
+    def buffer(options)
       return if options.nil?
 
       if pt = options.delete(:point)
-        set points[pt]
+        buffer points[pt]
       end
 
       capabilities.each_with_index do |c, i|
@@ -30,24 +35,39 @@ module OpenLighting
     end
 
     def point(key)
-      # d { key }
-      # d { self.points }
-
       self.points[key]
     end
 
+    def add_points(options)
+      options ||= {}
+      options.values.each{|opt| opt.symbolize_keys!}
+      self.points.merge!(options.symbolize_keys!)
+    end
+
     def to_dmx
       current_values.join ","
     end
 
     def method_missing(meth, *args, &block)
-        if points[meth.to_sym]
-          set points[meth.to_sym]
-        else
-          super # You *must* call super if you don't handle the
-                # method, otherwise you'll mess up Ruby's method
-                # lookup.
-        end
+      if points[meth]
+        buffer points[meth]
+      elsif capabilities.include? meth
+        buffer meth => args.first
+      else
+        super # You *must* call super if you don't handle the
+              # method, otherwise you'll mess up Ruby's method
+              # lookup.
       end
+    end
+  end
+end
+
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
   end
 end
+

data/lib/open_lighting/version.rb

@@ -1,3 +1,3 @@
 module OpenLighting
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/open_lighting/dmx_controller_spec.rb

@@ -17,6 +17,7 @@ module OpenLighting
           c.cmd.should == "ola_streaming_client -u 2"
         end
       end
+
       context 'given updated values' do
         it 'updates fps value' do
           c = DmxController.new(:fps => 20)
@@ -74,14 +75,18 @@ module OpenLighting
       end
 
       it "should report correct capabilities" do
-        @controller.capabilities.should == [:pan, :tilt, :dimmer, :center]
+        @controller.capabilities.should == [:pan, :tilt, :dimmer]
+      end
+
+      it "should report correct points" do
+        @controller.points.should == [:center]
       end
 
       it "should serialize all DmxDevices" do
         @controller.to_dmx.should == "0,0,0,0,0,0"
-        @controller.set(:pan => 255)
+        @controller.buffer(:pan => 255)
         @controller.to_dmx.should == "255,0,0,255,0,0"
-        @controller.set(:point => :center)
+        @controller.buffer(:point => :center)
         @controller.to_dmx.should == "127,127,0,127,127,0"
       end
 
@@ -89,6 +94,17 @@ module OpenLighting
         @controller.to_dmx.should == "0,0,0,0,0,0"
         @controller.center
         @controller.to_dmx.should == "127,127,0,127,127,0"
+        @controller.dimmer(80)
+        @controller.to_dmx.should == "127,127,80,127,127,80"
+      end
+
+      it "should do method_missing magics" do
+        @controller.connect_test_pipe
+        @controller.center!
+        @controller.read_pipe.gets.should == "127,127,0,127,127,0\n"
+        @controller.dimmer!(80)
+        @controller.read_pipe.gets.should == "127,127,80,127,127,80\n"
+        @controller.close!
       end
 
       it "but not for incorrect names" do
@@ -97,13 +113,13 @@ module OpenLighting
 
       it "should honor overlapping start_address" do
         @controller << DmxDevice.new(:start_address => 5, :capabilities => [:pan, :tilt, :dimmer])
-        @controller.set(:pan => 127)
+        @controller.buffer(:pan => 127)
         @controller.to_dmx.should == "127,0,0,127,127,0,0"
       end
 
       it "should insert zeros for missing data points" do
         @controller << DmxDevice.new(:start_address => 9, :capabilities => [:pan, :tilt, :dimmer])
-        @controller.set(:pan => 127)
+        @controller.buffer(:pan => 127)
         @controller.to_dmx.should == "127,0,0,127,0,0,0,0,127,0,0"
       end
     end
@@ -163,7 +179,7 @@ module OpenLighting
       end
     end
 
-    describe ".transition!" do
+    describe ".begin_animation!" do
       before(:each) do
         @controller = DmxController.new(:fps => 1, :test => true)
         @controller << DmxDevice.new(:start_address => 1, :capabilities => [:pan, :tilt, :dimmer])
@@ -171,7 +187,7 @@ module OpenLighting
       end
 
       it "should write interpolated values to the pipe" do
-        @controller.transition!(:seconds => 5, :pan => 25)
+        @controller.begin_animation!(:seconds => 5, :pan => 25)
         @controller.read_pipe.gets.should == "5,0,0,5,0,0\n"
         @controller.read_pipe.gets.should == "10,0,0,10,0,0\n"
         @controller.read_pipe.gets.should == "15,0,0,15,0,0\n"
@@ -179,6 +195,19 @@ module OpenLighting
         @controller.read_pipe.gets.should == "25,0,0,25,0,0\n"
         @controller.write_pipe.close
       end
+
+      it "should allow block syntax" do
+        @controller.begin_animation!(:seconds => 5) do |devices|
+          devices[0].pan(25)
+          devices[1].pan(50)
+        end
+        @controller.read_pipe.gets.should == "5,0,0,10,0,0\n"
+        @controller.read_pipe.gets.should == "10,0,0,20,0,0\n"
+        @controller.read_pipe.gets.should == "15,0,0,30,0,0\n"
+        @controller.read_pipe.gets.should == "20,0,0,40,0,0\n"
+        @controller.read_pipe.gets.should == "25,0,0,50,0,0\n"
+        @controller.write_pipe.close
+      end
     end
   end
 end

data/spec/open_lighting/dmx_device_spec.rb

@@ -36,7 +36,7 @@ module OpenLighting
       end
     end
 
-    context ".set" do
+    context ".buffer" do
       before(:each) do
         @device = DmxDevice.new(:capabilities => [:pan, :tilt, :dimmer])
       end
@@ -44,7 +44,7 @@ module OpenLighting
       context "when setting correct capabilities" do
         it "should update current_values" do
           @device.current_values.should == [0, 0, 0]
-          @device.set(:pan => 127)
+          @device.buffer(:pan => 127)
           @device.current_values.should == [127, 0, 0]
         end
       end
@@ -52,7 +52,7 @@ module OpenLighting
       context "when setting incorrect capabilities" do
         it "should not update current_values" do
           @device.current_values.should == [0, 0, 0]
-          @device.set(:some_junk => 127)
+          @device.buffer(:some_junk => 127)
           @device.current_values.should == [0, 0, 0]
         end
       end
@@ -62,7 +62,7 @@ module OpenLighting
       it "should make comma laden magics" do
         @device = DmxDevice.new(:capabilities => [:pan, :tilt, :dimmer])
         @device.to_dmx.should == "0,0,0"
-        @device.set(:pan => 127)
+        @device.buffer(:pan => 127)
         @device.to_dmx.should == "127,0,0"
       end
     end
@@ -87,12 +87,17 @@ module OpenLighting
 
         context "when setting a point" do
           it "should fail silently for incorrect point" do
-            @device.set(:point => :off)
+            @device.buffer(:point => :off)
             @device.current_values.should == [0, 0, 0]
           end
 
           it "should update current_values" do
-            @device.set(:point => :center)
+            @device.buffer(:point => :center)
+            @device.current_values.should == [127, 127, 0]
+          end
+
+          it "should do method_missing magics" do
+            @device.center
             @device.current_values.should == [127, 127, 0]
           end
 
@@ -108,8 +113,8 @@ module OpenLighting
 
         context "when setting multiple points" do
           it "should update current_values" do
-            @device.set(:point => :center)
-            @device.set(:point => :on)
+            @device.buffer(:point => :center)
+            @device.buffer(:point => :on)
             @device.current_values.should == [127, 127, 255]
           end
         end

data/spec/spec_helper.rb

@@ -3,7 +3,9 @@ Bundler.setup
 
 if RUBY_VERSION.to_f == 1.9
   require 'simplecov'
-  SimpleCov.start
+  SimpleCov.start do
+    add_filter "vendor"
+  end
 end
 
 require "open_lighting"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_lighting
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A ruby gem wrapper for the Open Lighting Architecture project