sdague-thermostat 0.0.2

data/README

@@ -0,0 +1,36 @@
+Copyright (c) 2008 - Sean Dague <sean at dague dot net>
+
+THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+This code is based on the Proliphix Software API which can be found
+here ( http://www.proliphix.com/Documentation.aspx ).  I am writing
+this software to interface with my NT20e unit.  The API looks to be
+the same across all their IP units, but I will only be testing on my
+unit in my house.
+
+Important notices from the manual:
+
+**Limitations on the Frequency of Operations**
+
+While the device can handle numerous back to back requests, it is
+advisable to not sustain an operation frequency higher than 1 request
+per 60 second period for a substantial amount of time. In other words,
+sustained polling of the device should not exceed a few requests per
+minute. A prolonged burst of requests higher than 1 request per 60
+second period may degrade the main function of the thermostat.  Also,
+if one is making a PIB set and wishes to observe a reaction from the
+device, it is advisable to wait for at least 1 second between the set
+request and subsequent get request.
+
+

data/lib/pdp/constants.rb

@@ -0,0 +1,130 @@
+
+module Proliphix
+    # a whole crap load of constants for the proliphix API
+
+    # read/write
+    ThermHvacMode = OID.new("HVAC Mode",
+                            "4.1.1",
+                            false,
+                            {
+                                1 => "Off",
+                                2 => "Heat", 
+                                3 => "Cool",
+                                4 => "Auto",
+                            })
+    
+    ThermHvacState = OID.new("HVAC State",
+                            "4.1.2",
+                             true,
+                            {
+                                1 => "Initializing",
+                                2 => "Off",
+                                3 => "Heat",
+                                4 => "Heat2",
+                                5 => "Heat3",
+                                6 => "Cool",
+                                7 => "Cool2",
+                                8 => "Delay", 
+                                9 => "ResetRelays"
+                            })
+
+    ThermFanMode = OID.new("Fan Mode",
+                           "4.1.3",
+                           false,
+                           {
+                               1 => "Auto",
+                               2 => "On",
+                               3 => "Schedule",
+                           })
+    
+    ThermFanState = OID.new("Fan State",
+                            "4.1.4",
+                            true,
+                            {
+                                0 => "Init",
+                                1 => "Off",
+                                2 => "On",
+                            })
+    
+    ThermSetbackHeat = OID.new("Setback Heat",
+                               "4.1.5",
+                               false)
+    
+    ThermSetbackCool = OID.new("Setback Cool",
+                               "4.1.6",
+                               false)
+    
+    # only on the NT150, and the math won't really work on this now anyway
+    ThermConfigHumidyCool = OID.new("thermConfigHumidityCool",
+                                    "4.2.22",
+                                    false)
+    
+    ThermSetbackStatus = OID.new("Setback Status",
+                                 "4.1.9",
+                                 false,
+                                 {
+                                     1 => "Normal",
+                                     2 => "Hold",
+                                     3 => "Override"
+                                 })
+
+    ThermCurrentPeriod = OID.new("Current Period",
+                                 "4.1.10",
+                                 true, # false, but the spec says writes are ignored
+                                 {
+                                     1 => "Morn",
+                                     2 => "Day",
+                                     3 => "Eve",
+                                     4 => "Night",
+                                 })
+
+    ThermActivePeriod = OID.new("Activity Period",
+                                "4.1.12",
+                                true,
+                                { 
+                                    1 => "Morn",
+                                    2 => "Day",
+                                    3 => "Eve",
+                                    4 => "Night",
+                                    5 => "Hold",
+                                    6 => "Override"
+                                })
+
+    ThermCurrentClass = OID.new("Current Day Class",
+                                "4.1.11",
+                                true,
+                                {
+                                    1 => "In",
+                                    2 => "Out",
+                                    3 => "Away"
+                                })
+    
+    ThermAverageTemp = OID.new("Temperature (degrees F)",
+                               "4.1.13",
+                               true)
+    
+    ThermHeat1Usage = OID.new("Heat Usage (minutes)",
+                              "4.5.1",
+                              true, nil, false) # it says false, but that's just too hard for me to wrap my brain around
+
+    ThermHeat2Usage = OID.new("Heat 2 Usage (minutes)",
+                              "4.5.2",
+                              true, nil, false) # it says false, but that's just too hard for me to wrap my brain around
+
+    ThermCool1Usage = OID.new("Cooling Usage (minutes)",
+                              "4.5.3",
+                              true, nil, false) # it says false, but that's just too hard for me to wrap my brain around
+
+    ThermCool2Usage = OID.new("Cooling 2 Usage (minutes)",
+                              "4.5.4",
+                              true, nil, false) # it says false, but that's just too hard for me to wrap my brain around
+    
+    ThermFanUsage = OID.new("Fan Usage (minutes)",
+                            "4.5.5",
+                            true, nil, false)
+
+    ThermLastUsageReset = OID.new("Last Usage Reset",
+                                  "4.5.6",
+                                  false, nil, false) # we're going to have to be tricky about this one
+    
+end

data/lib/pdp/oid.rb

@@ -0,0 +1,37 @@
+module Proliphix
+    class OID
+        def initialize(name, oid, readonly, valuemap = nil, scale = true)
+            @name = name
+            @oid = oid
+            @valuemap = valuemap
+            @readonly = readonly
+            @scale = scale
+        end
+        
+        def oid
+            return @oid
+        end
+
+        def name
+            return @name
+        end
+
+        def ro?
+            return @readonly
+        end
+
+        # a little tricky, but not too bad.  Basically the access
+        # gives us either the value off the value map, or the degrees
+        # reading (as we always get degrees as 10x ints)
+
+        def [](value)
+            if @valuemap 
+                return @valuemap[value.to_i]
+            elsif @scale
+                return value.to_i / 10.0
+            else
+                return value.to_i
+            end
+        end
+    end
+end

data/lib/thermostat.rb

@@ -0,0 +1,95 @@
+require 'net/http'
+require 'uri'
+require 'open-uri'
+
+# order here is important
+require 'pdp/oid'
+require 'pdp/constants'
+
+# Some docs
+class Thermostat
+
+    def initialize(ip, user, passwd)
+        @ip = ip
+        @user = user
+        @passwd = passwd
+        @fetched = {}
+        @sensors = []
+    end
+
+    def [](reading)
+        return @fetched[reading]
+    end
+
+    def url
+        return "http://#{@ip}"
+    end
+
+    def set_senors(*array)
+        @sensors = array
+        return self
+    end
+
+    def get_query_url
+        query = ""
+        for item in @sensors
+            if query != ""
+                query += "&"
+            end
+            query += "OID#{item.oid}="
+        end
+        query = url + "/get?" + query
+    end
+
+    def set_query_url(mod, value)
+        query = "OID#{mod.oid}=#{value}"
+        query = url + "/pdp?" + query + "&sumbit=Submit"
+    end
+
+    # Because of the timing issues with the thermostat we want to get all the data we can in one packet.
+    def fetch_data()
+        open(get_query_url, :http_basic_authentication => [@user, @passwd]) do |line|
+            parse_data(line.read)
+        end
+        return self
+    end
+
+    def set_data(mod, value)
+        unless mod.ro?
+            open(set_query_url(mod, value), :http_basic_authentication => [@user, @passwd]) do |line|
+                parse_data(line.read)
+            end
+        end
+        return self
+    end
+
+
+    def parse_data(raw_data)
+        results = raw_data.split('&')
+        results.each do |r|
+            (oid, value) = r.split('=')
+            mod = lookup_oid(oid)
+            if mod
+                @fetched[mod] = mod[value]
+            end
+        end
+    end
+
+    def lookup_oid(oid)
+        newid = oid.sub(/^OID/, '')
+        @sensors.each do |s|
+            if s.oid == newid
+                return s
+            end
+        end
+        return nil
+    end
+
+    def to_s
+        s = ""
+        @fetched.each do |k, v|
+            s += "#{k.name}: #{v}\n"
+        end
+        return s
+    end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: sdague-thermostat
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Sean Dague
+autorequire: thermostat
+bindir: bin
+cert_chain: []
+
+date: 2008-12-22 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: sean at dague dot net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/thermostat.rb
+- lib/pdp
+- lib/pdp/constants.rb
+- lib/pdp/oid.rb
+- README
+has_rdoc: true
+homepage: http://rubyforge.net/projects/rtc
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby modules to control Prolipix IP Thermostats
+test_files: []
+