saal 0.2.13 → 0.2.14

data/README.rdoc

@@ -1,13 +1,13 @@
 = saal
 
-saal stands for Sensor and Actuator Abstraction Layer, and it aims to handle the mechanics of accessing sensors and actuators and logging their state over time. In its present state it is capable of reading from any set of one wire sensors attached one or more owserver processes from the owfs project. In the future other forms of sensors as well as actuators can be added.
+saal stands for Sensor and Actuator Abstraction Layer, and it aims to handle the mechanics of accessing sensors and actuators and logging their state over time. In its present state it is capable of reading from any set of one wire sensors attached one or more owserver processes from the owfs project. It is also able to read and actuate the DIN mounted IP relay from digital loggers (http://www.digital-loggers.com/din.html). In the future other forms of sensors as well as actuators can be added.
 
-Based on a single definition of available sensors several features are available:
+Based on a single definition of available sensors/actuators several features are available:
 
-* An API to read from the sensors
+* An API to read/write to sensors/actuators
 * A daemon that periodically records all sensor values into a MySQL database
 * An API to interrogate the database of recorded values
-* A graphing API and example code to produce ongoing displays of the sensor reads
+* A graphing API and full program to produce charts from the stored sensor reads
 
 An example of the usage of saal can be seen at http://www.corujas.net.
 
@@ -60,16 +60,37 @@ Both arguments to average are unix timestamps in UTC timezone.
 
 == Charting
 
-SAAL::ChartData provides some helper methods to produce a time series of values for a sensor where each point is the average of the sensor reads for the interval:
+After you've gotten sensor logging working and some values in the database you can start creating charts based on it. Here's an example /etc/saal/charts.yml file:
 
-  saal = SAAL::Sensors.new
-  chart = SAAL::ChartData.new(saal.fake_temp)
-  now = Time.now.utc.to_i
-  # Average fake_temp over the last 10 minutes divided in 4 intervals
-  chart.get_data(now - 60*10, now, 4) 
-  #=> [19.1555206999183, 28.3404493331909, 56.4694658915202, 50.4347496032715]
+  day:
+    sensors: [temp_exterior, hum_exterior, pressure]
+    last: 24
+    periods: hours
 
-See saal_chart for an example of creating chart images over several time spans including serveral sensors using Google's chart API.
+  week:
+    sensors: [temp_exterior, hum_exterior, pressure]
+    last: 7
+    periods: days
+
+  4week:
+    sensors: [temp_exterior, hum_exterior, pressure]
+    last: 4
+    periods: weeks
+    alignlabels: left
+
+  year:
+    sensors: [temp_exterior, hum_exterior, pressure]
+    last: 12
+    periods: months
+
+  4year:
+    sensors: [temp_exterior, hum_exterior, pressure]
+    last: 4
+    periods: years
+
+With this in place you can now run "saal_chart <some_directory>" and get 5 png files produced with the Google charts API that show the data recorded in the database over the given periods. This is almost exactly the config that generates the graphs at http://www.corujas.net.
+
+The charting code handles range selection and period naming automatically, so all possibilities of number and type of periods are possible.
 
 == Author
 

data/TODO

@@ -1,5 +1,6 @@
 TODO
-- Make the sensor storage in saal_daemon threaded so a single sensor read can't stall everything else for a long time
+- Only enable the outlier proofing for the daemon so things like saal_readall don't block for a long time on unavailable sensors trying to seed the outlier cache
+- Make the sensor value storage in saal_daemon threaded so a single sensor read can't stall everything else for a long time
 !-Index the value column of the sensor reads for minimum and maximum
 - Change the filtering operations (e.g., outliercache) so that the raw value is always stored in the database
 - Make the outliercache filter based on the expected sensor range (e.g. -20-50 in temperature and 800-1200 in pressure) so as to not be overly sensitive when around 0)

data/lib/dinrelay.rb

@@ -29,23 +29,31 @@ module SAAL
 
     class OutletGroup
       DEFAULT_TIMEOUT = 2
+      DEFAULT_CACHE_TIMEOUT = 60
 
-      attr_reader :timeout
+      attr_accessor :host, :port, :user, :pass, :timeout, :cache_timeout
 
       def initialize(opts={})
         @host = opts[:host] || opts['host'] || 'localhost'
         @port = opts[:port] || opts['port'] || 80
         @user = opts[:user] || opts['user'] || 'admin'
         @pass = opts[:pass] || opts['pass'] || '1234'
-        @timeout = opts[:timeout] || DEFAULT_TIMEOUT
+        @timeout = opts[:timeout] || opts['timeout'] || DEFAULT_TIMEOUT
+        @cache_timeout = opts[:cache_timeout] || opts['cache_timeout'] || DEFAULT_CACHE_TIMEOUT
+        @cache = nil
+        @cachehit = nil
       end
 
       def state(num)
-        response = do_get('/index.htm')
-        return response ? parse_index_html(response.body)[num] : nil
+        if !@cachetime or @cachetime < Time.now - @cache_timeout
+          @cache = do_get('/index.htm')
+          @cachetime = Time.now
+        end
+        return @cache ? parse_index_html(@cache.body)[num] : nil
       end
 
       def set_state(num, state)
+        @cachetime = nil
         response = do_get("/outlet?#{num}=#{state}")
         response != nil
       end

data/lib/saal.rb

@@ -10,7 +10,7 @@ module SAAL
     DBCONF = CONFDIR+"database.yml"
     CHARTSCONF = CONFDIR+"charts.yml"
 
-    VERSION = '0.2.13'
+    VERSION = '0.2.14'
 end
 
 require File.dirname(__FILE__)+'/dbstore.rb'

data/saal.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.name              = 'saal'
-  s.version           = '0.2.13'
-  s.date              = '2011-06-03'
+  s.version           = '0.2.14'
+  s.date              = '2011-06-21'
 
   s.summary     = "Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)"
   s.description = <<EOF

data/test/dinrelay_test.rb

@@ -21,6 +21,7 @@ class TestDINRelay < Test::Unit::TestCase
     def do_GET(req, res)
       sleep @sleep
       @feedback[:uri] = req.request_uri.to_s
+      @feedback[:nrequests] = (@feedback[:nrequests]||0)+1
       WEBrick::HTTPAuth.basic_auth(req, res, "My Realm") {|user, pass|
         user == @user && pass == @pass
       }
@@ -105,6 +106,7 @@ class TestDINRelay < Test::Unit::TestCase
         assert_equal value, sensors.send('name'+num.to_s).read
         assert_path '/index.htm', feedback[:uri]
       end
+      assert_equal 1, feedback[:nrequests], "dinrelay request caching not working"
     end
   end
 
@@ -121,6 +123,30 @@ class TestDINRelay < Test::Unit::TestCase
     end
   end
 
+  # Test that write invalidates any caching
+  def test_write_read_sensors
+    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    with_webrick(:html=>create_index_html(@vals)) do |feedback|
+      @vals.each do |num, state|
+        sensors.send('name'+num.to_s).write(0.0)
+        sensors.send('name'+num.to_s).read
+      end
+      assert_equal 16, feedback[:nrequests], "dinrelay caching too much"
+    end
+  end
+
+  # Test that the cache times out
+  def test_cache_invalidation
+    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    @og.cache_timeout = 0.1
+    with_webrick(:html=>create_index_html(@vals)) do |feedback|
+      @og.state(1)
+      sleep 0.2
+      @og.state(1)
+      assert_equal 2, feedback[:nrequests], "dinrelay caching not invalidating"
+    end
+  end
+
   def test_failed_connection
     @vals.each do |num, state|
       assert_equal nil, @og.state(num)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saal
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 2
-  - 13
-  version: 0.2.13
+  - 14
+  version: 0.2.14
 platform: ruby
 authors: 
 - "Pedro C\xC3\xB4rte-Real"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 -07:00
+date: 2011-06-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency