ansible4ozw 0.0.1

data/lib/ansible/knx/dpt/dpt19.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
+    
+        #
+        # DPT19: 8-byte Date and Time
+        #
+        module DPT19
+    
+            class DPT19_Frame < DPTFrame
+                # byte 8 (MSB)
+                uint8 :year, { 
+                    :display_name => "Year" 
+                }
+                # byte 7
+                bit4    :pad7
+                bit4    :month, {
+                    :display_name => "Month"
+                }
+                # byte 6
+                bit3    :pad6
+                bit5    :dayofmonth, {
+                    :display_name => "Day of month"
+                }
+                # byte 5
+                bit3    :dayofweek, {
+                    :display_name => "Day of week"
+                }
+                bit5    :hourofday, {
+                :display_name => "Hour of day"
+                }
+                # byte 4
+                bit2    :pad4
+                bit6    :minutes, {
+                    :display_name => "Minutes"
+                }
+                # byte 3
+                bit2    :pad3
+                bit6    :seconds, {
+                    :display_name => "Seconds"
+                }
+                # byte 2
+                bit1    :flag_F   #
+                bit1    :flag_WD  #
+                bit1    :flag_NWD # no week day
+                bit1    :flag_NY  # no year
+                bit1    :flag_ND  # no day
+                bit1    :flag_NDOW # no day of week
+                bit1    :flag_NT   # no time
+                bit1    :flag_SUTI # summertime
+                # byte 1
+                bit1    :flag_CLQ #clock accuracy
+                bit7    :pad1
+            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
+

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

@@ -0,0 +1,156 @@
+=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 'knx/dpt/canonical_1bit'
+
+module Ansible
+    
+    module KNX
+
+        #
+        # DPT2: 2-bit control value
+        #
+        module DPT2
+            
+            # DPT2 frame description. 
+            # Always 8-bit aligned.
+            class DPT2_Frame < DPTFrame
+                bit2    :apci_pad, {
+                    :display_name => "APCI info (not useful)"
+                }
+                bit4    :pad1 
+                bit1    :priority, {
+                    :display_name => "0=No Control 1=Priority"
+                }
+                bit1    :data, :display_name => "Value"
+            end
+            
+            include Canonical_1bit
+                        
+            # DPT basetype info hash
+            Basetype = {
+                :bitlength => 2,
+                :valuetype => :composite,
+                :desc => "1-bit value with priority"
+            }
+            
+            # DPT subtypes info hash
+            Subtypes = {
+                # 2.001 switch control
+                "001" => { :use => "G",
+                    :name => "DPT_Switch_Control", 
+                    :desc => "switch with priority", 
+                    :enc => { 0 => "Off", 1 => "On" }
+                },
+                # 2.002 boolean control
+                "002" => { :use => "G",
+                    :name => "DPT_Bool_Control", 
+                    :desc => "boolean with priority", 
+                    :enc => { 0 => "false", 1 => "true" }
+                },
+                # 2.003 enable control
+                "003" => {  :use => "FB",
+                    :name => "DPT_Emable_Control", 
+                    :desc => "enable with priority", 
+                    :enc => { 0 => "Disabled", 1 => "Enabled" }
+                },
+
+                # 2.004 ramp control
+                "004" => { :use => "FB",
+                    :name => "DPT_Ramp_Control", 
+                    :desc => "ramp with priority", 
+                    :enc => { 0 => "No ramp", 1 => "Ramp" }
+                },
+
+                # 2.005 alarm control
+                "005" => { :use => "FB",
+                    :name => "DPT_Alarm_Control", 
+                    :desc => "alarm with priority", 
+                    :enc => { 0 => "No alarm", 1 => "Alarm" }
+                },
+
+                # 2.006 binary value control
+                "006" => { :use => "FB",
+                    :name => "DPT_BinaryValue_Control", 
+                    :desc => "binary value with priority", 
+                    :enc => { 0 => "Off", 1 => "On" }
+                },
+
+                # 2.007 step control
+                "007" => { :use => "FB",
+                    :name => "DPT_Step_Control", 
+                    :desc => "step with priority", 
+                    :enc => { 0 => "Off", 1 => "On" }
+                },
+
+                # 2.008 Direction1 control
+                "008" => { :use => "FB",
+                    :name => "DPT_Direction1_Control", 
+                    :desc => "direction 1 with priority", 
+                    :enc => { 0 => "Off", 1 => "On" }
+                },
+               
+                # 2.009 Direction2 control
+                "009" => { :use => "FB",
+                    :name => "DPT_Direction2_Control", 
+                    :desc => "direction 2 with priority", 
+                    :enc => { 0 => "Off", 1 => "On" }
+                },
+                
+                # 2.010 start control
+                "001" => { :use => "FB",
+                    :name => "DPT_Start_Control", 
+                    :desc => "start with priority", 
+                    :enc => { 0..1 => "No control", 2 => "Off", 3 => "On" }
+                },
+
+                # 2.011 state control
+                "001" => { :use => "FB",
+                    :name => "DPT_Switch_Control", :desc => "switch", 
+                    :enc => { 0..1 => "No control", 2 => "Off", 3 => "On" }
+                },
+
+                # 2.012 invert control
+                "001" => { :use => "FB",
+                    :name => "DPT_Switch_Control", :desc => "switch", 
+                    :enc => { 0..1 => "No control", 2 => "Off", 3 => "On" }
+                }
+            }
+             
+        end #class
+        
+    end
+    
+end
+
+=begin
+puts KNX_DPT2.bit_length
+puts KNX_DPT2.new([0x00].pack('c')).inspect #
+puts KNX_DPT2.new([0x01].pack('c')).inspect #
+puts KNX_DPT2.new([0x02].pack('c')).inspect #
+puts KNX_DPT2.new([0x03].pack('c')).inspect #
+
+puts [0x02].pack('c').inspect
+=begin
+=end

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

@@ -0,0 +1,104 @@
+=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
+
+        #
+        # DPT3.*: 4-bit dimming/blinds control 
+        #       
+        module DPT3
+            
+            # Bitstruct to parse a DPT3 frame. 
+            # Always 8-bit aligned.
+            class DPT3_Frame < DPTFrame
+                bit2    :apci_pad, :display_name => "APCI data"
+                bit2    :pad1
+                bit1    :decr_incr, :display_name => "Decrease(0) / Increase(1)"
+                bit3    :data,  {
+                    :display_name => "0=break, 1-7 = amount of intervals between 1..100%",
+                    :enc => {
+                        0 => "break",
+                        1 => "ival=50%",
+                        2 => "ival=25%",
+                        3 => "ival=12,5%",
+                        4 => "ival=6,25%",
+                        5 => "ival=3,125%",
+                        6 => "ival=1,5625%",
+                        7 => "ival=0.78125%"
+                    }
+                }
+            end
+                       
+            Basetype = {
+                :bitlength => 4,
+                :valuetype => :composite,
+                :desc => "4-bit relative dimming control"
+            }
+            
+            Subtypes = {
+                # 3.007 dimming control
+                "3.007" => {
+                    :name => "DPT_Control_Dimming",
+                    :desc => "dimming control"
+                },
+                
+                # 3.008 blind control
+                "3.008" => {
+                    :name => "DPT_Control_Blinds",
+                    :desc => "blinds control"
+                }
+            }
+            
+        end
+
+    end
+
+end
+
+=begin
+        2.6.3.5 Behavior
+Status
+off     dimming actuator switched off
+on      dimming actuator switched on, constant brightness, at least
+        minimal brightness dimming
+dimming actuator switched on, moving from actual value in direction of
+        set value
+Events
+    position = 0        off command
+    position = 1        on command
+    control = up dX     command, dX more bright dimming
+    control = down dX   command, dX less bright dimming
+    control = stop      stop command
+    value = 0           dimming value = off
+    value = x%          dimming value = x% (not zero)
+    value_reached       actual value reached set value
+
+The step size dX for up and down dimming may be 1/1, 1/2, 1/4, 1/8, 1/16, 1/32 and 1/64 of
+the full dimming range (0 - FFh).
+
+3.007 dimming control
+3.008 blind control
+=end

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

@@ -0,0 +1,75 @@
+=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
+
+        #
+        # DPT4: 8-bit character
+        #
+        module DPT4
+            
+            # Bitstruct to parse a DPT4 frame. 
+            # Always 8-bit aligned.
+            class DPT4_Frame < DPTFrame
+                uint8 :data, :display_name => "Character"
+            end
+
+            Basetype =  {
+                :bitlength => 8,
+                :valuetype => :basic,
+                :desc => "8-bit character"
+            }
+                        
+            Subtypes = {
+                # 4.001 character (ASCII)
+                "001" => {
+                    :name => "DPT_Char_ASCII",
+                    :desc => "ASCII character (0-127)",
+                    :range => 0..127,
+                    :use => "G",
+                },
+                # 4.002 character (ISO-8859-1)
+                "002" => {
+                    :name => "DPT_Char_8859_1",
+                    :desc => "ISO-8859-1 character (0..255)",
+                    :use => "G",
+                }
+            }
+            
+        end
+        
+    end
+
+end
+=begin
+puts KNX_DPT2.bit_length
+puts KNX_DPT2.new([0x00].pack('c')).inspect #
+puts KNX_DPT2.new([0x01].pack('c')).inspect #
+puts KNX_DPT2.new([0x02].pack('c')).inspect #
+puts KNX_DPT2.new([0x03].pack('c')).inspect #
+
+puts [0x02].pack('c').inspect
+=end

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

@@ -0,0 +1,124 @@
+# encoding: ISO-8859-1
+
+=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 'knx_dpt_scalar'
+
+module Ansible
+    
+    module KNX
+    
+        #
+        # DPT5: 8-bit unsigned value 
+        #
+        module DPT5
+            
+            # DPT5 is the only (AFAIK) DPT with scalar datatypes (5.001 and 5.003)
+            include ScalarValue
+            
+            # Bitstruct to parse a DPT5 frame. 
+            # Always 8-bit aligned.
+            class DPT5_Frame < DPTFrame
+                uint8  :data,  {
+                    :display_name => "8-bit unsigned value",
+                }
+            end
+            
+            # DPT base type
+            Basetype = {
+                :bitlength => 8,
+                :range => 0..255,
+                :valuetype => :basic,
+                :desc => "8-bit unsigned value"
+            }
+            
+            # DPT subtypes
+            Subtypes = {
+                # 5.001 percentage (0=0..ff=100%)
+                "001" => {
+                    :name => "DPT_Scaling", :desc => "percent", 
+                    :unit => "%", :scalar_range => 0..100
+                },
+                
+                # 5.003 angle (degrees 0=0, ff=360)
+                "003" => {
+                    :name => "DPT_Angle", :desc => "angle degrees", 
+                    :unit => "°", :scalar_range => 0..360
+                },
+                
+                # 5.004 percentage (0..255%)
+                "004" => {
+                    :name => "DPT_Percent_U8", :desc => "percent", 
+                    :unit => "%", 
+                },
+                
+                # 5.005 ratio (0..255)
+                "005" => {
+                    :name => "DPT_DecimalFactor", :desc => "ratio", 
+                    :unit => "ratio", 
+                },
+                
+                # 5.006 tariff (0..255)
+                "006" => {
+                    :name => "DPT_Tariff", :desc => "tariff", 
+                    :unit => "tariff", 
+                },
+                
+                # 5.010 counter pulses (0..255)
+                "010" => {
+                    :name => "DPT_Value_1_Ucount", :desc => "counter pulses", 
+                    :unit => "pulses",
+                },
+            }
+
+            # DPT5 canonical values
+            # ---------------------
+            # use scalar conversion, if applicable 
+            # otherwise just return the data value
+            def as_canonical_value()
+                return nil if current_value.nil?
+                # get and apply field's scalar range, if any (only in DPT5 afaik)
+                if (sr = getparam(:scalar_range) and range = getparam(:range)) then
+                    return to_scalar(current_value.data.value, range, sr)
+                else
+                    return current_value.data.value
+                end
+            end
+     
+            #
+            #
+            def to_protocol_value(v)
+                if (sr = getparam(:scalar_range) and range = getparam(:range)) then
+                    return from_scalar(v, range, sr)
+                else
+                    return v
+                end
+            end
+            
+        end 
+        
+    end
+    
+end