hue-cli 0.1.0 → 0.1.1

data/README.md

@@ -10,19 +10,21 @@ To begin using, install the ruby gem (this requires ruby 1.9 and rubygems)
 $ gem install hue-cli
 ```
 
+This will install the "hue" command.
+
 # Usage
 
-This install the hue command. Simply type 
+To check the bridge state, simply type 
 
 ```
 $ hue
 ```
 
-and the bridge state will be verified. Follow the instructions to register the application with your bridge.
+If this is the first time the command is run, it will scan for bridges on the network and attempt to register the application. Follow the on-screen instructions to do so.
 
 ## Register
 
-You can explicity register the application with
+You can also explicity register the application with
 
 ```
 $ hue register
@@ -30,13 +32,20 @@ $ hue register
 
 ## Bridge state
 
-Examine the current state of the bridge
+Once registered, examine the current state of the bridge.
 
 ```
 $ hue
 Philips Hue
-IP: 196.168.0.1
 Button pressed: false
+Timestamp: 2013-09-02T17:44:10
+Network configuration:
+  IP:      196.168.0.1
+  Gateway: 196.168.0.255
+  Mask:    255.255.255.0
+  DHCP:    true
+  MAC:     00:00:00:00:00:00
+  Proxy:   none:0
 Applications:
   073f2ed95fcbbef2532c751dd404cc9d : hue-cli
 Lights:
@@ -45,26 +54,48 @@ Lights:
   3. Living Corner Lamp - OFF
 ```
 
+## Lights state
+
+### Examine or operate on all lights.
+
+```
+$ hue lights
+1.  Bedroom - Overhead: ON
+    Brightness: 254 (100%)
+    Color: XY=[0.6736, 0.3221], RGB\u2248[255, 60, 40]
+2.  Living Room - Cabinet: OFF
+    Brightness: 142 (56%)
+    Color: XY=[0.674, 0.322], RGB\u2248[255, 60, 40]
+3.  Living Room - Overhead: ON
+    Brightness: 254 (100%)
+    Color: Temperature=2710°K (369 mired), RGB\u2248[255, 166, 87]
+```
+
+### Find new lights.
+
+```
+$ hue lights find
+```
 ## Light state
 
-Examine the state of one of the lights
+Examine the state of a single light
 
 ```
-$ hue lights 1
+$ hue light 1
 ```
 
 or just 
 
 ```
 $ hue 1
-Living Overhead: ON
-Brightness: 254 (100%)
-Color: Temperature=2012°K (497 mired), RGB≈[255, 136, 13]
+1.  Bedroom - Overhead: ON
+    Brightness: 254 (100%)
+    Color: XY=[0.6736, 0.3221], RGB\u2248[255, 60, 40]
 ```
 
-## Change Light state
+### Change Light state
 
-Change a single lights state with the follow (rather self-explanatory) commands
+Change a single light state with the follow (rather self-explanatory) commands
 
 ```
 $ hue 1 on
@@ -74,9 +105,10 @@ $ hue 1 blink
 $ hue 1 solid
 ```
 
-### Light brightness
+### Brightness
+
+Brightness can be set with a value (0-255) or percentage (0%-100%)
 
-The lights brightness command takes a value (0-255) or percentage (0%-100%)
 ```
 $ hue 1 brightness 200
 $ hue 1 brightness 50%
@@ -86,18 +118,22 @@ Brightness: 128 (50%)
 Color: Temperature=2012°K (497 mired), RGB≈[255, 136, 13]
 ```
 
-### Light color
+### Color
+
+The color command takes 1-3 arguments, each interpreted depending on range and value.
 
-The lights color command takes 1-3 arguments, each interpreted depending on range and value.
+Set to 6500 Kelvin.
 
 ```
-$ hue 1 color 6500
+$ hue 1 color 6500 
 $ hue 1
 Living Overhead: ON
 Brightness: 128 (50%)
 Color: Temperature=6500°K (153 mired), RGB≈[255, 254, 250]
 ```
 
+Set to 240 mired.
+
 ```
 $ hue 1 color 240
 $ hue 1
@@ -106,6 +142,8 @@ Brightness: 128 (50%)
 Color: Temperature=4167°K (240 mired), RGB≈[255, 208, 170]
 ```
 
+Set the hue and saturation.
+
 ```
 $ hue 1 color 30000 255
 $ hue 1
@@ -114,4 +152,19 @@ Brightness: 128 (50%)
 Color: Hue=30000, Saturation=255, RGB≈[0, 255, 190]
 ```
 
-## More coming...
+Set the XY
+
+```
+$ hue 1 color 0.25 0.25
+$ hue 1
+Living Overhead: ON
+Brightness: 128 (50%)
+Color: Hue=30000, Saturation=255, RGB≈[0, 255, 190]
+```
+## Set all lights.
+
+All the single light state commands can be applied to all lights.
+
+```
+$ hue lights brightness 50%
+```

data/Rakefile

@@ -16,4 +16,30 @@ rescue LoadError
   end
 end
 
+namespace :gem do
+  desc 'Build the gem'
+  task :build do
+    `mkdir -p pkg`
+    `gem build hue-cli.gemspec`
+    `mv *.gem pkg/`
+  end
+
+  desc 'Publish the gem'
+  task :publish => :build do
+    gem = `ls pkg | sort | tail -n 1`
+    exec("gem push pkg/#{gem}")
+  end
+
+  desc 'Install the gem locally'
+  task :install => :build do
+    gem = `ls pkg`.split.sort
+    `gem install pkg/#{gem.last}`
+  end
+end
+
+desc 'Remove generated files'
+task :clean do
+  `rm -rf pkg`
+end
+
 task :default => [:spec]

data/config/light_alias.yml

@@ -0,0 +1,9 @@
+"relax": {"on":true,"bri":254,"ct":467,"alert":"none","effect":"none"}
+"energize": {"on":true,"bri":203,"ct":156,"alert":"none","effect":"none"}
+"reading": {"on":true,"bri":240,"ct":346,"alert":"none","effect":"none"}
+"concentrate": {"on":true,"bri":219,"ct":231,"alert":"none","effect":"none"}
+"red": {"on":true,"bri":254,"xy":[0.67,0.32],"alert":"none","effect":"none"}
+"blue": {"on":true,"bri":254,"xy":[0.17,0.04],"alert":"none","effect":"none"}
+"green": {"on":true,"bri":254,"xy":[0.41,0.52],"alert":"none","effect":"none"}
+"white": {"on":true,"bri":254,"xy":[0.31,0.33],"alert":"none","effect":"none"}
+"pink": {"on":true,"bri":254,"xy":[0.39,0.17],"alert":"none","effect":"none"}

data/hue-cli.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "hue-cli"
-  s.version     = '0.1.0'
+  s.version     = '0.1.1'
   s.authors     = ["Birkir A. Barkarson", ""]
   s.email       = ["birkirb@stoicviking.net"]
   s.homepage    = "https://github.com/birkirb/hue-lib"
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency("json")
-  s.add_runtime_dependency("hue-lib", '>= 0.7.0')
+  s.add_runtime_dependency("hue-lib", '>= 0.7.2')
   s.add_development_dependency("rspec", '>= 2.6.0')
   s.add_development_dependency("mocha", '>= 0.9.0')
   s.add_development_dependency("webmock", '>= 1.8.0')

data/lib/hue/cli/command.rb

@@ -27,10 +27,10 @@ module Hue
 
       def is_available!(method_name)
         is_available?(method_name) or
-          raise Error.new("Action '#{method_name.to_s}' is not available for operation '#{name}'")
+          raise Error.new("Action '#{method_name.to_s}' is not available for operation '#{class_name}'")
       end
 
-      def name
+      def class_name
         self.class.name.gsub(/.*\:\:/, '').downcase
       end
 
@@ -39,11 +39,10 @@ module Hue
       end
 
       def parse_methods
-        @methods = self.class.instance_methods(false).inject(Hash.new(false)) do |hash, method_name|
+        @methods = (self.class.instance_methods - Command.instance_methods).inject(Hash.new(false)) do |hash, method_name|
           hash[method_name] = true
           hash
         end
-        @methods[:execute] = false
       end
 
       def send_method(*args)

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

@@ -18,7 +18,13 @@ module Hue
           # bulb exists (is valid?)
 
           if args.size > 0
-            super(*args)
+            if is_available?(args.first)
+              super(*args)
+            else
+              if _alias = Processors::LightStateAlias.new(args.join(' '))
+                bulb.state = _alias.state
+              end
+            end
           else
             bulb.print_state
           end
@@ -54,6 +60,39 @@ module Hue
           bulb.color = Colors.parse(*args)
         end
 
+        def name(*args)
+          name = args.join(' ')
+          bulb.name = name
+        end
+
+        def action(*args)
+          bulb.effect = args.join
+        end
+
+        def effect(*args)
+          bulb.effect = args.join
+        end
+
+        def colorloop(*args)
+          bulb.colorloop
+        end
+
+        def clear(*args)
+          case args.first
+          when 'effect'
+            bulb.clear_effect
+          when 'action'
+            bulb.solid
+          else
+            bulb.clear_effect
+            bulb.solid
+          end
+        end
+
+        def dump(*args)
+          puts bulb.state.to_json
+        end
+
       end
     end
   end

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

@@ -0,0 +1,29 @@
+module Hue
+  module CLI
+    module Commands
+      class Lights < Hue::CLI::Command
+
+        def execute(*args)
+          if args.size > 0
+            if is_available?(args.first)
+              send_method(*args)
+            else
+              bridge.lights.each do |number, name|
+                Light.new.execute(number, *args)
+              end
+            end
+          else
+            bridge.print_bulbs
+          end
+        end
+
+        protected
+
+        def find
+          bridge.add_lights
+        end
+
+      end
+    end
+  end
+end

data/lib/hue/cli/processors/light_state_alias.rb

@@ -0,0 +1,41 @@
+module Hue
+  module CLI
+    module Processors
+      class LightStateAlias
+
+        ALIAS_FILE_NAME = 'light_alias.yml'
+        ALIAS_FILE_PATHS = [
+          File.join(Hue::CLI::LOCATION, 'config'),  # Default
+          '/etc/hue/',   # System
+          '~/.hue-cli/', # User
+        ]
+
+        def self.read_alias_files
+          ALIAS_FILE_PATHS.each do |path|
+            file_path = File.join(path, ALIAS_FILE_NAME)
+            yaml = YAML.load_file(file_path) rescue []
+            yaml.each do |name, state|
+              @@alias_map[name.to_sym] = state
+            end
+          end
+        end
+
+        @@alias_map = Hash.new
+        read_alias_files
+
+        public
+
+        attr_reader :name,:state
+
+        def initialize(name)
+          @name = name
+          @state = @@alias_map[name.to_sym]
+          if @state.nil?
+            raise Error.new("Unknown light state: #{name}")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/hue/cli.rb

@@ -1,14 +1,21 @@
 require 'hue'
 require 'find'
-require_relative 'cli/command'
-require_relative 'extensions/bulb'
-require_relative 'extensions/bridge'
-require_relative 'extensions/hue'
 
 module Hue
   module CLI
+
+    LOCATION = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+
+    require_relative 'cli/command'
+    require_relative 'cli/processors/light_state_alias'
+    require_relative 'extensions/bulb'
+    require_relative 'extensions/bridge'
+    require_relative 'extensions/hue'
+
     class Error < StandardError; end;
 
+    ERROR_BRIDGE_CONNECTION_PROBLEM = /execution expired|No route to host/
+
     def self.bridge
       Hue.application
     end
@@ -20,14 +27,22 @@ module Hue
         first_arg = args.shift
         if command = commands[first_arg.to_sym]
           command.new.execute(*args)
-        else
+        elsif first_arg.to_i > 0
           Commands::Light.new.execute(first_arg, *args)
+        else
+          raise Error.new("Unknown command: #{first_arg}")
         end
       else
         print_default
       end
     rescue Hue::Error => err
-      puts err.message
+      if ERROR_BRIDGE_CONNECTION_PROBLEM.match(err.message)
+        Hue.logger.warn("Error contacting bridge, verifying IP and trying again.")
+        Hue.register_bridges
+        retry
+      else
+        puts err.message
+      end
     rescue Hue::CLI::Error => err
       puts err.message
     end
@@ -36,8 +51,8 @@ module Hue
 
     def self.print_default
       Command.new.execute
-    rescue Hue::Error => err
-      puts "Failed to initialize bridge."
+    rescue Hue::Config::NotFound => err
+      puts "Application not registered."
       if bridges = Hue.register_bridges
         puts "Found bridges:"
         bridges.each do |key, config|

data/lib/hue/extensions/bridge.rb

@@ -1,12 +1,22 @@
 module Hue
   class Bridge
+    include Indentation
 
     def print_state
       state = self.status
       config = state['config']
       puts "#{config['name']}"
-      puts "IP: #{config['ipaddress']}"
       puts "Button pressed: #{config['linkbutton']}"
+      puts "Timestamp: #{config['UTC']}"
+      puts "Network configuration:"
+      puts "  IP:      #{config['ipaddress']}"
+      puts "  Gateway: #{config['gateway']}"
+      puts "  Mask:    #{config['netmask']}"
+      puts "  DHCP:    #{config['dhcp']}"
+      puts "  MAC:     #{config['mac']}"
+      if !config['proxyaddress'].strip.empty?
+        puts "  Proxy:   #{config['proxyaddress']}:#{config['proxyport']}"
+      end
       puts "Applications:"
       config['whitelist'].each do |key, values|
         puts "  #{key} : #{values['name']}"
@@ -17,5 +27,11 @@ module Hue
       end
     end
 
+    def print_bulbs
+      self.bulbs.each do |bulb|
+        bulb.print_state
+      end
+    end
+
   end
 end

data/lib/hue/extensions/bulb.rb

@@ -1,14 +1,21 @@
+require_relative '../../utilities/indentation'
+
 module Hue
   class Bulb
+    include Indentation
 
     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!"
+      spaces = 4
+      puts "#{self.id}.".ljust(spaces) + "#{self.name}: #{self.on? ? 'ON' : 'OFF'}"
+      indent(spaces) do
+        puts "Brightness: #{self.brightness} (#{(self.brightness_percent).to_i}%)"
+        puts "Color: #{self.color}, #{self.color.to_rgb}"
+        transitory_state = [
+          (self.transition_time > 0 ? "Transition time: #{self.transition_time} sec" : nil),
+          (self.blinking? ? 'Alert: Blinking!' : nil),
+          (self.effect? ? "Effect: #{self.effect}" : nil),
+        ].compact
+        puts transitory_state.join(", ") unless transitory_state.empty?
       end
     end
 

data/lib/utilities/indentation.rb

@@ -0,0 +1,23 @@
+module Indentation
+  DEFAULT_INDENTATION_SIZE = 2
+  @@indentation_size = 0
+  @@indentation_char = ' '
+  @@indentation_level = 0
+
+  def indent(size = DEFAULT_INDENTATION_SIZE, &block)
+    original_size = @@indentation_size
+    @@indentation_size = size
+    @@indentation_level += 1
+    yield
+  ensure
+    @@indentation_size = original_size
+    @@indentation_level -= 1
+  end
+
+  def puts(*message)
+    message.each do |line|
+      print(@@indentation_char * @@indentation_size * @@indentation_level)
+      super(line)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hue-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,18 @@ files:
 - README.md
 - Rakefile
 - bin/hue
+- config/light_alias.yml
 - hue-cli.gemspec
 - lib/hue/cli.rb
 - lib/hue/cli/command.rb
 - lib/hue/cli/commands/light.rb
+- lib/hue/cli/commands/lights.rb
 - lib/hue/cli/commands/register.rb
+- lib/hue/cli/processors/light_state_alias.rb
 - lib/hue/extensions/bridge.rb
 - lib/hue/extensions/bulb.rb
 - lib/hue/extensions/hue.rb
+- lib/utilities/indentation.rb
 homepage: https://github.com/birkirb/hue-lib
 licenses: []
 post_install_message: 
@@ -139,4 +143,3 @@ signing_key:
 specification_version: 3
 summary: Command line interface for controlling Philips Hue system's lights and bridge.
 test_files: []
-has_rdoc: