limitless-led 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d1f24493fb0e1bf0d62283ed57df1023164eb0c
-  data.tar.gz: 80b13e7fc94f52ce3238d1a1700295daea7de6c5
+  metadata.gz: 2493a478e96a65a5874432d0c460c7c2fe93d701
+  data.tar.gz: 168bc9cec555559dbd1865da74dbc7bef7e894f7
 SHA512:
-  metadata.gz: dc3eef7c107828f3bb958d84e88e3f9fde501668205db6e8ecf045abc40bc12948dc840fc6ba86ff68f038c45c8b1a3667c0eec2a963e1d1a766f29aa627bcba
-  data.tar.gz: abfc458f4eb38b41404b03a1fe733f24720c06f5b909224d737578e9d3abaffae0bd3307d3b9359ac76ec4f20ff9accb1990571f364ee2b1dbc797cfcbeafbd2
+  metadata.gz: 8c1804293d1663fd6c9d9440178dd19b44e0ad0cdcb7b6e8cbe185a5b667ca4b774b5391cfa404b8d6b3b06f959cd7632caf47fdd6bd8468f66cf722515bc8d0
+  data.tar.gz: 07ce2abed795a7564a6f3bf066c30b8ac240b8359f791c9d5938f3474b009fed94fbd92ae55f5d8cb0a62dcc259746368db93c7621e15e471478b0de62d45807

data/README.md

@@ -2,11 +2,15 @@
 
 [![Build Status](https://travis-ci.org/jpsilvashy/limitless-led.png?branch=master)](https://travis-ci.org/jpsilvashy/limitless-led)
 
+A Ruby gem for controlling the [LimitlessLED v3.0 RGBW color-changing light bulbs](http://www.limitlessled.com/), based on the official [LimitlessLED API documentation](http://www.limitlessled.com/dev/).  
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'limitless-led'
+``` ruby
+gem 'limitless-led'
+```
 
 And then execute:
 
@@ -31,19 +35,45 @@ bridge.color "#ff0000"
 # You can send a triple
 bridge.color "#f00"
 
+# Send data straight to the bridge:
+bridge.send_packet "\x40\x00\x55"
+
+# Send a lot of data to the bridge very quickly:
+10.times do
+  (0..255).each do |int|
+    bridge.send_packet "\x40#{ int.chr }\x55"
+    sleep 0.005
+  end
+end
+
+
 # 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
+# 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")
 ```
 
-## Contributing
+_View more demos in the [/examples](https://github.com/jpsilvashy/limitless-led/tree/master/examples) directory_
+
+If you are using the development server you should see this output:
 
+![Output](https://www.evernote.com/shard/s5/sh/df5047a2-faa4-4985-98a7-63d86d8a131d/e45fb64438bc946c37c13d88c2dd412d/deep/0/output.jpg)
+
+**As a note,** since we are transforming the colors from RGB to HSL and then back for representing the color in the console (which additionally is more limiting than the true color space offered by the LED) some of the hex values may not exactly match, especially near the dark limit. Since we are controlling the the brightness of the LED separately, and do not have access to the saturation some colors maybe be harder to reproduce than others, especially dark colors.
+
+## Contributors
+
+- [Nate Clark](https://github.com/heythisisnate)
+- [Curtis Gagliardi](https://github.com/cgag)
+
+*_This originally was a fork of [hired/limitless-led](https://github.com/hired/limitless-led) but quickly grew larger in scope so I decided to move it to a new repo._
+
+## Contributing
 1. Fork it ( http://github.com/jpsilvashy/limitless-led/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 new Pull Request
+

data/examples/demo.rb

@@ -12,6 +12,18 @@ bridge.color "#ff0000"
 # You can send a triple
 bridge.color "#f00"
 
+# Send data straight to the bridge:
+bridge.send_packet "\x40\x00\x55"
+
+# Send a lot of data to the bridge very quickly:
+10.times do
+  (0..255).each do |int|
+    bridge.send_packet "\x40#{ int.chr }\x55"
+    sleep 0.005
+  end
+end
+
+
 # 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)

data/examples/skycolor.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# This example takes a photo and approximates the most dominant color in the image and changes
+# the LED to match. Our example is using a remote image from a webcam, but you can put any
+# image source uri.
+
+# Install miro gem first
+# https://github.com/jonbuda/miro
+require 'miro'
+require 'limitless_led'
+
+# Source of image
+colors = Miro::DominantColors.new('http://cdn.abclocal.go.com/three/kgo/webcam/tahoecam.jpg')
+
+# Connect to bridge
+bridge = LimitlessLed::Bridge.new(host: 'localhost', port: 8899)
+
+# Send send most dominant color from image to the LED
+bridge.color colors.to_hex[0]

data/lib/limitless_led.rb

@@ -1,4 +1,4 @@
-  #!/usr/bin/ruby
+#!/usr/bin/ruby
 require "limitless_led/version"
 
 require "limitless_led/logger"
@@ -8,4 +8,4 @@ require "limitless_led/server"
 module LimitlessLed
   class CommandNotImplemented < StandardError; end
   class UnknownCommand < StandardError; end
-end
+end

data/lib/limitless_led/bridge.rb

@@ -22,16 +22,43 @@ module LimitlessLed
       end
     end
 
-    # this sends the actual bytes to the real bridge/led over the UDP socket method
+    # Sends the actual bytes to the real bridge/led over the UDP socket method.
+    #
+    # Usage:
+    #
+    #   # Default
+    #   send_packet "\x40\xff\x55"
+    #
+    # Options:
+    #
+    # +packet+::  the bytes to send to the device
+    #
     def send_packet(packet)
       socket.send packet, 0
     end
 
     # This sets the color of the LED with a hex value for the color the packets
     # are sent to the socket for the command
+    #
+    # Usage:
+    #
+    #   # Default
+    #   color '#ff0000'
+    #
+    #   # Triplet
+    #   color '#f00'
+    #
+    #   # Optional "#"
+    #   color 'ff0000'
+    #
+    # Options:
+    #
+    # +color+::  The color in the hex format rrggbb or rgb
+    #
     def color(color)
 
       # receive color as string like #ff0000 or a triplet
+      # transform to HSL color
       color = Color::RGB.from_html(color).to_hsl
 
       # Transform color into value out of 255

data/lib/limitless_led/logger.rb

@@ -3,15 +3,42 @@
 module LimitlessLed
   module Logger
 
+    # Logs timestamp and message
+    #
+    # Usage:
+    #
+    #   # Default
+    #   log "something happend"
+    #
+    # Options:
+    #
+    # +message+::  any string for the message you want to log
+    #
     def log(message)
       puts "#{DateTime.now.to_s} : #{message}"
     end
 
-    # this receives and integer as the color value from 0-255, this value
+    # 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.
+    #
+    # Usage:
+    #
+    #   # Default
+    #   log_color 0
+    #
+    #   # Different color
+    #   log_color 120
+    #
+    #   # HSL hue is radial so 255 is the same as 0
+    #   log_color 255
+    #
+    # Options:
+    #
+    # +color+::  color 0-255
+    #
     def log_color(color)
 
       # Turn second byte int a value out of 360, this is because HSL color maps

data/lib/limitless_led/server.rb

@@ -16,8 +16,18 @@ module LimitlessLed
 
     # 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
+    # real led which command to expect, most commands are 3 bytes long total
     # and always end with 0x55
+    #
+    # Usage:
+    #
+    #   # Default
+    #   receive_data "\x40\xff\x55"
+    #
+    # Options:
+    #
+    # +input+::  bytes used to run the commands
+    #
     def receive_data(input)
       command = input.bytes
 

data/lib/limitless_led/version.rb

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

data/spec/bridge_spec.rb

@@ -70,14 +70,6 @@ describe LimitlessLed::Bridge do
       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

@@ -2,4 +2,4 @@ require 'spec_helper'
 
 describe LimitlessLed::Logger do
 
-end
+end

data/spec/server_spec.rb

@@ -33,9 +33,14 @@ require 'spec_helper'
 
 describe LimitlessLed::Server do
 
-  let(:params) { {} }
+  let(:params) { { host: 'localhost', port: 6666 } }
   subject { LimitlessLed::Server.new(params) }
 
-end
-
+  describe '#receive_data' do
+    it 'should raise an exception when improperly formed commands are sent' do
+      #subject.send(:receive_data, "\xFF\x55")
+      #subject.should raise_error(LimitlessLed::CommandNotImplemented)
+    end
+  end
 
+end

data/spec/spec_helper.rb

@@ -5,4 +5,4 @@ require 'limitless_led'
 
 RSpec.configure do |config|
   # some (optional) config here
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: limitless-led
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joseph Silvashy
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - bin/server
 - examples/demo.rb
+- examples/skycolor.rb
 - lib/limitless_led.rb
 - lib/limitless_led/bridge.rb
 - lib/limitless_led/logger.rb