mios 0.2.0 → 0.3.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/lib/mios/device.rb

@@ -42,7 +42,15 @@ module MiOS
     def integer_for(urn, key)
       value_for(urn, key).to_i
     end
-    
+
+    def float_for(urn, key)
+      value_for(urn, key).to_f
+    end
+
+    def time_for(urn, key)
+      Time.at(value_for(urn, key).to_i)
+    end
+
     def value_for(urn, key)
       @states.each do |state_hash|
         if state_hash['service'] == urn
@@ -61,12 +69,12 @@ module MiOS
         data.select { |k, v|
           !data[k].kind_of?(Hash) and !data[k].kind_of?(Array)
         }.to_a
-      ] unless skip_attributes
-      
+      ] unless skip_attributes     
       @states = data['states']
       @states.map { |state|
         state['service'].split(":").last
       }.uniq.each { |service|
+        service.gsub!(/[^a-zA-Z0-9]/, '')
         if MiOS::Services.const_defined?(service)
           extend MiOS::Services.const_get(service)
         else

data/lib/mios/interface.rb

@@ -33,7 +33,6 @@ module MiOS
       ['loadtime', 'devicesync'].each do |attr|
         @attributes[attr] = Time.at(@attributes[attr].to_i)
       end
-
       @devices = Hash[
         data['devices'].map { |device|
           [device['id'], Device.new(@client, @base_uri, device)]

data/lib/mios/services/dimmable_light1.rb

@@ -13,7 +13,7 @@ module MiOS
         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(@dimming1_urn, "SetLoadLevelTarget", {"newLoadlevelTarget" => new_level}, async, &block)
       end
     end
   end

data/lib/mios/services/energy_metering1.rb

@@ -2,12 +2,20 @@ module MiOS
   module Services
     module EnergyMetering1
       def self.extended(base)
-        base.instance_variable_set("@energymetering1_urn", "urn:upnp-org:serviceId:EnergyMetering1")
+        base.instance_variable_set("@energymetering1_urn", "urn:micasaverde-com:serviceId:EnergyMetering1")
       end
 
       def watts
         integer_for(@energymetering1_urn, 'Watts')
       end
+
+      def kWh
+        float_for(@energymetering1_urn, 'KWH')
+      end
+
+      def last_reading_at
+        time_for(@energymetering1_urn, "KWHReading")
+      end
     end
   end
 end

data/lib/mios/services/hvac_fan_operating_mode1.rb

@@ -0,0 +1,13 @@
+module MiOS
+  module Services
+    module HVACFanOperatingMode1
+      def self.extended(base)
+        base.instance_variable_set("@hvac_fan_operating_mode1_urn", "urn:upnp-org:serviceId:HVAC_FanOperatingMode1")
+      end
+
+      def fan_mode
+        value_for(@hvac_fan_operating_mode1_urn, 'Mode')
+      end
+    end
+  end
+end

data/lib/mios/services/hvac_operating_state1.rb

@@ -0,0 +1,13 @@
+module MiOS
+  module Services
+    module HVACOperatingState1
+      def self.extended(base)
+        base.instance_variable_set("@hvac_operating_state1_urn", "urn:micasaverde-com:serviceId:HVAC_OperatingState1")
+      end
+
+      def operating_state
+        value_for(@hvac_operating_state1_urn, 'ModeState')
+      end
+    end
+  end
+end

data/lib/mios/services/hvac_user_operating_mode1.rb

@@ -0,0 +1,13 @@
+module MiOS
+  module Services
+    module HVACUserOperatingMode1
+      def self.extended(base)
+        base.instance_variable_set("@hvac_user_operating_mode1_urn", "urn:upnp-org:serviceId:HVAC_UserOperatingMode1")
+      end
+
+      def mode
+        value_for(@hvac_user_operating_mode1_urn, 'ModeStatus')
+      end
+    end
+  end
+end

data/lib/mios/services/temperature_setpoint1_cool.rb

@@ -0,0 +1,13 @@
+module MiOS
+  module Services
+    module TemperatureSetpoint1Cool
+      def self.extended(base)
+        base.instance_variable_set("@temperaturesetpoint1cool_urn", "urn:upnp-org:serviceId:TemperatureSetpoint1_Cool")
+      end
+
+      def cool_target
+        integer_for(@temperaturesetpoint1cool_urn, 'CurrentSetpoint')
+      end
+    end
+  end
+end

data/lib/mios/services/temperature_setpoint1_heat.rb

@@ -0,0 +1,13 @@
+module MiOS
+  module Services
+    module TemperatureSetpoint1Heat
+      def self.extended(base)
+        base.instance_variable_set("@temperaturesetpoint1heat_urn", "urn:upnp-org:serviceId:TemperatureSetpoint1_Heat")
+      end
+
+      def heat_target
+        integer_for(@temperaturesetpoint1heat_urn, 'CurrentSetpoint')
+      end
+    end
+  end
+end

data/lib/mios/version.rb

@@ -1,3 +1,3 @@
 module MiOS
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/mios.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
+  
   gem.add_dependency "httpclient", ">= 2.2.0"
   gem.add_dependency "multi_json", ">= 1.3.0"
   
@@ -24,4 +24,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "syntax"
   gem.add_development_dependency "rake", ">= 0.9.2"
   gem.add_development_dependency "yard", ">= 0.7.2"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "simplecov"
 end

data/spec/lib/mios/device_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe "device" do
+  it "should correctly parse service names" do
+    output = capture_stderr do
+      device = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/echo-energy-manager.json')))
+    end
+    expect(output).to eql "WARNING: EEMPlugin1 not yet supported\n"
+  end
+end

data/spec/lib/mios/interface_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe "interface" do
+  it "should load all the devices" do
+    VCR.use_cassette('data_request') do
+      mios = MiOS::Interface.new('http://192.168.50.21:3480')
+      expect(mios.devices.length).to eql 16
+    end    
+  end
+end
+

data/spec/lib/mios/services/energy_metering1_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe MiOS::Services::EnergyMetering1 do
+  before do
+    @meter = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/power-meter.json')))
+  end
+
+  describe :watts do
+    it "should return the correct power value" do
+      expect(@meter.watts).to eql 501
+    end
+  end
+
+  describe :kWh do
+    it "should return the correct energy value" do
+      expect(@meter.kWh).to eql 22.1990
+    end
+  end
+
+  describe :last_reading_at do
+    it "should return the correct time the last energy value was read" do
+      expect(@meter.last_reading_at).to eql Time.at(1395006325)
+    end
+  end
+
+end

data/spec/lib/mios/services/hvac_fan_operating_mode1_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MiOS::Services::HVACFanOperatingMode1 do
+  before do
+    @thermostat = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/thermostat.json')))
+  end
+
+  describe :mode do
+    it "should return the correct fan mode" do
+      expect(@thermostat.fan_mode).to eql "Auto"
+    end
+  end
+end

data/spec/lib/mios/services/hvac_operating_state1_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MiOS::Services::HVACOperatingState1 do
+  before do
+    @thermostat = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/thermostat.json')))
+  end
+
+  describe :operating_state do
+    it "should return the correct operating state" do
+      expect(@thermostat.operating_state).to eql "Idle"
+    end
+  end
+end

data/spec/lib/mios/services/hvac_user_operating_mode1_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MiOS::Services::HVACUserOperatingMode1 do
+  before do
+    @thermostat = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/thermostat.json')))
+  end
+
+  describe :mode do
+    it "should return the correct operating mode" do
+      expect(@thermostat.mode).to eql "HeatOn"
+    end
+  end
+end

data/spec/lib/mios/services/temperature_setpoint1_cool_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MiOS::Services::TemperatureSetpoint1Cool do
+  before do
+    @thermostat = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/thermostat.json')))
+  end
+
+  describe :cool_target do
+    it "should return the correct target" do
+      expect(@thermostat.cool_target).to eql 80
+    end
+  end
+end

data/spec/lib/mios/services/temperature_setpoint1_heat_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MiOS::Services::TemperatureSetpoint1Heat do
+  before do
+    @thermostat = MiOS::Device.new(nil, '', MultiJson.load(File.read('spec/support/device_data/thermostat.json')))
+  end
+
+  describe :heat_target do
+    it "should return the correct target" do
+      expect(@thermostat.heat_target).to eql 68
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,28 @@
 require 'rubygems'
 require 'rspec'
+require 'vcr'
+require 'pry'
+require 'simplecov'
+SimpleCov.start
 
 $LOAD_PATH << "#{File.expand_path(File.dirname(__FILE__))}/../lib"
 require "mios"
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.allow_http_connections_when_no_cassette = true
+end
+
+
+def capture_stderr(&block)
+  original_stderr = $stderr
+  $stderr = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stderr = original_stderr
+  end
+  fake.string
+end

data/spec/support/device_data/echo-energy-manager.json

@@ -0,0 +1,84 @@
+{
+         "id":"17",
+         "room":"0",
+         "id_parent":0,
+         "embedded":0,
+         "disabled":0,
+         "device_file":"D_EchoEnergyManager.xml",
+         "manufacturer":"",
+         "model":"",
+         "altid":"",
+         "ip":"",
+         "mac":"",
+         "time_created":"1394899227",
+         "plugin":"1328",
+         "states":[
+            {
+               "id":2,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"DevicesRegistered",
+               "value":"1"
+            },
+            {
+               "id":3,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"GotKey",
+               "value":"1"
+            },
+            {
+               "id":4,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"UserDataVersion",
+               "value":"0"
+            },
+            {
+               "id":5,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"OutsideTS",
+               "value":""
+            },
+            {
+               "id":6,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"InsideTS",
+               "value":""
+            },
+            {
+               "id":17,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"GatewayRegistered",
+               "value":"1"
+            },
+            {
+               "id":34,
+               "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+               "variable":"IpFeature",
+               "value":"0"
+            },
+            {
+               "id":36,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"EMDeviceList",
+               "value":"16;17;3;5;12;14;15"
+            },
+            {
+               "id":37,
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "variable":"TSDeviceList",
+               "value":"17;17;17;17;3;3;3;3;3;3"
+            }
+         ],
+         "invisible":"1",
+         "impl_file":"I_EchoEnergyManager.xml",
+         "name":"Ergy",
+         "ControlURLs":{
+            "service_39":{
+               "service":"urn:micasaverde-com:serviceId:EEM-Plugin1",
+               "ControlURL":"/upnp/control/dev_39",
+               "EventURL":"/upnp/event/dev_39",
+               "serviceType":"urn:schemas-micasaverde-com:service:EEM-Plugin:1"
+            }
+         },
+         "device_type":"urn:schemas-micasaverde-com:device:EnergyCalculator:1",
+         "local_udn":"uuid:4d494342-5342-5645-0011-000002161961"
+      }

data/spec/support/device_data/power-meter.json

@@ -0,0 +1,84 @@
+{
+   "id":"15",
+   "device_type":"urn:schemas-micasaverde-com:device:PowerMeter:1",
+   "room":"0",
+   "id_parent":14,
+   "disabled":0,
+   "device_file":"D_PowerMeter1.xml",
+   "impl_file":"",
+   "manufacturer":"",
+   "model":"",
+   "altid":"e1",
+   "ip":"",
+   "mac":"",
+   "time_created":"1394899070",
+   "states":[
+      {
+         "service":"urn:micasaverde-com:serviceId:ZWaveDevice1",
+         "variable":"VariablesGet",
+         "value":"",
+         "id":0
+      },
+      {
+         "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+         "variable":"Watts",
+         "id":1,
+         "value":"501"
+      },
+      {
+         "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+         "variable":"Log",
+         "id":2,
+         "value":"501,493,516,1395006325,926"
+      },
+      {
+         "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+         "variable":"ActualUsage",
+         "value":"1",
+         "id":3
+      },
+      {
+         "service":"urn:micasaverde-com:serviceId:ZWaveDevice1",
+         "variable":"ManufacturerInfo",
+         "value":"0,0,0",
+         "id":4
+      },
+      {
+         "service":"urn:micasaverde-com:serviceId:ZWaveDevice1",
+         "variable":"Capabilities",
+         "value":"82,92,0,4,33,1,R,B,RS,W1,|49,50,",
+         "id":5
+      },
+      {
+         "id":29,
+         "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+         "variable":"KWH",
+         "value":"22.1990"
+      },
+      {
+         "id":30,
+         "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+         "variable":"KWHReading",
+         "value":"1395006325"
+      }
+   ],
+   "category_num":21,
+   "subcategory_num":0,
+   "embedded":"1",
+   "ControlURLs":{
+      "service_35":{
+         "service":"urn:micasaverde-com:serviceId:EnergyMetering1",
+         "ControlURL":"/upnp/control/dev_35",
+         "EventURL":"/upnp/event/dev_35",
+         "serviceType":"urn:schemas-micasaverde-com:service:EnergyMetering:1"
+      },
+      "service_36":{
+         "service":"urn:micasaverde-com:serviceId:HaDevice1",
+         "ControlURL":"/upnp/control/dev_36",
+         "EventURL":"/upnp/event/dev_36",
+         "serviceType":"urn:schemas-micasaverde-com:service:HaDevice:1"
+      }
+   },
+   "name":"_Home Energy Monitor Clamp 1",
+   "local_udn":"uuid:4d494342-5342-5645-000f-000002161961"
+}