ansible4ozw 0.0.1

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

@@ -0,0 +1,54 @@
+=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
+        
+        #
+        # 1-bit canonical values for KNX
+        # implements value casting to/from the canonical type, a boolean value 
+        module Canonical_1bit
+            
+            # DPT1 canonical values
+            # ---------------------
+            # Use Ruby convention for booleans in order to convert 
+            # input value of (nil, false) into 0, otherwise 1
+            
+            # data is 1 ==> true, false otherwise
+            def as_canonical_value()
+                return (current_value.data.eql?1)
+            end
+    
+            # v is true? 1 : 0 
+            def to_protocol_value(v)
+                return (v ? 1 : 0)
+            end
+    
+        end
+        
+    end
+    
+end

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

@@ -0,0 +1,224 @@
+=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
+
+        #
+        # DPT1: 1-bit (boolean) value
+        #
+        module DPT1
+            
+            # DPT1 frame description.
+            # Always 8-bit aligned.
+            class DPT1_Frame < DPTFrame
+                bit2  :apci_pad, :display_name => "APCI info (not useful)"
+                bit5  :null_pad
+                bit1  :data, :display_name => "6 bit of useful data"
+            end
+            
+            include Canonical_1bit
+            
+            # DPT basetype info hash
+            Basetype = {
+                :bitlength => 1,
+                :range => 0..1,
+                :valuetype => :basic,
+                :desc => "1-bit value"
+            }
+            
+            # DPT subtypes info hash
+            Subtypes = {
+                # 1.001 on/off
+                "001" => { :use => "G",
+                    :name => "DPT_Switch", 
+                    :desc => "switch", 
+                    :enc => { 0 => "Off", 1 => "On" }
+                },
+                
+                # 1.002 boolean
+                "002" => { :use => "G",
+                    :name => "DPT_Bool", 
+                    :desc => "bool", 
+                    :enc => { 0 => "false", 1 => "true" }
+                },
+                
+                # 1.003 enable
+                "003" => { :use => "G",
+                    :name => "DPT_Enable", 
+                    :desc => "enable", 
+                    :enc => { 0 => "disable", 1 => "enable" }
+                },
+                
+                # 1.004 ramp
+                "004" => { :use => "FB",
+                    :name => "DPT_Ramp", 
+                    :desc => "ramp", 
+                    :enc => { 0 => "No ramp", 1 => "Ramp" }
+                },
+                
+                # 1.005 alarm
+                "005" => { :use => "FB",
+                    :name => "DPT_Alarm", 
+                    :desc => "alarm", 
+                    :enc => { 0 => "No alarm", 1 => "Alarm" }
+                },
+                
+                # 1.006 binary value
+                "006" => { :use => "FB",
+                    :name => "DPT_BinaryValue", 
+                    :desc => "binary value", 
+                    :enc => { 0 => "Low", 1 => "High" }
+                },
+                
+                # 1.007 step
+                "007" => { :use => "FB",
+                    :name => "DPT_Step", 
+                    :desc => "step", 
+                    :enc => { 0 => "Decrease", 1 => "Increase" }
+                },
+                
+                # 1.008 up/down
+                "008" => { :use => "G",
+                    :name => "DPT_UpDown", 
+                    :desc => "up/down", 
+                    :enc => { 0 => "Up", 1 => "Down" }
+                },
+                
+                # 1.009 open/close
+                "009" => { :use => "G",
+                    :name => "DPT_OpenClose", 
+                    :desc => "open/close", 
+                    :enc => { 0 => "Open", 1 => "Close" }
+                },
+                
+                # 1.010 start/stop
+                "010" => { :use => "G",
+                    :name => "DPT_Start", 
+                    :desc => "start/stop", 
+                    :enc => { 0 => "Stop", 1 => "Start" }
+                },
+                
+                # 1.011 state
+                "011" => { :use => "FB",
+                    :name => "DPT_State", 
+                    :desc => "state", 
+                    :enc => { 0 => "Inactive", 1 => "Active" }
+                },
+                
+                # 1.012 invert
+                "012" => { :use => "FB",
+                    :name => "DPT_Invert", 
+                    :desc => "invert", 
+                    :enc => { 0 => "Not inverted", 1 => "inverted" }
+                },
+                
+                # 1.013 dim send style
+                "013" => { :use => "FB",
+                    :name => "DPT_DimSendStyle", 
+                    :desc => "dim send style", 
+                    :enc => { 0 => "Start/stop", 1 => "Cyclically" }
+                },
+                
+                # 1.014 input source
+                "014" => { :use => "FB",
+                    :name => "DPT_InputSource", 
+                    :desc => "input source", 
+                    :enc => { 0 => "Fixed", 1 => "Calculated" }
+                },
+                
+                # 1.015 reset
+                "015" => { :use => "G",
+                    :name => "DPT_Reset", 
+                    :desc => "reset",  
+                    :enc => { 0 => "no action(dummy)", 1 => "reset command(trigger)" }
+                },
+                
+                # 1.016 acknowledge
+                "016" => { :use => "G",
+                    :name => "DPT_Ack", 
+                    :desc => "ack",  
+                    :enc => { 0 => "no action(dummy)", 1 => "acknowledge command(trigger)" }
+                },
+                
+                # 1.017 trigger
+                "017" => { :use => "G",
+                    :name => "DPT_Trigger", 
+                    :desc => "trigger", 
+                    :enc => { 0 => "trigger", 1 => "trigger" }
+                },
+                
+                # 1.018 occupied
+                "018" => { :use => "G",
+                    :name => "DPT_Occupancy", 
+                    :desc => "occupancy", 
+                    :enc => { 0 => "not occupied", 1 => "occupied" }
+                },
+                
+                # 1.019 open window or door
+                "019" => { :use => "G",
+                    :name => "DPT_WindowDoor", 
+                    :desc => "open window/door", 
+                    :enc => { 0 => "closed", 1 => "open" }
+                },
+                
+                # 1.021 and/or
+                "021" => { :use => "FB",
+                    :name => "DPT_LogicalFunction", 
+                    :desc => "and/or", 
+                    :enc => { 0 => "logical function OR", 1 => "logical function AND" }
+                },
+                
+                # 1.022 scene A/B
+                "022" => { :use => "FB",
+                    :name => "DPT_Scene_AB", 
+                    :desc => "scene A/B", 
+                    :enc => { 0 => "scene A", 1 => "scene B" }
+                },
+                
+                # 1.023 shutter/blinds mode
+                "023" => { :use => "FB",
+                    :name => "DPT_ShutterBlinds_Mode", 
+                    :desc => "shutter/blinds mode", 
+                    :enc => { 0 => "only move Up/Down mode (shutter)", 1 => "move Up/Down + StepStop mode (blind)" }
+                },
+                
+                # 1.100 cooling/heating     ---FIXME---
+                "100" => {  :use => "???",
+                    :name => "DPT_Heat/Cool", 
+                    :desc => "heat/cool",
+                    :enc => { 0 => "???", 1 => "???" }
+                },
+            }
+            
+            include Canonical_1bit
+            
+        end #module DPT1
+        
+    end
+    
+end

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

@@ -0,0 +1,85 @@
+=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
+        
+        #
+        # DPT10.*: time
+        #
+        module DPT10
+            
+            # DPTFrame to parse a DPT10 frame. 
+            # Always 8-bit aligned.
+            class DPT10_Frame < DPTFrame
+                bit3 :dayofweek, {
+                    :display_name => "Day of week", 
+                    :range => 0..7, 
+                    :enc => {
+                        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 :pad2
+                bit6 :minutes, {
+                    :display_name =>  "Minutes", :range => 0..59
+                }
+                #
+                bit2 :pad3
+                bit6 :seconds, {
+                    :display_name =>  "Seconds", :range => 0..59
+                }
+            end
+
+            # DPT10 base type info
+            Basetype = {
+                :bitlength => 24,
+                :valuetype => :composite,
+                :desc => "day of week + time of day"
+            }
+            
+            # DPT10 subtypes info
+            Subtypes = {
+                # 10.001 time of day
+                "001" => {
+                    :name => "DPT_TimeOfDay", :desc => "time of day"
+                }
+            }
+
+        end
+        
+    end
+    
+end

data/lib/ansible/knx/dpt/dpt11.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
+        
+        #
+        # DPT11.*: date
+        #        
+        module DPT11
+
+            class DPT11_Frame < DPTFrame
+                bit3 :pad1 
+                bit5 :dayofmonth,  {
+                    :display_name =>  "Day of month (1..31)", :range => 1..31
+                }
+                #
+                bit4 :pad2
+                bit4 :month, {
+                    :display_name => "Month (1..12)", :range => 1..12 
+                }
+                #
+                bit1 :pad3
+                bit7 :year,  {
+                    :display_name => "Year 0..99 (<90 => 20xx, >=90 => 19xx)", :range => 0..99 
+                } 
+            end
+            
+            # DPT11 base type info
+            Basetype = {
+                :bitlength => 24,
+                :valuetype => :composite,
+                :desc => "3-byte date value"
+            }
+            
+            
+            # DPT11 subtypes info
+            Subtypes = {   
+                # 11.001 date
+                "001" => {
+                    :name => "DPT_Date", :desc => "Date"
+                }
+            }
+            
+        end
+        
+    end
+    
+end
+

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

@@ -0,0 +1,61 @@
+=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
+        
+        #
+        # DPT12.*:  4-byte unsigned value
+        #        
+        module DPT12
+
+            class DPT12_Frame < DPTFrame
+                uint32 :data, { 
+                    :display_name => "32-bit value",
+                    :range => 0..2**32-1
+                }
+            end
+
+            # DPT12 base type info
+            Basetype = {
+                :bitlength => 32,
+                :valuetype => :basic,
+                :desc => "4-byte unsigned value"
+            }
+                        
+            # DPT12 subtype info
+            Subtypes = {   
+                # 12.001 counter pulses
+                "001" => {
+                    :name => "DPT_Value_4_Ucount", :desc => "counter pulses"
+                }
+            }
+            
+        end
+        
+    end
+    
+end
+