lights 0.8.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTEyNWE2YjJjODA3ZTk3Y2ZjNzRjZjk0OTY1NWI5NmFmMTMxNzU5Ng==
+  data.tar.gz: !binary |-
+    NDRlMzY3NmRmYjNmNWJlMDczNTI1MzUxN2ZjMTVlYTY4YmMyZTQ4MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YmNhM2RkODM4N2I1MjQ1MTMxNzhjZDlkMmI2NGZlODUyNjQ4NDQxOTJiOGUx
+    YTZkMjg5YjhjZDE0ZWNjOGU4Y2E5ZDUyMmRjOGZlNThkN2ZmZjA1YjU0OTky
+    NTVmN2E3ODViZmQyNWY5MjQ1ZWMwYTFmYWNjZGRiNTdjN2YyYjI=
+  data.tar.gz: !binary |-
+    NWM2ODdiNTljNzhlODFiNDZhMjE4ZjlhYmNlMTFkOGE2YmY4OWRkNThkNzM4
+    MTgzMzllYTA0ZmIzZGVlN2QwY2E0Y2UyMTVmYThhODQ4Yzg2NGZmM2I3YzE3
+    ZTVmNGQwNjA2NGUzY2Y2YmU2OWMwYzRiN2Q2NDJlMjA3M2M5MGE=

data/.gitignore

@@ -0,0 +1,22 @@
+# TESTING FILES
+lib/run.rb
+
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lights.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brady Turner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+lights
+========
+A Ruby library & CLI for controlling Phillips Hue lightbulbs.
+
+Phillips Hue API Documentation: http://developers.meethue.com/index.html
+
+Installation
+----
+```
+gem install lights 
+```
+
+Basic Usage
+-----
+```ruby
+require 'lights'
+client = Lights.new( '192.168.x.x', 'username' )
+client.register_username
+client.request_bulb_list
+```
+
+CLI Quick Setup
+----
+
+```
+lights discover -s
+lights config -f --user username
+lights register
+lights list
+lights on -l all
+lights off -l all
+```
+
+See [Sample Usage (Implemented)](https://github.com/turnerba/lights/wiki/Sample-Usage-(Implemented)) for more usage examples.
+
+Development
+-----
+#### Test:
+```
+bundle exec rspec spec/
+bundle exec cucumber spec/features/
+```
+or
+```
+rake test
+```
+
+#### Build:
+```
+rake build
+```
+
+#### Install:
+```
+rake install
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+task :test do
+  puts `bundle exec rspec spec/`
+  puts `bundle exec cucumber spec/features/`
+end

data/bin/lights

@@ -0,0 +1,302 @@
+#!/usr/bin/env ruby
+
+require 'lights'
+require 'optparse'
+
+LIGHTS_CONFIG_PATH = "#{ENV["HOME"]}/.lightsconfig"
+
+class LightsCli
+
+  def initialize
+    @config = {}
+    if File.exists? LIGHTS_CONFIG_PATH
+      @config = JSON.parse( IO.read( LIGHTS_CONFIG_PATH ) )
+    end
+  end
+
+  def configured?
+    @config["username"] && @config["bridge_ip"]
+  end
+  
+  def config
+    options = {}
+    OptionParser.new do |opts|
+      opts.on("-u", "--user <username>", String, "Username") do |url|
+        options[:user] = url
+      end
+      opts.on("-i", "--ip <bridge ip>", String, "Bridge ip address") do |ip|
+        options[:ip] = ip
+      end
+      opts.on("-f", "--force", "Force write to config file") do |f|
+        options[:force] = f
+      end
+      opts.on("-l", "--list", "List saved configuration settings") do |l|
+        options[:list] = l
+      end
+    end.parse!
+ 
+    if !options[:user] && !options[:ip] && !options[:list]
+      puts "Must specify username and/or bridge IP: --user <username> --ip <IP addr. of bridge>"
+      exit 1
+    end
+ 
+    if options[:list]
+      @config.each { |k,v| puts "#{k}: #{v}" }
+    else
+      if !options[:force] && File.exists?(LIGHTS_CONFIG_PATH)
+        overwrite = ""
+        while overwrite[0] != "y" \
+                && overwrite[0] != "Y" \
+                && overwrite[0] != "n" \
+                && overwrite[0] != "N" \
+                && overwrite[0] != "\n"
+          print "Lights config already exists. Overwrite? [Y/n]: "
+          overwrite = STDIN.gets
+        end
+        overwrite.upcase!
+        if overwrite[0] == "N"
+          exit
+        end
+      end
+  
+      @config["username"] = options[:user] || @config["username"]
+      @config["bridge_ip"] = options[:ip] || @config["bridge_ip"]
+  
+      write_config
+      puts "Configuration settings saved."
+    end
+  end
+  
+  def list
+    lights = Lights.new @config["bridge_ip"], @config["username"]
+    if !ARGV[0] || ARGV[0] == "lights"
+      bulbs_response = lights.request_bulb_list
+      bulbs_response.each do |id,value|
+        bulb = lights.request_bulb_info( id )
+        puts "[#{id}] #{bulb.name}"
+      end
+    elsif ARGV[0] == "sensors"
+      sensors_response = lights.request_sensor_list
+      sensors_response.each do |id,value|
+        sensor = lights.request_sensor_info( id )
+        puts "[#{id}] #{sensor.name}"
+      end
+    elsif ARGV[0] == "groups"
+      groups_response = lights.request_group_list
+      groups_response.each do |id,value|
+        group = lights.request_group_info( id )
+        puts "[#{id}] #{group.name} (#{group.lights.join(',')})"
+      end
+    end
+  end
+  
+  def register
+    lights = Lights.new @config["bridge_ip"], @config["username"]
+    response = lights.register_username
+  end
+
+  def discover 
+    options = {}
+    OptionParser.new do |opts|
+      opts.on("-s", "--save", "Save discovered bridge to configuration file") do |s|
+        options[:save] = s
+      end
+    end.parse!
+
+    lights = Lights.new @config["bridge_ip"], @config["username"]
+    bridges = lights.discover_hubs
+    bridges.each_with_index { |b,i| puts "[#{i+1}] #{b.name}: #{b.ip}" }
+
+    if options[:save] && bridges.length >= 1
+      if bridges.length > 1
+        which_bridge = -1
+        while !(which_bridge >=0 && which_bridge <= bridges.length)
+          print "Which bridge would you like to save? (0 for none): "
+          which_bridge = Integer( gets ) rescue -1 
+        end
+      else
+        which_bridge = 1
+      end
+      if which_bridge != 0
+        @config["bridge_ip"] = bridges[which_bridge.to_i-1].ip
+        write_config
+        puts "Discovered bridge IP saved: #{bridges[which_bridge-1].ip}"
+      end
+    elsif bridges.length == 0
+      puts "Did not discover any bridges."
+    end
+  end
+
+  def on
+    on_off true
+  end
+
+  def off
+    on_off false
+  end
+
+  def set
+    options = {}
+    OptionParser.new do |opts|
+      opts.on("-o", "--on", "Turn lights on") do |o|
+        options[:on] = o
+      end
+      opts.on("-f", "--off", "Turn lights off") do |f|
+        options[:off] = f
+      end
+      opts.on("-c", "--ct color_temp", OptionParser::DecimalInteger, "Set color temperature") do |c|
+        options[:ct] = c
+      end
+      opts.on("-b", "--brightness brightness", OptionParser::DecimalInteger, "Set brightness") do |b|
+        options[:brightness] = b
+      end
+      opts.on("-s", "--saturation saturation", OptionParser::DecimalInteger, "Set saturation") do |s|
+        options[:saturation] = s
+      end
+      opts.on("-h", "--hue hue", OptionParser::DecimalInteger, "Set hue") do |h|
+        options[:hue] = h
+      end
+      opts.on("-e", "--effect none|colorloop", String, "Set effect") do |e|
+        options[:effect] = e
+      end
+      opts.on("-a", "--alert none|select|lselect", String, "Set alert") do |a|
+        options[:alert] = a
+      end
+      opts.on("-z", "--xy x,y", Array, "Set xy") do |z|
+        options[:xy] = z
+      end
+      opts.on("-l", "--lights 1,2,...N", Array, "Which lights to control") do |l|
+        options[:lights] = l
+      end
+      opts.on("-d", "--duration seconds", OptionParser::DecimalInteger, "Transition duration in seconds") do |d|
+        options[:duration] = d
+      end
+    end.parse!
+
+    bad_args = false
+    if !options[:on] && !options[:off] \
+        && !options[:ct] && !options[:brightness] \
+        && !options[:hue] && !options[:saturation] \
+        && !options[:effect] && !options[:alert] \
+        && !options[:xy]
+      puts "Must specify a state to set."
+      bad_args = true
+    end
+    if !options[:lights]
+      puts "Must specify which lights to control."
+      bad_args = true
+    end
+    if (options[:hue] || options[:saturation]) \
+        && options[:ct]
+      puts "Cannot set both color temperature and hue/saturation."
+      bad_args = true
+    end
+    exit 1 if bad_args    
+   
+    s = BulbState.new 
+    if options[:on]
+      s.on = true
+    elsif options[:off]
+      s.on = false
+    end
+    if options[:ct]
+      s.ct = options[:ct]
+    end 
+    if options[:brightness]
+      s.bri = options[:brightness]
+    end
+    if options[:saturation]
+      s.sat = options[:saturation]
+    end
+    if options[:hue]
+      s.hue = options[:hue]
+    end
+    if options[:effect]
+      s.effect = options[:effect]
+    end
+    if options[:duration]
+      s.transition_time = options[:duration] * 10
+    end
+    if options[:alert]
+      s.alert = options[:alert]
+    end
+    if options[:xy]
+      s.xy = options[:xy]
+    end
+    set_state(s,options[:lights])
+    
+  end
+
+private
+  def set_state(state,bulbs)
+    lights = Lights.new @config["bridge_ip"], @config["username"]
+    if bulbs.first == "all"
+      lights.set_group_state 0,state
+    else
+      bulbs.each { |l| lights.set_bulb_state(l,state) }
+    end 
+  end
+
+  def write_config
+    File.open(LIGHTS_CONFIG_PATH,"w+") { |file| file.write(@config.to_json) }
+  end
+
+  def on_off(is_on)
+    options = {}
+    OptionParser.new do |opts|
+      opts.on("-l", "--lights 1,2,...N", Array, "Which lights to control") do |l|
+        options[:lights] = l 
+      end
+    end.parse!
+
+    if !options[:lights]
+      puts "Must specify which lights to control."
+      exit 1
+    end
+
+    s = BulbState.new
+    s.on = is_on
+    set_state s, options[:lights]
+  end
+end
+
+  
+if !ARGV[0]
+  STDERR.puts "Must specify a command. (config, list, register, discover, on, off, set)"
+  exit 1
+end
+
+begin
+  cli = LightsCli.new
+  command = ARGV.shift
+  if command == "config"
+    cli.config
+  elsif command == "discover"
+    cli.discover
+  elsif !cli.configured?
+    puts "Please run 'lights config' before using."
+  elsif command == "list"
+    cli.list
+  elsif command == "register"
+    cli.register
+  elsif command == "on"
+    cli.on
+  elsif command == "off"
+    cli.off
+  elsif command == "set"
+    cli.set
+  else
+    puts "Cannot find command #{command}."
+  end
+rescue BridgeConnectException,
+        UsernameException,
+        BulbStateValueOutOfRangeException,
+        BulbStateValueTypeException => e
+  puts e.message
+rescue Errno::ENETUNREACH, Errno::ENETDOWN
+  puts "Please check your internet connection and try again."
+rescue Interrupt
+  puts ""
+end
+
+

data/lib/lights.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+require 'lights/bulb.rb'
+require 'lights/group.rb'
+require 'lights/bridge.rb'
+require 'lights/exception.rb'
+require 'lights/sensor.rb'
+require 'lights/loggerconfig.rb'
+
+def jp( s )
+  puts JSON.pretty_generate( s )
+end
+
+class Lights 
+
+  attr_reader :bulbs
+  def initialize(ip,username)
+    @ip = ip 
+    @username = username
+    @http = Net::HTTP.new(ip,80)
+    @bulbs = []
+    @groups = []
+    @bridges = []
+    @logger = Logger.new(STDERR)
+    @logger.level = LoggerConfig::LIGHTS_LEVEL
+  end
+
+  def discover_hubs
+    http = Net::HTTP.new("www.meethue.com",443)
+    http.use_ssl = tlights
+    request = Net::HTTP::Get.new( "/api/nupnp" )
+    response = http.request request
+    
+    case response.code.to_i
+    when 200
+      result = JSON.parse( response.body )
+      result.each { |b| @bridges << Bridge.new(b) } 
+    else
+      raise "Unknown error" 
+    end
+    @bridges
+  end
+
+  def register_username
+    data = { "devicetype"=>"lights",
+              "username"=>@username }
+    response = @http.post "/api", data.to_json
+    result = JSON.parse(response.body).first
+    if result.has_key? "error"
+      process_error result
+    end
+  end
+
+  def request_config
+    get "config"
+  end
+
+  def add_bulb(id,bulb_data)
+    @bulbs << Bulb.new( id, bulb_data )
+  end
+
+  def request_bulb_list
+    get "lights"
+  end
+
+  def request_bulb_info( id )
+    response = get "lights/#{id}"
+    Bulb.new(id,response)
+  end
+
+  def request_group_info( id )
+    response = get "groups/#{id}"
+    Group.new(id,response)
+  end
+
+  def request_sensor_info( id )
+    response = get("sensors/#{id}")
+    Sensor.new(id,response)
+  end
+
+  def request_sensor_list
+    get "sensors"
+  end
+
+  def request_group_list
+    get "groups"
+  end
+
+  def request_schedule_list
+    get "schedules"
+  end
+
+  def set_bulb_state( id, state )
+    put "lights/#{id}/state", state
+  end
+
+  def set_group_state( id, state )
+    put "groups/#{id}/action", state
+  end
+
+private
+
+  def process_error(result)
+    type = result["error"]["type"]
+    case type
+    when 1
+      raise UsernameException
+    when 101
+      raise BridgeConnectException
+    else
+      puts "Unknown Error."
+    end
+  end
+
+  def get( path )
+    @logger.debug "==> GET: #{path}"
+    request = Net::HTTP::Get.new( "/api/#{@username}/#{path}" )
+    response = @http.request request
+    result = JSON.parse( response.body )
+    @logger.debug "<== #{response.code}"
+    @logger.debug response.body
+    if result.first.kind_of?(Hash) && result.first.has_key?("error")
+      process_error result.first
+    end
+    result
+  end
+
+  def put( path, data )
+    @logger.debug "==> PUT: #{path}"
+    @logger.debug data.to_json 
+    response = @http.put( "/api/#{@username}/#{path}", data.to_json )
+    @logger.debug "<== #{response.code}"
+    @logger.debug response.body
+    JSON.parse response.body
+  end
+
+end
+