saal 0.2.2

data/lib/outliercache.rb

@@ -0,0 +1,53 @@
+module SAAL
+  class OutlierCache
+    # By feeding values into this cache the outliers are identified. The cache
+    # is conservative and only flags down values that it is sure are outliers.
+    # The cache considers itself "live" when the values in the cache are all
+    # within a few percent of each other and will then flag down outliers. When
+    # the cache is not live all values will be considered good.
+
+    COMP_CACHE_SIZE = 11 # Should be even so the median is well calculated
+
+    # These are conservative settings that can be made stricted if the cache is
+    # not rejecting enough values or is often not "live"
+    # Sets how close the central values have to be for the cache to be "live"
+    MAX_CACHE_DEVIATION = 0.05
+    # Sets how off the read value can be from the cache median to be accepted
+    MAX_VALUE_DEVIATION = 0.25
+
+    def initialize
+      @compcache = []
+    end
+
+    def live
+      @compcache.size == COMP_CACHE_SIZE && valid_cache
+    end
+
+    def validate(value)
+      ret = compare_with_cache(value)
+      @compcache.shift if @compcache.size == COMP_CACHE_SIZE
+      @compcache.push value
+      ret
+    end
+
+    private
+    def compare_with_cache(value)
+      return true if !live
+      @compcache.sort!
+      median = @compcache[COMP_CACHE_SIZE/2]
+      (value.to_f/median.to_f - 1.0).abs < MAX_VALUE_DEVIATION 
+    end
+
+    def valid_cache
+      @compcache.sort!
+      central = @compcache[1..(@compcache.size-2)]
+      sum = central.inject(0.0){|sum,el| sum+el}
+      return false if sum == 0.0
+      average = sum/central.size
+      central.each do |el|
+        return false if (el.to_f/average.to_f - 1.0).abs > MAX_CACHE_DEVIATION
+      end
+      true
+    end
+  end
+end

data/lib/owsensor.rb

@@ -0,0 +1,21 @@
+module SAAL
+  class OWSensor < SensorUnderlying
+    attr_reader :serial
+    def initialize(defs, opts={})
+      @serial = defs['serial']
+      @connect_opts = {}
+      @connect_opts[:server] = defs['server'] if defs['server']
+      @connect_opts[:port] = defs['port'] if defs['port']
+      @owconn = opts[:owconn]
+    end
+
+    def read(uncached = false)
+      @owconn ||= OWNet::Connection.new(@connect_opts)
+      begin
+        @owconn.read((uncached ? '/uncached' : '')+@serial)
+      rescue Exception
+        nil
+      end
+    end
+  end
+end

data/lib/saal.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+require "mysql"
+require 'ownet'
+require 'nokogiri'
+require 'erb'
+
+module SAAL
+    CONFDIR = "/etc/saal/"
+    SENSORSCONF = CONFDIR+"sensors.yml"
+    DBCONF = CONFDIR+"database.yml"
+
+    VERSION = '0.2.2'
+end
+
+require File.dirname(__FILE__)+'/dbstore.rb'
+require File.dirname(__FILE__)+'/sensors.rb'
+require File.dirname(__FILE__)+'/sensor.rb'
+require File.dirname(__FILE__)+'/owsensor.rb'
+require File.dirname(__FILE__)+'/daemon.rb'
+require File.dirname(__FILE__)+'/chart_data.rb'
+require File.dirname(__FILE__)+'/outliercache.rb'
+require File.dirname(__FILE__)+'/dinrelay.rb'
+  

data/lib/sensor.rb

@@ -0,0 +1,100 @@
+module SAAL  
+  class UnimplementedMethod < RuntimeError
+  end
+
+  class SensorUnderlying
+    def writeable?; false; end
+    def self.writeable! 
+      define_method(:writeable?){true}
+    end
+  end
+
+  class Sensor
+    MAX_READ_TRIES = 5
+
+    attr_reader :name, :description
+    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']
+
+      # Outliercache
+      @outliercache = opts[:no_outliercache] ? nil : OutlierCache.new
+    end  
+
+    def writeable?
+      @underlying.writeable?
+    end
+
+    def read
+      outlier_proof_read(false)
+    end
+
+    def read_uncached
+      outlier_proof_read(true)
+    end
+
+    def write(value)
+      if @mock_opts[:value]
+        @mock_opts[:value] = value
+      else
+        @underlying.write(value)
+      end
+    end 
+
+    def average(from, to)
+      return @mock_opts[:average] if @mock_opts[:average]
+      @dbstore.average(@name, from, to)
+    end
+
+    def minimum(from, to)
+      return @mock_opts[:minimum] if @mock_opts[:minimum]
+      @dbstore.minimum(@name, from, to)
+    end
+
+    def maximum(from, to)
+      return @mock_opts[:maximum] if @mock_opts[:maximum]
+      @dbstore.maximum(@name, from, to)
+    end
+
+    def store_value
+      value = read_uncached
+      @dbstore.write(@name, Time.now.utc.to_i, value) if value
+    end
+
+    def mock_set(opts)
+      @mock_opts.merge!(opts)
+    end
+
+    private
+    def outlier_proof_read(uncached)
+      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)
+    end
+
+    def normalize(value)
+      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
+    end
+  end
+end

data/lib/sensors.rb

@@ -0,0 +1,48 @@
+module SAAL
+  class UnknownSensorType < RuntimeError
+  end
+
+  class Sensors
+    include Enumerable
+    
+    def initialize(conffile=SAAL::SENSORSCONF, dbconffile=SAAL::DBCONF)
+      @defs = YAML::load(File.new(conffile))
+      @dbstore = DBStore.new(dbconffile)
+      @sensors =  {}
+      @defs.each do |name, defs|
+        self.class.sensors_from_defs(@dbstore, name, defs).each{|s| @sensors[s.name] = s}
+      end 
+      
+    end
+        
+    # Implements the get methods to fetch a specific sensor
+    def method_missing(name, *args)
+      name = name.to_s
+      if args.size == 0 && @sensors.include?(name)
+        @sensors[name]
+      else
+        raise NoMethodError, "undefined method \"#{name}\" for #{self}"
+      end
+    end
+    
+    def each
+      @sensors.each{|name, sensor| yield sensor}
+    end
+
+    def self.sensors_from_defs(dbstore, name, defs, opts={})
+      if defs['onewire']
+        return [Sensor.new(dbstore, name, OWSensor.new(defs['onewire'], opts), 
+                           defs, opts)]
+      elsif defs['dinrelay']
+        og = DINRelay::OutletGroup.new(defs['dinrelay'])
+        outlet_names = defs['dinrelay']['outlets'] || []
+        return outlet_names.map do |num, oname|
+          Sensor.new(dbstore, oname, DINRelay::Outlet.new(num.to_i, og), defs, opts)
+        end
+      else
+        raise UnknownSensorType, "Couldn't figure out a valid sensor type "
+                                 "from the configuration for #{name}"
+      end
+    end
+  end
+end

data/saal.gemspec

@@ -0,0 +1,77 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.platform = Gem::Platform::RUBY
+
+  s.name              = 'saal'
+  s.version           = '0.2.2'
+  s.date              = '2010-12-29'
+
+  s.summary     = "Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)"
+  s.description = <<EOF
+A daemon and libraries to create an abstraction layer that interfaces with 
+sensors and actuators, recording their state, responding to requests 
+for current and historical values, and allowing changes of state.
+EOF
+
+  s.authors  = ["Pedro Côrte-Real"]
+  s.email    = 'pedro@pedrocr.net'
+  s.homepage = 'https://github.com/pedrocr/saal'
+
+  s.require_paths = %w[lib]
+
+  s.has_rdoc = true
+  s.rdoc_options = ['-S', '-w 2', '-N', '-c utf8']
+  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+
+  s.executables = Dir.glob("bin/*").map{|f| f.gsub('bin/','')}
+
+  s.add_dependency('ownet', [">= 0.1.0"])
+  s.add_dependency('nokogiri')
+  s.add_dependency('mysql')
+
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.rdoc
+    Rakefile
+    TODO
+    bin/.gitignore
+    bin/dinrelayset
+    bin/dinrelaystatus
+    bin/saal_chart
+    bin/saal_daemon
+    bin/saal_dump_database
+    bin/saal_import_mysql
+    bin/saal_readall
+    lib/chart_data.rb
+    lib/daemon.rb
+    lib/dbstore.rb
+    lib/dinrelay.rb
+    lib/outliercache.rb
+    lib/owsensor.rb
+    lib/saal.rb
+    lib/sensor.rb
+    lib/sensors.rb
+    saal.gemspec
+    test/chart_data_test.rb
+    test/daemon_test.rb
+    test/dbstore_test.rb
+    test/dinrelay.html.erb
+    test/dinrelay_test.rb
+    test/nonexistant_sensor.yml
+    test/outliercache_test.rb
+    test/sensor_test.rb
+    test/sensors_test.rb
+    test/test_db.yml
+    test/test_dinrelay_sensors.yml
+    test/test_helper.rb
+    test/test_sensor_cleanups.yml
+    test/test_sensors.yml
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/.*\.rb/ }
+end

data/test/chart_data_test.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'time'
+
+MOCK_AVERAGES = [40.001,30.002,nil,60.004,300.005]
+MOCK_MAX = 215.3
+MOCK_MIN = 35.2
+NORMALIZED_MOCK_AVERAGES = [2.7,0.0,-1.0,13.8,100.0]
+
+class MockSensor
+  attr_reader :asked_averages
+  def initialize
+    @averages = MOCK_AVERAGES.dup
+    @asked_averages = []
+  end
+  def average(from, to) 
+    @asked_averages << [from,to]; 
+    @averages.shift
+  end
+end
+
+class TestChartData < Test::Unit::TestCase
+  def test_get_data
+    sensor = MockSensor.new
+    c = SAAL::ChartData.new(sensor)
+    assert_equal MOCK_AVERAGES, c.get_data(0, 1000, 5)
+    assert_equal([[0,199],[200,399],[400,599],[600,799],[800,1000]],
+                 sensor.asked_averages)
+  end
+  
+  def test_normalize_data
+    sensor = MockSensor.new
+    c = SAAL::ChartData.new(sensor)
+    d = c.get_data(0, 1000, 5)
+    assert_equal NORMALIZED_MOCK_AVERAGES, 
+                 c.normalize_data(d, MOCK_MIN, MOCK_MAX)
+    assert_equal([[0,199],[200,399],[400,599],[600,799],[800,1000]],
+                 sensor.asked_averages)    
+  end
+end

data/test/daemon_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'time'
+
+class TestDaemon < Test::Unit::TestCase
+  def test_working_daemon
+    db_setup
+    nsecs = 0.5
+    interval = 0.00001
+    with_fake_owserver do
+      d = SAAL::Daemon.new(:keep_stdin => true,
+                           :interval => interval, 
+                           :dbconf => TEST_DBCONF, 
+                           :sensorconf => TEST_SENSORS_FILE)
+      pid = d.run
+      sleep nsecs # Potential timing bug when the system is under load
+      Process.kill("TERM", pid)
+      Process.waitpid(pid)
+    end
+
+    db_test_query("SELECT * FROM sensor_reads") do |res|
+      assert res.num_rows > 0, "No sensor reads in DB"
+    end
+  end
+
+  def test_empty_reads_daemon
+    db_setup
+    nsecs = 0.5
+    interval = 0.00001
+    with_fake_owserver do
+      d = SAAL::Daemon.new(:keep_stdin => true,
+                           :interval => interval, 
+                           :dbconf => TEST_DBCONF, 
+                           :sensorconf => TEST_NONEXIST_SENSOR_FILE)
+      pid = d.run
+      sleep nsecs # Potential timing bug when the system is under load
+      Process.kill("TERM", pid)
+      Process.waitpid(pid)
+    end
+
+    db_test_query("SELECT * FROM sensor_reads") do |res|
+      assert res.num_rows == 0
+    end
+  end
+end

data/test/dbstore_test.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+
+class TestFileStore < Test::Unit::TestCase
+  def test_insert
+    db_setup
+    test_time = 1196024160
+    test_value = 7.323
+    
+    @dbstore.write(:test_sensor, test_time, test_value)
+    
+    db_test_query("SELECT * FROM sensor_reads") do |res|
+      assert_equal 1, res.num_rows
+      assert_equal ["test_sensor", test_time.to_s, test_value.to_s], res.fetch_row
+    end
+  end
+
+  def test_insert_nil
+    db_setup
+    
+    assert_raise(ArgumentError) {@dbstore.write(:test_sensor, 1, nil)}
+    assert_raise(ArgumentError) {@dbstore.write(:test_sensor, 0, 1)}
+    assert_raise(ArgumentError) {@dbstore.write(:test_sensor, nil, 1)}
+  end
+  
+  def test_average
+    db_setup
+    test_values = [[10, 7.323],[12, 5.432],[23, -2.125], [44, 0.123]]
+    test_average = (5.432 - 2.125)/2.0
+    test_values.each do |values|
+      @dbstore.write(:test_sensor, *values)
+    end
+    
+    assert_instance_of Float, @dbstore.average(:test_sensor, 11, 25)
+    assert_in_delta test_average, @dbstore.average(:test_sensor, 11, 25), 0.001
+    assert_in_delta test_average, @dbstore.average(:test_sensor, 12, 25), 0.001
+    assert_in_delta test_average, @dbstore.average(:test_sensor, 12, 23), 0.001
+    
+    # when there are no points it's nil
+    assert_nil @dbstore.average(:test_sensor, 50, 60)
+  end
+
+  def test_min_max
+    db_setup
+    test_values = [[10, 7.323],[12, 5.432],[23, -2.125], [44, 0.123]]
+    test_values.each do |values|
+      @dbstore.write(:test_sensor, *values)
+    end
+
+    [[:minimum, -2.125], [:maximum, 5.432]].each do |func, value|
+      assert_instance_of Float, @dbstore.send(func, :test_sensor, 11, 25)
+      assert_in_delta value, @dbstore.send(func,:test_sensor, 11, 25), 0.0001
+      assert_in_delta value, @dbstore.send(func,:test_sensor, 12, 25), 0.0001
+      assert_in_delta value, @dbstore.send(func,:test_sensor, 12, 23), 0.0001
+      
+      # when there are no points it's nil
+      assert_nil @dbstore.send(func,:test_sensor, 50, 60)
+    end
+  end
+
+  def test_enumerable
+    db_setup
+    test_time = 1196024160
+    test_value = 7.323
+    n = 5
+    
+    n.times {@dbstore.write(:test_sensor, test_time, test_value)}
+    assert_equal [["test_sensor", test_time, test_value]]*n,
+                 @dbstore.map{|sensor,time,value| [sensor,time,value]}   
+  end
+end

data/test/dinrelay.html.erb

@@ -0,0 +1,143 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-15">
+<meta name="ROBOTS" content="NOINDEX, NOFOLLOW">
+
+<meta http-equiv="Refresh" content="300">
+<title>Outlet Control  - Lite Power Controller</title></head>
+<!-- state=00 lock=00 -->
+
+<body alink="#0000FF" vlink="#0000FF">
+<font face="Arial, Helvetica, Sans-Serif">
+<table width="100%" cellspacing="0" cellpadding="0">
+<tbody><tr>
+<td valign="top" width="17%" height="100%">
+
+    <!-- menu -->
+    <table width="100%" height="100%" align="center" border="0" cellspacing="1" cellpadding="0">
+    <tbody><tr><td valign="top" bgcolor="#F4F4F4">
+    <table width="100%" cellpadding="1" cellspacing="5">
+
+    <tbody><tr><td align="center">
+    
+    <table><tbody><tr><td><a href="http://www.digital-loggers.com/8.html"><img src="./index_files/logo.gif" width="195" height="65" border="0"></a></td>
+    
+    <td><b><font size="-1">Ethernet Power Controller</font></b></td></tr></tbody></table>
+    <hr>
+    </td></tr>
+
+
+
+<tr><td nowrap=""><b><a href="./index_files/index.html">Outlet Control</a></b></td></tr>
+<tr><td nowrap=""><b><a href="http://localhost:8080/admin.htm">Setup</a></b></td></tr>
+
+
+
+
+
+<tr><td nowrap=""><b><a href="http://localhost:8080/ap.htm">AutoPing</a></b></td></tr>
+<tr><td nowrap=""><b><a href="http://localhost:8080/syslog.htm">System Log</a></b></td></tr>
+<tr><td nowrap=""><b><a href="http://localhost:8080/logout">Logout</a></b></td></tr>
+<tr><td nowrap=""><b><a href="http://localhost:8080/help/">Help</a></b></td></tr>
+
+<tr><td><hr></td></tr>
+
+
+<tr><td><b><a href="http://www.digital-loggers.com/5.html">Manual</a></b></td></tr>
+
+<tr><td><b><a href="http://www.digital-loggers.com/6.html">FAQ</a></b></td></tr>
+
+<tr><td><b><a href="http://www.digital-loggers.com/7.html">Product Information</a></b></td></tr>
+
+<tr><td><b><a href="http://www.digital-loggers.com/8.html">Digital Loggers, Inc.</a></b></td></tr>
+
+
+    </tbody></table>
+    </td></tr>
+
+
+    <tr><td valign="bottom" height="100%" bgcolor="#F4F4F4">
+    <small>Version 1.2.C (Apr 12 2009 / 14:28:13) 43858FBE-7E60D1A3</small>
+    </td></tr>
+    <tr><td valign="bottom" height="100%" bgcolor="#F4F4F4">
+    <small>S/N:0000131097</small>
+    </td></tr>
+
+    </tbody></table>
+    <!-- /menu -->
+
+</td>
+<td valign="top" width="83%">
+
+    <!-- heading table -->
+    <table width="100%" align="center" border="0" cellspacing="1" cellpadding="3">
+	<tbody><tr><td bgcolor="red">&nbsp;</td></tr><tr><td align="center"><h1>We recommend that you change the password!</h1></td></tr><tr><td bgcolor="red">&nbsp;</td></tr>
+        <tr>
+        <th bgcolor="#DDDDFF" align="left">
+        Controller: Lite Power Controller
+        </th>
+        </tr>
+
+        <tr bgcolor="#FFFFFF" align="left">
+        <td>
+        Uptime:   115:48:32 <!-- 416912s up -->
+        </td>
+        </tr>
+
+    </tbody></table>
+    <!-- /heading table -->
+
+    <br>
+
+    <!-- individual control table -->
+    <table width="100%" align="center" border="0" cellspacing="1" cellpadding="3">
+
+        <tbody><tr>
+        <td bgcolor="#DDDDFF" colspan="5" align="left">
+        Individual Control
+        </td>
+        </tr>
+
+        <!-- heading rows -->
+        <tr bgcolor="#DDDDDD">
+        <th>#</th>
+        <th align="left">Name</th>
+        <th align="left">State</th>
+        <th align="left" colspan="2">Action</th>
+        </tr>
+        <!-- /heading rows -->
+
+<% (1..8).each do |num| %>
+<% state = outlets[num] %>
+<% color = state == "ON" ? "green" : "red" %>
+<% reverse = state == "ON" ? "OFF" : "ON" %>
+<tr bgcolor="#F4F4F4"><td align="center">8</td>
+<td>Outlet <%= num %></td><td>
+<b><font color="<%= color %>"><%= state %></font></b></td><td>
+<a href="http://example.com/outlet?<%= num %>=<%= reverse %>">Switch <%= reverse %></a>
+</td><td>
+<!-- <a  href=outlet?<%= num %>=CCL>Cycle</a> -->
+</td></tr>
+<% end %>>
+
+    </tbody></table>
+    <!-- /individual control table -->
+
+    <br>
+
+<table width="100%" align="center" border="0" cellspacing="1" cellpadding="3">
+<tbody><tr><td bgcolor="#DDDDFF" align="left">Master Control</td></tr>
+
+<tr><td bgcolor="#F4F4F4" align="left"><a href="http://localhost:8080/outlet?a=OFF">All outlets OFF</a></td></tr>
+<tr><td bgcolor="#F4F4F4" align="left"><a href="http://localhost:8080/outlet?a=ON">All outlets ON</a></td></tr>
+<tr><td bgcolor="#F4F4F4" align="left"><a href="http://localhost:8080/outlet?a=CCL">Cycle all outlets</a></td></tr>
+<tr><td align="center">Sequence delay: 1 sec.</td></tr>
+
+</tbody></table>
+
+
+</td>
+</tr>
+</tbody></table>
+
+
+
+</font></body><style type="text/css">embed[type*="application/x-shockwave-flash"],embed[src*=".swf"],object[type*="application/x-shockwave-flash"],object[codetype*="application/x-shockwave-flash"],object[src*=".swf"],object[codebase*="swflash.cab"],object[classid*="D27CDB6E-AE6D-11cf-96B8-444553540000"],object[classid*="d27cdb6e-ae6d-11cf-96b8-444553540000"],object[classid*="D27CDB6E-AE6D-11cf-96B8-444553540000"]{	display: none !important;}</style></html>