rzwaveway 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,22 @@
+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
+```
+require 'rzwaveway'
+
+z_way = RZWaveWay::ZWay.new('192.168.1.123)
+devices = z_way.get_devices
+devices.values.each do | device |
+  puts device.build_json
+end
+
+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
+```

data/lib/rzwaveway/command_classes.rb

@@ -0,0 +1,51 @@
+require 'pp'
+require_relative 'events'
+
+module RZWaveWay
+  module CommandClasses
+    SENSOR_BINARY = 48
+    MULTI_LEVEL_SENSOR = 49
+    CONFIGURATION = 112
+    BATTERY = 128
+    WAKEUP = 132
+    ALARM_SENSOR = 156
+  end
+
+  class CommandClass
+    include CommandClasses
+    attr_reader :id
+    @data
+
+    def initialize(id, data)
+      @id = id
+      @data = data
+    end
+
+    def get_data name
+      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
+
+    def process updates, device_id
+      event = nil
+      names = updates.collect { |x| x[0]}
+      case id
+      when WAKEUP
+        if names.include?("data.lastWakeup") &&
+          names.include?("data.lastSleep")
+          event = AliveEvent.new(device_id, updates[1][1]["value"])
+        end
+      when SENSOR_BINARY
+        if names.include?("data.1")
+          event = LevelEvent.new(device_id,updates[0][1]["level"]["updateTime"], updates[0][1]["level"]["value"])
+        end
+      end
+      event
+    end
+  end
+end

data/lib/rzwaveway/events.rb

@@ -0,0 +1,38 @@
+module RZWaveWay
+  class AliveEvent
+    attr_reader :device_id
+    attr_reader :time
+
+    def initialize device_id, time
+      @device_id = device_id
+      @time = time
+    end
+  end
+
+  class LevelEvent
+    attr_reader :device_id
+    attr_reader :time
+    attr_reader :level
+
+    def initialize device_id, time, level
+      @device_id = device_id
+      @time = time
+      @level = level
+    end
+  end
+
+  class SmokeEvent
+    attr_reader :device_id
+    attr_reader :time
+  end
+
+  class HighTemperatureEvent
+    attr_reader :device_id
+    attr_reader :time
+  end
+
+  class TamperingEvent
+    attr_reader :device_id
+    attr_reader :time
+  end
+end

data/lib/rzwaveway/zwave_device.rb

@@ -0,0 +1,81 @@
+require 'json'
+
+require_relative 'command_classes'
+
+module RZWaveWay
+  class ZWaveDevice
+    include CommandClasses
+
+    attr_reader :id
+
+    def initialize(id, data)
+      @id = id
+      @command_classes = create_commandclasses_from data
+      puts "Created ZWaveDevice with id='#{id}'"
+    end
+
+    def create_commandclasses_from data
+      cc_classes = {}
+      data['instances']['0']['commandClasses'].each do |cc_id, sub_tree|
+        cc_classes[cc_id.to_i] = CommandClass.new(cc_id.to_i, sub_tree)
+      end
+      cc_classes
+    end
+
+    def build_json
+      properties = {'deviceId' => @id}
+      if(support_commandclass? SENSOR_BINARY)
+        properties.merge!( {
+          'level' => @command_classes[SENSOR_BINARY].get_data('data.1.level.value'),
+          'lastLevelChangeTime' => @command_classes[SENSOR_BINARY].get_data('data.1.level.updateTime')          
+        })
+      end
+      if(support_commandclass? WAKEUP)
+        properties.merge!( {
+          'wakeUpInterval' => @command_classes[WAKEUP].get_data('data.interval.value'),
+          'lastSleepTime' => @command_classes[WAKEUP].get_data('data.lastSleep.value'),
+          'lastWakeUpTime' => @command_classes[WAKEUP].get_data('data.lastWakeup.value')
+        })
+      end
+      if(support_commandclass? BATTERY)
+        properties.merge!( {
+          'batteryLevel' => @command_classes[BATTERY].get_data('data.last.value')
+        })
+      end
+      properties.to_json
+    end
+
+    def support_commandclass? command_class
+      @command_classes.has_key? command_class
+    end
+
+    def process updates
+      events = []
+      updates_per_commandclass =  group_per_commandclass updates
+      updates_per_commandclass.each do |cc, values|
+        if @command_classes.has_key? cc
+          events << (@command_classes[cc].process(values, @id))
+        else
+          puts "Could not find command class: '#{cc}'"
+      end
+      events
+    end
+
+    def group_per_commandclass updates
+      updates_per_commandclass = Hash.new { [] }
+      updates.each do | key, value |
+        match_data = key.match(/\Ainstances.0.commandClasses.(\d+)./)
+        if match_data
+          command_class = match_data[1].to_i
+          cc_updates = updates_per_commandclass[command_class]
+          cc_updates << [match_data.post_match, value]
+          updates_per_commandclass[command_class] = cc_updates
+        else
+          puts "? #{key}" unless key.match(/\Adata./)
+        end
+      end
+      updates_per_commandclass
+    end
+
+  end
+end

data/lib/rzwaveway/zway.rb

@@ -0,0 +1,94 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module RZWaveWay
+  class ZWay
+    def initialize hostname
+      @devices = {}
+      @update_time = "0"
+      @uri = URI::HTTP.build({:host => hostname, :port => 8083})
+      @event_handlers = {}
+    end
+
+    def get_devices
+      @uri.path = "/ZWaveAPI/Data/#{@update_time}"
+      response = http_post_request
+      if response.code == "200"
+        results = JSON.parse response.body
+        @update_time = results["updateTime"]
+        results["devices"].each do |device |
+          device_id = device[0].to_i
+          @devices[device_id] = ZWaveDevice.new(device_id, device[1]) if device_id > 1
+        end
+        @devices
+      else
+        pp response.code
+        return {}
+      end
+    end
+
+    def process_events
+      events = []
+      updates = get_updates
+      updates_per_device = group_per_device updates
+      updates_per_device.each do | id, updates |
+        if @devices[id]
+          events.concat (@devices[id].process updates)
+        else
+          puts "Could not find device with id '#{id}'"
+        end
+      end
+      events.each do |event|
+        handler = @event_handlers[event.class]
+        if handler
+          handler.call(event)
+        else
+          puts "no handler for #{event.class}"
+        end
+      end
+      events
+    end
+
+    def get_updates
+      @uri.path = "/ZWaveAPI/Data/#{@update_time}"
+      response = http_post_request
+      if response.is_a?(Net::HTTPSuccess)
+        results = JSON.parse response.body
+        @update_time = results.delete("updateTime")
+        return results
+      else
+        pp response.code
+        return {}
+      end
+    end
+
+    def group_per_device updates
+      updates_per_device = Hash.new { [] }
+      updates.each do | key, value |
+        match_data = key.match(/\Adevices\.(\d+)\./)
+        if match_data
+          device_id = match_data[1].to_i
+          device_updates = updates_per_device[device_id]
+          device_updates << [match_data.post_match, value]
+          updates_per_device[device_id] = device_updates
+        else
+          puts "? #{key}"
+        end
+      end
+      updates_per_device
+    end
+
+    def http_post_request
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      http.use_ssl = false
+
+      request = Net::HTTP::Post.new(@uri.path)
+      http.request(request)
+    end
+
+    def on_event (event, &listener)
+      @event_handlers[event] = listener
+    end
+  end
+end

data/lib/rzwaveway.rb

@@ -0,0 +1,4 @@
+require 'rzwaveway/command_classes'
+require 'rzwaveway/events'
+require 'rzwaveway/zwave_device'
+require 'rzwaveway/zway'

data/rzwaveway.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = "rzwaveway"
+  s.version = "0.0.1"
+  s.authors = ["Vincent Touchard"]
+  s.date = %q{2014-02-08}
+  s.summary = 'ZWave API for ZWay'
+  s.description = 'A Ruby API to use the Razberry ZWave ZWay interface'
+  s.email = 'vincentoo@yahoo.com'
+  s.homepage = 'https://github.com/rzwaveway'
+  s.files = `git ls-files`.split("\n")
+  s.has_rdoc = false
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: rzwaveway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vincent Touchard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby API to use the Razberry ZWave ZWay interface
+email: vincentoo@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- lib/rzwaveway.rb
+- lib/rzwaveway/command_classes.rb
+- lib/rzwaveway/events.rb
+- lib/rzwaveway/zwave_device.rb
+- lib/rzwaveway/zway.rb
+- rzwaveway.gemspec
+homepage: https://github.com/rzwaveway
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ZWave API for ZWay
+test_files: []