saal 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8e07d635b3ad4c944de3ccbe81096f826754aa457b9ebf06854f01a760d715d
-  data.tar.gz: 766a7168fa122a72b388b6547b1f6b9531cd4afd5bc1df9df52673b9fd8291ce
+  metadata.gz: 90aa53b1093427163af28bee630532e79ccefea47de44463641c3e387f038640
+  data.tar.gz: 41fca314cb32d91ca10bfb1982cf7e60a6b584c3c521b8ddcd148b18f465fd86
 SHA512:
-  metadata.gz: 1ada5f05af261f043ef3e871c21d61b3f1924b4b99d8059233f1202a8594c30ea9af425e3f62d75050ee2f6c8bc15782c1535e4fc4696c277d7619c0569e40dc
-  data.tar.gz: 39ece8cad43590608d9410d7ffdcab1449e1fcc309f123343ffa6872dd84b820a59635a0f3a1aaf5807d05e111394674aa1aa49d9dcc2589930477d5f3c10426
+  metadata.gz: ff26de3ff3cca4750a365b9672a82165d449f7c11fb3bd57d7f3f27758636a521d766ae99dc84b50cd30e940453eb30826ad485e44f9e50d723bb5625cd07915
+  data.tar.gz: f93e18eacc3a2eb6555c95b9ea91f74506a39af91c6083ab6dbb3acc1ef2d83387db9ed59a573afcb7bbd1354cfdf7af51ec11122d9f48f287baf273c235debf

data/bin/saal_denkovi_relays

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__)+'/../lib/saal.rb'
+
+def usage
+  $stderr.puts "USAGE: saal_denkovi_relays <host>"
+  $stderr.puts "USAGE: saal_denkovi_relays <host> <num> <ON/OFF>"
+end
+
+if ARGV.size != 1 && ARGV.size != 3
+  usage()
+  exit(1)
+end
+
+denkovi = SAAL::Denkovi::OutletGroup::new(
+  :host => ARGV[0],
+)
+
+if ARGV.size == 3
+  num = ARGV[1].to_i
+  newstate = ARGV[2]
+  if !["ON","OFF"].include? newstate
+    $stderr.puts "ERROR: Unknown state '#{newstate}'"
+    usage()
+    exit(1)
+  end
+  puts "Setting Relay #{num} to #{newstate}"
+  denkovi.set_state(num, newstate)
+end
+
+(1..16).each do |num|
+  puts "Relay #{num} is #{denkovi.state(num)}"
+end
+

data/lib/denkovi.rb

@@ -0,0 +1,101 @@
+require 'net/http'
+require 'json'
+
+module SAAL
+  module Denkovi
+    class Outlet < SensorUnderlying
+      writeable!
+
+      def initialize(num, outletgroup)
+        @num = num
+        @og = outletgroup
+      end
+
+      def sensor_type
+        :onoff
+      end
+
+      def read(uncached = false)
+        {'ON' => 1.0, 'OFF' => 0.0}[@og.state(@num)]
+      end
+
+      def write(value)
+        newstate = {1.0 => 'ON', 0.0 => 'OFF'}[value]
+        if newstate
+          @og.set_state(@num,newstate)
+          value
+        end
+      end
+    end
+
+    class OutletGroup
+      DEFAULT_TIMEOUT = 2
+      DEFAULT_CACHE_TIMEOUT = 60
+      DEFAULT_OUTLETS = {}
+      DEFAULT_DESCRIPTIONS = {}
+
+      attr_accessor :host, :port, :pass, :timeout, :cache_timeout
+
+      def initialize(opts={})
+        @host = opts[:host] || opts['host'] || 'localhost'
+        @port = opts[:port] || opts['port'] || 80
+        @pass = opts[:pass] || opts['pass'] || 'admin'
+        @timeout = opts[:timeout] || opts['timeout'] || DEFAULT_TIMEOUT
+        @cache_timeout = opts[:cache_timeout] || opts['cache_timeout'] || DEFAULT_CACHE_TIMEOUT
+        @outlets = opts[:outlets] || opts["outlets"] || DEFAULT_OUTLETS
+        @descriptions = opts[:descriptions] || opts["descriptions"] || DEFAULT_DESCRIPTIONS
+        @cache = nil
+        @cachehit = nil
+        @cachetime = nil
+      end
+
+      def state(num)
+        if !@cachetime or @cachetime < Time.now - @cache_timeout
+          @cache = do_get("/current_state.json?pw=#{@pass}")
+          @cachetime = Time.now
+        end
+        return nil if !@cache
+        json = JSON.parse(@cache.body)
+        num = num - 1
+        if json &&
+           json["CurrentState"] &&
+           json["CurrentState"]["Output"] &&
+           json["CurrentState"]["Output"][num] &&
+           json["CurrentState"]["Output"][num]["Value"]
+           val = json["CurrentState"]["Output"][num]["Value"]
+           {"1" => "ON", "0" => "OFF"}[val]
+        else
+          nil
+        end
+      end
+
+      def set_state(num, state)
+        @cachetime = nil
+        val = {"ON" => "1", "OFF" => "0"}[state]
+        if val
+          response = do_get("/current_state.json?pw=#{@pass}&Relay#{num}=#{val}")
+          response != nil
+        else
+          false
+        end
+      end
+
+      def create_sensors
+        sensors = {}
+        (1..16).each do |num|
+          name = @outlets[num]
+          if name
+            description = @descriptions[num] || ""
+            sensors[name] = [Outlet.new(num, self), description]
+          end
+        end
+        sensors
+      end
+
+      private
+      def do_get(path)
+        SAAL::do_http_get(@host, @port, path, nil, nil, @timeout)
+      end
+    end
+  end
+end

data/lib/saal.rb

@@ -10,7 +10,7 @@ module SAAL
     DBCONF = CONFDIR+"database.yml"
     CHARTSCONF = CONFDIR+"charts.yml"
 
-    VERSION = '0.3.2'
+    VERSION = '0.3.3'
 end
 
 require File.dirname(__FILE__)+'/dbstore.rb'
@@ -25,4 +25,5 @@ require File.dirname(__FILE__)+'/outliercache.rb'
 require File.dirname(__FILE__)+'/dinrelay.rb'
 require File.dirname(__FILE__)+'/envoy.rb'
 require File.dirname(__FILE__)+'/http.rb'
+require File.dirname(__FILE__)+'/denkovi.rb'
   

data/lib/sensors.rb

@@ -61,6 +61,15 @@ module SAAL
         return sensors.map do |name, underlying|
           Sensor.new(dbstore, name, underlying, defs, opts)
         end
+      elsif defs['denkovi']
+        defs = defs['denkovi'].merge('prefix' => name)
+        denkovi = SAAL::Denkovi::OutletGroup::new(defs)
+        sensors = denkovi.create_sensors
+        return sensors.map do |name, vals|
+          underlying, description = vals
+          defs.merge!('name' => description)
+          Sensor.new(dbstore, name, underlying, defs, opts)
+        end
       else
         $stderror.puts "WARNING: Couldn't figure out a valid sensor type for #{name}"
       end

data/saal.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
 
   s.name              = 'saal'
-  s.version           = '0.3.2'
-  s.date              = '2020-12-25'
+  s.version           = '0.3.3'
+  s.date              = '2020-12-28'
 
   s.summary     = "Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)"
   s.description = <<EOF
@@ -45,6 +45,7 @@ EOF
     bin/dinrelaystatus
     bin/saal_chart
     bin/saal_daemon
+    bin/saal_denkovi_relays
     bin/saal_dump_database
     bin/saal_envoy_generate_config
     bin/saal_envoy_read
@@ -55,6 +56,7 @@ EOF
     lib/charts.rb
     lib/daemon.rb
     lib/dbstore.rb
+    lib/denkovi.rb
     lib/dinrelay.rb
     lib/envoy.rb
     lib/http.rb
@@ -69,6 +71,8 @@ EOF
     test/charts_test.rb
     test/daemon_test.rb
     test/dbstore_test.rb
+    test/denkovi.json.erb
+    test/denkovi_test.rb
     test/dinrelay.html.erb
     test/dinrelay_test.rb
     test/nonexistant_sensor.yml
@@ -77,6 +81,7 @@ EOF
     test/sensors_test.rb
     test/test_charts.yml
     test/test_db.yml
+    test/test_denkovi_sensors.yml
     test/test_dinrelay_sensors.yml
     test/test_helper.rb
     test/test_sensor_cleanups.yml

data/test/denkovi.json.erb

@@ -0,0 +1,39 @@
+{
+
+  "CurrentState": {
+
+    "Output": [
+
+<% (1..16).each do |num| %>
+<% state = outlets[num] %>
+<% val = state == "ON" ? "1" : "0" %>
+<% if num < 16 %>
+      {"Name": "RELAY<%= num %>", "Value": "<%= val %>"},
+<% else %>
+      {"Name": "RELAY<%= num %>", "Value": "<%= val %>"}
+<% end %>
+<% end %>
+
+    ],
+
+    "Auto-reboot": {
+
+      "RebootsNumber": "0",
+
+      "LastReboot": "-"
+
+    },
+
+    "Device": {
+
+      "Name": "SMARTDEN_IP-16R",
+
+      "MAC": "E8:EA:DA:AA:AA:AA"
+
+    }
+
+  }
+
+}
+
+

data/test/denkovi_test.rb

@@ -0,0 +1,212 @@
+require File.dirname(__FILE__)+'/test_helper.rb'
+require 'webrick'
+require 'benchmark'
+
+class TestDenkoviRelay < Test::Unit::TestCase
+  def setup
+    @@serv_num ||= 0
+    @@serv_num += 1
+
+    @og=SAAL::Denkovi::OutletGroup.new(service_opts)
+    @vals={1=>"OFF",2=>"OFF",3=>"ON",4=>"OFF",5=>"ON",6=>"ON",7=>"ON",8=>"OFF",
+           9=>"OFF",10=>"OFF",11=>"ON",12=>"OFF",13=>"ON",14=>"ON",15=>"ON",16=>"OFF"}
+    @rvals={1=>"ON",2=>"ON",3=>"OFF",4=>"ON",5=>"OFF",6=>"OFF",7=>"OFF",8=>"ON",
+            9=>"ON",10=>"ON",11=>"OFF",12=>"ON",13=>"OFF",14=>"OFF",15=>"OFF",16=>"ON"}
+
+    defs = YAML::load(File.new(TEST_SENSORS_DENKOVI_FILE))
+    @pass = defs["group1"]["denkovi"]["pass"]
+    defs['group1']['denkovi']['port'] = service_opts[:port]
+    tempfile = Tempfile.new('denkovi_test_yml')
+    File.open(tempfile.path,'w') {|f| f.write(YAML::dump defs)}
+    @test_sensors_denkovi_file = tempfile.path
+  end
+
+  def service_opts
+    base_opts = {:host => 'localhost', :pass =>"somepass"}
+    base_opts.merge(:port => 3333+@@serv_num)
+  end
+
+  class BasicServing < WEBrick::HTTPServlet::AbstractServlet
+    def self.get_instance(config, opts)
+      new(opts)
+    end
+    def initialize(opts)
+      @html = opts[:html]
+      @pass = opts[:pass]
+      @status = opts[:status] || 200
+      @feedback = opts[:feedback] || {}
+      @sleep = opts[:sleep] || 0
+    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
+      res.body = @html
+      res.status = @status
+      res['Content-Type'] = "text/html"
+    end
+  end
+
+  def with_webrick(opts)
+    opts = service_opts.merge(opts)  
+
+    Socket.do_not_reverse_lookup = true # Speed up startup
+    log = WEBrick::Log.new($stderr, WEBrick::Log::ERROR)
+    access_log = [[log, WEBrick::AccessLog::COMBINED_LOG_FORMAT]]
+    s = WEBrick::HTTPServer.new(:Port => opts[:port], 
+                                :Logger => log,
+                                :AccessLog => access_log)
+    s.mount('/', BasicServing, opts.merge(:feedback => (f = {})))
+    
+    thread = Thread.new do
+      s.start
+    end
+    while s.status != :Running; sleep 0.1; end # Make sure the server is up
+    yield f
+    s.shutdown
+    thread.exit
+  end
+
+  def create_current_state_json(hash)
+    outlets = hash
+    erb = ERB.new(File.open(File.dirname(__FILE__)+'/denkovi.json.erb').read)
+    erb.result(binding)
+  end
+
+  def assert_path(path, uri)
+    assert_equal "http://localhost:#{service_opts[:port]}"+path, uri
+  end
+
+  def test_read_state
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @vals.each do |num, state|
+        assert_equal state, @og.state(num)
+        assert_path "/current_state.json?pw=#{@pass}", feedback[:uri]
+      end
+    end
+  end
+
+  def test_set_state
+    with_webrick(:html=>create_current_state_json(@rvals)) do |feedback|
+      @vals.each do |num, state|
+        newstate = state == "ON" ? "OFF" : "ON"
+        val = {"ON" => "1", "OFF" => "0"}[newstate]
+        assert @og.set_state(num,newstate), "State change not working"
+        assert_path "/current_state.json?pw=#{@pass}&Relay#{num}=#{val}", feedback[:uri]
+      end
+    end
+  end
+
+  def test_enumerate_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    assert_equal((1..16).map{|i| "name#{i.to_s.rjust(2, "0")}"}, sensors.map{|s| s.name}.sort)
+    assert_equal((1..16).map{|i| "description#{i.to_s.rjust(2, "0")}"}, sensors.map{|s| s.description}.sort)
+  end
+
+  def test_sensor_type
+    SAAL::Sensors.new(TEST_SENSORS_DENKOVI_FILE, TEST_DBCONF).each do |s|
+      assert_equal :onoff, s.sensor_type
+    end
+  end
+
+  def test_read_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @vals.each do |num, state|
+        value = state == "ON" ? 1.0 : 0.0
+        assert_equal value, sensors.send('name'+num.to_s.rjust(2, "0")).read
+        assert_path "/current_state.json?pw=#{@pass}", feedback[:uri]
+      end
+      assert_equal 1, feedback[:nrequests], "denkovi request caching not working"
+    end
+  end
+
+  def test_set_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    with_webrick(:html=>create_current_state_json(@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.rjust(2, "0")).write(newval), 
+                     "State change not working"
+        val = {"ON" => "1", "OFF" => "0"}[newstate]
+        assert_path "/current_state.json?pw=#{@pass}&Relay#{num}=#{val}", feedback[:uris][-2]
+        assert_path "/current_state.json?pw=#{@pass}", feedback[:uris][-1]
+      end
+    end
+  end
+
+  # Test that write invalidates any caching
+  def test_write_read_sensors
+    sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @vals.each do |num, state|
+        sensors.send('name'+num.to_s.rjust(2, "0")).write(0.0)
+        sensors.send('name'+num.to_s.rjust(2, "0")).read
+      end
+      assert_equal 32, feedback[:nrequests], "denkovi caching too much"
+    end
+  end
+
+  # Test that the cache times out
+  def test_cache_invalidation
+    _sensors = SAAL::Sensors.new(@test_sensors_denkovi_file, TEST_DBCONF)
+    @og.cache_timeout = 0.1
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      @og.state(1)
+      sleep 0.2
+      @og.state(1)
+      assert_equal 2, feedback[:nrequests], "denkovi caching not invalidating"
+    end
+  end
+
+  def test_failed_connection
+    @vals.each do |num, state|
+      assert_equal nil, @og.state(num)
+      assert !@og.set_state(num,"ON"), "State change working without a server?!"
+    end
+  end
+
+  def test_failed_request
+    with_webrick(:html=>create_current_state_json(@vals),:status=>404) do |feedback|
+      @vals.each do |num, state|
+        assert_equal nil, @og.state(num)
+        assert !@og.set_state(num,"ON"), "State change working without a server?!"
+      end
+    end
+  end
+
+  def test_fast_open_timeout
+    #FIXME: Find a way to make this test address more generic
+    @og=SAAL::Denkovi::OutletGroup.new(service_opts.merge(:host => "10.254.254.254", 
+                                                           :timeout=>0.1))
+    with_webrick(:html=>create_current_state_json(@vals)) do |feedback|
+      time = Benchmark.measure do
+        @vals.each do |num, state|
+          assert_equal nil, @og.state(num), "Read not timing out?"
+          assert !@og.set_state(num,"ON"), "State change not timing out?"
+        end
+      end
+      total_time = @og.timeout*2*@vals.keys.size
+      assert time.total < total_time
+             "Doing the reads took too long, are we really timing out?"
+    end
+  end
+
+  def test_fast_read_timeout
+    @og=SAAL::Denkovi::OutletGroup.new(service_opts.merge(:timeout=>0.1))
+    with_webrick(:html=>create_current_state_json(@vals),:sleep=>10) do |feedback|
+      time = Benchmark.measure do
+        @vals.each do |num, state|
+          assert_equal nil, @og.state(num), "Read not timing out?"
+          assert !@og.set_state(num,"ON"), "State change not timing out?"
+        end
+      end
+      total_time = @og.timeout*2*@vals.keys.size
+      assert time.total < total_time
+             "Doing the reads took too long, are we really timing out?"
+    end
+  end
+end

data/test/test_denkovi_sensors.yml

@@ -0,0 +1,39 @@
+group1:
+  denkovi:
+    host: localhost
+    port: 33333
+    pass: somepass
+    outlets:
+      1: name01
+      2: name02
+      3: name03
+      4: name04
+      5: name05
+      6: name06
+      7: name07
+      8: name08
+      9: name09
+      10: name10
+      11: name11
+      12: name12
+      13: name13
+      14: name14
+      15: name15
+      16: name16
+    descriptions:
+      1: description01
+      2: description02
+      3: description03
+      4: description04
+      5: description05
+      6: description06
+      7: description07
+      8: description08
+      9: description09
+      10: description10
+      11: description11
+      12: description12
+      13: description13
+      14: description14
+      15: description15
+      16: description16

data/test/test_helper.rb

@@ -6,6 +6,7 @@ require File.dirname(__FILE__)+'/../lib/saal.rb'
 class Test::Unit::TestCase
   TEST_SENSORS_FILE = File.dirname(__FILE__)+'/test_sensors.yml'
   TEST_SENSORS_DINRELAY_FILE = File.dirname(__FILE__)+'/test_dinrelay_sensors.yml'
+  TEST_SENSORS_DENKOVI_FILE = File.dirname(__FILE__)+'/test_denkovi_sensors.yml'
   TEST_SENSOR_CLEANUPS_FILE = File.dirname(__FILE__)+'/test_sensor_cleanups.yml'
   TEST_NONEXIST_SENSOR_FILE = File.dirname(__FILE__)+'/nonexistant_sensor.yml'
   TEST_CHARTS_FILE = File.dirname(__FILE__)+'/test_charts.yml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saal
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Pedro Côrte-Real
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-25 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ownet
@@ -76,6 +76,7 @@ executables:
 - saal_import_mysql
 - saal_dump_database
 - saal_readall
+- saal_denkovi_relays
 - saal_chart
 - saal_daemon
 - saal_envoy_generate_config
@@ -94,6 +95,7 @@ files:
 - bin/dinrelaystatus
 - bin/saal_chart
 - bin/saal_daemon
+- bin/saal_denkovi_relays
 - bin/saal_dump_database
 - bin/saal_envoy_generate_config
 - bin/saal_envoy_read
@@ -104,6 +106,7 @@ files:
 - lib/charts.rb
 - lib/daemon.rb
 - lib/dbstore.rb
+- lib/denkovi.rb
 - lib/dinrelay.rb
 - lib/envoy.rb
 - lib/http.rb
@@ -118,6 +121,8 @@ files:
 - test/charts_test.rb
 - test/daemon_test.rb
 - test/dbstore_test.rb
+- test/denkovi.json.erb
+- test/denkovi_test.rb
 - test/dinrelay.html.erb
 - test/dinrelay_test.rb
 - test/nonexistant_sensor.yml
@@ -126,6 +131,7 @@ files:
 - test/sensors_test.rb
 - test/test_charts.yml
 - test/test_db.yml
+- test/test_denkovi_sensors.yml
 - test/test_dinrelay_sensors.yml
 - test/test_helper.rb
 - test/test_sensor_cleanups.yml
@@ -164,6 +170,7 @@ test_files:
 - test/charts_test.rb
 - test/daemon_test.rb
 - test/dbstore_test.rb
+- test/denkovi_test.rb
 - test/dinrelay_test.rb
 - test/outliercache_test.rb
 - test/sensor_test.rb