limitless-led 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffa1ba16ac8fc123b0f8f433de1f54b3c266ec2f
-  data.tar.gz: d0ce26cf2bb3e727257a0136127b4ce9ecfaf428
+  metadata.gz: 6d1f24493fb0e1bf0d62283ed57df1023164eb0c
+  data.tar.gz: 80b13e7fc94f52ce3238d1a1700295daea7de6c5
 SHA512:
-  metadata.gz: e3d8809d24f2921be6ee05b0edeae2091f7024796e1622c6150372bfaefd2eb734fba64f2b002047ee32807ad3e776496a921d57e582fc5e1ed7bf3bba282ec4
-  data.tar.gz: e061ad0d1a1d47d8530066562434227ed0f8230f268021d5e8b8d56d9cef4dd4429a610872dfcb0065ef9d7188ed05afbe1d5f5dbb63b23513f31658843b9a32
+  metadata.gz: dc3eef7c107828f3bb958d84e88e3f9fde501668205db6e8ecf045abc40bc12948dc840fc6ba86ff68f038c45c8b1a3667c0eec2a963e1d1a766f29aa627bcba
+  data.tar.gz: abfc458f4eb38b41404b03a1fe733f24720c06f5b909224d737578e9d3abaffae0bd3307d3b9359ac76ec4f20ff9accb1990571f364ee2b1dbc797cfcbeafbd2

data/README.md

@@ -18,7 +18,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+``` ruby
+require 'limitless_led'
+
+# If you don't have a LimitlessLED handy you can start the development
+# server by running bin/server, it logs to stdout
+bridge = LimitlessLed::Bridge.new(host: 'localhost', port: 8899)
+
+# Send in hex like this:
+bridge.color "#ff0000"
+
+# You can send a triple
+bridge.color "#f00"
+
+# Again if you don't have the LimitlessLED, you can create an instance
+# of the development server, we run it in an eventmachine reactor loop
+# in bin/server
+server = LimitlessLed::Server.new(host: 'localhost', port: 8899)
+
+# Then you can see what the server does when it receives messages
+server.receive_data("\x40\x00\xff")
+```
 
 ## Contributing
 

data/bin/server

@@ -4,15 +4,12 @@ require 'optparse'
 require 'eventmachine'
 require 'limitless_led'
 
-options = {}
+options = { port: 8899 }
 
-optparse = OptionParser.new do|opts|
+optparse = OptionParser.new do |opts|
   opts.banner = "Usage: server [options]"
-
-  options[:port] = 8899
-
-  opts.on( '-p', '--port [PORT]', "Optional port" ) do|f|
-    options[:port] = f
+  opts.on('-p', '--port [PORT]', "Optional port") do |port|
+    options[:port] = port
   end
 end
 
@@ -21,5 +18,5 @@ optparse.parse!
 puts ">> Starting Limitless LED Server running on port: #{options[:port]}"
 
 EM.run do
-  EM.open_datagram_socket('0.0.0.0', options[:port], LimitlessLed::Server)
+  EM.open_datagram_socket('localhost', options[:port], LimitlessLed::Server)
 end

data/examples/demo.rb

@@ -2,10 +2,22 @@
 
 require 'limitless_led'
 
-# You can start the proxy server bin/server
-bridge = LimitlessLed::Bridge.new
+# If you don't have a LimitlessLED handy you can start the development
+# server by running bin/server, it logs to stdout
+bridge = LimitlessLed::Bridge.new(host: 'localhost', port: 8899)
+
+# Send in hex like this:
+bridge.color "#ff0000"
+
+# You can send a triple
+bridge.color "#f00"
+
+# Again if you don't have the LimitlessLED, you can create an instance
+# of the development server
+server = LimitlessLed::Server.new(host: 'localhost', port: 8899)
+
+# Then you can see what the server does when it receives messages
+server.receive_data("\x40\x00\xff")
+
+
 
-(0..255).each do |int|
-  bridge.send_packet "\x40#{ int.to_s(16).hex.chr }\x55"
-  sleep 0.025
-end

data/lib/limitless_led.rb

@@ -5,3 +5,7 @@ require "limitless_led/logger"
 require "limitless_led/bridge"
 require "limitless_led/server"
 
+module LimitlessLed
+  class CommandNotImplemented < StandardError; end
+  class UnknownCommand < StandardError; end
+end

data/lib/limitless_led/bridge.rb

@@ -27,47 +27,18 @@ module LimitlessLed
       socket.send packet, 0
     end
 
-    # This method dispatches the raw command in bytes to the proper method used
-    # to run commands for the led the first byte in the command code tells the
-    # real led which command to expect, most commands are 3-4 bytes long total
-    # and always end with 0x55
-    def run(input)
-      command = input.bytes
-
-      case command.first
-      when 64
-        color command[1]
-      when 65..77
-          raise 'command not implemented'
-      else
-          log "invalid command received: #{command.first}: #{command}"
-      end
-
-    end
-
-    private
-
-    # this receives and integer as the color value from 0-255, this value
-    # maps directly to the dial on the limitless-led controller and app where
-    # the color at 12 o'clock is 0, the colors are mapped clockwise around
-    # the dial with 255 being almost the same color as 0, this is because the
-    # color space we are using is HSL.
+    # This sets the color of the LED with a hex value for the color the packets
+    # are sent to the socket for the command
     def color(color)
 
-      # Turn second byte int a value out of 360, this is because HSL color maps
-      # the hue on a radial scale so the first and last values are the same color
-      color = color.to_f / 255.0 * 360.0
-
-      # Rotate 90 degrees and flip to match dial ui on device
-      hue = color - 90
-
-      # Return the color
-      color = Color::HSL.new( hue, 90, 50)
+      # receive color as string like #ff0000 or a triplet
+      color = Color::RGB.from_html(color).to_hsl
 
-      # log the color that the device would be set to
-      # TODO: this should only happen with the bridge is initialized with the verbose parameter as true
-      log_color color
+      # Transform color into value out of 255
+      hue = color.hue  / 360.0 * 255.0
 
+      # send command
+      send_packet "\x40#{ hue.to_i.chr }\x55"
     end
 
   end

data/lib/limitless_led/logger.rb

@@ -7,10 +7,19 @@ module LimitlessLed
       puts "#{DateTime.now.to_s} : #{message}"
     end
 
+    # this receives and integer as the color value from 0-255, this value
+    # maps directly to the dial on the limitless-led controller and app where
+    # the color at 12 o'clock is 0, the colors are mapped clockwise around
+    # the dial with 255 being almost the same color as 0, this is because the
+    # color space we are using is HSL.
     def log_color(color)
 
-      #
-      color = color.to_rgb
+      # Turn second byte int a value out of 360, this is because HSL color maps
+      # the hue on a radial scale so the first and last values are the same color
+      hue= color.to_f / 255.0 * 360.0
+
+      # Return the color
+      color = Color::HSL.new( hue, 100, 50).to_rgb
 
       # Get each channel and prepare for loggers output
       red   = color.r * 255

data/lib/limitless_led/server.rb

@@ -14,8 +14,22 @@ module LimitlessLed
       @bridge = LimitlessLed::Bridge.new(host: host, port: port)
     end
 
-    def receive_data(command)
-      @bridge.run command
+    # This method dispatches the raw command in bytes to the proper method used
+    # to run commands for the led the first byte in the command code tells the
+    # real led which command to expect, most commands are 3-4 bytes long total
+    # and always end with 0x55
+    def receive_data(input)
+      command = input.bytes
+
+      case command.first
+      when 64
+        log_color command[1]
+      when 65..77
+        raise LimitlessLed::CommandNotImplemented
+      else
+        raise LimitlessLed::UnknownCommand
+      end
+
     end
 
   end

data/lib/limitless_led/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/ruby
 
 module LimitlessLed
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/bridge_spec.rb

@@ -0,0 +1,83 @@
+# Tests should cover these commands, which can also be found here:
+# http://www.limitlessled.com/dev/
+
+# All UDP Commands are 3 Bytes. First byte is from the list below, plus a fixed 2 byte suffix of 0x00 (decimal: 0) and 0x55 (decimal: 85)
+# i.e. to turn all RGBW COLOR LimitlessLED Smart lights to ON then send the TCP/IP UDP packet of:  0x42 0x00 0x55
+#
+#                           Hexidecimal (byte)	 Decimal (integer)
+#
+# RGBW COLOR LED ALL OFF	        0x41	           65
+# RGBW COLOR LED ALL ON	          0x42	           66
+#
+# DISCO SPEED SLOWER	            0x43	           67
+# DISCO SPEED FASTER	            0x44	           68
+#
+# GROUP 1 ALL ON		              0x45	           69	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 1 ALL OFF		              0x46	           70
+# GROUP 2 ALL ON		              0x47	           71	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 2 ALL OFF		              0x48	           72
+# GROUP 3 ALL ON		              0x49	           73	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 3 ALL OFF		              0x4A	           74
+# GROUP 4 ALL ON		              0x4B	           75	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 4 ALL OFF		              0x4C	           76
+#
+# DISCO MODE	                    0x4D	           77
+#
+# SET COLOR TO WHITE (GROUP ALL)  0x42    100ms followed by:	0xC2
+# SET COLOR TO WHITE (GROUP 1)    0x45	  100ms followed by:	0xC5
+# SET COLOR TO WHITE (GROUP 2)    0x47	  100ms followed by:	0xC7
+# SET COLOR TO WHITE (GROUP 3)    0x49	  100ms followed by:	0xC9
+# SET COLOR TO WHITE (GROUP 4)    0x4B	  100ms followed by:	0xCB
+
+
+require 'spec_helper'
+
+describe LimitlessLed::Bridge do
+
+  let(:params) { {} }
+  subject { LimitlessLed::Bridge.new(params) }
+
+  describe 'can be initialized with default values' do
+    its(:host) { should == 'localhost' }
+    its(:port) { should == 8899 }
+  end
+
+  describe 'can be initialized with a host and port' do
+    let(:params) { { host: '192.168.100.100', port: 6666 } }
+
+    its(:host) { should == '192.168.100.100' }
+    its(:port) { should == 6666 }
+  end
+
+  describe '#color' do
+    it 'changes color' do
+      subject.send(:send_packet, "\x40\xFF\x55")
+
+      # true.should be_true
+      # subject.should_receive(:send_packet).with("\x40\xFF\x55")
+    end
+  end
+
+  describe '#send_packet' do
+    it 'should create a new socket and send the packet' do
+
+      fake_socket = double(:fake_udp_socket)
+      fake_socket.should_receive(:connect).with( subject.host, subject.port )
+      fake_socket.should_receive(:send).with("\x40\xFF\x55", 0)
+
+      UDPSocket.should_receive(:new) { fake_socket }
+
+      subject.send(:send_packet, "\x40\xFF\x55")
+
+    end
+
+    it 'should raise an exception when improperly formed commands are sent' do
+      # subject.send(:send_packet, "\x40\xFF\x55")
+      # subject.should_receive(:new) { fake_socket }
+      should raise_error(HipChat::UnknownResponseCode)
+    end
+  end
+
+end
+
+

data/spec/logger_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe LimitlessLed::Logger do
+
+end

data/spec/server_spec.rb

@@ -0,0 +1,41 @@
+# Tests should cover these commands, which can also be found here:
+# http://www.limitlessled.com/dev/
+
+# All UDP Commands are 3 Bytes. First byte is from the list below, plus a fixed 2 byte suffix of 0x00 (decimal: 0) and 0x55 (decimal: 85)
+# i.e. to turn all RGBW COLOR LimitlessLED Smart lights to ON then send the TCP/IP UDP packet of:  0x42 0x00 0x55
+#
+#                           Hexidecimal (byte)	 Decimal (integer)
+#
+# RGBW COLOR LED ALL OFF	        0x41	           65
+# RGBW COLOR LED ALL ON	          0x42	           66
+#
+# DISCO SPEED SLOWER	            0x43	           67
+# DISCO SPEED FASTER	            0x44	           68
+#
+# GROUP 1 ALL ON		              0x45	           69	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 1 ALL OFF		              0x46	           70
+# GROUP 2 ALL ON		              0x47	           71	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 2 ALL OFF		              0x48	           72
+# GROUP 3 ALL ON		              0x49	           73	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 3 ALL OFF		              0x4A	           74
+# GROUP 4 ALL ON		              0x4B	           75	(SYNC/PAIR RGB+W Bulb within 2 seconds of Wall Switch Power being turned ON)
+# GROUP 4 ALL OFF		              0x4C	           76
+#
+# DISCO MODE	                    0x4D	           77
+#
+# SET COLOR TO WHITE (GROUP ALL)  0x42    100ms followed by:	0xC2
+# SET COLOR TO WHITE (GROUP 1)    0x45	  100ms followed by:	0xC5
+# SET COLOR TO WHITE (GROUP 2)    0x47	  100ms followed by:	0xC7
+# SET COLOR TO WHITE (GROUP 3)    0x49	  100ms followed by:	0xC9
+# SET COLOR TO WHITE (GROUP 4)    0x4B	  100ms followed by:	0xCB
+
+require 'spec_helper'
+
+describe LimitlessLed::Server do
+
+  let(:params) { {} }
+  subject { LimitlessLed::Server.new(params) }
+
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limitless-led
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Joseph Silvashy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-30 00:00:00.000000000 Z
+date: 2013-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,7 +103,9 @@ files:
 - lib/limitless_led/server.rb
 - lib/limitless_led/version.rb
 - limitless_led.gemspec
-- spec/limitless_led_spec.rb
+- spec/bridge_spec.rb
+- spec/logger_spec.rb
+- spec/server_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -130,5 +132,7 @@ signing_key:
 specification_version: 4
 summary: Control the LimitlessLED
 test_files:
-- spec/limitless_led_spec.rb
+- spec/bridge_spec.rb
+- spec/logger_spec.rb
+- spec/server_spec.rb
 - spec/spec_helper.rb

data/spec/limitless_led_spec.rb

@@ -1,44 +0,0 @@
-require 'spec_helper'
-
-describe LimitlessLed do
-
-  let(:params) { {} }
-
-  subject { LimitlessLed::Bridge.new(params) }
-
-  describe 'can be initialized with default values' do
-    its(:host) { should == 'localhost' }
-    its(:port) { should == 8899 }
-  end
-
-  describe 'can be initialized with a host and port' do
-    let(:params) { { host: '192.168.100.100', port: 6666 } }
-
-    its(:host) { should == '192.168.100.100' }
-    its(:port) { should == 6666 }
-  end
-
-  describe '#color' do
-    it 'changes color' do
-      true.should be_true
-      # subject.should_receive(:send_packet).with("\x40\xFF\x55")
-    end
-  end
-
-  describe '#send_packet' do
-    it 'should create a new socket and send the packet' do
-
-      fake_socket = double(:fake_udp_socket)
-      fake_socket.should_receive(:connect).with( subject.host, subject.port )
-      fake_socket.should_receive(:send).with('stuff', 0)
-
-      UDPSocket.should_receive(:new) { fake_socket }
-
-      subject.send(:send_packet, 'stuff')
-
-    end
-  end
-
-end
-
-