hue 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32b4e4137e61f92f9e4a2033f4b01f5abf57a197
-  data.tar.gz: fcd37ed79cb42411e10ac9bc84b4802390b54d5e
+  metadata.gz: 3c06483132e27c548f6636b9717d0fb1d7d3fb52
+  data.tar.gz: 4fe57bd0ecb43a9a208adcb8cdef6b490b0f813e
 SHA512:
-  metadata.gz: 7c72e22fdd17c1065ae118474c03a6aaf9efe2d1cca17b7f27620e2727949b74808795cb729fb2851a1c21ea6e4117f3bb0641940c6a78f954970866cae3b3b2
-  data.tar.gz: 6b5ab557a8a00e8ea23fa1f485134ad963052e8b517ed2b969c4895f8adab9ab8b621332997362835f64466064fa88b35acd4204aa5e03849245af3a3510f240
+  metadata.gz: 79d882703ab4d35a2792e8b62711941cb8ff88b33a5a444c31f11c450fe1d5ef0e9f713d55dadbf36666155f63f312351f8220570e375c70c2399c5a4d0b2b13
+  data.tar.gz: 2fa2d565f33b0a7464a906da5eebbae52f220baca044436f7c0f2e55009a461227cbe4d133bbf7226f0264fea1e3c428d9bbd10a23240115a1121415eea3ff0b

data/Readme.markdown

@@ -4,19 +4,46 @@ Work with Philips Hue light bulbs from Ruby.
 
 ## Installation
 
-This gem is currently unreleased. For now, simply clone the repository.
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'hue'
+```
+
+And then execute:
+
+``` shell
+$ bundle
+```
+
+Or install it yourself as:
+
+``` shell
+$ gem install hue
+```
 
 ## Usage
 
+The first time you use it, it will automatically create a user for you. Doing this requires you to have pushed the button on your bridge in the last 30 seconds. If you haven't it will throw an exception and let you know you need to push the button. Simply press the button and run the command again.
+
+From CLI:
+
 ``` shell
-$ git clone https://github.com/soffes/hue.git
-$ irb -Ihue/lib -rhue
+$ hue all on
+$ hue all off
+$ hue light 2 on
+$ hue light 2 --brightness 20
 ```
 
+From Ruby:
+
 ``` ruby
 > client = Hue::Client.new
 > light = client.lights.first
 > light.on = true
+> light.hue = 46920
+> light.color_temperature = 100
+> light.set_state({:color_temperature => 400, :transition => 100})
 ```
 
 ## Contributing

data/Todo.markdown

@@ -0,0 +1,11 @@
+# To Do
+
+* RGB translation
+* Hex translation
+* Groups
+* Scheduling
+* Effects
+* User management
+* Configuration
+* More efficient calls
+* Local UPNP

data/lib/hue/cli.rb

@@ -17,6 +17,19 @@ module Hue
       end
     end
 
+    desc 'light ID STATE', 'Access a light'
+    option :hue, :type => :numeric
+    option :saturation, :type => :numeric
+    option :brightness, :type => :numeric
+    def light(id, state = nil)
+      light = client.light(id)
+      puts light.name
+
+      body = options.dup
+      body[:on] = state unless state.nil?
+      light.set_state(body) if body.length > 0
+    end
+
   private
 
     def client

data/lib/hue/client.rb

@@ -36,6 +36,10 @@ module Hue
       end
     end
 
+    def light(id)
+      self.lights.select { |l| l.id == id }.first
+    end
+
   private
 
     def validate_user

data/lib/hue/light.rb

@@ -1,11 +1,81 @@
 module Hue
   class Light
+    HUE_RANGE = 0..65535
+    SATURATION_RANGE = 0..255
+    BRIGHTNESS_RANGE = 0..255
+    COLOR_TEMPERATURE_RANGE = 153..500
+
+    # Unique identification number.
     attr_reader :id
-    attr_reader :name
-    attr_reader :state
+
+    # A unique, editable name given to the light.
+    attr_accessor :name
+
+    # Hue of the light. This is a wrapping value between 0 and 65535.
+    # Both 0 and 65535 are red, 25500 is green and 46920 is blue.
+    attr_accessor :hue
+
+    # Saturation of the light. 255 is the most saturated (colored)
+    # and 0 is the least saturated (white).
+    attr_accessor :saturation
+
+    # Brightness of the light. This is a scale from the minimum
+    # brightness the light is capable of, 0, to the maximum capable
+    # brightness, 255. Note a brightness of 0 is not off.
+    attr_accessor :brightness
+
+    # The x coordinate of a color in CIE color space. Between 0 and 1.
+    #
+    # @see http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
+    attr_reader :x
+
+    # The y coordinate of a color in CIE color space. Between 0 and 1.
+    #
+    # @see http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
+    attr_reader :y
+
+    # The Mired Color temperature of the light. 2012 connected lights
+    # are capable of 153 (6500K) to 500 (2000K).
+    #
+    # @see http://en.wikipedia.org/wiki/Mired
+    attr_accessor :color_temperature
+
+    # The alert effect, which is a temporary change to the bulb’s state.
+    # This can take one of the following values:
+    # * `none` – The light is not performing an alert effect.
+    # * `select` – The light is performing one breathe cycle.
+    # * `lselect` – The light is performing breathe cycles for 30 seconds
+    #     or until an "alert": "none" command is received.
+    #
+    # Note that in version 1.0 this contains the last alert sent to the
+    # light and not its current state. This will be changed to contain the
+    # current state in an upcoming patch.
+    #
+    # @see http://developers.meethue.com/coreconcepts.html#some_extra_fun_stuff
+    attr_accessor :alert
+
+    # The dynamic effect of the light, can either be `none` or
+    # `colorloop`. If set to colorloop, the light will cycle through
+    # all hues using the current brightness and saturation settings.
+    attr_accessor :effect
+
+    # Indicates the color mode in which the light is working, this is
+    # the last command type it received. Values are `hs` for Hue and
+    # Saturation, `xy` for XY and `ct` for Color Temperature. This
+    # parameter is only present when the light supports at least one
+    # of the values.
+    attr_reader :color_mode
+
+    # A fixed name describing the type of light.
     attr_reader :type
+
+    # The hardware model of the light.
     attr_reader :model
+
+    # An identifier for the software version running on the light.
     attr_reader :software_version
+
+    # Reserved for future functionality.
     attr_reader :point_symbol
 
     def initialize(client, id, name)
@@ -15,52 +85,105 @@ module Hue
       refresh
     end
 
+    def [](index)
+      lights[index]
+    end
+
+    def name=(new_name)
+      unless (1..32).include?(new_name.length)
+        raise InvalidValueForParameter, 'name must be between 1 and 32 characters.'
+      end
+
+      body = {
+        :name => new_name
+      }
+
+      uri = URI.parse(base_url)
+      http = Net::HTTP.new(uri.hostname)
+      response = http.request_put(uri.path, MultiJson.dump(body))
+      response = MultiJson.load(response.body).first
+      if response['success']
+        @name = new_name
+      # else
+        # TODO: Error
+      end
+    end
+
     def on?
       @state['on']
     end
 
-    def on=(new_state)
-      self.set_state(new_state)
+    %w{on hue saturation brightness color_temperature}.each do |key|
+      define_method "#{key}=".to_sym do |value|
+        set_state({key.to_sym => value})
+        instance_variable_set("@#{key}".to_sym, value)
+      end
     end
 
-    def hsb
-      @state.select { |k, v| %w{sat bri hue}.include?(k) }
+    def set_xy(x, y)
+      set_state({:xy => [x, y]})
+      @x, @y = x, y
     end
 
-    def set_state(on, hue = nil, saturation = nil, brightness = nil)
-      body = {
-        on: on
+    # Indicates if a light can be reached by the bridge. Currently
+    # always returns true, functionality will be added in a future
+    # patch.
+    def reachable?
+      @state['reachable']
+    end
+
+    # @param transition The duration of the transition from the light’s current
+    #   state to the new state. This is given as a multiple of 100ms and defaults
+    #   to 4 (400ms). For example, setting transistiontime:10 will make the
+    #   transition last 1 second.
+    def set_state(attributes, transition = nil)
+      map = {
+        :brightness => :bri,
+        :saturation => :sat,
+        :color_temperature => :ct,
       }
 
-      if on
-        body.merge!({
-          hue: hue,
-          sat: saturation,
-          bri: brightness
-        })
+      body = {}
+      attributes.each do |key, value|
+        new_key = map[key.to_sym]
+        key = new_key if new_key
+        body[key] = value
       end
 
-      bridge_ip = @client.base_station['internalipaddress']
-      uri = URI.parse("http://#{bridge_ip}/api/#{@client.username}/lights/#{self.id}/state")
+      # Add transition
+      body.merge!({:transitiontime => transition}) if transition
 
+      uri = URI.parse("#{base_url}/state")
       http = Net::HTTP.new(uri.hostname)
       response = http.request_put(uri.path, MultiJson.dump(body))
       MultiJson.load(response.body)
     end
 
-  private
-
+    # Refresh the state of the lamp
     def refresh
-      bridge_ip = @client.base_station['internalipaddress']
-      uri = URI.parse("http://#{bridge_ip}/api/#{@client.username}/lights/#{self.id}")
-      json = MultiJson.load(Net::HTTP.get(uri))
+      json = MultiJson.load(Net::HTTP.get(URI.parse(base_url)))
 
       @state = json['state']
+      @brightness = @state['bri']
+      @hue = @state['hue']
+      @saturation = @state['sat']
+      @x, @y = @state['xy']
+      @color_temperature = @state['ct']
+      @alert = @state['alert'].to_sym
+      @effect = @state['effect'].to_sym
+      @color_mode = @state['colormode']
       @type = json['type']
       @name = json['name']
       @model = json['modelid']
       @software_version = json['swversion']
       @point_symbol = json['pointsymbol']
     end
+
+  private
+
+    def base_url
+      bridge_ip = @client.base_station['internalipaddress']
+      "http://#{bridge_ip}/api/#{@client.username}/lights/#{id}"
+    end
   end
 end

data/lib/hue/version.rb

@@ -1,3 +1,3 @@
 module Hue
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -52,6 +52,7 @@ files:
 - LICENSE
 - Rakefile
 - Readme.markdown
+- Todo.markdown
 - bin/hue
 - hue.gemspec
 - lib/hue.rb
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Work with Philips Hue light bulbs from Ruby.