rzwaveway 0.0.4 → 0.0.6

data/.gitignore

@@ -1 +1,3 @@
 *.gem
+Gemfile.lock
+*.log

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+platforms :ruby do
+  gemspec name: 'rzwaveway'
+end

data/README.md

@@ -3,20 +3,43 @@ rzwaveway
 
 A Ruby library for communicating with the ZWave protocol stack from ZWay, running on the Raspberry Pi "razberry" add-on card (see http://razberry.z-wave.me/).
 
-## Example
+## Usage examples
+
+### Initialize the framework
 ```
 require 'rzwaveway'
 
-z_way = RZWaveWay::ZWay.new('192.168.1.123)
-devices = z_way.get_devices
-devices.values.each do | device |
+z_way = RZWaveWay::ZWay.instance
+z_way.setup('192.168.1.123')
+z_way.start
+```
+
+### List the devices
+```
+z_way.devices.each do |device_id,device|
   puts device.build_json
 end
+```
 
+### Listen to events
+```
 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
 end
+```
+
+### Switch on/off a device
+```
+z_way.execute(4, RZWaveWay::CommandClass::SWITCH_BINARY, :Set, 1)
+z_way.execute(4, RZWaveWay::CommandClass::SWITCH_BINARY, :Set, 0)
+```
+or
+
+```
+switch = z_way.devices[4]
+switch.SwitchBinary.set(1)
+switch.SwitchBinary.set(0)
 ```

data/lib/rzwaveway/command_class.rb

@@ -0,0 +1,29 @@
+module RZWaveWay
+  module CommandClass
+    BASIC = 32
+    SWITCH_BINARY = 37
+    SWITCH_MULTI_LEVEL = 38
+    SENSOR_BINARY = 48
+    SENSOR_MULTI_LEVEL = 49
+    CONFIGURATION = 112
+    ALARM = 113
+    MANUFACTURER_SPECIFIC = 114
+    BATTERY = 128
+    WAKEUP = 132
+    ASSOCIATION = 133
+    VERSION = 134
+    ALARM_SENSOR = 156
+
+    private
+
+    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
+    end
+  end
+end

data/lib/rzwaveway/command_classes/battery.rb

@@ -0,0 +1,33 @@
+module RZWaveWay
+  module CommandClasses
+    class Battery
+      include CommandClass
+
+      def initialize(data, device)
+        @device = device
+        @device.add_property(:battery_level,
+                             find('data.last.value', data),
+                             find('data.last.updateTime', 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)
+          end
+        end
+      end
+
+      def battery_value
+        @device.get_property(:battery_level)[0]
+      end
+
+      def get
+        RZWaveWay::ZWay.instance.execute(@device.id, BATTERY, :Get)
+      end
+    end
+  end
+end

data/lib/rzwaveway/command_classes/sensor_binary.rb

@@ -0,0 +1,33 @@
+module RZWaveWay
+  module CommandClasses
+    class SensorBinary
+      include CommandClass
+
+      def initialize(data, device)
+        @device = device
+        @device.add_property(:level,
+                             find('data.1.level.value', data),
+                             find('data.1.level.updateTime', 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)
+          end
+        end
+      end
+
+      def level
+        @device.get_property(:level)[0]
+      end
+
+      def get
+        RZWaveWay::ZWay.instance.execute(@device.id, SENSOR_BINARY, :Get)
+      end
+    end
+  end
+end

data/lib/rzwaveway/command_classes/switch_binary.rb

@@ -0,0 +1,37 @@
+module RZWaveWay
+  module CommandClasses
+    class SwitchBinary
+      include CommandClass
+
+      def initialize(data, device)
+        @device = device
+        @device.add_property(:level,
+                             find('data.level.value', data),
+                             find('data.level.updateTime', 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)
+          end
+        end
+      end
+
+      def level
+        @device.get_property(:level)[0]
+      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)
+      end
+    end
+  end
+end

data/lib/rzwaveway/command_classes/switch_multi_level.rb

@@ -0,0 +1,37 @@
+module RZWaveWay
+  module CommandClasses
+    class SwitchMultiLevel
+      include CommandClass
+
+      def initialize(data, device)
+        @device = device
+        @device.add_property(:level,
+                             find('data.level.value', data),
+                             find('data.level.updateTime', 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)
+          end
+        end
+      end
+
+      def level
+        @device.get_property(:level)[0]
+      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)
+      end
+    end
+  end
+end

data/lib/rzwaveway/command_classes/wake_up.rb

@@ -0,0 +1,41 @@
+module RZWaveWay
+  module CommandClasses
+    class WakeUp
+      include 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)
+
+        @device.add_property(:wakeup_interval,
+                             wakeup_interval,
+                             find('data.interval.updateTime', data))
+        @device.add_property(:wakeup_last_sleep_time,
+                             last_sleep_time,
+                             find('data.lastSleep.updateTime', data))
+        @device.add_property(:wakeup_last_wakeup_time,
+                             last_wakeup_time,
+                             find('data.lastSleep.updateTime', data))
+
+        @device.contact_frequency = wakeup_interval
+        @device.notify_contacted(last_wakeup_time)
+      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)
+          end
+        end
+
+        # TODO handle change of wake up interval value?
+      end
+    end
+  end
+end

data/lib/rzwaveway/command_classes.rb

@@ -1,82 +1,45 @@
-module RZWaveWay
-  module CommandClasses
-    BASIC = 32
-    SENSOR_BINARY = 48
-    MULTI_LEVEL_SENSOR = 49
-    CONFIGURATION = 112
-    BATTERY = 128
-    WAKEUP = 132
-    ALARM_SENSOR = 156
+require 'singleton'
 
-    DATA = {
-      SENSOR_BINARY => {
-        'level' => 'data.1.level.value',
-        'lastLevelChangeTime' => 'data.1.level.updateTime'
-      },
-      WAKEUP => {
-        'wakeUpInterval' => 'data.interval.value',
-        'lastSleepTime' => 'data.lastSleep.value',
-        'lastWakeUpTime' => 'data.lastWakeup.value'
-      },
-      BATTERY => {
-        'batteryLevel' => 'data.last.value'
-      }
-    }
-  end
+require_relative 'command_class'
+require_relative 'command_classes/battery'
+require_relative 'command_classes/switch_binary'
+require_relative 'command_classes/switch_multi_level'
+require_relative 'command_classes/sensor_binary'
+require_relative 'command_classes/wake_up'
 
-  class CommandClass
-    include CommandClasses
-    attr_reader :id
-    attr_reader :properties
+module RZWaveWay
+  module CommandClasses
+    class Dummy
+      include Singleton
 
-    def initialize(id, data)
-      @id = id
-      @properties = {}
-      if DATA.has_key? id 
-        DATA[id].each do |key, name|
-          @properties[key] = get_data(name, data)
-        end
+      def initialize
       end
-    end
 
-    def get_data 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]
+      def process(updates)
       end
-      result
     end
 
-    def process updates, device_id
-      event = nil
-      names = updates.keys
-      case id
-      when WAKEUP
-        if names.include?("data.lastWakeup") &&
-          names.include?("data.lastSleep")
-          @properties['lastSleepTime'] = updates["data.lastSleep"]["value"]
-          event = AliveEvent.new(device_id, @properties['lastSleepTime'])
-        end
-      when SENSOR_BINARY
-        if names.include?("data.1")
-          @properties['lastLevelChangeTime'] = updates['data.1']["level"]["updateTime"]
-          @properties['level'] = updates['data.1']["level"]["value"]
-          event = LevelEvent.new(device_id, @properties['lastLevelChangeTime'], @properties['level'])
+    class Factory
+      include Singleton
+      include CommandClass
+
+      def instantiate(id, data, device)
+        if CLASSES.has_key? id
+          return CLASSES[id].new(data, device)
+        else
+          return CommandClasses::Dummy.instance
         end
       end
-      event
-    end
 
-    def process_alive_check device_id
-      wakeup_interval = @properties['wakeUpInterval']
-      last_sleep_time = @properties['lastSleepTime']
-      current_time = Time.now.to_i
-      estimated_wakeup_time = (last_sleep_time + wakeup_interval * 1.1).to_i
-      if(current_time > estimated_wakeup_time)
-        return NotAliveEvent.new(device_id, current_time - estimated_wakeup_time)
-      end
+      private
+
+      CLASSES = {
+        SWITCH_BINARY => CommandClasses::SwitchBinary,
+        SWITCH_MULTI_LEVEL => CommandClasses::SwitchMultiLevel,
+        SENSOR_BINARY => CommandClasses::SensorBinary,
+        WAKEUP => CommandClasses::WakeUp,
+        BATTERY => CommandClasses::Battery
+      }
     end
   end
-end
+end

data/lib/rzwaveway/events.rb

@@ -12,10 +12,20 @@ module RZWaveWay
   class NotAliveEvent
     attr_reader :device_id
     attr_reader :time_delay
+    attr_reader :missed_count
 
-    def initialize device_id, time_delay
+    def initialize(device_id, time_delay, missed_count)
       @device_id = device_id
       @time_delay = time_delay
+      @missed_count = missed_count
+    end
+  end
+
+  class DeadEvent
+    attr_reader :device_id
+
+    def initialize(device_id)
+      @device_id = device_id
     end
   end
 
@@ -24,13 +34,28 @@ module RZWaveWay
     attr_reader :time
     attr_reader :level
 
-    def initialize device_id, time, level
+    def initialize(device_id, time, level)
       @device_id = device_id
       @time = time
       @level = level
     end
   end
 
+  class MultiLevelEvent < LevelEvent
+  end
+
+  class BatteryValueEvent
+    attr_reader :device_id
+    attr_reader :time
+    attr_reader :value
+
+    def initialize(device_id, time, value)
+      @device_id = device_id
+      @time = time
+      @value = value
+    end
+  end
+
   class SmokeEvent
     attr_reader :device_id
     attr_reader :time
@@ -45,4 +70,4 @@ module RZWaveWay
     attr_reader :device_id
     attr_reader :time
   end
-end
+end

data/lib/rzwaveway/extensions/fibaro_smoke_sensor.rb

@@ -0,0 +1,11 @@
+module RZWaveWay
+  module Extensions
+    class FibaroSmokeSensor
+      def initialize device
+        @device = device
+      end
+
+      # TODO add some usefull methods here for this kind of device
+    end
+  end
+end

data/lib/rzwaveway/extensions/ssa_siren_strobe_alarm.rb

@@ -0,0 +1,53 @@
+module RZWaveWay
+  module Extensions
+    class SSASirenStrobeAlarm
+      def initialize device
+        @device = device
+      end
+
+      def disable
+        set DISABLED
+      end
+
+      def enable
+        set(STROBE + SIREN)
+      end
+
+      def enable_siren
+        set SIREN
+      end
+
+      def enable_strobe
+        set STROBE
+      end
+
+      def level
+        case @device.SwitchMultiLevel.level
+        when DISABLED
+          :disabled
+        when STROBE
+          :strobe
+        when SIREN
+          :siren
+        else
+          :strobe_and_siren
+        end
+      end
+
+      def level!
+        @device.SwitchMultiLevel.get
+        nil
+      end
+
+      private
+
+      DISABLED = 0
+      STROBE = 33
+      SIREN = 66
+
+      def set level
+        @device.SwitchMultiLevel.set level
+      end
+    end
+  end
+end

data/lib/rzwaveway/extensions.rb

@@ -0,0 +1,2 @@
+require_relative 'extensions/fibaro_smoke_sensor'
+require_relative 'extensions/ssa_siren_strobe_alarm'

data/lib/rzwaveway/version.rb

@@ -0,0 +1,3 @@
+module RZWaveWay
+  VERSION = '0.0.6'
+end