ansible4ozw 0.0.1

data/lib/ansible/knx/dpt/dpt13.rb

@@ -0,0 +1,100 @@
+=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
+                
+        #
+        # DPT13: 4-byte signed value
+        #
+        module DPT13
+            
+            class DPT13_Frame < DPTFrame
+                int32 :data,  { 
+                    :display_name => "32-bit signed value",
+                    :range => -2**31..2**31-1
+                }
+            end
+
+            # DPT13 base type info
+            Basetype = {
+                :bitlength => 32,
+                :valuetype => :basic,
+                :desc => "4-byte signed value"
+            }
+            
+            # DPT13 subtypes
+            Subtypes = {
+                # 13.001 counter pulses (signed)
+                "001" => {
+                    :name => "DPT_Value_4_Count", :desc => "counter pulses (signed)", 
+                    :unit => "pulses"
+                },
+                
+                # 13.010 active energy (Wh)
+                "010" => {
+                    :name => "DPT_ActiveEnergy", :desc => "active energy (Wh)", 
+                    :unit => "Wh"
+                },
+                
+                # 13.011 apparent energy (VAh)
+                "011" => {
+                    :name => "DPT_ApparantEnergy", :desc => "apparent energy (VAh)", 
+                    :unit => "VAh"
+                },
+                
+                # 13.012 reactive energy (VARh)
+                "012" => {
+                    :name => "DPT_ReactiveEnergy", :desc => "reactive energy (VARh)", 
+                    :unit => "VARh"
+                },
+                
+                # 13.013 active energy (KWh)
+                "013" => {
+                    :name => "DPT_ActiveEnergy_kWh", :desc => "active energy (kWh)", 
+                    :unit => "kWh"
+                },
+                
+                # 13.014 apparent energy (kVAh)
+                "014" => {
+                    :name => "DPT_ApparantEnergy_kVAh", :desc => "apparent energy (kVAh)", 
+                    :unit => "VAh"
+                },
+                
+                # 13.015 reactive energy (kVARh)
+                "015" => {
+                    :name => "DPT_ReactiveEnergy_kVARh", :desc => "reactive energy (kVARh)", 
+                    :unit => "kVARh"
+                },
+                
+                # 13.100 time lag(s)
+                "100" => {
+                    :name => "DPT_LongDeltaTimeSec", :desc => "time lag(s)", 
+                    :unit => "s"
+                },
+            }
+        end
+    end
+end

data/lib/ansible/knx/dpt/dpt14.rb

@@ -0,0 +1,87 @@
+=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
+                
+        #
+        # DPT14.*: 4-byte floating point value
+        #
+        module DPT14
+
+            # special Bindata::Primitive class required 
+            # for non-standard 32-bit floats used by DPT14
+            class DPT14_Float < BinData::Primitive
+                endian :big
+                #
+                bit1  :sign, :display_name => "Sign"
+                bit8  :exp,  :display_name => "Exponent"
+                bit23 :mant, :display_name => "Mantissa"
+                #
+                def get
+                    # puts "sign=#{sign} exp=#{exp} mant=#{mant}"
+                    mantissa = (self.sign==1) ? ~(self.mant^8388607) : self.mant
+                    return Math.ldexp(mantissa, self.exp)
+                end
+                #
+                #DPT9_Range = -671088.64..670760.96
+                #
+                def set(v)
+                    #raise "Value (#{v}) out of range" unless DPT9_Range === 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(-127).find{ | e |
+                        max_mantissa = Math.ldexp(100*mantissa, e).to_i
+                        max_mantissa.between?(-8388608, 8388607)
+                    } 
+                    self.sign = (mantissa < 0) ?  1 :  0 
+                    self.mant  = (mantissa < 0) ?  ~(max_mantissa^8388607) : max_mantissa 
+                    self.exp = exponent - minimum_exp  
+                end # set
+            end
+
+            # Bitstruct to parse a DPT9 frame. 
+            # Always 8-bit aligned.
+            class DPT14_Frame < BinData::Record
+                dpt14_float :data
+            end
+
+            # DPT14 base type info
+            Basetype = {
+                :bitlength => 32,
+                :valuetype => :basic,
+                :desc => "32-bit floating point value"
+            }
+            
+            # DPT14 subtypes info
+            Subtypes = {
+                # TODO: so fucking many of them!
+            }
+        end
+    end
+end

data/lib/ansible/knx/dpt/dpt15.rb

@@ -0,0 +1,72 @@
+=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
+    
+        #
+        # DPT15.*: Access data
+        #        
+        module DPT15
+        
+            # Bitstruct to parse a DPT4 frame. 
+            # Always 8-bit aligned.
+            class DPT15_Frame < DPTFrame
+                bit4 :d6, :display_name => "D6"
+                bit4 :d5, :display_name => "D5"
+                #
+                bit4 :d4, :display_name => "D4"
+                bit4 :d3, :display_name => "D3"
+                #
+                bit4 :d2, :display_name => "D2"
+                bit4 :d1, :display_name => "D1"
+                #
+                bit1  :e
+                bit1  :p
+                bit1  :d
+                bit1  :c
+                bit4  :idx
+            end
+            
+            # DPT15 base type info
+            Basetype = {
+                :bitlength => 32,
+                :valuetype => :basic,
+                :desc => "4-byte access control data"
+            }
+            
+            # DPT8 subtypes info
+            Subtypes = {
+                "000" => {
+                    :name => "DPT_Access_Data"
+                }
+            }
+            
+        end
+        
+    end
+    
+end
+

data/lib/ansible/knx/dpt/dpt16.rb

@@ -0,0 +1,67 @@
+=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
+
+        #
+        # DPT16: ASCII string
+        #
+        module DPT16
+        
+            # Bitstruct to parse a DPT16 frame. 
+            # Always 8-bit aligned.
+            class DPT16_Frame < DPTFrame
+                string :data, :length => 14
+            end
+            
+            # DPT16 basetype info
+            Basetype = {
+                :bitlength => 14*8,
+                :valuetype => :basic,
+                :desc => "14-character string"
+            }
+            
+            # DPT9 subtypes
+            Subtypes = {    
+                # 16.000 ASCII string
+                "000" => { :use => "G",
+                    :name => "DPT_String_ASCII", :desc => "ASCII string",
+                    :force_encoding => "US-ASCII"
+                },
+
+                # 16.001 ISO-8859-1 string
+                "001" => { :use => "G",
+                    :name => "DPT_String_8859_1", :desc => "ISO-8859-1 string",
+                    :force_encoding => "ISO-8859-1"
+                },
+            }
+            
+        end
+        
+    end
+
+end
+

data/lib/ansible/knx/dpt/dpt17.rb

@@ -0,0 +1,65 @@
+=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
+
+        #
+        # DPT17: Scene number
+        #
+        module DPT17
+        
+            # Bitstruct to parse a DPT17 frame. 
+            # Always 8-bit aligned.
+            class DPT17_Frame < DPTFrame
+                bit2 :pad
+                bit6 :data, { 
+                    :display_name => "Scene number"
+                }
+            end
+            
+            # DPT16 basetype info
+            Basetype = {
+                :bitlength => 8,
+                :valuetype => :basic,
+                :desc => "scene number"
+            }
+            
+            # DPT9 subtypes
+            Subtypes = {    
+                # 17.001 Scene number
+                "001" => { :use => "G",
+                    :name => "DPT_SceneNumber", :desc => "Scene Number",
+                },
+            }
+            
+        end
+        
+    end
+
+end
+

data/lib/ansible/knx/dpt/dpt18.rb

@@ -0,0 +1,66 @@
+=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
+
+        #
+        # DPT18: 8-bit Scene Control
+        #
+        module DPT18
+    
+            class DPT18_Frame < DPTFrame
+                bit1  :exec_learn, {
+                    :display_name => "Execute=0, Learn = 1"
+                }
+                bit1  :pad, {
+                    :display_name => "Reserved bit"
+                }
+                bit6  :data, {
+                    :display_name => "Scene number"
+                }
+            end
+            
+            # DPT18 basetype info
+            Basetype = {
+                :bitlength => 8,
+                :valuetype => :composite,
+                :desc => "8-bit Scene Activate/Learn + number"
+            }
+            
+            # DPT9 subtypes
+            Subtypes = {    
+                # 9.001 temperature (oC)
+                "001" => {
+                    :name => "DPT_SceneControl", :desc => "scene control"
+                },
+            }
+            
+        end 
+        
+    end
+    
+end
+