ansible4ozw 0.0.1

data/lib/ansible/zwave/types/valuetype_bool.rb

@@ -0,0 +1,74 @@
+=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 ZWave 
+        
+        # boolean value type for OpenZWave
+        module ValueType_Bool
+            
+            # define type-specific OZW::Manager API calls
+            def read_operation 
+                return :GetValueAsBool 
+            end
+            
+            #
+            def write_operation
+                return :SetValue_Bool
+            end
+
+            #            
+            def as_canonical_value()
+                return (
+                    case 
+                    when [TrueClass, FalseClass].include?(current_value.class) then current_value
+                    else false
+                    end
+                )
+            end
+            
+            # map any ruby value to boolean
+            def to_protocol_value(new_val)
+                return (
+                    case
+                    when [Fixnum].include?(new_val.class) then (new_val > 0)
+                    when [TrueClass, FalseClass].include?(new_val.class) then new_val
+                    when new_val.nil? then false
+                    else true
+                    end
+                )
+            end 
+
+            # return a human-readable representation of a ZWave frame
+            def explain
+                puts "cv = #{@current_value}"
+                return(@current_value? "ON":"OFF")
+            end
+        end
+        
+    end
+    
+end
+                

data/lib/ansible/zwave/types/valuetype_button.rb

@@ -0,0 +1,63 @@
+=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 ZWave 
+        
+        # button value type for OpenZWave
+        module ValueType_Button
+
+            # define type-specific OZW::Manager API calls
+            def read_operation 
+                return nil # FIXME 
+            end
+                
+            def write_operation 
+                return :PressButton # FIXME: also: ReleaseButton
+            end
+             
+            #            
+            def as_canonical_value()
+                puts 'TODO:: zwave_button: as_canonical'
+                return (current_value > 0)
+            end
+            
+            #
+            def to_protocol_value(new_val)
+                puts 'TODO:: zwave_button: to_protocol'
+                result = nil
+                if [TrueClass, FalseClass].include?(new_val.class)
+                    result = new_val ? 1 : 0
+                end
+            end 
+            
+            # return a human-readable representation of a ZWave frame
+            def explain
+            end
+        end
+        
+    end
+    
+end

data/lib/ansible/zwave/types/valuetype_byte.rb

@@ -0,0 +1,78 @@
+=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 ZWave 
+        
+        # byte value type for OpenZWave (0-255)
+        module ValueType_Byte
+
+            # define type-specific OZW::Manager API calls
+            def read_operation 
+                return :GetValueAsByte 
+            end
+            
+            def write_operation 
+                return :SetValue_UInt8 
+            end 
+            
+            # ZWave 1-byte values canonical form is a Fixnum between 0 and 255     
+            def as_canonical_value()
+                return( case current_value
+                when 0..255 then current_value
+                    else raise "#{self}: value #{current value} out of bounds 0..255"
+                    end
+                )
+            end
+            
+            # ZWave 1-byte values protocol form is a Fixnum between 0 and 255
+            def to_protocol_value(new_val)
+                return( case new_val
+                    when TrueClass then 255
+                    when FalseClass then 0
+                    when 0..255 then new_val
+                    else raise "#{self}: value #{current value} out of bounds 0..255"
+                    end
+                )
+            end 
+            
+            # return a human-readable representation of a ZWave frame
+            def explain
+                result = case @_commandClassId
+                when 38 then 
+                    case @current_value
+                    when 0..99 then "#{@current_value} %"
+                    else "Off"
+                    end
+                else "#{@current_value}"
+                end    
+                return(result)
+            end
+            
+        end
+        
+    end
+    
+end

data/lib/ansible/zwave/types/valuetype_decimal.rb

@@ -0,0 +1,64 @@
+=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 ZWave 
+        
+        # Decimal value type for OpenZWave: special form for string representation 
+        # of floating point values in order to avoid rounding errors 
+        module ValueType_Decimal
+            
+            # define type-specific OZW::Manager API calls
+            def read_operation 
+                return :GetValueAsString
+            end
+            
+            def write_operation
+                return :SetValue_String
+            end
+             
+            #            
+            def as_canonical_value()
+                puts 'TODO:: zwave_decimal: as_canonical'
+                return (current_value > 0)
+            end
+            
+            #
+            def to_protocol_value(new_val)
+                puts 'TODO:: zwave_decimal: to_protocol'
+                result = nil
+                if [TrueClass, FalseClass].include?(new_val.class)
+                    result = new_val ? 1 : 0
+                end
+            end 
+            
+            # return a human-readable representation of a ZWave frame
+            def explain
+            end
+        end
+        
+    end
+    
+end

data/lib/ansible/zwave/types/valuetype_int.rb

@@ -0,0 +1,63 @@
+=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 ZWave 
+        
+        # integer (32-bit) value type for OpenZWave
+        module ValueType_Int
+            
+            # define type-specific OZW::Manager API calls
+            def read_operation
+                return :GetValueAsInt
+            end
+            
+            def write_operation 
+                return :SetValue_Int32
+            end
+             
+            #            
+            def as_canonical_value()
+                puts 'TODO:: zwave_int: as_canonical'
+                return (current_value > 0)
+            end
+            
+            #
+            def to_protocol_value(new_val)
+                puts 'TODO:: zwave_int: to_protocol'
+                result = nil
+                if [TrueClass, FalseClass].include?(new_val.class)
+                    result = new_val ? 1 : 0
+                end
+            end 
+            
+            # return a human-readable representation of a ZWave frame
+            def explain
+            end
+        end
+        
+    end
+    
+end

data/lib/ansible/zwave/types/valuetype_list.rb

@@ -0,0 +1,64 @@
+=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 ZWave 
+        
+        # list value type for OpenZWave
+        # 
+        module ValueType_List
+            
+            # define type-specific OZW::Manager API calls
+            def read_operation
+                raise 'FIXME'
+                return :GetValueListItems
+            end
+            
+            def write_operation
+                raise 'FIXME'
+                return :SetValueListSelection
+            end
+            
+            #
+            def as_canonical_value()
+                puts 'TODO'
+            end
+            
+            #
+            def to_protocol_value(new_val)
+                result = nil
+                if [TrueClass, FalseClass].include?(new_val.class)
+                    result = new_val ? 1 : 0
+                end
+            end 
+            
+            # return a human-readable representation of a ZWave frame
+            def explain
+            end
+        end
+        
+    end
+    
+end

data/lib/ansible/zwave/types/valuetype_short.rb

@@ -0,0 +1,63 @@
+=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 ZWave 
+        
+        # short integer (16-bit) value type for OpenZWave
+        module ValueType_Short
+            
+            # define type-specific OZW::Manager API calls
+            def read_operation
+                return :GetValueAsShort
+            end
+            
+            def write_operation 
+                return :SetValue_Int16
+            end
+             
+            #            
+            def as_canonical_value()
+                puts 'TODO:: zwave_short: as_canonical'
+                return (current_value > 0)
+            end
+            
+            #
+            def to_protocol_value(new_val)
+                puts 'TODO:: zwave_short: to_protocol'
+                result = nil
+                if [TrueClass, FalseClass].include?(new_val.class)
+                    result = new_val ? 1 : 0
+                end
+            end 
+            
+            # return a human-readable representation of a ZWave frame
+            def explain
+            end
+        end
+        
+    end
+    
+end