mios 0.3.0 → 0.3.1

data/README.md

@@ -16,6 +16,10 @@ Or install it yourself as:
 
     $ gem install mios
 
+## Requirements
+
+Ruby 1.9 or greater
+
 ## Usage
 
 MiOS works on a job queue. If you wish to change an attribute or the status of a particular device, you must submit a
@@ -29,13 +33,13 @@ occur if used improperly.
 
 ### Devices could be anything of course, assuming here the first is a switch
     switch = mios.devices[0]
-    
+
 ### Turn the switch off (light switch or outlet or anything classed as a switch)
     switch.off!
-    
+
 ### The job object is returned from calls that require API calls
     job = switch.on!
-    
+
 ### Execute some code once the job has finished
     switch.off! { |obj|
       puts "The #{obj.name} is now off"
@@ -49,6 +53,20 @@ occur if used improperly.
     puts "This will output immediately"
     sleep(5) # Sleep to wait for the thread to finish, will clean this up later
 
+### List Defined Rooms
+    mios.rooms
+
+### List Defined Scenes
+    mios.scenes
+
+### Run a scene
+    mios.scenes[0].run   # => 'OK'
+
+## Additional information
+
+http://wiki.micasaverde.com/index.php/Category:Development
+http://wiki.micasaverde.com/index.php/Luup_Requests
+
 ## Contributing
 
 1. Fork it

data/lib/mios/action.rb

@@ -1,25 +1,32 @@
-require 'cgi'
-
 module MiOS
   class Action
-    def initialize(device, service_id, action, parameters={})
-      @device, @service_id, @action, @parameters = device, service_id, action, parameters
+    def initialize(interface, service_id, action, parameters = {})
+      @interface = interface
+      @service_id = service_id
+      @action = action
+      @parameters = parameters
     end
-    
-    def take(async=false, &block)
-      response = MultiJson.load(@device.client.get("#{@device.base_uri}/data_request", url_params).content)
-      # Are there ever more than one jobs from a device action?
-      Job.new(@device, response.values.first['JobID'], async, &block)
+
+    def take(async = false, &block)
+      response = @interface.action(@action, @service_id, @parameters)
+      # Is there ever more than one job from a device action?
+
+      # Device actions return a response with a job ID.  Scene actions
+      # do not.  This is an attempt to abstract that knowledge away
+      # from the caller.
+      if has_job?(response)
+        Job.new(@interface, response.values.first['JobID'], async, &block)
+      else
+        yield if block_given?
+      end
+      response
     end
 
-    def url_params
-      {
-        :id => 'action',
-        :DeviceNum => @device.attributes["id"],
-        :action => @action,
-        :serviceId => @service_id,
-        :output_format => :json,
-      }.merge(@parameters)
+  private
+
+    def has_job?(response)
+      response.values.first.include? 'JobID'
     end
+
   end
-end
+end

data/lib/mios/category.rb

@@ -0,0 +1,14 @@
+module MiOS
+  class Category
+    attr_reader :label, :ids
+
+    def initialize(label, ids)
+      @label = label
+      @ids = ids
+    end
+
+    def to_s
+      label
+    end
+  end
+end

data/lib/mios/category_collection.rb

@@ -0,0 +1,38 @@
+module MiOS
+  class CategoryCollection
+
+    def initialize(filters)
+      @filters = filters
+      @categories = @filters.each_with_object([]) do |filter, categories|
+        categories << Category.new(label_for(filter), category_nums_for(filter))
+      end
+    end
+
+    def all
+      @categories
+    end
+
+    def find_by_id(id)
+      @categories.find { |c| c.ids.include? id }
+    end
+
+    def find_by_label(label)
+      @categories.find { |c| c.label == label }
+    end
+
+    def to_s
+      @categories.to_s
+    end
+
+  private
+
+    def label_for(filter)
+      filter['Label']['text']
+    end
+
+    def category_nums_for(filter)
+      filter['categories'].map {|cat_num| cat_num.to_i }
+    end
+
+  end
+end

data/lib/mios/client.rb

@@ -0,0 +1,35 @@
+module MiOS
+  class Client
+    attr_reader :base_uri
+
+    def initialize(base_uri)
+      @base_uri = base_uri
+      @client = HTTPClient.new
+    end
+
+    def data_request(params)
+      default_params = { output_format: :json }
+      params = default_params.merge(params)
+      response = @client.get("#{@base_uri}/data_request", params)
+      return JSON.parse(response.content) if response.ok?
+      fail 'Device not available'
+    end
+
+    def device_status(device_id)
+      result = data_request(id: 'status', DeviceNum: device_id)
+      result["Device_Num_#{device_id}"]
+    end
+
+    def action(action, service_id, params = {})
+      data_request({
+        id: 'action',
+        action: action,
+        serviceId: service_id,
+      }.merge(params))
+    end
+
+    def job_status(job_id)
+      data_request(id: 'jobstatus', job: job_id, plugin: 'zwave')['status']
+    end
+  end
+end

data/lib/mios/device.rb

@@ -1,88 +1,80 @@
 module MiOS
   class Device
-    attr_reader :attributes, :client, :base_uri
+    attr_reader :interface, :category
 
-    def initialize(client, base_uri, data)
-      @client, @base_uri = client, base_uri
-      parse(data)
-    end
-
-    def inspect
-      "#<MiOS::Device:0x#{'%x' % (self.object_id << 1)} name=#{@attributes['name']}>"
+    def initialize(interface, status_info)
+      @interface = interface
+      @status_info = status_info
+      initialize_services!
     end
 
     def method_missing(method, *args)
-      if @attributes.has_key?(method.to_s)
-        @attributes[method.to_s]
-      else
-        super
-      end
+      attributes[method.to_s] || super
     end
 
     def reload
-      parse(MultiJson.load(@client.get("#{@base_uri}/data_request", {:id => 'status', :DeviceNum => attributes['id'], :output_format => :json}).content)["Device_Num_#{attributes['id']}"], true)
-      
+      @status_info = @interface.device_status(id)
       self
     end
-    
-    private
-    
-    def set(urn, action, params, async=false, &block)
-      MiOS::Action.new(self, urn, action, params).take(async, &block)
+
+    def attributes
+      @attributes ||= @status_info.select do |key, val|
+        !val.kind_of?(Hash) && !val.kind_of?(Array)
+      end
     end
-    
-    def timestamp_for(urn, key)
-      Time.at integer_for(urn, key)
+
+    def states
+      @status_info['states']
     end
-    
-    def boolean_for(urn, key)
-      integer_for(urn, key) == 1
+
+    def category
+      @category ||= @interface.categories.find_by_id(category_num)
     end
-    
-    def integer_for(urn, key)
-      value_for(urn, key).to_i
+
+    def room
+      @room ||=  @interface.rooms.find { |r| r.id == attributes['room'].to_i }
     end
 
-    def float_for(urn, key)
-      value_for(urn, key).to_f
+  private
+
+    def category_num
+      attributes['category_num'] || 0
     end
 
-    def time_for(urn, key)
-      Time.at(value_for(urn, key).to_i)
+    def set(urn, action, params, async = false, &block)
+      params.merge!('DeviceNum' => id)
+      Action.new(interface, urn, action, params).take(async) do
+        yield reload if block_given?
+      end
     end
 
-    def value_for(urn, key)
-      @states.each do |state_hash|
-        if state_hash['service'] == urn
-          if state_hash['variable'] == key
-            return state_hash['value']
+    def value_for(urn, key, type = { as: nil })
+      states.each do |state|
+        if state['service'] == urn
+          if state['variable'] == key
+            return MiOS.cast(state['value'], type[:as])
           end
         end
       end
-      
       nil
     end
-    
-    def parse(data, skip_attributes=false)
 
-      @attributes = Hash[
-        data.select { |k, v|
-          !data[k].kind_of?(Hash) and !data[k].kind_of?(Array)
-        }.to_a
-      ] unless skip_attributes     
-      @states = data['states']
-      @states.map { |state|
-        state['service'].split(":").last
-      }.uniq.each { |service|
-        service.gsub!(/[^a-zA-Z0-9]/, '')
+    def services
+      states.map { |state|
+        state['service'].split(':').last.gsub(/[^a-zA-Z0-9]/, '')
+      }.uniq
+    end
+
+    def initialize_services!
+      services.each do |service|
         if MiOS::Services.const_defined?(service)
           extend MiOS::Services.const_get(service)
         else
           $stderr.puts "WARNING: #{service} not yet supported"
         end
-      }
-      
-      true
+      end
+      nil
     end
+
   end
-end
+end

data/lib/mios/interface.rb

@@ -1,55 +1,71 @@
 module MiOS
+
   class Interface
-    attr_reader :attributes, :base_uri
+    extend Forwardable
+
+    def_delegator :@client, :device_status
+    def_delegator :@client, :action
+    def_delegator :@client, :job_status
 
     def initialize(base_uri)
-      @base_uri = base_uri
-      @client = HTTPClient.new
-      refresh!
+      @client = Client.new(base_uri)
+    end
+
+    def refresh!
+      @raw_data, @devices, @attributes, @categories, @rooms, @scenes = nil
+    end
+
+    def categories
+      @categories ||= CategoryCollection.new(raw_data['category_filter'])
+    end
+
+    def devices
+      @devices ||= raw_data['devices'].collect { |d| Device.new(self, d) }
+    end
+
+    def devices_for_label(label)
+      devices.select { |device| device.category && device.category.label == label }
+    end
+
+    def rooms
+      @rooms ||= raw_data['rooms'].collect { |r| Room.new(r['id'], r['name']) }
+    end
+
+    def scenes
+      @scenes ||= raw_data['scenes'].collect { |s| Scene.new(self, s['id'], s['name']) }
+    end
+
+    def device_names
+      devices.map(&:name)
+    end
+
+    def attributes
+      @attributes ||= load_attributes
     end
 
     def method_missing(method, *args)
-      if @attributes.has_key?(method.to_s)
-        @attributes[method.to_s]
-      else
-        super
-      end
+      attributes[method.to_s] || super
     end
 
-    def inspect
-      "#<MiOS::Interface:0x#{'%x' % (self.object_id << 1)} @base_uri=#{@base_uri} @attributes=#{@attributes.inspect}>"
+  private
+
+    def raw_data
+      @raw_data ||= @client.data_request(id: 'user_data')
     end
 
-    def refresh!
-      data = MultiJson.load(@client.get("#{base_uri}/data_request", {:id => "user_data", :output_format => :json}).content)
-      @attributes = Hash[
-        data.select { |k, v|
-          !data[k].kind_of?(Hash) and !data[k].kind_of?(Array)
-        }.map { |k, v|
-          [k.downcase, v]
-        }
+    def load_attributes
+      attributes = Hash[
+        raw_data
+          .select { |k, v| !raw_data[k].kind_of?(Hash) && !raw_data[k].kind_of?(Array) }
+          .map { |k, v| [k.downcase, v] }
       ]
+
       # Convert some time objects
       ['loadtime', 'devicesync'].each do |attr|
-        @attributes[attr] = Time.at(@attributes[attr].to_i)
+        attributes[attr] = MiOS.cast(attributes[attr], as: Time)
       end
-      @devices = Hash[
-        data['devices'].map { |device|
-          [device['id'], Device.new(@client, @base_uri, device)]
-        }
-      ]
 
-      true
+      attributes
     end
-
-    def categories
-      @devices.values.map { |device|
-        device.category
-      }.uniq.sort
-    end
-
-    def devices; @devices.values; end
-    
-    def device_names; devices.map(&:name); end
   end
-end
+end

data/lib/mios/job.rb

@@ -8,23 +8,32 @@ module MiOS
     class JobRequeue < StandardError; end
     class JobTimeout < StandardError; end
   end
-  
+
   class Job
-    Status = {
-      -1 => "Nonexistent",
-      0 => "Waiting",
-      1 => "In progress",
-      2 => "Error",
-      3 => "Aborted",
-      4 => "Completed",
-      5 => "Waiting for callback",
-      6 => "Requeue",
-      7 => "In progress with pending data"
+    STATUS = {
+      -1 => 'Nonexistent',
+      0 => 'Waiting',
+      1 => 'In progress',
+      2 => 'Error',
+      3 => 'Aborted',
+      4 => 'Completed',
+      5 => 'Waiting for callback',
+      6 => 'Requeue',
+      7 => 'In progress with pending data'
     }
+
+    # Define a query method for each status (eg. waiting?, in_progress?)
+    STATUS.each do |status_id, method_name|
+      define_method("#{method_name.downcase.gsub(' ', '_')}?") do
+        status == status_id
+      end
+    end
+
     attr_reader :id
 
-    def initialize(obj, id, async=false, &block)
-      @obj, @id = obj, id
+    def initialize(interface, id, async = false, &block)
+      @interface = interface
+      @id = id
       reload_status!
 
       if block_given?
@@ -39,41 +48,31 @@ module MiOS
     end
 
     def when_complete(&block)
-      raise Error::JobTimeout if !exists?
+      raise Error::JobTimeout if nonexistent?
       Timeout::timeout(20) do
         sleep_interval = 0.25
-        
+
         # If the job is still processing, wait a bit and try again
         while waiting? || in_progress? || waiting_for_callback? || in_progress_with_pending_data? do
           sleep(sleep_interval += 0.25)
           reload_status!
         end
-        raise JobError if error?
-        raise JobAborted if aborted?
-        raise JobRequeue if requeue?
+        raise Error::JobError if error?
+        raise Error::JobAborted if aborted?
+        raise Error::JobRequeue if requeue?
       end
-      yield @obj.reload
+      yield
     rescue Timeout::Error
-      $stderr.puts "Timed out waiting for job status to become complete"
+      $stderr.puts 'Timed out waiting for job status to become complete'
       raise Error::JobTimeout
     end
-    
-    def exists?; status != -1; end
-    def waiting?; status == 0; end
-    def in_progress?; status == 1; end
-    def error?; status == 2; end
-    def aborted?; status == 3; end
-    def completed?; status == 4; end
-    def waiting_for_callback?; status == 5; end
-    def requeue?; status == 6; end
-    def in_progress_with_pending_data?; status == 7; end
-    
+
     def status
       @status || reload_status!
     end
-    
+
     def reload_status!
-      @status = MultiJson.load(@obj.client.get("#{@obj.base_uri}/data_request", {:id => 'jobstatus', :job => @id, :plugin => 'zwave', :output_format => :json}).content)['status']
+      @status = @interface.job_status(@id)
     end
   end
-end
+end

data/lib/mios/room.rb

@@ -0,0 +1,14 @@
+module MiOS
+  class Room
+    attr_reader :id, :name
+
+    def initialize(id, name)
+      @id = id.to_i
+      @name = name
+    end
+
+    def to_s
+      name
+    end
+  end
+end

data/lib/mios/scene.rb

@@ -0,0 +1,22 @@
+module MiOS
+  class Scene
+    attr_reader :id, :name
+
+    def initialize(interface, id, name)
+      @interface = interface
+      @id = id.to_i
+      @name = name
+    end
+
+    def to_s
+      name
+    end
+
+    def run
+      response = Action.new(@interface,
+        'urn:micasaverde-com:serviceId:HomeAutomationGateway1',
+        'RunScene', 'SceneNum' => @id).take
+      response.values.first.values.first
+    end
+  end
+end

data/lib/mios/services/camera1.rb

@@ -1,12 +1,11 @@
 module MiOS
   module Services
     module Camera1
-      def self.extended(base)
-        base.instance_variable_set("@camera1_urn", "urn:micasaverde-com:serviceId:Camera1")
-      end
-      
+
+      URN = 'urn:micasaverde-com:serviceId:Camera1'
+
       def url
-        value_for(@camera1_urn, 'URL')
+        value_for(URN, 'URL')
       end
 
       def full_url

data/lib/mios/services/dimmable_light1.rb

@@ -1,19 +1,18 @@
 module MiOS
   module Services
     module Dimming1
-      def self.extended(base)
-        base.instance_variable_set("@dimming1_urn", "urn:upnp-org:serviceId:Dimming1")
-      end
+
+      URN = 'urn:upnp-org:serviceId:Dimming1'
 
       def level
-        integer_for(@dimming1_urn, 'LoadLevelStatus')
+        value_for(URN, 'LoadLevelStatus', as: Integer)
       end
-      
+
       def set_level!(new_level, async=false, &block)
         new_level = new_load_level.to_i
         new_level = 100 if new_load_level > 100
         new_level = 0 if new_load_level < 0
-        set(@dimming1_urn, "SetLoadLevelTarget", {"newLoadlevelTarget" => new_level}, async, &block)
+        set(URN, 'SetLoadLevelTarget', { "newLoadlevelTarget" => new_level }, async, &block)
       end
     end
   end

data/lib/mios/services/door_lock1.rb

@@ -1,20 +1,19 @@
 module MiOS
   module Services
     module DoorLock1
-      def self.extended(base)
-        base.instance_variable_set("@doorlock1_urn", "urn:micasaverde-com:serviceId:DoorLock1")
-      end
+
+      URN = 'urn:micasaverde-com:serviceId:DoorLock1'
 
       def min_pin_size
-        integer_for(@doorlock1_urn, 'MinPinSize')
+        value_for URN, 'MinPinSize', as: Integer
       end
 
       def max_pin_size
-        integer_for(@doorlock1_urn, 'MaxPinSize')
+        value_for URN, 'MaxPinSize', as: Integer
       end
 
       def locked?
-        boolean_for(@doorlock1_urn, 'Status')
+        value_for URN, 'Status', as: Boolean
       end
 
       def unlocked?
@@ -22,24 +21,24 @@ module MiOS
       end
 
       def pincodes
-        tmp = value_for(@doorlock1_urn, 'PinCodes')
+        tmp = value_for(URN, 'PinCodes')
         tmp.gsub!(/^<[^>]+>/, '').split("\t")
       end
-      
+
       def lock!(async=false, &block)
-        set(@doorlock1_urn, "SetTarget", {"newTargetValue" => 1}, async, &block)
+        set(URN, 'SetTarget', { "newTargetValue" => 1 }, async, &block)
       end
 
       def unlock!(async=false, &block)
-        set(@doorlock1_urn, "SetTarget", {"newTargetValue" => 0}, async, &block)
+        set(URN, 'SetTarget', { "newTargetValue" => 0 }, async, &block)
       end
-      
+
       def set_pin(name, pin, index, async=false, &block)
-        set(@doorlock1_urn, "SetPin", {"UserCodeName" => name, "newPin" => pin, "user" => index}, async, &block)
+        set(URN, 'SetPin', { "UserCodeName" => name, "newPin" => pin, "user" => index }, async, &block)
       end
 
       def clear_pin(index, async=false, &block)
-        set(@doorlock1_urn, "ClearPin", {"UserCode" => index}, async, &block)
+        set(URN, 'ClearPin', { "UserCode" => index }, async, &block)
       end
     end
   end