rzwaveway 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01e99f245086e41fbeca9e16d6c0c6867324906d
-  data.tar.gz: adc57ec22b54fb1f084b2adc44bbcde9835fb3c8
+  metadata.gz: 6f5e0b677ce1728466c714be10191c2fea92bc97
+  data.tar.gz: b07f33865fb9ac752453ef12efcccfa3f206d120
 SHA512:
-  metadata.gz: 54c2f9b32d733c49a8e5022e452cc8d16c828f9b7eab5da5436db7dab2c15b73f7391378895f163b17bc6558a46dd13c3330e033a255d9b8fc23d0a973264687
-  data.tar.gz: 7c1b8a78ebd3e5942b86e576b9e2323089b865c73dff680c7edd031c0c096e50afed5aa469db3853523b8911e640a53567e2ad8affbee8b55f10652f934e6486
+  metadata.gz: e0043ffd5ae35ceaaea940771f828e1662256d9a145ae9440dcd7d53a03f4ce604ec5a7ebdfc7ec09855062bdbb24729865638f95f7c56d665a56341aec8dba5
+  data.tar.gz: b9d79401b008fe87b9ba484602fe4c7c7f3027d7dcc7ae210c328cb7fa6ebca8e29f632b27ec0dce053cc909283116652920c231230436e8ae8d0b23f34427c5

data/README.md

@@ -10,7 +10,7 @@ A Ruby library for communicating with the ZWave protocol stack from ZWay, runnin
 require 'rzwaveway'
 
 z_way = RZWaveWay::ZWay.instance
-z_way.setup('192.168.1.123')
+z_way.setup(hostname: '192.168.1.123', port: 8083)
 z_way.start
 ```
 
@@ -27,7 +27,7 @@ z_way.on_event(RZWaveWay::AliveEvent) {|event| puts "A device woke up" }
 z_way.on_event(RZWaveWay::LevelEvent) {|event| puts "A device got triggered" }
 while true do
   sleep 5
-  z_way.process_events
+  z_way.process
 end
 ```
 
@@ -40,6 +40,6 @@ or
 
 ```
 switch = z_way.devices[4]
-switch.SwitchBinary.set(1)
-switch.SwitchBinary.set(0)
+switch.SwitchBinary.level = 1
+switch.SwitchBinary.level = 0
 ```

data/lib/rzwaveway.rb

@@ -1,6 +1,8 @@
+require_relative 'rzwaveway/logger'
+require_relative 'rzwaveway/property'
+require_relative 'rzwaveway/properties_cache'
 require_relative 'rzwaveway/command_classes'
 require_relative 'rzwaveway/events'
-require_relative 'rzwaveway/logger'
 require_relative 'rzwaveway/zwave_device'
 require_relative 'rzwaveway/zway'
 require_relative 'rzwaveway/extensions'

data/lib/rzwaveway/command_class.rb

@@ -1,29 +1,40 @@
 module RZWaveWay
-  module CommandClass
+  class CommandClass
+    include Logger
+    include PropertiesCache
+
     BASIC = 32
     SWITCH_BINARY = 37
     SWITCH_MULTI_LEVEL = 38
     SENSOR_BINARY = 48
     SENSOR_MULTI_LEVEL = 49
+    METER = 50
     CONFIGURATION = 112
     ALARM = 113
+    NOTIFICATION = ALARM
     MANUFACTURER_SPECIFIC = 114
     BATTERY = 128
     WAKEUP = 132
     ASSOCIATION = 133
     VERSION = 134
+    SECURITY = 152
     ALARM_SENSOR = 156
 
-    private
+    attr_reader :device
+
+    def initialize(device)
+      @device = device
+    end
+
+    def build_from(data)
+    end
 
-    def find(name, data)
-      parts = name.split '.'
-      result = data
-      parts.each do | part |
-        raise "Could not find part '#{part}' in '#{name}'" unless result.has_key? part
-        result = result[part]
-      end
-      result
+    def name
+      self.class.name.split('::').last
+    end
+    
+    def to_s
+      name
     end
   end
 end

data/lib/rzwaveway/command_classes.rb

@@ -1,6 +1,8 @@
 require 'singleton'
 
 require_relative 'command_class'
+require_relative 'command_classes/alarm'
+require_relative 'command_classes/alarm_sensor'
 require_relative 'command_classes/battery'
 require_relative 'command_classes/switch_binary'
 require_relative 'command_classes/switch_multi_level'
@@ -9,36 +11,48 @@ require_relative 'command_classes/wake_up'
 
 module RZWaveWay
   module CommandClasses
-    class Dummy
+    class Unsupported
       include Singleton
 
-      def initialize
+      def build_from(data)
       end
 
       def process(updates)
       end
+
+      def save_properties
+      end
+
+      def to_hash
+        {}
+      end
+
+      def to_s
+        'Unsupported'
+      end
     end
 
     class Factory
       include Singleton
-      include CommandClass
 
-      def instantiate(id, data, device)
+      def instantiate(id, device)
         if CLASSES.has_key? id
-          return CLASSES[id].new(data, device)
+          CLASSES[id].new(device)
         else
-          return CommandClasses::Dummy.instance
+          CommandClasses::Unsupported.instance
         end
       end
 
       private
 
       CLASSES = {
-        SWITCH_BINARY => CommandClasses::SwitchBinary,
-        SWITCH_MULTI_LEVEL => CommandClasses::SwitchMultiLevel,
-        SENSOR_BINARY => CommandClasses::SensorBinary,
-        WAKEUP => CommandClasses::WakeUp,
-        BATTERY => CommandClasses::Battery
+        CommandClass::SWITCH_BINARY => CommandClasses::SwitchBinary,
+        CommandClass::SWITCH_MULTI_LEVEL => CommandClasses::SwitchMultiLevel,
+        CommandClass::SENSOR_BINARY => CommandClasses::SensorBinary,
+        CommandClass::WAKEUP => CommandClasses::WakeUp,
+        CommandClass::ALARM => CommandClasses::Alarm,
+        CommandClass::ALARM_SENSOR => CommandClasses::AlarmSensor,
+        CommandClass::BATTERY => CommandClasses::Battery
       }
     end
   end

data/lib/rzwaveway/command_classes/alarm.rb

@@ -0,0 +1,43 @@
+module RZWaveWay
+  module CommandClasses
+    class Alarm < CommandClass
+
+      def process(updates)
+        updates.each do |key, value|
+          if key == 'data.V1event'
+            alarm_type = value['alarmType']['value']
+            yield AlarmEvent.new(device_id: device.id,
+                                 time: value['updateTime'],
+                                 alarm_type: ALARM_TYPES[alarm_type],
+                                 level: value['level']['value'])
+          else
+            match_data = key.match(/^data.(\d+)/)
+            if match_data
+              alarm_type = match_data[1].to_i
+              yield AlarmEvent.new(device_id: device.id,
+                                   time: value['updateTime'],
+                                   alarm_type: ALARM_TYPES[alarm_type],
+                                   level: value['event']['value'])
+            end
+          end
+        end
+      end
+
+      private
+
+      ALARM_TYPES = {
+        0x01 => :smoke,
+        0x02 => :co,
+        0x03 => :co2,
+        0x04 => :heat,
+        0x05 => :water,
+        0x06 => :access_control,
+        0x07 => :burglar,
+        0x08 => :power_management,
+        0x09 => :system,
+        0x0a => :emergency,
+        0x0b => :clock
+      }
+    end
+  end
+end

data/lib/rzwaveway/command_classes/alarm_sensor.rb

@@ -0,0 +1,17 @@
+module RZWaveWay
+  module CommandClasses
+    class AlarmSensor < CommandClass
+      GENERAL_PURPOSE = 0x00
+      SMOKE = 0x01
+      CO = 0x02
+      CO2 = 0x03
+      HEAT = 0x04
+      WATER_LEAK = 0x05
+
+      def process(updates)
+        log.info updates
+        nil
+      end
+    end
+  end
+end

data/lib/rzwaveway/command_classes/battery.rb

@@ -1,28 +1,24 @@
 module RZWaveWay
   module CommandClasses
-    class Battery
-      include CommandClass
+    class Battery < CommandClass
 
-      def initialize(data, device)
-        @device = device
-        @device.add_property(name: :battery_level,
-                             value: find('data.last.value', data),
-                             update_time: find('data.last.updateTime', data))
+      def build_from(data)
+        define_property(:battery_level, 'data.last', true, data)
       end
 
       def process(updates)
         if updates.keys.include?('data.last')
           data = updates['data.last']
           value = data['value']
-          updateTime = data['updateTime']
-          if @device.update_property(:battery_level, value, updateTime)
-            return BatteryValueEvent.new(@device.id, updateTime, value)
+          update_time = data['updateTime']
+          if @properties[:battery_level].update(value, update_time)
+            yield BatteryValueEvent.new(device_id: device.id, time: update_time, value: value)
           end
         end
       end
 
-      def get
-        RZWaveWay::ZWay.instance.execute(@device.id, BATTERY, :Get)
+      def refresh
+        RZWaveWay::ZWay.instance.execute(device.id, BATTERY, :Get)
       end
     end
   end

data/lib/rzwaveway/command_classes/sensor_binary.rb

@@ -1,32 +1,24 @@
 module RZWaveWay
   module CommandClasses
-    class SensorBinary
-      include CommandClass
+    class SensorBinary < CommandClass
 
-      def initialize(data, device)
-        @device = device
-        @device.add_property(name: :level,
-                             value: find('data.1.level.value', data),
-                             update_time: find('data.1.level.updateTime', data))
+      def build_from(data)
+        define_property(:level, 'data.1.level', true, data)
       end
 
       def process(updates)
         if updates.keys.include?('data.1')
           data = updates['data.1']['level']
           value = data['value']
-          updateTime = data['updateTime']
-          if @device.update_property(:level, value, updateTime)
-            return LevelEvent.new(@device.id, updateTime, value)
+          update_time = data['updateTime']
+          if @properties[:level].update(value, update_time)
+            yield LevelEvent.new(device_id: device.id, time: update_time, level: value)
           end
         end
       end
 
-      def level
-        @device.get_property(:level)[0]
-      end
-
-      def get
-        RZWaveWay::ZWay.instance.execute(@device.id, SENSOR_BINARY, :Get)
+      def refresh
+        RZWaveWay::ZWay.instance.execute(device.id, SENSOR_BINARY, :Get)
       end
     end
   end

data/lib/rzwaveway/command_classes/switch_binary.rb

@@ -1,37 +1,28 @@
 module RZWaveWay
   module CommandClasses
-    class SwitchBinary
-      include CommandClass
+    class SwitchBinary < CommandClass
 
-      def initialize(data, device)
-        @device = device
-        @device.add_property(name: :level,
-                             value: find('data.level.value', data),
-                             update_time: find('data.level.updateTime', data),
-                             read_only: false)
+      def build_from(data)
+        define_property(:level, 'data.level', false, data)
       end
 
       def process(updates)
         if updates.keys.include?('data.level')
           data = updates['data.level']
           value = data['value']
-          updateTime = data['updateTime']
-          if @device.update_property(:level, value, updateTime)
-            return LevelEvent.new(@device.id, updateTime, value)
+          update_time = data['updateTime']
+          if @properties[:level].update(value, update_time)
+            yield LevelEvent.new(device_id: device.id, time: update_time, level: value)
           end
         end
       end
 
-      def level
-        @device.get_property(:level)[0]
+      def level=(value)
+        RZWaveWay::ZWay.instance.execute(device.id, SWITCH_BINARY, :Set, value)
       end
 
-      def get
-        RZWaveWay::ZWay.instance.execute(@device.id, SWITCH_BINARY, :Get)
-      end
-
-      def set(value)
-        RZWaveWay::ZWay.instance.execute(@device.id, SWITCH_BINARY, :Set, value)
+      def refresh
+        RZWaveWay::ZWay.instance.execute(device.id, SWITCH_BINARY, :Get)
       end
     end
   end

data/lib/rzwaveway/command_classes/switch_multi_level.rb

@@ -1,37 +1,28 @@
 module RZWaveWay
   module CommandClasses
-    class SwitchMultiLevel
-      include CommandClass
+    class SwitchMultiLevel < CommandClass
 
-      def initialize(data, device)
-        @device = device
-        @device.add_property(name: :level,
-                             value: find('data.level.value', data),
-                             update_time: find('data.level.updateTime', data),
-                             read_only: false)
+      def build_from(data)
+        define_property(:level, 'data.level', false, data)
       end
 
       def process(updates)
         if updates.keys.include?('data.level')
           data = updates['data.level']
           value = data['value']
-          updateTime = data['updateTime']
-          if @device.update_property(:level, value, updateTime)
-            return MultiLevelEvent.new(@device.id, updateTime, value)
+          update_time = data['updateTime']
+          if @properties[:level].update(value, update_time)
+            yield MultiLevelEvent.new(device_id: device.id, time: update_time, level: value)
           end
         end
       end
 
-      def level
-        @device.get_property(:level)[0]
+      def level=(value)
+        RZWaveWay::ZWay.instance.execute(device.id, SWITCH_MULTI_LEVEL, :Set, value)
       end
 
-      def get
-        RZWaveWay::ZWay.instance.execute(@device.id, SWITCH_MULTI_LEVEL, :Get)
-      end
-
-      def set(value)
-        RZWaveWay::ZWay.instance.execute(@device.id, SWITCH_MULTI_LEVEL, :Set, value)
+      def refresh
+        RZWaveWay::ZWay.instance.execute(device.id, SWITCH_MULTI_LEVEL, :Get)
       end
     end
   end

data/lib/rzwaveway/command_classes/wake_up.rb

@@ -1,44 +1,41 @@
 module RZWaveWay
   module CommandClasses
-    class WakeUp
-      include CommandClass
+    class WakeUp < CommandClass
 
-      def initialize(data, device)
-        @device = device
-        wakeup_interval = find('data.interval.value', data)
-        last_wakeup_time = find('data.lastWakeup.value', data)
-        last_sleep_time = find('data.lastSleep.value', data)
+      def build_from(data)
+        define_property(:contact_frequency, 'data.interval', true, data)
+        define_property(:last_sleep_time, 'data.lastSleep', true, data)
+        define_property(:last_wakeup_time, 'data.lastWakeup', true, data)
 
-        @device.add_property(name: :wakeup_interval,
-                             value: wakeup_interval,
-                             update_time: find('data.interval.updateTime', data),
-                             internal: true)
-        @device.add_property(name: :wakeup_last_sleep_time,
-                             value: last_sleep_time,
-                             update_time: find('data.lastSleep.updateTime', data),
-                             internal: true)
-        @device.add_property(name: :wakeup_last_wakeup_time,
-                             value: last_wakeup_time,
-                             update_time: find('data.lastWakeup.updateTime', data),
-                             internal: true)
+        device.notify_contacted(find('data.lastWakeup.value', data))
+      end
+
+      def missed_contact_count(time = Time.now)
+        (elapsed_seconds_since_last_contact(time) / contact_frequency).to_i
+      end
 
-        @device.contact_frequency = wakeup_interval
-        @device.notify_contacted(last_wakeup_time)
+      def on_time?(time = Time.now)
+        elapsed_seconds_since_last_contact(time) < (contact_frequency * 1.2)
       end
 
       def process(updates)
         if updates.keys.include?('data.lastWakeup')
           data = updates['data.lastWakeup']
           value = data['value']
-          updateTime = data['updateTime']
-          if @device.update_property(:wakeup_last_wakeup_time, value, updateTime)
-            @device.notify_contacted(value)
-            return AliveEvent.new(@device.id, value)
+          update_time = data['updateTime']
+          if @properties[:last_wakeup_time].update(value, update_time)
+            device.notify_contacted(value)
           end
         end
-
+        nil
         # TODO handle change of wake up interval value?
       end
+
+      private
+
+      def elapsed_seconds_since_last_contact(time)
+        time.to_i - device.last_contact_time
+      end
     end
   end
 end