hue-cli 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+Gemfile.lock
+*.gem
+*.gem
+*.rbc
+.bundle
+.config
+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,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,117 @@
+hue-cli
+=======
+
+Command Line Interface to the Philips Hue lighting system.
+
+# Installation
+To begin using, install the ruby gem (this requires ruby 1.9 and rubygems)
+
+```
+$ gem install hue-cli
+```
+
+# Usage
+
+This install the hue command. Simply type 
+
+```
+$ hue
+```
+
+and the bridge state will be verified. Follow the instructions to register the application with your bridge.
+
+## Register
+
+You can explicity register the application with
+
+```
+$ hue register
+```
+
+## Bridge state
+
+Examine the current state of the bridge
+
+```
+$ hue
+Philips Hue
+IP: 196.168.0.1
+Button pressed: false
+Applications:
+  073f2ed95fcbbef2532c751dd404cc9d : hue-cli
+Lights:
+  1. Living Overhead - OFF
+  2. Living Cabinet - OFF
+  3. Living Corner Lamp - OFF
+```
+
+## Light state
+
+Examine the state of one of the lights
+
+```
+$ hue lights 1
+```
+
+or just 
+
+```
+$ hue 1
+Living Overhead: ON
+Brightness: 254 (100%)
+Color: Temperature=2012°K (497 mired), RGB≈[255, 136, 13]
+```
+
+## Change Light state
+
+Change a single lights state with the follow (rather self-explanatory) commands
+
+```
+$ hue 1 on
+$ hue 1 off
+$ hue 1 flash
+$ hue 1 blink
+$ hue 1 solid
+```
+
+### Light brightness
+
+The lights brightness command takes a value (0-255) or percentage (0%-100%)
+```
+$ hue 1 brightness 200
+$ hue 1 brightness 50%
+$ hue 1
+Living Overhead: ON
+Brightness: 128 (50%)
+Color: Temperature=2012°K (497 mired), RGB≈[255, 136, 13]
+```
+
+### Light color
+
+The lights color command takes 1-3 arguments, each interpreted depending on range and value.
+
+```
+$ hue 1 color 6500
+$ hue 1
+Living Overhead: ON
+Brightness: 128 (50%)
+Color: Temperature=6500°K (153 mired), RGB≈[255, 254, 250]
+```
+
+```
+$ hue 1 color 240
+$ hue 1
+Living Overhead: ON
+Brightness: 128 (50%)
+Color: Temperature=4167°K (240 mired), RGB≈[255, 208, 170]
+```
+
+```
+$ hue 1 color 30000 255
+$ hue 1
+Living Overhead: ON
+Brightness: 128 (50%)
+Color: Hue=30000, Saturation=255, RGB≈[0, 255, 190]
+```
+
+## More coming...

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.rspec_opts = ["-fd", "-c"]
+    t.ruby_opts = ["-Ispec,lib"]
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+rescue LoadError
+  desc 'Spec rake task not available'
+  task :spec do
+    abort 'Spec rake task is not available. Be sure to install rspec as a gem or plugin'
+  end
+end
+
+task :default => [:spec]

data/bin/hue

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "#{File.dirname(__FILE__)}/../lib/hue/cli"
+
+Hue::CLI.run(ARGV)

data/hue-cli.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "hue-cli"
+  s.version     = '0.1.0'
+  s.authors     = ["Birkir A. Barkarson", ""]
+  s.email       = ["birkirb@stoicviking.net"]
+  s.homepage    = "https://github.com/birkirb/hue-lib"
+  s.summary     = %q{Command line interface for controlling Philips Hue system's lights and bridge.}
+  s.description = %q{CLI that allows simple printing of bridge and light state, with easy-to-use syntax to manipulate state}
+
+  s.rubyforge_project = "hue-cli"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("json")
+  s.add_runtime_dependency("hue-lib", '>= 0.7.0')
+  s.add_development_dependency("rspec", '>= 2.6.0')
+  s.add_development_dependency("mocha", '>= 0.9.0')
+  s.add_development_dependency("webmock", '>= 1.8.0')
+end

data/lib/hue/cli/command.rb

@@ -0,0 +1,58 @@
+module Hue
+  module CLI
+    class Command
+
+      public
+
+      def initialize
+        set_bridge
+        parse_methods
+      end
+
+      def execute(*args)
+        if args.size > 0
+          send_method(*args)
+        else
+          @bridge.print_state
+        end
+      end
+
+      private
+
+      attr_reader :bridge
+
+      def is_available?(method_name)
+        @methods[method_name.to_sym]
+      end
+
+      def is_available!(method_name)
+        is_available?(method_name) or
+          raise Error.new("Action '#{method_name.to_s}' is not available for operation '#{name}'")
+      end
+
+      def name
+        self.class.name.gsub(/.*\:\:/, '').downcase
+      end
+
+      def set_bridge
+        @bridge = Hue::CLI.bridge
+      end
+
+      def parse_methods
+        @methods = self.class.instance_methods(false).inject(Hash.new(false)) do |hash, method_name|
+          hash[method_name] = true
+          hash
+        end
+        @methods[:execute] = false
+      end
+
+      def send_method(*args)
+        method = args.shift.to_sym
+        if is_available!(method)
+          send(method, *args)
+        end
+      end
+
+    end
+  end
+end

data/lib/hue/cli/commands/light.rb

@@ -0,0 +1,60 @@
+module Hue
+  module CLI
+    module Commands
+      class Light < Hue::CLI::Command
+
+        attr_reader :bulb
+
+        def execute(*args)
+          arg = args.shift
+          light_number = arg.to_i
+
+          if light_number > 0
+            @bulb = Hue::Bulb.new(bridge, light_number)
+          else
+            raise Hue::CLI::Error.new("Not a valid light number: #{arg}")
+          end
+
+          # bulb exists (is valid?)
+
+          if args.size > 0
+            super(*args)
+          else
+            bulb.print_state
+          end
+        end
+
+        protected
+
+        def on(*args)
+          bulb.on
+        end
+
+        def off(*args)
+          bulb.off
+        end
+
+        def brightness(*args)
+          bulb.brightness = args.first
+        end
+
+        def flash(*args)
+          bulb.flash
+        end
+
+        def blink(*args)
+          bulb.blink
+        end
+
+        def solid(*args)
+          bulb.solid
+        end
+
+        def color(*args)
+          bulb.color = Colors.parse(*args)
+        end
+
+      end
+    end
+  end
+end

data/lib/hue/cli/commands/register.rb

@@ -0,0 +1,37 @@
+module Hue
+  module CLI
+    module Commands
+      class Register < Hue::CLI::Command
+
+        def initialize
+          parse_methods
+        end
+
+        def execute(*args)
+          if args.size > 0
+            super(*args)
+          else
+            default
+          end
+        end
+
+        protected
+
+        def default(*args)
+          print_button_instructions
+          Hue.register_default
+        end
+
+        private
+
+        def print_button_instructions
+          puts "Please press the button on your bridge."
+          sleep 1
+          puts "Once done, press Enter to continue with the registration."
+          gets
+        end
+
+      end
+    end
+  end
+end

data/lib/hue/cli.rb

@@ -0,0 +1,73 @@
+require 'hue'
+require 'find'
+require_relative 'cli/command'
+require_relative 'extensions/bulb'
+require_relative 'extensions/bridge'
+require_relative 'extensions/hue'
+
+module Hue
+  module CLI
+    class Error < StandardError; end;
+
+    def self.bridge
+      Hue.application
+    end
+
+    def self.run(args = [])
+      commands = commands_in_object_space
+
+      if args.size > 0
+        first_arg = args.shift
+        if command = commands[first_arg.to_sym]
+          command.new.execute(*args)
+        else
+          Commands::Light.new.execute(first_arg, *args)
+        end
+      else
+        print_default
+      end
+    rescue Hue::Error => err
+      puts err.message
+    rescue Hue::CLI::Error => err
+      puts err.message
+    end
+
+    private
+
+    def self.print_default
+      Command.new.execute
+    rescue Hue::Error => err
+      puts "Failed to initialize bridge."
+      if bridges = Hue.register_bridges
+        puts "Found bridges:"
+        bridges.each do |key, config|
+          puts "  #{config.uri} (uuid: #{key})"
+        end
+        puts
+        puts "Please type 'hue register' to register your application with the bridge."
+      else
+        puts "No bridges found on the local network."
+      end
+    end
+
+    def self.commands_in_object_space
+      require_commands
+      commands = Hash.new
+      ::ObjectSpace.each_object(Class) do |klass|
+        if(Hue::CLI::Command > klass)
+          commands[klass.name.gsub(/.*\:\:/, '').downcase.to_sym] = klass
+        end
+      end
+      commands
+    end
+
+    def self.require_commands
+      Find.find(File.join(File.dirname(__FILE__), 'cli', 'commands')) do |path|
+        if File.file?(path) && path.match(/\.rb$/)
+          require path
+        end
+      end
+    end
+
+  end
+end

data/lib/hue/extensions/bridge.rb

@@ -0,0 +1,21 @@
+module Hue
+  class Bridge
+
+    def print_state
+      state = self.status
+      config = state['config']
+      puts "#{config['name']}"
+      puts "IP: #{config['ipaddress']}"
+      puts "Button pressed: #{config['linkbutton']}"
+      puts "Applications:"
+      config['whitelist'].each do |key, values|
+        puts "  #{key} : #{values['name']}"
+      end
+      puts "Lights:"
+      state['lights'].each do |key, values|
+        puts "  #{key}. #{values['name']} - #{values['state']['on'] ? 'ON' : 'OFF'}"
+      end
+    end
+
+  end
+end

data/lib/hue/extensions/bulb.rb

@@ -0,0 +1,16 @@
+module Hue
+  class Bulb
+
+    def print_state
+      puts "#{self.name}: #{self.on? ? 'ON' : 'OFF'}"
+      puts "Brightness: #{self.brightness} (#{(self.brightness_percent).to_i}%)"
+      print "Color: "
+      print self.color.to_s
+      puts ", #{self.color.to_rgb.to_s}"
+      if blinking?
+        puts "Alert: Blinking!"
+      end
+    end
+
+  end
+end

data/lib/hue/extensions/hue.rb

@@ -0,0 +1,5 @@
+module Hue
+  def self.device_type
+    'hue-cli'
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: hue-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Birkir A. Barkarson
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hue-lib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: CLI that allows simple printing of bridge and light state, with easy-to-use
+  syntax to manipulate state
+email:
+- birkirb@stoicviking.net
+executables:
+- hue
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/hue
+- hue-cli.gemspec
+- lib/hue/cli.rb
+- lib/hue/cli/command.rb
+- lib/hue/cli/commands/light.rb
+- lib/hue/cli/commands/register.rb
+- lib/hue/extensions/bridge.rb
+- lib/hue/extensions/bulb.rb
+- lib/hue/extensions/hue.rb
+homepage: https://github.com/birkirb/hue-lib
+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: hue-cli
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Command line interface for controlling Philips Hue system's lights and bridge.
+test_files: []
+has_rdoc: