ansible4ozw 0.0.1

data/lib/ansible/knx/dpt/tests/test_dpt10.rb

@@ -0,0 +1,45 @@
+require 'bindata'
+
+class DPT10 < BinData::Record
+    bit3 :dayofweek, {
+        :display_name => "Day of week", 
+        :range => 0..7, :data_desc => {
+            0 => "(no day set)",
+            1 => "Monday",
+            2 => "Tuesday",
+            3 => "Wednesday",
+            4 => "Thursday",
+            5 => "Friday",
+            6 => "Saturday",
+            7 => "Sunday"
+        }    
+    }
+    bit5 :hour,      {
+        :display_name =>  "Hour", :range => 0..23
+    }
+    #
+    bit2 :unused1
+    bit6 :minutes,   {
+        :display_name =>  "Minutes", :range => 0..59
+    }
+    #
+    bit2 :unused2
+    bit6 :seconds,  {
+        :display_name =>  "Seconds", :range => 0..59
+    }
+end
+[
+    [0x8e, 0x21, 0x00]
+].each {|arr|
+    f = DPT10.read(arr.pack('C*'))
+    puts arr.inspect + " ==> " + f.inspect
+#    f.data = -10
+ #   puts "after set() ==> " + f.inspect + " serialized as " + f.to_binary_s.unpack("H*").join('0x')  
+ #f.dayofweek.get_parameter(:range)
+}
+=begin
+[
+    # DPT11.001 date
+    [0x17, 0x01, 0x0C] # 23/Jan/2012
+].each {|arr|
+=end

data/lib/ansible/knx/dpt/tests/test_dpt9.rb

@@ -0,0 +1,60 @@
+require 'bindata'
+
+class DPT9_Float < BinData::Primitive
+    endian :big
+    #
+    bit1 :sign,  :display_name =>  "Sign"
+    bit4 :exp,   :display_name => "Exponent"
+    bit11 :mant,   :display_name => "Mantissa"
+    #
+    def get
+        puts "get, sign=#{sign} exp=#{exp} mant=#{mant}"
+        mantissa = (self.sign==1) ? ~(self.mant^2047) : self.mant
+        return Math.ldexp((0.01*mantissa), self.exp)
+    end
+    #
+    def set(v)
+        mantissa, exponent = Math.frexp(v)
+        puts "#{self}.set(#{v}) with initial mantissa=#{mantissa}, exponent=#{exponent}"
+        # find the minimum exponent that will upsize the normalized mantissa (0,5 to 1 range)
+        # in order to fit in 11 bits (-2048..2047)
+        max_mantissa = 0
+        minimum_exp = exponent.downto(-15).find{ | e |
+            max_mantissa = Math.ldexp(100*mantissa, e).to_i
+            max_mantissa.between?(-2048, 2047)
+        } 
+        self.sign = (mantissa < 0) ?  1 :  0 
+        self.mant  = (mantissa < 0) ?  ~(max_mantissa^2047) : max_mantissa 
+        self.exp = exponent - minimum_exp  
+        puts "... set(#{v}) finished: sign=#{sign}, mantissa=#{mant}, exponent=#{exp}"
+    end # set
+end
+
+class DPT9 < BinData::Record
+    dpt9_float :data
+end
+
+{
+#forward test (raw data to float)
+    DPT9.read([0x00, 0x02].pack('C*')).data => 0.02,
+    DPT9.read([0x87, 0xfe].pack('C*')).data => -0.02,
+    DPT9.read([0x5c, 0xc4].pack('C*')).data => 24980..25000,
+    DPT9.read([0xdb, 0x3c].pack('C*')).data => -25000..-24980,
+    DPT9.read([0x7f, 0xfe].pack('C*')).data => 670400..670760,
+    DPT9.read([0xf8, 0x02].pack('C*')).data => -670760..-670400,
+#backward test (float to raw data)
+    "----" => "----",
+    DPT9_Float.new(0.02).to_binary_s.unpack("C*") =>  [0x00, 0x02],
+    DPT9_Float.new(-0.02).to_binary_s.unpack("C*") =>  [0x87, 0xfe],
+    DPT9_Float.new(25000).to_binary_s.unpack("C*") =>  [0x5c, 0xc4],
+    DPT9_Float.new(-25000).to_binary_s.unpack("C*") =>  [0xdb, 0x3c],
+    DPT9_Float.new(670760).to_binary_s.unpack("C*") =>  [0x7f, 0xfe],
+    DPT9_Float.new(-670760).to_binary_s.unpack("C*") =>  [0xf8, 0x02],
+}.each {|arr, test|
+    #f = DPT9.read(arr.pack('C*'))
+    puts arr.inspect + " ==> " + test.inspect + " \t TEST: " + (test === arr ? 'ok':"\t---FAIL---")
+#    f.data = -30
+#    puts "after set() ==> " + f.inspect + " serialized as " + f.to_binary_s.unpack('B*').join(' ') + " (0x" + f.to_binary_s.unpack("H*").join('') + ")"
+}
+
+

data/lib/ansible/knx/hexdump.rb

@@ -0,0 +1,113 @@
+# ==============================================================================
+# EXTENDING CLASS STRING
+# ==============================================================================
+#
+# (C) Copyright 2004 by Tilo Sloboda <tools@unixgods.org>
+#
+# License:
+#         Freely available under the terms of the OpenSource "Artistic License"
+#         in combination with the Addendum A (below)
+#
+#         In case you did not get a copy of the license along with the software,
+#         it is also available at:   http://www.unixgods.org/~tilo/artistic-license.html
+#
+# Addendum A:
+#         THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU!
+#         SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+#         REPAIR OR CORRECTION.
+#
+#         IN NO EVENT WILL THE COPYRIGHT HOLDERS  BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
+#         SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY
+#         TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
+#         INACCURATE OR USELESS OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+#         TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF THE COPYRIGHT HOLDERS OR OTHER PARTY HAS BEEN
+#         ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+
+class String
+  #
+  # prints out a good'ol hexdump of the data contained in the string
+  #
+  # parameters:     sparse:   true / false     do we want to print multiple lines with zero values?
+
+  def hexdump(sparse = false)
+     selfsize = self.size
+     first = true
+
+     print "\n index       0 1 2 3  4 5 6 7  8 9 A B  C D E F\n\n"
+
+     lines,rest = selfsize.divmod(16)
+     address = 0; i = 0    # we count them independently for future extension.
+
+     while lines > 0
+        str = self[i..i+15]
+        
+        # we don't print lines with all zeroes, unless it's the last line
+
+        if str == "\0"*16     # if the 16 bytes are all zero
+        
+          if (!sparse) || (sparse &&  lines == 1 && rest == 0)
+             str.tr!("\000-\037\177-\377",'.')
+             printf( "%08x    %8s %8s %8s %8s    %s\n", 
+                address, self[i..i+3].unpack('H8'), self[i+4..i+7].unpack('H8'),
+                self[i+8..i+11].unpack('H8'), self[i+12..i+15].unpack('H8'), str)
+          else
+                print "  ....      00 .. 00 00 .. 00 00 .. 00 00 .. 00    ................\n" if first
+                first = false
+	  end
+
+        else  # print string which is not all zeros
+
+          str.tr!("\000-\037\177-\377",'.')
+          printf( "%08x    %8s %8s %8s %8s    %s\n", 
+                address, self[i..i+3].unpack('H8'), self[i+4..i+7].unpack('H8'),
+                self[i+8..i+11].unpack('H8'), self[i+12..i+15].unpack('H8'), str)
+          first = true
+	end
+        i += 16; address += 16; lines -= 1
+     end
+     
+     # now do the remaining bytes, which don't fit a full line..
+     # yikes - this is truly ugly!  REWRITE THIS!!
+
+     if rest > 0
+        chunks2,rest2 = rest.divmod(4)     
+        j = i; k = 0
+        if (i < selfsize)
+           printf( "%08x    ", address)
+           while (i < selfsize)
+                printf "%02x", self[i]
+                i += 1; k += 1
+                print  " " if ((i % 4) == 0)
+           end
+           for i in (k..15)
+                  print "  "
+           end
+           str = self[j..selfsize]
+           str.tr!("\000-\037\177-\377",'.')
+           print " " * (4 - chunks2+1)
+           printf("  %s\n", str)
+        end
+     end
+  end
+
+end
+
+
+
+__END__
+
+require 'hexdump'
+
+s =  "some random long string"
+
+t =  s << "\0"*40  << s << "\0"*32 << s << "bla bla bla!"
+t.hexdump(true)
+t.hexdump(false)
+
+4.times {t.chop!}
+
+t.hexdump(true)
+t.hexdump(false)
+
+

data/lib/ansible/knx/knx_dpt.rb

@@ -0,0 +1,58 @@
+=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 'bindata'
+
+module Ansible
+    
+    module KNX
+        
+        # a base class for DPT data structures.
+        # derives from BinData::Record,
+        # implements some common stuff 
+        class DPTFrame < BinData::Record
+            # endianness in KNX is big
+            endian :big
+        
+            # make sure all frame fields are valid (within min,max range) 
+            def validate_ranges()
+                # range checking is global: applies to all subtypes
+                field_names.each { |fieldname|
+                    # skip padding fields
+                    next if /pad/.match(fieldname)
+                    field = self.send(fieldname)
+                    if range = field.get_parameter(:range) then
+                        raise "#{self}: field #{fieldname} value (#{field.value}) out of range #{range}" unless range === field.value
+                    end
+                }
+            end    
+        end
+
+        #
+        # load all known DPT modules
+        Dir["knx/dpt/*.rb"].each { |f| load f }
+
+    end
+    
+end

data/lib/ansible/knx/knx_dpt_scalar.rb

@@ -0,0 +1,62 @@
+=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
+    
+    module KNX
+        
+        # KNX specification declares some special DPTs (5.001 and 5.003) that need
+        # scalar adjustment functions to get the true value contained in a DPT frame.
+        module ScalarValue
+            
+            # convert value to its scalar representation
+            # e.g. in DPT5.001, 0x7F => 50(%), 0xFF => 100(%)
+            def to_scalar(val, data_range, scalar_range)
+                if data_range.is_a?(Range) and scalar_range.is_a?(Range) then   
+                    a = (scalar_range.max - scalar_range.min).to_f / (data_range.max - data_range.min)
+                    b = (scalar_range.min - data_range.min)
+                    return (a*val + b).round
+                else
+                    return val
+                end
+            end
+            
+            # convert value from its scalar representation
+            # e.g. in DPT5.001, 50(%) => 0x7F , 100(%) => 0xFF 
+            def from_scalar(val, data_range, scalar_range)
+                if data_range.is_a?(Range) and scalar_range.is_a?(Range) then
+                    a = (scalar_range.max - scalar_range.min).to_f / (data_range.max - data_range.min)
+                    b = (scalar_range.min - data_range.min)
+                    #puts "a=#{a} b=#{b}"
+                    return ((val - b) / a).round
+                else
+                    return val
+                end
+            end 
+            
+        end
+        
+    end
+    
+end

data/lib/ansible/knx/knx_eistypes.rb

@@ -0,0 +1,76 @@
+=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
+
+    module KNX
+    
+        # the skeleton class for the datatypes in use by the KNX standard
+        class EISType
+        
+            # singleton hash holding all known EISType instances
+            # key => primary_type (integer 1 to 255)
+            # value => hash of secondary types (secondary_type => instance)
+            #       -- NOTE: the contained secondary types hash can be set
+            #       to report a default instance that holds a generic EISType.
+            #       Thus we define datatypes with great granularity.
+            @@alltypes = {}
+            
+            # method for getting all known EIS types as a flat array
+            def EISType.all
+                return @@alltypes.values.collect{ |st| st.values + st.default}.flatten.compact
+            end
+            
+            # initializes a new datatype
+            def initialize(primary_type, secondary_type)
+                puts "Initializing new EISType pri=#{primary_type} sec=#{secondary_type}"
+                @primary_type , @secondary_type = primary_type , secondary_type  
+                @@alltypes[primary_type] = {} unless @@alltypes[primary_type].is_a? Hash
+                # store ourselves in the big hash of types
+                if secondary_type.nil? then
+                    puts "==> Redeclaring default EISType for primary=#{primary_type}" if @@alltypes[primary_type] 
+                    @@alltypes[primary_type].default = self
+                else
+                    @@alltypes[primary_type][secondary_type] = self
+                end
+            end
+            
+            # return a human-readable description for this EISType
+            def to_s
+                return 'EIS' + @primary_type.to_s + (@secondary_type.nil? ? "" : ".#{@secondary_type}") 
+            end
+            
+            # takes a KNX value and abstracts its data
+            # usage: eis1.abstractor {|value| value.to_s }
+            
+            def abstractor=(&block)
+                # in its most basic form, abstract_value just returns the value
+                return(value.get()
+            end
+            
+        end # class
+        
+    end #module KNX
+    
+end #module Ansible

data/lib/ansible/knx/knx_protocol.rb

@@ -0,0 +1,99 @@
+=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 'bindata'
+
+module Ansible
+    
+    module KNX
+    
+        # the basic Control field structure for KNX/TP (Twisted Pair) telegrams
+        # contains only low-level transmission medium data
+        class TP_ControlField < BinData::Record
+            bit2    :lpdu_code, { :display_name => "LPDU (2bit) 2=L_DATA.req 3=L_Poll_data.req" }
+            bit1    :rep_flag,  { :display_name => "Repeat flag"}
+            bit1    :ack_not,   { :display_name => "0 = Acknowledge frame, 1 = standard frame"}
+            bit2    :prio_class,{ :display_name => "Priority class (0=highest .. 3=lowest)"}
+            bit2    :unused1,   { :display_name => "two unused bits (should be 00)"}
+        end
+        
+        # same as TP_ControlField, plus network- and application-layer data 
+        # also known as APDU (Application Datagram Unit)
+        class L_DATA_Frame < BinData::Record
+            endian :big
+            # octet 0: TP1 control field
+            bit2    :lpdu_code, { :display_name => "LPDU (2bit) 2=L_DATA.req 3=L_Poll_data.req"}
+            bit1    :rep_flag,  { :display_name => "Repeat flag"}
+            bit1    :ack_not,   { :display_name => "0 = Acknowledge frame, 1 = standard frame"}
+            bit2    :prio_class,{ :display_name => "Priority class (0=highest .. 3=lowest)"}
+            bit2    :unused1,   { :display_name => "two unused bits (should be 00)"}
+            # octet 1+2: source
+            uint16  :src_addr,  { :display_name => "Source Address"}
+            # octet 3+4: destination
+            uint16  :dst_addr,  { :display_name => "Destination Address"}
+            # octet 5: control fields
+            bit1    :daf,       { :display_name => "Dest.Address flag 0=physical 1=group"}
+            bit3    :ctrlfield, { :display_name => "Network control field"}
+            bit4    :datalength,{ :display_name => "Data length (bytes after octet #6)"}
+            # octet 6 + octet 7: TPCI+APCI+6-bit data
+            bit2    :tpci,      { :display_name => "TPCI control bits 8+7"}
+            bit4    :seq,       { :display_name => "Packet sequence"}
+            bit4    :apci,      { :display_name => "APCI control bits"}
+            bit6    :apci_data, { :display_name => "APCI/Data combined"}
+            # octet 8 .. end
+            string  :data, {
+                :read_length => lambda { datalength - 1 },
+                :display_nane => "rest of frame"
+            }
+        end
+    
+        #########################################################
+        
+        # APCI codes array
+        APCICODES = "A_GroupValue_Read A_GroupValue_Response A_GroupValue_Write \
+                A_PhysicalAddress_Write A_PhysicalAddress_Read A_PhysicalAddress_Response \
+                A_ADC_Read A_ADC_Response A_Memory_Read A_Memory_Response A_Memory_Write \
+                A_UserMemory A_DeviceDescriptor_Read A_DeviceDescriptor_Response A_Restart \
+                A_OTHER".split()
+        
+        # TPDU codes array
+        TPDUCODES = "T_DATA_XXX_REQ T_DATA_CONNECTED_REQ T_DISCONNECT_REQ T_ACK".split()
+        
+        # Priority classes
+        PRIOCLASSES = "system alarm high low".split()
+    
+        #########################################################
+        
+    end #module KNX
+    
+end #module
+
+#~ data = [188, 17, 200, 18, 1, 242, 0, 128, 80, 171] .pack("c*")
+#~ knxpacket = KNX_L_DATA_Frame.new(data)
+#~ knxpacket.fields.each { |a|
+    #~ puts "#{a.name} == #{a.inspect_in_object(knxpacket, :default)}"
+#~ }
+#puts knxpacket.inspect_detailed
+#~ require 'knx_tools'
+#puts addr2str(knxpacket.src_addr)