hue 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7a23b14e8208a859509d097fef847c13d57d182
-  data.tar.gz: 2e272e991cf0e356918d0ece627ebabb85e2c24a
+  metadata.gz: 710c4221738dfdb074848e444283c1e7dce6d356
+  data.tar.gz: c861ca67f30f33986b7a1ede40a368cc71815c3b
 SHA512:
-  metadata.gz: 1afc23c78f02b7a51531c38bb83a35c09d2fbf797ade300209c2b59ce6cefa4860a0b9647d1b82db83b7b8a107e1434faf55952e5d726d355ab7f51391828b74
-  data.tar.gz: 74a25b2a7c6cd6cc19c126dc151f541ff70c1e769b8b4aea24448c170f2c5f967b100c22785a30eb08ca1ff55fba21c28ca8df2fd0db9df8a3fe0f5f8b21f20a
+  metadata.gz: d9571dacb6fdb61edc5255f58610096c30a0fd2a7c5ce9ff66d79638687a48f08aa50251acb9516efb98c30d40aa28b14a1978cb373c194809b4dfe428a0a62f
+  data.tar.gz: a73d019ab7664247744638dfced2b7cf582d913d05c35b2a96f848ec91ed17fb06e0275ec6d476594f1141d6375879d74dc0552e8db7a6cc1c616d840d3ad2f9

data/Readme.markdown

@@ -28,24 +28,55 @@ $ gem install hue
 
 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:
+### CLI
 
 ``` shell
 $ hue all on
 $ hue all off
+$ hue all --hue 65280 --brightness 20
 $ hue light 2 on
 $ hue light 2 --brightness 20
 ```
 
-From Ruby:
+### 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})
+client = Hue::Client.new
+```
+
+#### Lights
+
+``` ruby
+light = client.lights.first
+light.on!
+light.hue = 46920
+light.color_temperature = 100
+transition_time = 10*5 # Hue transition times are in 1/10 of a second.
+light.set_state({:color_temperature => 400}, transition_time)
+```
+
+#### Groups
+
+``` ruby
+# Fetching
+group = client.groups.first
+group = client.group(1)
+
+# Accessing group lights
+group.lights.first.on!
+group.lights.each { |light| light.hue = rand(0...65535) }
+
+# Creating groups
+group = client.group # Don't specify an ID
+group.name = "My Group"
+group.lights = [3, 4] # Can specify lights by ID
+group.lights = client.lights.first(2) # Or by Light objects
+group.new? # => true
+group.create! # Once the group is created, you can continue to customize it
+group.new? # => false
+
+# Destroying groups
+client.groups.last.destroy!
 ```
 
 ## Contributing

data/Todo.markdown

@@ -2,9 +2,7 @@
 
 * RGB translation
 * Hex translation
-* Groups
 * Scheduling
 * Effects
 * User management
 * Configuration
-* Local UPNP

data/hue.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.8.7'
+  spec.required_ruby_version = '>= 1.9.3'
   spec.add_dependency 'thor'
   spec.add_dependency 'json'
+  spec.add_dependency 'log_switch', '0.4.0'
+  spec.add_dependency 'playful'
+  spec.add_dependency 'curb'
 end

data/lib/hue.rb

@@ -2,7 +2,11 @@ require 'hue/version'
 require 'hue/errors'
 require 'hue/client'
 require 'hue/bridge'
+require 'hue/editable_state'
+require 'hue/translate_keys'
 require 'hue/light'
+require 'hue/group'
+require 'hue/scene'
 
 module Hue
   USERNAME_RANGE = 10..40

data/lib/hue/bridge.rb

@@ -70,7 +70,7 @@ module Hue
 
     def lights
       @lights ||= begin
-        json = JSON(Net::HTTP.get(URI.parse("http://#{ip}/api/#{@client.username}")))
+        json = JSON(Net::HTTP.get(URI.parse(base_url)))
         json['lights'].map do |key, value|
           Light.new(@client, self, key, value)
         end
@@ -78,12 +78,30 @@ module Hue
     end
 
     def add_lights
-      uri = URI.parse("http://#{ip}/api/#{@client.username}/lights")
+      uri = URI.parse("#{base_url}/lights")
       http = Net::HTTP.new(uri.host)
       response = http.request_post(uri.path, nil)
       (response.body).first
     end
 
+    def groups
+      @groups ||= begin
+        json = JSON(Net::HTTP.get(URI.parse("#{base_url}/groups")))
+        json.map do |id, data|
+          Group.new(@client, self, id, data)
+        end
+      end
+    end
+
+    def scenes
+      @scenes ||= begin
+        json = JSON(Net::HTTP.get(URI.parse("#{base_url}/scenes")))
+        json.map do |id, data|
+          Scene.new(@client, self, id, data)
+        end
+      end
+    end
+
   private
 
     KEYS_MAP = {

data/lib/hue/cli.rb

@@ -17,11 +17,26 @@ module Hue
       end
     end
 
+    desc 'light ID STATE [COLOR]', 'Access a light'
+    long_desc <<-LONGDESC
+    Examples: \n
+      hue all on \n
+      hue all off \n
+      hue all --hue 12345  \n
+      hue all --bri 25 \n
+      hue all --hue 50000 --bri 200 --sat 240 \n
+      hue all --alert lselect \n
+    LONGDESC
+    option :hue, :type => :numeric
+    option :sat, :type => :numeric, :aliases => '--saturation'
+    option :bri, :type => :numeric, :aliases => '--brightness'
+    option :alert, :type => :string
     desc 'all STATE', 'Send commands to all lights'
-    def all(state)
-      on = state == 'on'
+    def all(state = 'on')
+      body = options.dup
+      body[:on] = state == 'on'
       client.lights.each do |light|
-        light.on = on
+        puts light.set_state body
       end
     end
 
@@ -34,8 +49,8 @@ module Hue
       hue light 1 off
     LONGDESC
     option :hue, :type => :numeric
-    option :sat, :type => :numeric
-    option :bri, :type => :numeric
+    option :sat, :type => :numeric, :aliases => '--saturation'
+    option :brightness, :type => :numeric, :aliases => '--brightness'
     option :alert, :type => :string
     def light(id, state = nil)
       light = client.light(id)
@@ -46,6 +61,37 @@ module Hue
       puts light.set_state(body) if body.length > 0
     end
 
+    desc 'groups', 'Find all light groups on your network'
+    def groups
+      client.groups.each do |group|
+        puts group.id.to_s.ljust(6) + group.name
+        group.lights.each do |light|
+          puts " -> " + light.id.to_s.ljust(6) + light.name
+        end
+      end
+    end
+
+    desc 'group ID STATE [COLOR]', 'Update a group of lights'
+    long_desc <<-LONGDESC
+    Examples: \n
+      hue groups 1 on --hue 12345
+      hue groups 1 --bri 25
+      hue groups 1 --alert lselect
+      hue groups 1 off
+    LONGDESC
+    option :hue, :type => :numeric
+    option :sat, :type => :numeric, :aliases => '--saturation'
+    option :brightness, :type => :numeric, :aliases => '--brightness'
+    option :alert, :type => :string
+    def group(id, state = nil)
+      group = client.group(id)
+      puts group.name
+
+      body = options.dup
+      body[:on] = (state == 'on' || !(state == 'off'))
+      puts group.set_state(body) if body.length > 0
+    end
+
   private
 
     def client

data/lib/hue/client.rb

@@ -1,5 +1,10 @@
 require 'net/http'
 require 'json'
+require 'playful/ssdp'
+require 'curb'
+
+# Playful is super verbose
+Playful.log = false
 
 module Hue
   class Client
@@ -11,7 +16,12 @@ module Hue
       end
 
       @username = username
-      validate_user
+
+      begin
+        validate_user
+      rescue Hue::UnauthorizedUser
+        register_user
+      end
     end
 
     def bridge
@@ -23,11 +33,31 @@ module Hue
 
     def bridges
       @bridges ||= begin
-        bs = []
-        JSON(Net::HTTP.get(URI.parse('https://www.meethue.com/api/nupnp'))).each do |hash|
-          bs << Bridge.new(self, hash)
+        devices = Playful::SSDP.search 'IpBridge'
+
+        if devices.count == 0
+          # UPnP failed, lets use N-UPnP
+          bs = []
+          easy = Curl::Easy.new
+          easy.follow_location = true
+          easy.max_redirects = 10
+          easy.url = 'https://www.meethue.com/api/nupnp'
+          easy.perform
+          JSON(easy.body).each do |hash|
+            bs << Bridge.new(self, hash)
+          end
+          bs
+        else
+          devices
+            .uniq { |d| d[:location] }
+            .map do |bridge|
+              Bridge.new(self, {
+                'id' => bridge[:usn],
+                'name' => bridge[:st],
+                'internalipaddress' => URI.parse(bridge[:location]).host
+              })
+            end
         end
-        bs
       end
     end
 
@@ -40,49 +70,68 @@ module Hue
     end
 
     def light(id)
-      self.lights.select { |l| l.id == id }.first
+      id = id.to_s
+      lights.select { |l| l.id == id }.first
     end
 
-  private
+    def groups
+      bridge.groups
+    end
 
-    def validate_user
-      response = JSON(Net::HTTP.get(URI.parse("http://#{bridge.ip}/api/#{@username}")))
+    def group(id = nil)
+      return Group.new(self, bridge) if id.nil?
 
-      if response.is_a? Array
-        response = response.first
-      end
+      id = id.to_s
+      groups.select { |g| g.id == id }.first
+    end
 
-      if error = response['error']
-        parse_error(error)
-      end
-      response['success']
+    def scenes
+      bridge.scenes
     end
 
-    def register_user
-      body = {
-        devicetype: 'Ruby',
-        username: @username
-      }
+    def scene(id)
+      id = id.to_s
+      scenes.select { |s| s.id == id }.first
+    end
 
-      uri = URI.parse("http://#{bridge.ip}/api")
-      http = Net::HTTP.new(uri.host)
-      response = JSON(http.request_post(uri.path, JSON.dump(body)).body).first
+  private
 
-      if error = response['error']
-        parse_error(error)
-      end
-      response['success']
+  def validate_user
+    response = JSON(Net::HTTP.get(URI.parse("http://#{bridge.ip}/api/#{@username}")))
+
+    if response.is_a? Array
+      response = response.first
+    end
+
+    if error = response['error']
+      raise get_error(error)
     end
 
-    def parse_error(error)
-      # Find error or return
-      klass = Hue::ERROR_MAP[error['type']]
-      klass = UnknownError unless klass
+    response['success']
+  end
+
+  def register_user
+    body = JSON.dump({
+      devicetype: 'Ruby',
+      username: @username
+    })
+
+    uri = URI.parse("http://#{bridge.ip}/api")
+    http = Net::HTTP.new(uri.host)
+    response = JSON(http.request_post(uri.path, body).body).first
 
-      # Raise error
-      raise klass.new(error['description'])
-    rescue  Hue::UnauthorizedUser
-      register_user
+    if error = response['error']
+      raise get_error(error)
     end
+
+    response['success']
+  end
+
+  def get_error(error)
+    # Find error class and return instance
+    klass = Hue::ERROR_MAP[error['type']] || UnknownError unless klass
+    klass.new(error['description'])
+  end
+
   end
 end

data/lib/hue/editable_state.rb

@@ -0,0 +1,27 @@
+module Hue
+  module EditableState
+    def on?
+      @state['on']
+    end
+
+    def on!
+      self.on = true
+    end
+
+    def off!
+      self.on = false
+    end
+
+    %w{on hue saturation brightness color_temperature alert effect}.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 set_xy(x, y)
+      set_state({:xy => [x, y]})
+      @x, @y = x, y
+    end
+  end
+end

data/lib/hue/group.rb

@@ -0,0 +1,181 @@
+module Hue
+  class Group
+    include Enumerable
+    include TranslateKeys
+    include EditableState
+
+    # Unique identification number.
+    attr_reader :id
+
+    # Bridge the group is associated with
+    attr_reader :bridge
+
+    # A unique, editable name given to the group.
+    attr_accessor :name
+
+    # Hue of the group. 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 group. 255 is the most saturated (colored)
+    # and 0 is the least saturated (white).
+    attr_accessor :saturation
+
+    # Brightness of the group. This is a scale from the minimum
+    # brightness the group 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
+
+    # A fixed name describing the type of group.
+    attr_reader :type
+
+    def initialize(client, bridge, id = nil, data = {})
+      @client = client
+      @bridge = bridge
+      @id = id
+
+      unpack(data)
+    end
+
+    def each(&block)
+      lights.each(&block)
+    end
+
+    def lights
+      @lights ||= begin
+        @light_ids.map do |light_id|
+          @client.light(light_id)
+        end
+      end
+    end
+
+    def name=(name)
+      resp = set_group_state({:name => name})
+      @name = new? ? name : resp[0]['success']["/groups/#{id}/name"]
+    end
+
+    def lights=(light_ids)
+      light_ids.map! do |light_id|
+        light_id.is_a?(Light) ? light_id.id : light_id.to_s
+      end
+
+      @light_ids = light_ids.uniq
+      @lights = nil # resets the memoization
+
+      set_group_state({:lights => @light_ids})
+    end
+
+    def scene=(scene)
+      scene_id = scene.is_a?(Scene) ? scene.id : scene
+      set_group_state({:scene => scene_id})
+    end
+
+    def <<(light_id)
+      @light_ids << light_id
+      set_group_state({:lights => @light_ids})
+    end
+    alias_method :add_light, :<<
+
+    def set_group_state(attributes)
+      return if new?
+      body = translate_keys(attributes, GROUP_KEYS_MAP)
+
+      uri = URI.parse(base_url)
+      http = Net::HTTP.new(uri.host)
+      response = http.request_put(uri.path, JSON.dump(body))
+      JSON(response.body)
+    end
+
+    def set_state(attributes)
+      return if new?
+      body = translate_keys(attributes, STATE_KEYS_MAP)
+
+      uri = URI.parse("#{base_url}/action")
+      http = Net::HTTP.new(uri.host)
+      response = http.request_put(uri.path, JSON.dump(body))
+      JSON(response.body)
+    end
+
+    def refresh
+      json = JSON(Net::HTTP.get(URI.parse(base_url)))
+      unpack(json)
+      @lights = nil
+    end
+
+    def create!
+      body = {
+        :name => @name,
+        :lights => @light_ids,
+      }
+
+      uri = URI.parse("http://#{@bridge.ip}/api/#{@client.username}/groups")
+      http = Net::HTTP.new(uri.host)
+      response = http.request_post(uri.path, JSON.dump(body))
+      json = JSON(response.body)
+
+      @id = json[0]['success']['id']
+    end
+
+    def destroy!
+      uri = URI.parse(base_url)
+      http = Net::HTTP.new(uri.host)
+      response = http.delete(uri.path)
+      json = JSON(response.body)
+      @id = nil if json[0]['success']
+    end
+
+    def new?
+      @id.nil?
+    end
+
+    private
+
+    GROUP_KEYS_MAP = {
+      :name => :name,
+      :light_ids => :lights,
+      :type => :type,
+      :state => :action
+    }
+
+    STATE_KEYS_MAP = {
+      :on => :on,
+      :brightness => :bri,
+      :hue => :hue,
+      :saturation => :sat,
+      :xy => :xy,
+      :color_temperature => :ct,
+      :alert => :alert,
+      :effect => :effect,
+      :color_mode => :colormode,
+    }
+
+    def unpack(data)
+      unpack_hash(data, GROUP_KEYS_MAP)
+
+      unless new?
+        unpack_hash(@state, STATE_KEYS_MAP)
+        @x, @y = @state['xy']
+      end
+    end
+
+    def base_url
+      "http://#{@bridge.ip}/api/#{@client.username}/groups/#{id}"
+    end
+  end
+end

data/lib/hue/light.rb

@@ -1,5 +1,8 @@
 module Hue
   class Light
+    include TranslateKeys
+    include EditableState
+
     HUE_RANGE = 0..65535
     SATURATION_RANGE = 0..255
     BRIGHTNESS_RANGE = 0..255
@@ -108,22 +111,6 @@ module Hue
       end
     end
 
-    def on?
-      @state['on']
-    end
-
-    %w{on hue saturation brightness color_temperature alert}.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 set_xy(x, y)
-      set_state({:xy => [x, y]})
-      @x, @y = x, y
-    end
-
     # Indicates if a light can be reached by the bridge. Currently
     # always returns true, functionality will be added in a future
     # patch.
@@ -136,7 +123,7 @@ module Hue
     #   defaults to 4 (400ms). For example, setting transistiontime:10 will
     #   make the transition last 1 second.
     def set_state(attributes, transition = nil)
-      body = translate_keys(attributes)
+      body = translate_keys(attributes, STATE_KEYS_MAP)
 
       # Add transition
       body.merge!({:transitiontime => transition}) if transition
@@ -177,30 +164,12 @@ module Hue
       :reachable => :reachable,
     }
 
-    def translate_keys(hash)
-      new_hash = {}
-      hash.each do |key, value|
-        new_key = STATE_KEYS_MAP[key.to_sym]
-        key = new_key if new_key
-        new_hash[key] = value
-      end
-      new_hash
-    end
-
     def unpack(hash)
       unpack_hash(hash, KEYS_MAP)
       unpack_hash(@state, STATE_KEYS_MAP)
       @x, @y = @state['xy']
     end
 
-    def unpack_hash(hash, map)
-      map.each do |local_key, remote_key|
-        value = hash[remote_key.to_s]
-        next unless value
-        instance_variable_set("@#{local_key}", value)
-      end
-    end
-
     def base_url
       "http://#{@bridge.ip}/api/#{@client.username}/lights/#{id}"
     end

data/lib/hue/scene.rb

@@ -0,0 +1,50 @@
+module Hue
+  class Scene
+    include Enumerable
+    include TranslateKeys
+
+    # Unique identification number.
+    attr_reader :id
+
+    # Bridge the scene is associated with
+    attr_reader :bridge
+
+    # A unique, editable name given to the scene.
+    attr_accessor :name
+
+    # Whether or not the scene is active on a group.
+    attr_reader :active
+
+    def initialize(client, bridge, id, data)
+      @client = client
+      @bridge = bridge
+      @id = id
+
+      unpack(data)
+    end
+
+    def lights
+      @lights ||= begin
+        @light_ids.map do |light_id|
+          @client.light(light_id)
+        end
+      end
+    end
+
+    private
+
+    SCENE_KEYS_MAP = {
+      :name => :name,
+      :light_ids => :lights,
+      :active => :active,
+    }
+
+    def unpack(data)
+      unpack_hash(data, SCENE_KEYS_MAP)
+    end
+
+    def base_url
+      "http://#{@bridge.ip}/api/#{@client.username}/scenes/#{id}"
+    end
+  end
+end

data/lib/hue/translate_keys.rb

@@ -0,0 +1,21 @@
+module Hue
+  module TranslateKeys
+    def translate_keys(hash, map)
+      new_hash = {}
+      hash.each do |key, value|
+        new_key = map[key.to_sym]
+        key = new_key if new_key
+        new_hash[key] = value
+      end
+      new_hash
+    end
+
+    def unpack_hash(hash, map)
+      map.each do |local_key, remote_key|
+        value = hash[remote_key.to_s]
+        next unless value
+        instance_variable_set("@#{local_key}", value)
+      end
+    end
+  end
+end

data/lib/hue/version.rb

@@ -1,3 +1,3 @@
 module Hue
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hue
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: log_switch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: playful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Work with Philips Hue light bulbs.
 email:
 - sam@soff.es
@@ -59,8 +101,12 @@ files:
 - lib/hue/bridge.rb
 - lib/hue/cli.rb
 - lib/hue/client.rb
+- lib/hue/editable_state.rb
 - lib/hue/errors.rb
+- lib/hue/group.rb
 - lib/hue/light.rb
+- lib/hue/scene.rb
+- lib/hue/translate_keys.rb
 - lib/hue/version.rb
 homepage: https://github.com/soffes/hue
 licenses:
@@ -74,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -82,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Work with Philips Hue light bulbs from Ruby.