saal 0.2.14 → 0.2.21

data/Rakefile

@@ -3,9 +3,10 @@
 require 'rubygems'
 require 'rake'
 require 'date'
+require 'rdoc'
 require 'rcov/rcovtask'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 #############################################################################
 #

data/TODO

@@ -4,11 +4,11 @@ TODO
 !-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)
+- Alternatively try using a different method to integrate values (Kalman filter?)
 - Add logging to the daemon
 ?- Change the sensor configuration to be a ruby DSL and make it a daemon config
 - Split classes into one per file with corresponding test (rails style)
 - Verify inputs on the server to make sure it never crashes
-- Remove the chart configuration options from the saal_chart script
 ?- Remove Sensors and Charts and move their functionality to Sensor and Chart
 - Add an init.d file to the package (and possibly an installer script for ubuntu/debian)
 - Add interface that does retries for reading as well as writing (e.g., dinrelay confirm state change)

data/bin/saal_chart

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
-NUM_VALUES = 500 # Number of datapoints per series in the chart
+
+NUM_VALUES_SMALL = 500 # Datapoints in "small" charts
+NUM_VALUES_LARGE = 150 # Datapoints in "large" charts
+LARGE_CHART_THRESHOLD = 30*24*60*60 # Threshold for a large chart (in seconds)
 
 require File.dirname(__FILE__)+'/../lib/saal.rb'
 
@@ -48,7 +51,11 @@ SAAL::Charts.new.each do |chart|
 
   @periodnames = chart.periodnames
   @numperiods = @periodnames.size
-  @averages = chart.average(NUM_VALUES)
+  num_values = ((chart.to-chart.from)>LARGE_CHART_THRESHOLD) ?
+               NUM_VALUES_LARGE : 
+               NUM_VALUES_SMALL
+
+  @averages = chart.average(num_values)
 
   @data = chart.sensors.map do |sensor|
     normalize_data(@averages[sensor.name.to_sym], *(SENSOR_RANGES[sensor.sensor_type]))
@@ -69,7 +76,7 @@ SAAL::Charts.new.each do |chart|
   r[:chof] = "png"
   r[:chs] = "700x300"
   r[:cht] = "lc"
-  r[:chco] = "00ff00,ff0000,0000ff,ffff00"
+  r[:chco] = "00ff00,ff0000,0000ff,ff9933,800080"
   r[:chxt] = "x,y,y,r"
   r[:chxl] = "0:#{@periodnamesurl}1:|-15ºC||0||15||30||45ºC|2:|0%|25|50|75|100%|3:|950||975||1000||1025||1050 hPa"
   r[:chg] = "#{@xincr},12.5,1,5"

data/bin/saal_chart~

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+NUM_VALUES_SMALL = 500 # Datapoints in "small" charts
+NUM_VALUES_LARGE = 150 # Datapoints in "large" charts
+LARGE_CHART_THRESHOLD = 30*24*60*60 # Threshold for a large chart (in seconds)
+
+require File.dirname(__FILE__)+'/../lib/saal.rb'
+
+def usage
+  $stderr.puts("Usage: saal_chart <chart dir>")
+end
+
+if ARGV.size != 1
+  usage
+  exit (2)
+end
+
+SENSOR_RANGES = {:temperature=>[-15, 45], :humidity=>[0,100], :pressure=>[950,1050]}
+
+
+SAAL::Charts.new.each do |chart|
+  $stderr.puts "Generating chart #{chart.name}"
+
+  pngfile = ARGV[0]+'/chart-'+chart.name.to_s+'.png'
+  ymlfile = ARGV[0]+'/chart-'+chart.name.to_s+'.yml'
+
+  @mins = chart.minimum
+  @maxs = chart.maximum
+  @avgs = chart.average
+  @minmax = {}
+  chart.sensors.each do |s|
+    s = s.name.to_sym
+    @minmax[s] = {:maximum => @maxs[s], :minimum => @mins[s], :average => @avgs[s]}
+  end
+
+  File.open(ymlfile, 'w').write(YAML::dump(@minmax))
+
+  def normalize_data(data, min, max)
+    data.map do |i|
+      if i.nil?
+        -1.0
+      elsif i < min
+        0.0
+      elsif i > max
+        100.0
+      else
+        (((i-min)/(max-min).to_f)*1000).round/10.0
+      end
+    end
+  end
+
+  @periodnames = chart.periodnames
+  @numperiods = @periodnames.size
+  num_values = ((chart.to-chart.from)>LARGE_CHART_THRESHOLD) ?
+               NUM_VALUES_LARGE : 
+               NUM_VALUES_SMALL
+
+  @averages = chart.average(num_values)
+
+  @data = chart.sensors.map do |sensor|
+    normalize_data(@averages[sensor.name.to_sym], *(SENSOR_RANGES[sensor.sensor_type]))
+  end
+
+  @dataurl = @data.map {|values| values.join(",")}.join('|')
+
+  r = {}
+  case chart.alignlabels
+  when :center
+    @periodnamesurl = "||"+@periodnames.join('||')+"||"
+  when :left
+    @periodnamesurl = "|"+@periodnames.join('|')+"||"
+    r[:chxs] = "0,555555,11,-1,lt"
+  end
+  @xincr = 100.0/@numperiods.to_f*10000.truncate.to_f/10000
+
+  r[:chof] = "png"
+  r[:chs] = "700x300"
+  r[:cht] = "lc"
+  r[:chco] = "00ff00,ff0000,0000ff,ffff00,800080"
+  r[:chxt] = "x,y,y,r"
+  r[:chxl] = "0:#{@periodnamesurl}1:|-15ºC||0||15||30||45ºC|2:|0%|25|50|75|100%|3:|950||975||1000||1025||1050 hPa"
+  r[:chg] = "#{@xincr},12.5,1,5"
+  r[:chd] = "t:#{@dataurl}"
+
+  @url = "http://chart.apis.google.com/chart?&"
+  @postdata = r.map{|k,v| k.to_s+"="+v}.join("&")
+
+
+  system "wget --quiet \"#{@url}\" --post-data=\"#{@postdata}\" -O #{pngfile}"
+end

data/lib/chart_data.rb

@@ -51,7 +51,7 @@ module SAAL
 
       case @periods
       when :hours
-        (0...@num).map{|i| ((@now.hour - i)%24).to_s}.reverse
+        (0...@num).map{|i| ((@now.getlocal - i*3600).hour).to_s}.reverse
       when :days
         (1..@num).map{|i| (@now.wday - i)%7}.map{|w| DAYNAMES[w]}.reverse
       when :weeks
@@ -82,7 +82,7 @@ module SAAL
         to = Time.utc(newy, newm, 1, 0, 0, 0)
         # Go back num months for from
         from = dec_months(num, to)
-        # subtract 1 second from two to get the end of current month
+        # subtract 1 second from to to get the end of current month
         to -= 1
       else
         # Calculate by elasped time
@@ -108,7 +108,7 @@ module SAAL
         newm = 12 - (-newm)
         newy -= 1
       end
-      from = Time.utc(newy, newm, time.day, time.hour, time.min, time.sec)
+      Time.utc(newy, newm, time.day, time.hour, time.min, time.sec)
     end
   end
 end

data/lib/dbstore.rb

@@ -1,5 +1,8 @@
 module SAAL
   class DBStore
+    # Only give out last_value if it's less than 5 min old
+    MAX_LAST_VAL_AGE = 5*60 
+
     include Enumerable
     def initialize(conffile=SAAL::DBCONF)
       @dbopts = YAML::load(File.new(conffile))
@@ -11,9 +14,9 @@ module SAAL
       db_query "CREATE TABLE IF NOT EXISTS sensor_reads
                    (sensor VARCHAR(100), 
                     date INT, 
-                    value FLOAT,
-                    INDEX USING HASH (sensor),
-                    INDEX USING BTREE (date))"
+                    value FLOAT) ENGINE=InnoDB"
+      db_query "ALTER TABLE sensor_reads ADD INDEX sensor_date_value (sensor,date,value) USING BTREE",
+               :ignoreerr => 1061
     end
     
     def db_wipe
@@ -38,6 +41,20 @@ module SAAL
     def maximum(sensor, from, to)     
       db_range("MAX", sensor, from, to)
     end
+    def last_value(sensor)
+      db_query "SELECT date,value FROM sensor_reads 
+                  WHERE sensor = '#{db_quote(sensor.to_s)}'
+                  AND date > '#{Time.now.utc.to_i - MAX_LAST_VAL_AGE}'
+                  ORDER BY date DESC LIMIT 1" do |r|
+        if r.num_rows == 0
+          return nil
+        else
+          row = r.fetch_row
+          date, value = [row[0].to_i, row[1].to_f]
+          return value
+        end
+      end
+    end
 
     def each
       db_query "SELECT sensor,date,value FROM sensor_reads" do |r|

data/lib/dinrelay.rb

@@ -55,6 +55,9 @@ module SAAL
       def set_state(num, state)
         @cachetime = nil
         response = do_get("/outlet?#{num}=#{state}")
+        #FIXME: Find a better workaround for dinrelay's crashing when you cycle
+        #       through outlets too fast
+        sleep 1
         response != nil
       end
 

data/lib/saal.rb

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

data/lib/sensor.rb

@@ -11,30 +11,34 @@ module SAAL
   end
 
   class Sensor
-    MAX_READ_TRIES = 5
-
-    attr_reader :name, :description
+    attr_reader :name, :description, :numreads
+    attr_accessor :underlying
     def initialize(dbstore, name, underlying, defs, opts={})
       @dbstore = dbstore
       @name = name
       @underlying = underlying
       @description = defs['name']
       @mock_opts = {}
-      
-      # Reading correction settings
-      @max_value = defs['max_value']
-      @max_correctable = defs['max_correctable']
-      @min_value = defs['min_value']
-      @min_correctable = defs['min_correctable']
-
-      @read_offset = if defs['altitude'] && @underlying.sensor_type == :pressure
-        defs['altitude'].to_f/9.2
+
+      if defs['altitude'] && @underlying.sensor_type == :pressure  
+        @read_offset = defs['altitude'].to_f/9.2
+      elsif defs['linear_offset']
+        @read_offset = defs['linear_offset'].to_f
+      else
+        @read_offset = 0.0
+      end
+
+      if defs['linear_multiplier']
+        @read_multiplier = defs['linear_multiplier'].to_f
       else
-        0.0
+        @read_multiplier = 1.0
       end
 
-      # Outliercache
-      @outliercache = opts[:no_outliercache] ? nil : OutlierCache.new
+      @set_type = defs['type'] ? defs['type'].to_sym : nil
+
+      @numreads = (defs['numreads']||1).to_i
+      @numreads = 1 if @numreads == 0
+      @numreads += 1 if @numreads.even?
     end
 
     def writeable?
@@ -42,22 +46,24 @@ module SAAL
     end
 
     def sensor_type
-      @underlying.sensor_type
+      @set_type || @underlying.sensor_type
     end
 
     def read
-      outlier_proof_read(false)
+      real_read(false)
     end
 
     def read_uncached
-      outlier_proof_read(true)
+      real_read(true)
     end
 
     def write(value)
       if @mock_opts[:value]
         @mock_opts[:value] = value
       else
-        @underlying.write(value)
+        ret = @underlying.write(value)
+        store_value
+        ret
       end
     end 
 
@@ -76,9 +82,14 @@ module SAAL
       apply_offset @dbstore.maximum(@name, from, to)
     end
 
+    def last_value
+      return @mock_opts[:last_value] if @mock_opts[:last_value]
+      apply_offset @dbstore.last_value(@name)
+    end
+
     def store_value
-      value = read_uncached
-      @dbstore.write(@name, Time.now.utc.to_i, value-@read_offset) if value
+      value = real_read(true,false)
+      @dbstore.write(@name, Time.now.utc.to_i, value) if value
     end
 
     def mock_set(opts)
@@ -86,30 +97,20 @@ module SAAL
     end
 
     private
-    def outlier_proof_read(uncached)
+    def real_read(uncached,offset=true)
       return @mock_opts[:value] if @mock_opts[:value]
-      tries = 0
-      value = nil
-      begin
-        tries += 1
-        value = @underlying.read(uncached)
-        break if value && @outliercache && @outliercache.validate(value)
-      end while tries < MAX_READ_TRIES
-      normalize(value)
+      values = (0..@numreads-1).map{@underlying.read(uncached)}
+      #FIXME: If we don't get all values give up and return the first value
+      if not values.all? {|v| v.instance_of?(Float) || v.instance_of?(Integer)}
+        value = values[0]
+      else
+        value = values.sort[@numreads/2]
+      end
+      offset ? apply_offset(value) : value
     end
-
+      
     def apply_offset(v)
-      v ? v+@read_offset : v
-    end
-
-    def normalize(value)
-      apply_offset(if @max_value and value > @max_value
-        (@max_correctable and value <= @max_correctable) ? @max_value : nil
-      elsif @min_value and value < @min_value
-        (@min_correctable and value >= @min_correctable) ? @min_value : nil
-      else
-        value
-      end)
+      v ? v*@read_multiplier+@read_offset : v
     end
   end
 end

data/saal.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.name              = 'saal'
-  s.version           = '0.2.14'
-  s.date              = '2011-06-21'
+  s.version           = '0.2.21'
+  s.date              = '2013-04-14'
 
   s.summary     = "Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)"
   s.description = <<EOF
@@ -28,7 +28,7 @@ EOF
 
   s.executables = Dir.glob("bin/*").map{|f| f.gsub('bin/','')}
 
-  s.add_dependency('ownet', [">= 0.1.0"])
+  s.add_dependency('ownet', [">= 0.2.0"])
   s.add_dependency('nokogiri')
   s.add_dependency('mysql')
 

data/test/chart_data_test.rb

@@ -50,16 +50,36 @@ class TestChartData < Test::Unit::TestCase
   
   # Test all the alignment functions underlying :last, :periods
   def self.assert_alignment_interval(num,periods,from,to, periodnames=nil, 
-                                     now = nil, extra=nil)
+                                     now = nil, extra=nil,timezone=nil)
     define_method("test_alignment_#{num}#{periods}#{extra.to_s}") do
+      ENV['TZ'] = timezone || "UTC"
       now = now || Time.utc(2010, 12, 30, 15, 38, 19)
       o = SAAL::ChartDataRange.new(:last => num, :periods => periods, :now => now)
       assert_equal [from.to_i, to.to_i], [o.from, o.to],
                    "Expecting #{from.utc} - #{to.utc}\n"+
                    "Got #{Time.at(o.from).utc} - #{Time.at(o.to).utc}"
       assert_equal periodnames, o.periodnames if periodnames
+      ENV['TZ'] = "UTC"
     end
   end
+  # Check for correct timezone handling
+  assert_alignment_interval(24, :hours, Time.utc(2010, 12, 29, 16, 0, 0),
+                                        Time.utc(2010, 12, 30, 15, 59, 59),
+                            (17..23).map{|s| s.to_s}+(0..16).map{|s| s.to_s}, 
+                            nil,"_timezone_test","UTC-1")
+  # Check for the timezone changing times (added hour)
+  assert_alignment_interval(24, :hours, Time.utc(2012, 10, 28, 0, 0, 0),
+                                        Time.utc(2012, 10, 28, 23, 59, 59),
+                            ["1"]+(1..23).map{|s| s.to_s}, 
+                            Time.utc(2012, 10, 28, 23, 59, 59),
+                            "_changing_timezone_test","Europe/Lisbon")
+  # Check for the timezone changing times (removed hour)
+  assert_alignment_interval(24, :hours, Time.utc(2012, 3, 25, 0, 0, 0),
+                                        Time.utc(2012, 3, 25, 23, 59, 59),
+                            ["0"]+(2..23).map{|s| s.to_s}+["0"], 
+                            Time.utc(2012, 3, 25, 23, 59, 59),
+                            "_changing_timezone_test","Europe/Lisbon")
+
   assert_alignment_interval(24, :hours, Time.utc(2010, 12, 29, 16, 0, 0),
                                         Time.utc(2010, 12, 30, 15, 59, 59),
                             (16..23).map{|s| s.to_s}+(0..15).map{|s| s.to_s})

data/test/dbstore_test.rb

@@ -67,4 +67,24 @@ class TestFileStore < Test::Unit::TestCase
     assert_equal [["test_sensor", test_time, test_value]]*n,
                  @dbstore.map{|sensor,time,value| [sensor,time,value]}   
   end
+
+  def test_last_value
+    db_setup
+    now = Time.now.utc.to_i
+    test_values = [[now-10, 105.0],[now-5, 95.0],[now-2, 100.0],[now, 100.5]]
+    test_values.each do |values|
+      @dbstore.write(:test_sensor, *values)
+    end
+    assert_equal 100.5, @dbstore.last_value(:test_sensor)
+  end
+
+  def test_last_value_stale
+    db_setup
+    now = Time.now.utc.to_i - SAAL::DBStore::MAX_LAST_VAL_AGE - 100
+    test_values = [[now-10, 105.0],[now-5, 95.0],[now-2, 100.0],[now, 100.5]]
+    test_values.each do |values|
+      @dbstore.write(:test_sensor, *values)
+    end
+    assert_equal nil, @dbstore.last_value(:test_sensor)
+  end
 end

data/test/dinrelay_test.rb

@@ -3,8 +3,25 @@ require 'webrick'
 require 'benchmark'
 
 class TestDINRelay < Test::Unit::TestCase
-  SERVICE_OPTS = {:host => 'localhost', :port => 33333, 
-                  :user => "someuser", :pass =>"somepass"}
+  def setup
+    @@serv_num ||= 0
+    @@serv_num += 1
+
+    @og=SAAL::DINRelay::OutletGroup.new(service_opts)
+    @vals={1=>"OFF",2=>"OFF",3=>"ON",4=>"OFF",5=>"ON",6=>"ON",7=>"ON",8=>"OFF"}
+    @rvals={1=>"ON",2=>"ON",3=>"OFF",4=>"ON",5=>"OFF",6=>"OFF",7=>"OFF",8=>"ON"}
+
+    defs = YAML::load(File.new(TEST_SENSORS_DINRELAY_FILE))
+    defs['group1']['dinrelay']['port'] = service_opts[:port]
+    tempfile = Tempfile.new('dinrelay_test_yml')
+    File.open(tempfile.path,'w') {|f| f.write(YAML::dump defs)}
+    @test_sensors_dinrelay_file = tempfile.path
+  end
+
+  def service_opts
+    base_opts = {:host => 'localhost', :user => "someuser", :pass =>"somepass"}
+    base_opts.merge(:port => 3333+@@serv_num)
+  end
 
   class BasicServing < WEBrick::HTTPServlet::AbstractServlet
     def self.get_instance(config, opts)
@@ -20,6 +37,8 @@ class TestDINRelay < Test::Unit::TestCase
     end
     def do_GET(req, res)
       sleep @sleep
+      @feedback[:uris] ||= []
+      @feedback[:uris] << req.request_uri.to_s
       @feedback[:uri] = req.request_uri.to_s
       @feedback[:nrequests] = (@feedback[:nrequests]||0)+1
       WEBrick::HTTPAuth.basic_auth(req, res, "My Realm") {|user, pass|
@@ -32,7 +51,7 @@ class TestDINRelay < Test::Unit::TestCase
   end
 
   def with_webrick(opts)
-    opts = SERVICE_OPTS.merge(opts)
+    opts = service_opts.merge(opts)  
 
     Socket.do_not_reverse_lookup = true # Speed up startup
     log = WEBrick::Log.new($stderr, WEBrick::Log::ERROR)
@@ -57,14 +76,8 @@ class TestDINRelay < Test::Unit::TestCase
     erb.result(binding)
   end
 
-  def setup
-    @og=SAAL::DINRelay::OutletGroup.new(SERVICE_OPTS)
-    @vals={1=>"OFF",2=>"OFF",3=>"ON",4=>"OFF",5=>"ON",6=>"ON",7=>"ON",8=>"OFF"}
-    @rvals={1=>"ON",2=>"ON",3=>"OFF",4=>"ON",5=>"OFF",6=>"OFF",7=>"OFF",8=>"ON"}
-  end
-
   def assert_path(path, uri)
-    assert_equal "http://localhost:#{SERVICE_OPTS[:port]}"+path, uri
+    assert_equal "http://localhost:#{service_opts[:port]}"+path, uri
   end
 
   def test_read_state
@@ -87,7 +100,7 @@ class TestDINRelay < Test::Unit::TestCase
   end
 
   def test_enumerate_sensors
-    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    sensors = SAAL::Sensors.new(@test_sensors_dinrelay_file, TEST_DBCONF)
     assert_equal((1..8).map{|i| "name#{i}"}, sensors.map{|s| s.name}.sort)
     assert_equal((1..8).map{|i| "description#{i}"}, sensors.map{|s| s.description}.sort)
   end
@@ -99,7 +112,7 @@ class TestDINRelay < Test::Unit::TestCase
   end
 
   def test_read_sensors
-    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    sensors = SAAL::Sensors.new(@test_sensors_dinrelay_file, TEST_DBCONF)
     with_webrick(:html=>create_index_html(@vals)) do |feedback|
       @vals.each do |num, state|
         value = state == "ON" ? 1.0 : 0.0
@@ -111,21 +124,22 @@ class TestDINRelay < Test::Unit::TestCase
   end
 
   def test_set_sensors
-    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    sensors = SAAL::Sensors.new(@test_sensors_dinrelay_file, TEST_DBCONF)
     with_webrick(:html=>create_index_html(@rvals)) do |feedback|
       @vals.each do |num, state|
         newval = state == "ON" ? 0.0 : 1.0
         newstate = state == "ON" ? "OFF" : "ON"
         assert_equal newval, sensors.send('name'+num.to_s).write(newval), 
                      "State change not working"
-        assert_path "/outlet?#{num}=#{newstate}", feedback[:uri]
+        assert_path "/outlet?#{num}=#{newstate}", feedback[:uris][-2]
+        assert_path "/index.htm", feedback[:uris][-1]
       end
     end
   end
 
   # Test that write invalidates any caching
   def test_write_read_sensors
-    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    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)
@@ -137,7 +151,7 @@ class TestDINRelay < Test::Unit::TestCase
 
   # Test that the cache times out
   def test_cache_invalidation
-    sensors = SAAL::Sensors.new(TEST_SENSORS_DINRELAY_FILE, TEST_DBCONF)
+    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)
@@ -165,7 +179,7 @@ class TestDINRelay < Test::Unit::TestCase
 
   def test_fast_open_timeout
     #FIXME: Find a way to make this test address more generic
-    @og=SAAL::DINRelay::OutletGroup.new(SERVICE_OPTS.merge(:host => "10.254.254.254", 
+    @og=SAAL::DINRelay::OutletGroup.new(service_opts.merge(:host => "10.254.254.254", 
                                                            :timeout=>0.1))
     with_webrick(:html=>create_index_html(@vals)) do |feedback|
       time = Benchmark.measure do
@@ -181,7 +195,7 @@ class TestDINRelay < Test::Unit::TestCase
   end
 
   def test_fast_read_timeout
-    @og=SAAL::DINRelay::OutletGroup.new(SERVICE_OPTS.merge(:timeout=>0.1))
+    @og=SAAL::DINRelay::OutletGroup.new(service_opts.merge(:timeout=>0.1))
     with_webrick(:html=>create_index_html(@vals),:sleep=>10) do |feedback|
       time = Benchmark.measure do
         @vals.each do |num, state|

data/test/sensor_test.rb

@@ -1,13 +1,29 @@
 require File.dirname(__FILE__)+'/test_helper.rb'
 
 class MockConnection
-  attr_accessor :value, :values
+  attr_accessor :value, :values, :stored_value
   def initialize
     @value = @values = nil
   end
   def read(serial)
     @value ? @value : @values.shift 
   end
+  def write(serial, value)
+    @stored_value = value
+  end
+end
+
+class MockOWUnderlying
+  attr_accessor :value
+  def initialize(opts={})
+    @value = opts[:value]
+  end
+  def read(cached)
+    @value
+  end
+  def write(value)
+    @value = value
+  end
 end
 
 class MockDBStore
@@ -21,6 +37,9 @@ class MockDBStore
   def maximum(sensor, from, to)
     @value
   end
+  def last_value(sensor)
+    @value
+  end
   def write(sensor,date,value)
     @stored_value = value
   end
@@ -36,78 +55,51 @@ class TestSensor < Test::Unit::TestCase
     @defs = YAML::load File.new(TEST_SENSOR_CLEANUPS_FILE)
     @conn = MockConnection.new
     @dbstore = MockDBStore.new
-    @fake = fake_sensor('fake', :no_outliercache => true)
-    @fake2 = fake_sensor('fake2', :no_outliercache => true)
-    @fake3 = fake_sensor('fake3')
-    @max_value = @defs['fake2']['max_value']
-    @max_correctable = @defs['fake2']['max_correctable']
-    @min_value = @defs['fake2']['min_value']
-    @min_correctable = @defs['fake2']['min_correctable']
-  end
-
-  def test_read_too_high_values
-    @conn.value = @max_value+1
-    assert_nil @fake.read
-    assert_nil @fake.read_uncached
-    @conn.value = @max_value
-    assert_equal @max_value, @fake.read
-    assert_equal @max_value, @fake.read_uncached
+    @fake = fake_sensor('fake')
   end
 
-  def test_read_too_high_but_correctable_values
-    @conn.value = @max_correctable
-    assert_equal @max_value, @fake2.read
-    assert_equal @max_value, @fake2.read_uncached
-    @conn.value = @max_correctable+1
-    assert_nil @fake2.read
-    assert_nil @fake2.read_uncached
+  def test_last_value
+    @dbstore.value = 55.3
+    assert_equal 55.3, @fake.last_value
   end
 
-  def test_read_too_low_values
-    @conn.value = @min_value-1
-    assert_nil @fake.read
-    assert_nil @fake.read_uncached
-    @conn.value = @min_value
-    assert_equal @min_value, @fake.read
-    assert_equal @min_value, @fake.read_uncached
+  def test_write_causes_store
+    @fake.underlying = MockOWUnderlying.new(:value => 5)
+    assert_equal 5, @fake.read
+    @fake.write(10)
+    assert_equal 10, @dbstore.stored_value
+    assert_equal 10, @fake.underlying.value
   end
 
-  def test_read_too_low_but_correctable_values
-    @conn.value = @min_correctable
-    assert_equal @min_value, @fake2.read
-    assert_equal @min_value, @fake2.read_uncached
-    @conn.value = @min_correctable-1
-    assert_nil @fake2.read
-    assert_nil @fake2.read_uncached
+  def test_numreads
+    sensor = fake_sensor('fake5')
+    assert_equal 1, sensor.numreads
+    sensor = fake_sensor('fake4')
+    assert_equal 5, sensor.numreads
   end
 
-  def test_read_without_limits
-    @conn.value = 200
-    assert_equal 200, @fake3.read
-    assert_equal 200, @fake3.read_uncached
+  def test_no_outlier_removal
+    sensor = fake_sensor('fake')
+    @conn.values = [1000.0,1.0,1.0,1.0,1.0]
+    assert_equal 1000.0, sensor.read
   end
 
-  def test_eliminate_outliers
-    @conn.values = [200]*20 + [1000,200]
-    assert_equal [200]*21, (1..21).map{@fake3.read}
-    @conn.values = [200]*20 + [1000,200,1000,200]
-    assert_equal [200]*21, (1..21).map{@fake3.read_uncached}
+  def test_single_outlier_removal
+    sensor = fake_sensor('fake2')
+    @conn.values = [1000.0,1.0,1.0,1.0,1.0]
+    assert_equal 1.0, sensor.read
   end
 
-  def test_eliminate_outliers_zeroes
-    @conn.values = [0]*20 + [1000,0]
-    assert_equal [0]*20+[1000], (1..21).map{@fake3.read}
-    @conn.values = [0]*20 + [1000,0]
-    assert_equal [0]*20+[1000], (1..21).map{@fake3.read_uncached}
+  def test_double_outlier_removal
+    sensor = fake_sensor('fake3')
+    @conn.values = [1000.0,1000.0,1.0,1.0,1.0]
+    assert_equal 1.0, sensor.read
   end
 
-  def test_eliminate_outliers
-    correctread = 994.422
-    fakeread = 817.309
-    @conn.values = [correctread]*20 + [fakeread,correctread]
-    assert_equal [correctread]*21, (1..21).map{@fake3.read}
-    @conn.values = [correctread]*20 + [fakeread,correctread]
-    assert_equal [correctread]*21, (1..21).map{@fake3.read_uncached}
+  def test_outlier_removal_with_nils
+    sensor = fake_sensor('fake')
+    @conn.values = [1000.0,nil,1.0]
+    assert_equal 1000.0, sensor.read
   end
 
   def test_sealevel_correction
@@ -122,24 +114,42 @@ class TestSensor < Test::Unit::TestCase
     assert_equal corrected, sensor.average(0,100)
   end
 
+  def test_linear_correction
+    sensor = fake_sensor('offset')
+    @conn.value = @dbstore.value = 1000
+    corrected = @defs['offset']['linear_multiplier'].to_f*1000+
+                @defs['offset']['linear_offset'].to_f
+    assert_equal corrected, sensor.read
+    sensor.store_value
+    assert_equal 1000, @dbstore.stored_value
+    assert_equal corrected, sensor.minimum(0,100)
+    assert_equal corrected, sensor.maximum(0,100)
+    assert_equal corrected, sensor.average(0,100)
+  end
+
   def test_sensor_type
     [:pressure, :humidity, :temperature].each do |type|
       assert_equal type, fake_sensor(type.to_s).sensor_type
     end
   end
 
+  def test_set_sensor_type
+    assert_equal :temperature, fake_sensor("temperature_forced").sensor_type
+  end
+
   def test_mocked
-    @mockable = fake_sensor('fake3')
+    @mockable = fake_sensor('fake')
     @conn.value = 1.0
     assert_equal 1.0, @mockable.read
     @mockable.mock_set(:value => 2.0)
     assert_equal 2.0, @mockable.read
     @mockable.write(3.0)
     assert_equal 3.0, @mockable.read
-    @mockable.mock_set(:minimum => 1.0, :average => 2.0, :maximum => 3.0)
+    @mockable.mock_set(:minimum => 1.0, :average => 2.0, :maximum => 3.0, :last_value => 5.0)
     assert_equal 1.0, @mockable.minimum(0,100)
     assert_equal 2.0, @mockable.average(0,100)
     assert_equal 3.0, @mockable.maximum(0,100)
+    assert_equal 5.0, @mockable.last_value
     assert_equal 3.0, @mockable.read
   end
 end

data/test/sensors_test.rb

@@ -31,7 +31,7 @@ class TestSensors < Test::Unit::TestCase
     
   def test_each
     expected = @defs.map{ |name, value| value['name']}
-    assert_equal expected, @sensors.map {|sensor| sensor.description}
+    assert_equal expected.sort, @sensors.map {|sensor| sensor.description}.sort
   end
 
   def test_writeable

data/test/test_db.yml

@@ -1,4 +1,4 @@
 host: localhost
 user: sensor_reads
-pass: abcd
+pass: password
 db: sensor_reads_test

data/test/test_sensor_cleanups.yml

@@ -1,24 +1,39 @@
 fake:
   name: "A fake temperature sensor"
-  max_value: 500
-  min_value: 100
   onewire: 
     serial: /10.4AEC29CDBAAB/temperature
 
 fake2:
   name: "A fake temperature sensor"
-  max_value: 500
-  max_correctable: 550
-  min_value: 100
-  min_correctable: 50
+  numreads: 3
   onewire: 
     serial: /10.4AEC29CDBAAB/temperature
 
 fake3:
   name: "A fake temperature sensor"
+  numreads: 5
   onewire: 
     serial: /10.4AEC29CDBAAB/temperature
 
+fake4:
+  name: "A fake temperature sensor"
+  numreads: 4
+  onewire: 
+    serial: /10.4AEC29CDBAAB/temperature
+
+fake5:
+  name: "A fake temperature sensor"
+  numreads: 0
+  onewire: 
+    serial: /10.4AEC29CDBAAB/temperature
+
+offset:
+  name: "A fake linear offset sensor"
+  linear_multiplier: 2
+  linear_offset: 100
+  onewire: 
+    serial: /10.4AEC29CDBAAB/pressure
+
 pressure:
   name: "A fake pressure sensor"
   altitude: 200
@@ -33,5 +48,11 @@ humidity:
   onewire: 
     serial: /10.4AEC29CDBAAB/humidity
 
+temperature_forced:
+  name: "A fake temperature sensor"
+  type: temperature
+  onewire: 
+    serial: /10.4AEC29CDBAAB/nondescript
+
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saal
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
+  hash: 61
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 14
-  version: 0.2.14
+  - 21
+  version: 0.2.21
 platform: ruby
 authors: 
 - "Pedro C\xC3\xB4rte-Real"
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-21 00:00:00 +01:00
-default_executable: 
+date: 2013-04-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ownet
@@ -26,12 +25,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 23
         segments: 
         - 0
-        - 1
+        - 2
         - 0
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -69,13 +68,14 @@ description: |
 
 email: pedro@pedrocr.net
 executables: 
+- saal_chart~
+- dinrelaystatus
 - saal_readall
 - saal_dump_database
-- dinrelayset
-- dinrelaystatus
-- saal_import_mysql
 - saal_daemon
 - saal_chart
+- dinrelayset
+- saal_import_mysql
 extensions: []
 
 extra_rdoc_files: 
@@ -123,7 +123,7 @@ files:
 - test/test_helper.rb
 - test/test_sensor_cleanups.yml
 - test/test_sensors.yml
-has_rdoc: true
+- bin/saal_chart~
 homepage: https://github.com/pedrocr/saal
 licenses: []
 
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 2
 summary: Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)