ansible4ozw 0.0.1

data/lib/ansible.rb

@@ -0,0 +1,47 @@
+=begin
+Project Ansible  - An extensible home automation scripting framework
+----------------------------------------------------
+Copyright (c) 2011 Elias Karakoulakis <elias.karakoulakis@gmail.com>
+
+SOFTWARE NOTICE AND LICENSE
+
+Project Ansible is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+Project Ansible is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Project Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+for more information on the LGPL, see:
+http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License
+=end
+
+$:.push(File.join(Dir.getwd, 'lib/ansible'))
+$:.push(File.join(Dir.getwd, 'lib/ansible/devices'))
+$:.push(File.join(Dir.getwd, 'lib/ansible/knx'))
+$:.push(File.join(Dir.getwd, 'lib/ansible/openzwave'))
+$:.push(File.join(Dir.getwd, 'lib/ansible/zwave'))
+
+require "rubygems"
+require "bundler/setup"
+require 'config'
+
+require 'transceiver'
+require 'zwave_transceiver'
+require 'zwave_command_classes'
+
+require 'knx_transceiver'
+require 'knx_tools'
+require 'knx_value'
+
+require 'ansible_device'
+
+include Ansible
+include Ansible::ZWave
+include Ansible::KNX

data/lib/ansible/ansible_callback.rb

@@ -0,0 +1,142 @@
+=begin
+Project Ansible  - An extensible home automation scripting framework
+----------------------------------------------------
+Copyright (c) 2011 Elias Karakoulakis <elias.karakoulakis@gmail.com>
+
+SOFTWARE NOTICE AND LICENSE
+
+Project Ansible is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+Project Ansible is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Project Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+for more information on the LGPL, see:
+http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License
+=end
+
+require 'weakref'
+
+module Ansible
+
+    #
+    # Callback module for project Ansible
+    #    
+    module AnsibleCallback
+    
+        
+        # callback declaration mechanism.
+        #
+        # ===Arguments:
+        # [event]   a Symbol for the event (eg :onChange) 
+        #           A special case is :default , this callback gets called at all events.
+        # [target]  a unique hashable target (so as to register a target-specific callback
+        #           for an event) - you can pass any value, if it can be hashed. 
+        #           TODO: use WeakRef,so that the target can be reclaimed by Ruby's GC 
+        #           when its fixed on Ruby1.9 (http://bugs.ruby-lang.org/issues/4168)
+        # [cb_body] the Proc to call when a callback is fired.
+        #
+        # the callback Proc block always gets these arguments supplied:
+        # [obj]   1st argument to callback proc is the AnsibleValue instance 
+        #         which generated the callback
+        # [cb]    2nd argument is the callback symbol (eg :onChange)
+        #         Very useful when declaring a default callback
+        # [*args] 3rd and later arguments: event-specific data
+        #
+        # examples:
+        #   obj.add_callback(:onChange) { |o| puts "Object #{o} has changed!" }
+        #   obj.add_callback(:onChange, 'SPECIAL') { |o| puts "Object #{o} has changed!" }
+        #   obj.add_callback(:default) { |o, cb, *args| puts "Object #{o}: callback #{cb}!" }
+        def add_callback(event, target=nil, &cb_body)
+            raise "add_callback: last argument must be a Proc" unless cb_body.is_a?Proc
+            init_callbacks(event)
+            puts "#{self}: Registering #{event} callback" + (target.nil? ? '' : " especially for target #{target}")
+            if target.nil? then
+                @callbacks[event].default = cb_body
+            else
+                @callbacks[event][target] = cb_body
+            end
+        end
+        
+        # remove a callback
+        #
+        # ===Arguments:
+        # [event]    a Symbol for the event (eg :onChange) 
+        #            A special case is :default , this callback gets called at all events.
+        # [target]   a unique hashable target - you can pass any value
+        #
+        # ===Examples:
+        #   obj.remove_callback(:onUpdate)
+        def remove_callback(event, target=nil)
+            init_callbacks(event)
+            @callbacks[event].delete(target)
+        end
+        
+        # callback firing processor.
+        #
+        # Checks if a proc is stored for a ginen event, then calls it
+        # with the object instance as its first argument,  the callback symbol 
+        # as its second arg, and all other *args appended to the call
+        #
+        # ===Arguments:
+        # [event]    a Symbol for the event (eg :onChange) 
+        # [target]  the unique id of target (so as to fire target-specific callbacks for a specific event)
+        #        
+        # ===Notes:
+        # 1) its prohibited to fire the DEFAULT callback programmatically (it will get fired 
+        # anyway at ANY event)
+        # 2) if a target_id is given, then try to fire target-specific callbacks. If none is found,
+        # fall-back to the generic callback for this event
+        #
+        # ===Example:
+        #   obj.fire_callback(:onChange, 'GROUPADDR', :arg1, :arg2, :arg3)
+        #
+        def fire_callback(event, target=nil, *args)
+            raise "cannot fire DEFAULT callback programmatically!" if event.to_s == "default"
+            #puts "fire_callback called by #{self}.#{event}, args: #{args.inspect}"
+            init_callbacks(event)
+            # array of callback Procs to get called
+            cb_procs = []
+            # first add callbacks for this specific event
+            if defined?(@callbacks) and @callbacks.is_a?Hash then
+                [@callbacks[event],  @callbacks[:default]].each { |hsh|
+                    if hsh.is_a?Hash then
+                        puts "#{self}.fire_callback, event #{event}: about to fire: #{hsh.inspect}"
+                        if target.nil? then 
+                            # add all targets to the list of procs to call
+                            # including the default 
+                            cb_procs << [hsh.values, hsh.default].flatten
+                        else
+                            # only add target-specific procs to the list
+                            cb_procs << hsh[target]
+                        end
+                    end                    
+                }
+            end
+            #puts cb_procs.inspect
+            # time to fire callbacks 
+            cb_procs.flatten.compact.each { |cb_proc|
+                raise "ooops, found a #{cb_proc.class} stored as a callback!" unless cb_proc.is_a?Proc                    
+                puts "firing #{event} callback, args: #{args.inspect}" 
+                cb_proc.call(self, event.to_s, *args)                    
+            }
+        end
+        
+        private
+        # initialize callback hash for a given event
+        def init_callbacks(event)
+            md = caller[1].match(/`(\w*)'/); clr = md and md[1] or caller[1]
+            raise "#{clr}: no event Symbol supplied!" unless event.is_a?Symbol
+            @callbacks = {} unless defined?(@callbacks) and @callbacks.is_a?Hash
+            @callbacks[event] = {} unless @callbacks[event].is_a?Hash            
+        end
+    end
+
+end #module

data/lib/ansible/ansible_device.rb

@@ -0,0 +1,68 @@
+=begin
+Project Ansible  - An extensible home automation scripting framework
+----------------------------------------------------
+Copyright (c) 2011 Elias Karakoulakis <elias.karakoulakis@gmail.com>
+
+SOFTWARE NOTICE AND LICENSE
+
+Project Ansible is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+Project Ansible is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Project Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+for more information on the LGPL, see:
+http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License
+=end
+
+module Ansible
+    
+    # root class describing an Ansible Device, i.e. a device controlled 
+    # at least by one automation protocol supported by Ansible
+    #
+    # ===Arguments: 
+    # [hashmap]  
+    #   hash consisting of Symbol => AnsibleValue pairs e.g. 
+    #   {
+    #    :onoff => KNXValue.new("1.001", "1/0/20")
+    #   } 
+    #
+    # ===Example:
+    #   obj.fire_callback(:onChange, 'GROUPADDR', :arg1, :arg2, :arg3)
+    #
+    class Device
+    
+        # initialize an Ansible Device
+        def initialize(hashmap)
+            # sanity check: check argument validity
+            args_valid = true
+            if hashmap.is_a?Hash then
+                hashmap.each { |k,v|
+                    args_valid = args_valid and (k.is_a?Symbol) and (v.is_a?AnsibleValue)
+                }
+            else
+                args_valid = false
+            end
+            raise "#{self.class}.new requires a hash map of Symbol => AnsibleValue!!!" unless args_valid
+            #
+            # store hashmap
+            @hashmap = hashmap
+            # link values
+            link()
+        end
+        
+    end
+        
+    
+    #
+    # load all known Ansible Device classes
+    Dir["devices/*.rb"].each { |f| load f }
+
+end

data/lib/ansible/ansible_value.rb

@@ -0,0 +1,179 @@
+=begin
+Project Ansible  - An extensible home automation scripting framework
+----------------------------------------------------
+Copyright (c) 2011 Elias Karakoulakis <elias.karakoulakis@gmail.com>
+
+SOFTWARE NOTICE AND LICENSE
+
+Project Ansible is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+Project Ansible is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Project Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+for more information on the LGPL, see:
+http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License
+=end
+
+require 'ansible_callback'
+
+module Ansible
+    
+    # A base module for Ansible Values, which is the most basic form to declare a
+    # protocol-agnostic control endpoint, be it an input (a button or event), or
+    # an output (a device such as a relay or dimmer)
+    module AnsibleValue
+    
+    include AnsibleCallback
+    
+    attr_reader :previous_value, :current_value
+    attr_reader :last_update
+    attr_reader :flags
+    
+    # return true if a value's instance variable (whose symbol is iv_symbol) matches a filter value (as a regexp)
+    # e.g. value.matches?(:name => /elias/, :telephone => /210/)
+    def matches?(hash)
+        raise "#{self.class}: AnsibleValue.match? single argument must be a hash.." unless hash.is_a?Hash
+        result = true 
+        hash.each { |iv_symbol, filter|
+            raise "#{self.class}: AnsibleValue.match?(hash)'s keys must be Symbols.." unless iv_symbol.is_a?Symbol
+            if respond_to?(iv_symbol) and (val = instance_eval(iv_symbol.to_s)) then
+                #puts "match.val(#{iv_symbol}) == #{val.inspect}" if $DEBUG
+                result = result & case filter
+                # if the filter is a regular expression, use it to match the instance value
+                when Regexp then filter.match(val.to_s)
+                # if the filter is an array, use set intersection
+                when Array then (filter & val).length > 0
+                else filter == val
+                end
+            else
+                return false
+            end
+        }
+        return(result)
+    end
+    
+    # singleton array of all known Values
+    @@AllValues = []
+    @@AllValuesMutex = Mutex.new
+
+    # lookup an AnsibleValue by a filter hash
+    # returns an array of matching values
+    def AnsibleValue.[](filter_hash)
+        result_set = []
+        @@AllValuesMutex.synchronize {
+            puts "AnsibleValue[] called, filter_hash=#{filter_hash}" if $DEBUG
+            @@AllValues.each { |v|
+                raise "ooops! @@AllValues contains a non-AnsibleValue!" unless v.is_a?(AnsibleValue)
+                if v.matches?(filter_hash) then
+                    puts "Found a matching value! #{v}" if $DEBUG
+                    result_set << v
+                end
+            }
+            puts "AnsibleValue[] returns=#{result_set}" if $DEBUG
+        }
+        return result_set
+    end
+    
+    #
+    # add an AnsibleValue to the singleton @@AllValues
+    # returns the newvalue, or the existing value (using equality test ==), if found
+    def AnsibleValue.insert(newvalue)
+        result = nil
+        @@AllValuesMutex.synchronize {
+            # check if newvalue is already stored in @@AllValues, find it and return it
+            if  (result = @@AllValues.find{|val| newvalue == val}).nil? then
+                puts "Adding a new value to @@AllValues (#{newvalue})" if $DEBUG
+                @@AllValues << (result = newvalue)
+                # get initial state
+                newvalue.get 
+            end
+        }
+        return(result)
+    end
+    
+    #
+    # get a value's current state
+    # returns: the value, if found in eibd's cache or nil otherwise
+    def get
+        return if write_only?
+        #
+        puts "get() called for #{self.inspect} by:\n\t" + caller[1] if $DEBUG
+        #
+        fire_callback(:onBeforeGet)
+        if read_value() then 
+            fire_callback(:onAfterGetSuccess)
+        else
+            fire_callback(:onAfterGetFail)
+            #raise "get value failed for #{self}"
+        end
+    end
+
+    #
+    # set a value 
+    # new_val: the new value, must be ruby-castable to OpenZWave's type system
+    # returns: true on success, raises exception on error
+    #WARNING: a true return value doesn't mean the command actually succeeded, 
+    # it only means that it was queued for delivery to the target node
+    def set(new_val)
+        return if read_only?
+        #
+        puts "set() called for #{self.inspect} by:\n\t" + caller[1] if $DEBUG
+        #
+        fire_callback(:onBeforeSet)
+        if write_value(new_val) then 
+            fire_callback(:onSetSuccess)
+        else
+            fire_callback(:onSetFail)
+            raise "set value #{self}: call to #{write_operation} failed!!"
+        end
+    end
+    
+    #
+    # update internal instance variable representing the current state of the value
+    # called by read_value() and write_value()
+    def update(newval)
+        validate_ranges() if respond_to?(:validate_ranges)
+        unless newval == @current_value then
+            @last_update = Time.now
+            puts "+++ updating value #{self}, with #{newval.class}:#{newval.inspect}"
+            
+            # previous value was different, update it and fire onUpdate handler
+            @previous_value = @current_value if defined?(@current_value)
+            @current_value = newval
+            # trigger onUpdate callback, if any
+            fire_callback(:onUpdate, nil, newval)
+        end
+        return(@current_value)
+    end
+
+    # GENERICS
+    # --------
+                
+    # write value to the protocol
+    def write_value()
+        raise "#{self.class}.write_value() must be overriden!!!"
+    end
+            
+    # value convertion from protocol-specific to its canonical form
+    # must be overriden by protocol value subclass
+    def as_canonical_value()
+        raise "#{self.class}.as_canonical_value() must be overriden!!!"
+    end
+    
+    # convert a canonical value back to its protocol-specific form
+    # must be overriden by protocol value subclass
+    def to_protocol_value(v)
+        raise "#{self.class}.to_protocol_value() must be overriden!!!"
+    end
+    
+end
+
+end #module

data/lib/ansible/config.rb

@@ -0,0 +1,92 @@
+=begin
+Project Ansible  - An extensible home automation scripting framework
+----------------------------------------------------
+Copyright (c) 2011 Elias Karakoulakis <elias.karakoulakis@gmail.com>
+
+SOFTWARE NOTICE AND LICENSE
+
+Project Ansible is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License,
+or (at your option) any later version.
+
+Project Ansible is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with Project Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+for more information on the LGPL, see:
+http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License
+=end
+
+#
+# global configuration options file
+#
+
+module Ansible
+        
+    # STOMP Server URL
+    STOMP_URL = 'stomp://192.168.10.14'
+    
+    #
+    # KNX subsystem configuration
+    #
+    module KNX
+        
+        # KNX eibd server URL (not the actual KNX interface URL!)
+        KNX_URL = "local:/tmp/eib"
+        #KNX_URL = "ip:localhost"
+        
+        ###################
+        # KNX MONITOR TOPIC: 
+        #   passes all KNX activity to STOMP
+        #   KNX frame headers as defined in knx_protocol.rb
+        KNX_MONITOR_TOPIC = "/queue/knx/monitor"
+    
+        #################
+        # KNX COMMAND_TOPIC
+        #   header "dest_addr" => KNX destination address (group/phys) in 16-bit unsigned integer format i.e. "1024" meaning "1/0/0" in 3-level fmt
+        #   body => the raw APDU for transmission (command flags+data) in Marshal.dump(CGI.escape()) format
+        KNX_COMMAND_TOPIC = "/queue/knx/command"
+    
+    end
+    
+    #
+    # ZWave sybsustem configuration
+    #    
+    module ZWave
+        
+        ###################
+        #ZWAVE MONITOR TOPIC: 
+        #   passes all ZWave activity to STOMP
+        #   ZWave frame headers as defined in zwave-protocol.rb
+        ZWAVE_MONITOR_TOPIC = "/queue/zwave/monitor"
+    
+        #################
+        # ZWAVE_COMMAND_TOPIC
+        #   header =>
+        #   body => 
+        #ZWAVE_COMMAND_TOPIC = "/queue/knx/command"
+
+        #################        
+        # OpenZWave Thrift Server URL
+        THRIFT_URL = 'thrift://192.168.10.14'
+        #THRIFT_URL = 'thrift://192.168.0.100'
+
+        ThriftPort = 9090
+    
+    end
+    
+end
+
+#
+
+module OpenZWave
+    
+    # path to OpenZWave source
+    OZW_SRC = "lib/ansible/openzwave/src"
+
+end