thermostat 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.1.0 2010-03-10
+* relatively complete unit test coverage
+* add a simulation mode to the network layer so it's easier to test
+* include usage methods in the main thermostat object
+
 === 1.0.0 2010-03-09
 
 * major enhancements:

data/Manifest.txt

@@ -5,7 +5,6 @@ README.rdoc
 Rakefile
 account.yaml.example
 config/website.yml
-config/website.yml.sample
 docs/PDP_API_R1_11.pdf
 examples/test-fan-off.rb
 examples/test-fan-on.rb
@@ -20,6 +19,7 @@ script/destroy
 script/generate
 script/txt2html
 test/test_helper.rb
+test/test_network.rb
 test/test_oid.rb
 test/test_thermostat.rb
 website/index.html

data/README.rdoc

@@ -32,7 +32,16 @@ request and subsequent get request.
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+  thermostat = Thermostate.new("hostname", "admin", "password")
+
+  # get the current temperature
+  current_temp = thermostat.temp
+
+  # get the current setback heat value
+  current_target_temp = thermostat.heat_to
+
+  # set the thermostat to 69F (units are set in the thermost)
+  thermostat.heat_to = 69
 
 == REQUIREMENTS:
 
@@ -44,7 +53,7 @@ sudo gem install thermostat
 
 (The MIT License)
 
-Copyright (c) 2010 Sean Dague
+Copyright (c) 2008-2010 Sean Dague
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/pdp/network.rb

@@ -6,11 +6,16 @@ module Proliphix
     require "open-uri"
     
     class Network
+        attr_accessor :debug, :simulate, :query, :squery, :buffer
+        
         def initialize(ip, user, passwd)
+            @buffer = ""
+            @debug = false
+            @simulate = false
             @ip = ip
             @user = user
             @passwd = passwd
-            @last = Time.now.to_i
+            @last = Time.now.to_i - 120
             @fetched = {}
             @sensors = [
                         ThermHvacMode,
@@ -43,7 +48,9 @@ module Proliphix
                   
         def set(name, value)
             set_data(name, value)
-            sleep 1
+            if not @simulate
+                sleep 1
+            end
             fetch_data
         end
         
@@ -60,34 +67,41 @@ module Proliphix
         end
         
         def get_query_url
-            query = ""
-            for item in @sensors
-                if query != ""
-                    query += "&"
-                end
-                query += "OID#{item.oid}="
+            @query = url + "/get?" + @sensors.map {|item| "OID#{item.oid}="}.join("&")
+            if @debug
+                puts @query
             end
-            query = url + "/get?" + query
+            return @query
         end
         
         def set_query_url(mod, value)
-            query = "OID#{mod.oid}=#{value}"
-            query = url + "/pdp?" + query + "&sumbit=Submit"
+            @squery = url + "/pdp?OID#{mod.oid}=#{value}&sumbit=Submit"
+            if @debug
+                puts @squery
+            end
+            return @squery
         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)
+            url = get_query_url
+            if not simulate
+                open(url, :http_basic_authentication => [@user, @passwd]) do |line|
+                    @buffer = line.read
+                end
             end
+            parse_data(@buffer)
             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)
+                url = set_query_url(mod, value)
+                if not simulate
+                    open(url, :http_basic_authentication => [@user, @passwd]) do |line|
+                        @buffer = line.read
+                    end
                 end
             end
             return self
@@ -97,6 +111,10 @@ module Proliphix
         # includes oids = values in what looks like a uri string.  So
         # split twice to get values.
         def parse_data(raw_data)
+            if @debug
+                puts raw_data
+            end
+            
             results = raw_data.split('&')
             results.each do |r|
                 (oid, value) = r.split('=')

data/lib/thermostat.rb

@@ -4,12 +4,14 @@ $:.unshift(File.dirname(__FILE__)) unless
 # This is the main class for controlling the Proliphix Thermostat.
 # You must first initialize it with the control point credentials
 class Thermostat
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
         
     require 'pdp/oid'
     require 'pdp/constants'
     require 'pdp/network'
     
+    attr :network
+    
     include Proliphix
     
     # create a new thermostat object.  It needs
@@ -89,6 +91,21 @@ class Thermostat
         self[ThermHvacState] == "Cool"
     end
 
+    # The number of minutes of active heating since last reset of the counters.  
+    def heat_usage
+        self[ThermHeat1Usage]
+    end
+
+    # The number of minutes of active cooling since last reset of the counters.  
+    def cool_usage
+        self[ThermCool1Usage]
+    end
+ 
+    # The number of minutes the fan was running since last reset of the counters. 
+    def fan_usage
+        self[ThermFanUsage]
+    end
+     
     # Is the fan currently on.  It doesn't matter why it's on, just
     # that it's on.
     def fan_on?

data/test/test_helper.rb

@@ -3,14 +3,14 @@ require 'test/unit'
 require File.dirname(__FILE__) + '/../lib/thermostat'
 
 @@values = {}
-module Proliphix
-    class Network
-        def get(name)
-            @@values[name]
-        end
+# module Proliphix
+#     class Network
+#         def get(name)
+#             @@values[name]
+#         end
         
-        def set(name, value)
-            @@values[name] = value
-        end
-    end
-end
+#         def set(name, value)
+#             @@values[name] = value
+#         end
+#     end
+# end

data/test/test_network.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestThermostatNetwork < Test::Unit::TestCase
+    include Proliphix
+    
+    def squery
+        @@t.network.squery
+    end
+    def query
+        @@t.network.query
+    end
+    
+    def setup
+        @@t = Thermostat.new("foo", "me", "go")
+        @@t.network.simulate = 1
+        # this is some real data
+        @@t.network.buffer = "OID4.1.1=2&OID4.1.2=3&OID4.1.3=1&OID4.1.4=2&OID4.1.5=690&OID4.1.6=760&OID4.5.1=87337&OID4.5.3=47835&OID4.5.5=36826&OID4.1.13=686&"
+    end
+
+    def test_get_query_generate
+        base_query = "http://foo/get?OID4.1.1=&OID4.1.2=&OID4.1.3=&OID4.1.4=&OID4.1.5=&OID4.1.6=&OID4.5.1=&OID4.5.3=&OID4.5.5=&OID4.1.13="
+        
+        @@t.heat_to
+        assert_equal(base_query, query)
+
+        @@t.cool_to
+        assert_equal(base_query, query)
+
+        @@t.temp
+        assert_equal(base_query, query)
+      
+        @@t.fan_on?
+        assert_equal(base_query, query)
+    end
+    
+    def test_set_query_generate
+        @@t.heat_to = 68
+        assert_equal("http://foo/pdp?OID4.1.5=680&sumbit=Submit", squery)
+        
+        @@t.heat_to = 68.0
+        assert_equal("http://foo/pdp?OID4.1.5=680&sumbit=Submit", squery)
+
+        @@t.heat_to = 68.01
+        assert_equal("http://foo/pdp?OID4.1.5=680&sumbit=Submit", squery)
+
+        @@t.heat_to = 68.095
+        assert_equal("http://foo/pdp?OID4.1.5=680&sumbit=Submit", squery)
+
+
+        @@t.cool_to = 76.5
+        assert_equal("http://foo/pdp?OID4.1.6=765&sumbit=Submit", squery)
+
+        @@t.cool_to = 76.51
+        assert_equal("http://foo/pdp?OID4.1.6=765&sumbit=Submit", squery)
+
+        @@t.cool_to = 76.519
+        assert_equal("http://foo/pdp?OID4.1.6=765&sumbit=Submit", squery)
+
+        @@t.fan_off!
+        assert_equal("http://foo/pdp?OID4.1.3=1&sumbit=Submit", squery)
+
+        @@t.fan_on!
+        assert_equal("http://foo/pdp?OID4.1.3=2&sumbit=Submit", squery)
+        
+        @@t.network.squery = ""
+      
+        # we have some safety measures in here
+        @@t.cool_to = 45
+        assert_equal("", squery)
+
+        @@t.cool_to = -100
+        assert_equal("", squery)
+
+        @@t.heat_to = 90
+        assert_equal("", squery)
+    end
+
+end

data/test/test_oid.rb

@@ -1,12 +1,19 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-require "pp"
-
-class TestThermostat < Test::Unit::TestCase
-    include Proliphix
-
-    def test_therm
-        puts ThermSetbackHeat[680]
-    end
-    
-end
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require "pp"
+
+class TestThermostat < Test::Unit::TestCase
+    include Proliphix
+
+    def test_oid_values
+        assert_equal(68, ThermSetbackHeat[680])
+        assert_equal(68.0, ThermSetbackHeat[680])
+
+        assert_equal(68, ThermSetbackCool[680])
+        assert_equal(68.0, ThermSetbackCool[680])
+
+        assert_equal(68, ThermAverageTemp[680])
+        assert_equal(68.0, ThermAverageTemp[680])
+    end
+    
+end

data/test/test_thermostat.rb

@@ -4,23 +4,50 @@ class TestThermostat < Test::Unit::TestCase
     include Proliphix
     
     def setup
-        @@thermostat = Thermostat.new("foo", "me", "go")
+        @@t = Thermostat.new("foo", "me", "go")
+        @@t.network.simulate = true
     end
     
     def test_scenario_one
-        @@values[ThermHvacMode] = "Heat"
-        @@values[ThermSetbackHeat] = 69.0
-        @@values[ThermSetbackCool] = 79.0
-        @@values[ThermAverageTemp] = 68.5
+        @@t.network.buffer = "OID4.1.1=2&OID4.1.2=3&OID4.1.3=1&OID4.1.4=2&OID4.1.5=690&OID4.1.6=760&OID4.5.1=87337&OID4.5.3=47835&OID4.5.5=36826&OID4.1.13=686&"
         
-        assert_equal @@thermostat.mode, "Heat"
-        assert_equal @@thermostat.temp, 68.5
-        assert_equal @@thermostat.heat_to, 69.0
-        assert_equal @@thermostat.cool_to, nil
+        assert_equal "Heat", @@t.mode
+        assert_equal 68.6, @@t.temp
+        assert_equal 69.0, @@t.heat_to
+        assert_equal true, @@t.heating?
+        assert_equal true, @@t.fan_on?
+        assert_equal false, @@t.cooling?
+        assert_equal nil, @@t.cool_to
+        assert_equal 87337, @@t.heat_usage
+        assert_equal 47835, @@t.cool_usage
+        assert_equal 36826, @@t.fan_usage
     end
 
     def test_scenario_two
+        @@t.network.buffer = "OID4.1.1=1&OID4.1.2=2&OID4.1.3=1&OID4.1.4=1&OID4.1.5=690&OID4.1.6=760&OID4.5.1=87337&OID4.5.3=47835&OID4.5.5=36826&OID4.1.13=686&"
+        
+        assert_equal "Off", @@t.mode
+        assert_equal 68.6, @@t.temp
+        assert_equal nil, @@t.heat_to
+        assert_equal false, @@t.heating?
+        assert_equal false, @@t.fan_on?
+        assert_equal false, @@t.cooling?
+        assert_equal nil, @@t.cool_to
         
     end
-    
+
+    def test_scenario_three
+        @@t.network.buffer = "OID4.1.1=3&OID4.1.2=2&OID4.1.3=1&OID4.1.4=1&OID4.1.5=690&OID4.1.6=760&OID4.5.1=87337&OID4.5.3=47835&OID4.5.5=36826&OID4.1.13=686&"
+        
+        assert_equal "Cool", @@t.mode
+        assert_equal 68.6, @@t.temp
+        assert_equal nil, @@t.heat_to
+        assert_equal false, @@t.heating?
+        assert_equal false, @@t.fan_on?
+        assert_equal false, @@t.cooling?
+        assert_equal 76, @@t.cool_to
+        assert_equal 76.0, @@t.cool_to
+        
+    end
+
 end

data/website/index.html

@@ -34,7 +34,7 @@
     <div class="sidebar">
       <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/sdaguegems"; return false'>
         <p>Get Version</p>
-        <a href="http://rubyforge.org/projects/sdaguegems" class="numbers">1.0</a>
+        <a href="http://rubyforge.org/projects/sdaguegems" class="numbers">1.0.0</a>
       </div>
     </div>
     <h2>What</h2>
@@ -63,7 +63,7 @@ rake install_gem</pre>
 <h2>Contact</h2>
 <p>Comments are welcome. Send an email to <a href="mailto:sean@dague.net">Sean Dague</a></p>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, 6th March 2010<br>
+      <a href="FIXME email">FIXME full name</a>, 7th March 2010<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -12,9 +12,21 @@ h2. Installing
 
 h2. The basics
 
-
 h2. Demonstration of usage
 
+<pre syntax="ruby">
+  thermostat = Thermostate.new("hostname", "admin", "password")
+
+  # get the current temperature
+  current_temp = thermostat.temp
+
+  # get the current setback heat value
+  current_target_temp = thermostat.heat_to
+
+  # set the thermostat to 69F (units are set in the thermost)
+  thermostat.heat_to = 69
+</pre>
+
 h2. Documentation
 
 Full module level documentat can be found here:http://sdaguegems.rubyforge.org/thermostat/rdoc
@@ -22,7 +34,7 @@ Full module level documentat can be found here:http://sdaguegems.rubyforge.org/t
 
 h2. How to submit patches
 
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/
 
 You can fetch the source from
 
@@ -30,13 +42,16 @@ You can fetch the source from
 
 <pre>git clone git://github.com/sdague/thermostat.rb.git</pre>
 
+To send me code updates, fork the tree on github, make your changes,
+then send me a pull request.  That will make it easy for me to
+integrate your patches.
+
 h3. Build and test instructions
 
 <pre>cd thermostat
 rake test
 rake install_gem</pre>
 
-
 h2. License
 
 This code is free to use under the terms of the MIT license. 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thermostat
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sean Dague
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-09 00:00:00 -05:00
+date: 2010-03-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,7 +79,6 @@ files:
 - Rakefile
 - account.yaml.example
 - config/website.yml
-- config/website.yml.sample
 - docs/PDP_API_R1_11.pdf
 - examples/test-fan-off.rb
 - examples/test-fan-on.rb
@@ -94,6 +93,7 @@ files:
 - script/generate
 - script/txt2html
 - test/test_helper.rb
+- test/test_network.rb
 - test/test_oid.rb
 - test/test_thermostat.rb
 - website/index.html
@@ -131,6 +131,7 @@ signing_key:
 specification_version: 3
 summary: Thermostat.rb is an attempt to build an easy to use ruby api around the web services provided by the Proliphix line of network thermostats
 test_files: 
+- test/test_network.rb
 - test/test_thermostat.rb
 - test/test_oid.rb
 - test/test_helper.rb

data/config/website.yml.sample

@@ -1,2 +0,0 @@
-host: unknown@rubyforge.org
-remote_dir: /var/www/gforge-projects/thermostat