philips_hue 0.1.0

data/README.md

@@ -0,0 +1,67 @@
+## Lights App
+
+This is a library for accessing and controlling your [Philips Hue](http://www.meethue.com/) lights using Ruby.
+
+#### TL;DR:
+
+Check out [bin/example_script.rb](https://github.com/dmerrick/lights_app/blob/master/bin/example_script.rb) for an example of how to use this project and what kind of things you can do.
+
+
+### Registering a New App
+
+You need two things to connect with your Hue, a name for your app and the IP address of the white Hue hockeypuck.
+
+* The IP address can be found on the Hue Community site. Login, [go here](https://www.meethue.com/en-US/user/preferencessmartbridge), click "Show me more," and find the IP under "Internal IP address." Example: `"192.168.1.14"`
+* The app name can be anything you like. You must register your app with the Hue by running `PhilipsHue#register!` and pressing the button on the hockeypuck. You must do this again for every new app name you create. Example: `"my light app"`
+
+Full example:
+```ruby
+  hue = PhilipsHue.new("my light app", "192.168.1.14")
+  hue.register!
+```
+
+### Getting the State of a Light
+
+There are many available status options in the `Light` class.
+
+```ruby
+  light1 = hue.lights.first
+  puts light1.state # returns JSON
+  puts light1.colormode
+  puts light1.xy
+  puts light1
+  # => "Front right is on and reachable"
+```
+
+
+### Changing the Color of a Light
+
+To change the state of a light, simply modify the value of one of the state parameters. For example:
+
+```ruby
+  light1.xy  = [0.6446, 0.3289]
+  light1.ct  = 200   # note that the colormode changes
+  light1.hue = 25000 # colormode changes again
+  # etc.
+```
+
+#### Helper Methods
+
+Some helper methods, including default color options, are provided. For example:
+
+```ruby
+  light1.blue
+  light2.red
+  light3.green
+  light1.blip  # blink once
+  light2.blink # blink repeatedly
+  light3.flash([0.6446, 0.3289]) # flash red
+```
+
+
+### See Also
+* [Official Philips Hue site](https://www.meethue.com/en-US)
+* [My original gist](https://gist.github.com/dmerrick/5000839)
+* [rsmck's hacking guide](http://rsmck.co.uk/hue)
+* [Hue hackers' community site](http://www.everyhue.com/)
+* [Thorough API docs](http://blog.ef.net/2012/11/02/philips-hue-api.html)

data/lib/philips_hue.rb

@@ -0,0 +1,11 @@
+require 'httparty'
+require 'digest/md5'
+require 'json'
+
+require 'philips_hue/bridge'
+require 'philips_hue/light'
+
+module PhilipsHue
+  # make this module a singleton
+  extend self
+end

data/lib/philips_hue/bridge.rb

@@ -0,0 +1,61 @@
+module PhilipsHue
+  class Bridge
+
+    # creates a new app to talk to a Philips Hue
+    #   app_name is used to register with the Hue
+    #   api_url is the hostname/IP address of the Hue hockeypuck
+    def initialize(app_name, api_url)
+      @name = app_name
+      @key = Digest::MD5.hexdigest(@name)
+      @api_endpoint = "http://#{api_url}/api"
+      @lights = add_all_lights
+    end
+
+    # provide getter methods for these variables
+    attr_reader :name, :key, :api_endpoint, :lights
+
+    # returns overall system status as JSON
+    def overview
+      request_uri = "#{@api_endpoint}/#{@key}"
+      HTTParty.get(request_uri)
+    end
+
+    # creates a new Light object
+    def add_light(light_id, light_name)
+      Light.new(light_name, light_id, @api_endpoint, @key)
+    end
+
+    # helper method to get light by light_id
+    def light(light_id)
+      @lights[light_id.to_i-1]
+    end
+
+    # registers your app with the Hue
+    # this must be run for every unique app name
+    # FIXME: this needs to be more adequately tested
+    def register!
+      puts "Press the link button on the Hue..."
+      sleep 10
+      json_body = {:username => @key, :devicetype => @name}.to_json
+      response = HTTParty.post(@api_endpoint, :body => json_body)
+
+      if response.first["error"] # should be response.code
+        puts "Press link button and try again."
+        exit
+      else
+        return response
+      end
+    end
+
+    private
+    # loop through the available lights and make corresponding objects
+    def add_all_lights
+      all_lights = []
+      overview["lights"].each do |id, light|
+        all_lights << add_light(id.to_i, light["name"])
+      end
+      all_lights
+    end
+
+  end
+end

data/lib/philips_hue/light.rb

@@ -0,0 +1,179 @@
+module PhilipsHue
+  class PhilipsHue::Light
+
+    def initialize(light_name, light_id, api_endpoint, key)
+      @name = light_name
+      @id = light_id
+      @api_endpoint = api_endpoint
+      @key = key
+    end
+
+    # query full status for single light
+    def status
+      request_uri = "#{@api_endpoint}/#{@key}/lights/#{@id}"
+      HTTParty.get(request_uri)
+    end
+
+    # change the state of a light
+    # note that colormode will automagically update
+    def set(options)
+      json_body = options.to_json
+      request_uri = "#{@api_endpoint}/#{@key}/lights/#{@id}/state"
+      HTTParty.put(request_uri, :body => json_body)
+    end
+
+    # current state of the light
+    def state
+      status["state"]
+    end
+
+    # determine if the light is on or off
+    def on?
+      state["on"]
+    end
+
+    # turn on the light
+    def on!
+      set(:on => true)
+    end
+
+    # turn off the light
+    def off!
+      set(:on => false)
+    end
+
+    # whether or not the lamp can be seen by the hub
+    def reachable?
+      state["reachable"]
+    end
+
+    # returns the current brightness value
+    # can be 0-254 (and 0 is NOT off)
+    def bri
+      state["bri"]
+    end
+
+    # sets the current brightness value
+    def bri=(value)
+      set(:bri => value)
+    end
+
+    # returns the current colormode
+    def colormode
+      state["colormode"]
+    end
+
+    # returns the current hue value
+    # used in tandem with "sat" to set the color
+    # the 'hue' parameter has the range 0-65535 so represents approximately 182.04*degrees
+    def hue
+      state["hue"]
+    end
+
+    # sets the current hue value
+    def hue=(value)
+      set(:hue => value)
+    end
+
+    # returns the current saturation value
+    # used in tandem with "hue" to set the color
+    # can be 0-254
+    def sat
+      state["sat"]
+    end
+
+    # sets the current saturation value
+    def sat=(value)
+      set(:sat => value)
+    end
+
+    # returns the current color temperature (white only)
+    # in mireds: 154 is the coolest, 500 is the warmest
+    # c.p. http://en.wikipedia.org/wiki/Mired
+    def ct
+      state["ct"]
+    end
+
+    # sets the current color temperature
+    def ct=(value)
+      set(:ct => value)
+    end
+
+    # returns the current xy value
+    # the color is expressed as an array of co-ordinates in CIE 1931 space
+    def xy
+      state["xy"]
+    end
+
+    # sets the current xy value
+    # TODO: consider x() and y() setters/getters
+    def xy=(value)
+      set(:xy => value)
+    end
+
+    # 'select' will flash the lamp once
+    # 'lselect' will flash the lamp repeatedly
+    # 'none' is the default state
+    def alert
+      state["alert"]
+    end
+
+    # set the alert state
+    def alert=(value)
+      set(:alert => value)
+    end
+
+    #TODO: figure out what this does (and if I can change it)
+    def effect
+      state["effect"]
+    end
+
+    # cheap helper method
+    def red
+      self.xy = [0.6446, 0.3289]
+    end
+
+    # cheap helper method
+    def green
+      self.xy = [0.4034, 0.5067]
+    end
+
+    # cheap helper method
+    def blue
+      self.xy = [0.1727, 0.0512]
+    end
+
+    # cheap helper method
+    def yellow
+      self.xy = [0.4447, 0.4918]
+    end
+
+    # flash once
+    def blip
+      self.alert = "select"
+    end
+
+    # flash repeatedly
+    def blink
+      self.alert = "lselect"
+    end
+
+    # flash a specified color
+    # if you're flashing multiple times, specify :old_xy to minimize API calls
+    def flash(xy, options = {})
+      old_xy = options[:old_xy] || self.xy
+      delay = options[:delay] || 1
+      self.xy = xy
+      sleep delay
+      self.xy = old_xy
+    end
+
+    # pretty-print the light's status
+    def to_s
+      pretty_name = @name.to_s.split(/_/).map(&:capitalize).join(" ")
+      on_or_off = on? ? "on" : "off"
+      reachable = reachable? ? "reachable" : "unreachable"
+      "#{pretty_name} is #{on_or_off} and #{reachable}"
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: philips_hue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dana Merrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-26 00:00:00.000000000 Z
+dependencies: []
+description: A library to control and query Philips Hue lights
+email: dana.merrick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/philips_hue/bridge.rb
+- lib/philips_hue/light.rb
+- lib/philips_hue.rb
+- README.md
+homepage: https://github.com/dmerrick/lights_app
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Philips Hue
+test_files: []
+has_rdoc: