saal 0.2.23 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8e07d635b3ad4c944de3ccbe81096f826754aa457b9ebf06854f01a760d715d
+  data.tar.gz: 766a7168fa122a72b388b6547b1f6b9531cd4afd5bc1df9df52673b9fd8291ce
+SHA512:
+  metadata.gz: 1ada5f05af261f043ef3e871c21d61b3f1924b4b99d8059233f1202a8594c30ea9af425e3f62d75050ee2f6c8bc15782c1535e4fc4696c277d7619c0569e40dc
+  data.tar.gz: 39ece8cad43590608d9410d7ffdcab1449e1fcc309f123343ffa6872dd84b820a59635a0f3a1aaf5807d05e111394674aa1aa49d9dcc2589930477d5f3c10426

data/bin/saal_chart

@@ -16,7 +16,11 @@ if ARGV.size != 1
   exit (2)
 end
 
-SENSOR_RANGES = {:temperature=>[-15, 45], :humidity=>[0,100], :pressure=>[950,1050]}
+MAX_RANGES = {:temperature=>[-10,70], 
+              :humidity=>[0,110], 
+              :pressure=>[900,1200]}
+
+TYPES = {:temperature => "ºC", :humidity => "%", :pressure => "hPa"}
 
 
 SAAL::Charts.new.each do |chart|
@@ -57,9 +61,35 @@ SAAL::Charts.new.each do |chart|
                NUM_VALUES_SMALL
 
   @averages = chart.average(num_values)
+  @ranges = {}
+
+  # First find the smallest interval that fits all sensors for each type
+  @data = chart.sensors.map do |sensor|
+    avgs = @averages[sensor.name.to_sym]
+
+    min = avgs.select{|o| o != nil}.min
+    max = avgs.select{|o| o != nil}.max
+    if min and max
+      range = [(min/5).floor*5, (max/5).ceil*5]
+      @ranges[sensor.sensor_type] ||= range
+      previous = @ranges[sensor.sensor_type]
+      @ranges[sensor.sensor_type] = [[range[0],previous[0]].min, 
+                                     [range[1],previous[1]].max]
+    end
+  end
 
+  # Then clip those intervals to MAX_RANGES
   @data = chart.sensors.map do |sensor|
-    normalize_data(@averages[sensor.name.to_sym], *(SENSOR_RANGES[sensor.sensor_type]))
+    maxrange = MAX_RANGES[sensor.sensor_type]
+    @ranges[sensor.sensor_type] ||= maxrange
+    previous = @ranges[sensor.sensor_type]
+    @ranges[sensor.sensor_type] = [[maxrange[0],previous[0]].max, 
+                                   [maxrange[1],previous[1]].min]
+  end
+
+  # Finally use those intervals to normalize the data
+  @data = chart.sensors.map do |sensor|
+    normalize_data(@averages[sensor.name.to_sym], *@ranges[sensor.sensor_type])
   end
 
   @dataurl = @data.map {|values| values.join(",")}.join('|')
@@ -74,12 +104,27 @@ SAAL::Charts.new.each do |chart|
   end
   @xincr = 100.0/@numperiods.to_f*10000.truncate.to_f/10000
 
+  @axes = []
+  @ranges.each do |type, range| 
+    min,max = range
+    step = (max-min).to_f/4.0
+    steps = (0..4).map{|i| (min+i*step).to_i.to_s}
+    steps[0] = "#{min} #{TYPES[type]}"
+    steps[4] = "#{max} #{TYPES[type]}"
+    @axes << steps.join("||")
+  end
+  # Duplicate the axis if there's only one
+  @axes *= 2 if @axes.size == 1
+  # Alternate between left and right axes
+  @axisset = (['y','r']*@axes.size)[0..@axes.size-1].join(",")
+  @axes = @axes.each_with_index.map {|a,i| "#{i+1}:|#{a}"}.join("|")
+
   r[:chof] = "png"
   r[:chs] = "700x300"
   r[:cht] = "lc"
   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[:chxt] = "x,#{@axisset}"
+  r[:chxl] = "0:#{@periodnamesurl}#{@axes}"
   r[:chg] = "#{@xincr},12.5,1,5"
   r[:chd] = "t:#{@dataurl}"
 

data/bin/saal_envoy_generate_config

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__)+'/../lib/saal.rb'
+
+if ARGV.size != 1 && ARGV.size != 3
+  $stderr.puts "USAGE: saal_envoy_generate_config <host> [<user> <password>]"
+  exit(1)
+end
+
+puts "power:"
+puts "  envoy_power_energy:"
+puts "    host: \"#{ARGV[0]}\""
+puts
+puts "ac:"
+puts "  envoy_ac_quality:"
+puts "    host: \"#{ARGV[0]}\""
+
+user = "envoy"
+password = nil
+
+if ARGV[2]
+  user = ARGV[1]
+  password = ARGV[2]
+else
+  Net::HTTP.get(ARGV[0], '/home').split("\n").each do |line|
+    if line.include?("serial:")
+      password = line.split('"')[1][-6..-1]
+    end
+  end
+  if !password
+    $stderr.puts "Couldn't find serial number for envoy"
+    exit 2
+  end
+end
+
+envoy = SAAL::Envoy::Inverters::new(
+  :host => ARGV[0],
+  :user => user,
+  :password => password,
+)
+envoy.set_all_inverters!
+exit 0 if envoy.inverters.size <= 0
+
+puts
+puts "inverters:"
+puts "  envoy_inverters:"
+puts "    host: \"#{ARGV[0]}\""
+puts "    user: \"#{user}\""
+puts "    password: \"#{password}\""
+puts "    inverters:"
+envoy.inverters.each do |serial|
+  puts "    - #{serial}"
+end

data/bin/saal_envoy_read

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__)+'/../lib/saal.rb'
+
+if ARGV.size != 3
+  $stderr.puts "USAGE: saal_envoy_read <host> <user> <password>"
+  exit(1)
+end
+
+def fdisp(val)
+  if val
+    '%10.0f' % val
+  else
+    "       n/a"
+  end
+end
+
+def fdispk(val)
+  if val
+    '%10.2f' % (val / 1000.0)
+  else
+    "       n/a"
+  end
+end
+
+def fdisp_dec(val)
+  if val
+    '%10.2f' % val
+  else
+    "       n/a"
+  end
+end
+
+def l(vals, name)
+  sensor = vals[name]
+  if sensor
+    sensor.read
+  else
+    nil
+  end
+end
+
+def lratio(vals, name1, name2)
+  v1 = l(vals, name1)
+  v2 = l(vals, name2)
+  if v1 && v2
+    v1 / v2
+  else
+    nil
+  end
+end
+
+ac_quality = SAAL::Envoy::ACQuality::new(:host => ARGV[0]).create_sensors
+
+puts " ========= AC QUALITY ========"
+puts "        voltage (V)  freq (Hz)"
+def qual_line(vals,name, type)
+  puts " #{name} \
+#{fdisp_dec(l(vals,"ac_#{type}_voltage"))} \
+#{fdisp_dec(l(vals,"ac_#{type}_frequency"))} \
+"
+end
+qual_line(ac_quality, "Total: ", "total")
+qual_line(ac_quality, "Phase1:", "phase1")
+qual_line(ac_quality, "Phase2:", "phase2")
+qual_line(ac_quality, "Phase3:", "phase3")
+
+production = SAAL::Envoy::PowerEnergy::new(:host => ARGV[0]).create_sensors
+
+puts ""
+puts " ============ TRUE POWER (W) ============  ======= TRUE ENERGY (kWh) ======="
+puts "        consumption production        net  consumption production        net"
+def p_line(vals, name, type, metric)
+  puts " #{name} \
+#{fdisp(l(vals,"pv_total_consumption_#{type}_#{metric}_now"))} \
+#{fdisp(l(vals,"pv_production_#{type}_#{metric}_now"))} \
+#{fdisp(l(vals,"pv_net_consumption_#{type}_#{metric}_now"))}   \
+#{fdispk(l(vals,"pv_total_consumption_#{type}_#{metric}h_lifetime"))} \
+#{fdispk(l(vals,"pv_production_#{type}_#{metric}h_lifetime"))} \
+#{fdispk(l(vals,"pv_net_consumption_#{type}_#{metric}h_lifetime"))} \
+"
+end
+p_line(production, "Total: ", "total", "w")
+p_line(production, "Phase1:", "phase1", "w")
+p_line(production, "Phase2:", "phase2", "w")
+p_line(production, "Phase3:", "phase3", "w")
+puts " Total Inverters:   \
+#{fdisp(l(production,"pv_production_inverters_w_now"))} \
+                        \
+#{fdispk(l(production,"pv_production_inverters_wh_lifetime"))} \
+"
+
+puts ""
+puts " ========== APPARENT POWER (VA) ========= ===== APPARENT ENERGY (kVAh) ===="
+puts "        consumption production        net  consumption production        net"
+p_line(production, "Total: ", "total", "va")
+p_line(production, "Phase1:", "phase1", "va")
+p_line(production, "Phase2:", "phase2", "va")
+p_line(production, "Phase3:", "phase3", "va")
+
+def pf_line(vals, name, type, metric)
+  pf_total_consumption_instant = lratio(vals,"pv_total_consumption_#{type}_w_now","pv_total_consumption_#{type}_va_now")
+  pf_total_production_instant = lratio(vals,"pv_production_#{type}_w_now","pv_production_#{type}_va_now")
+  pf_net_production_instant = lratio(vals,"pv_net_consumption_#{type}_w_now","pv_net_consumption_#{type}_va_now")
+
+  pf_total_consumption_lifetime = lratio(vals,"pv_total_consumption_#{type}_wh_lifetime","pv_total_consumption_#{type}_vah_lifetime")
+  pf_total_production_lifetime = lratio(vals,"pv_production_#{type}_wh_lifetime","pv_production_#{type}_vah_lifetime")
+  pf_net_production_lifetime = lratio(vals,"pv_net_consumption_#{type}_wh_lifetime","pv_net_consumption_#{type}_vah_lifetime")
+
+  puts " #{name} \
+#{fdisp_dec(pf_total_consumption_instant)} \
+#{fdisp_dec(pf_total_production_instant)} \
+#{fdisp_dec(pf_net_production_instant)}   \
+#{fdisp_dec(pf_total_consumption_lifetime)} \
+#{fdisp_dec(pf_total_production_lifetime)} \
+#{fdisp_dec(pf_net_production_lifetime)} \
+"
+end
+
+puts ""
+puts " ========= INSTANT POWER FACTOR ========= ====== LIFETIME POWER FACTOR ====="
+puts "        consumption production        net  consumption production        net"
+pf_line(production, "Total: ", "total", "va")
+pf_line(production, "Phase1:", "phase1", "va")
+pf_line(production, "Phase2:", "phase2", "va")
+pf_line(production, "Phase3:", "phase3", "va")
+
+puts ""
+envoy = SAAL::Envoy::Inverters::new(
+  :host => ARGV[0],
+  :user => ARGV[1],
+  :password => ARGV[2],
+  :types => ["w_now", "last_report_date", "w_max"],
+)
+envoy.set_all_inverters!
+inverters = envoy.create_sensors
+puts " Found #{envoy.inverters.size} inverters"
+envoy.inverters.each do |serial|
+  puts " INVERTER: #{serial} \
+date:#{l(inverters,"inverters_#{serial}_last_report_date")} \
+lastWatts:#{l(inverters,"inverters_#{serial}_w_now")} \
+maxWatts:#{l(inverters,"inverters_#{serial}_w_max")} \
+"
+end

data/lib/chart.rb

@@ -5,7 +5,7 @@ module SAAL
       @name = name
       @defs = defs
       @alignlabels = (defs['alignlabels'] || :center).to_sym
-      @sensors = defs['sensors'].map{|name| sensors.send(name)} 
+      @sensors = defs['sensors'].map{|sname| sensors.send(sname)}
       @num = defs['last']
       @periods = defs['periods']
       @alt = defs['alt']

data/lib/chart_data.rb

@@ -39,7 +39,7 @@ module SAAL
       (0..num-2).map do |i|
         f = t + 1
         t = (f+step)
-        v = sensor.send(method, f.to_i, t.to_i)
+        _v = sensor.send(method, f.to_i, t.to_i)
       end << sensor.send(method, (t+1).to_i, to.to_i)
     end
 

data/lib/dbstore.rb

@@ -46,54 +46,51 @@ module SAAL
                   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
+        row = r.first
+        if row
+          _date, value = [row["date"].to_i, row["value"].to_f]
+          value
         else
-          row = r.fetch_row
-          date, value = [row[0].to_i, row[1].to_f]
-          return value
+          nil
         end
       end
     end
 
     def each
       db_query "SELECT sensor,date,value FROM sensor_reads" do |r|
-        r.num_rows.times do
-          row = r.fetch_row
-          yield [row[0],row[1].to_i, row[2].to_f]
+        r.each do |row|
+          yield [row["sensor"],row["date"].to_i, row["value"].to_f]
         end
       end
     end
     
     private
     def db_range(function, sensor, from, to)
-      db_query "SELECT #{function}(value) AS average FROM sensor_reads
+      db_query "SELECT #{function}(value) AS func FROM sensor_reads
                        WHERE sensor = '#{db_quote(sensor.to_s)}' 
                          AND date >= #{from.to_s} 
                          AND date <= #{to.to_s}" do |r|
-        if r.num_rows == 0 
-          nil
+        row = r.first
+        if row && row["func"]
+          row["func"].to_f
         else
-          row = r.fetch_row
-          row[0] ? row[0].to_f : nil
+          nil
         end
       end
     end
 
     def db_quote(text)
-      Mysql.quote(text)
+      Mysql2::Client.escape(text)
     end
 
     def db_query(query, opts={})
       db = nil
       begin
         # connect to the MySQL server
-        db = Mysql.new(@dbopts['host'],@dbopts['user'],@dbopts['pass'],
-                       @dbopts['db'],@dbopts['port'],@dbopts['socket'],
-                       @dbopts['flags'])
+        db = Mysql2::Client.new(@dbopts)
         res = db.query(query)
         yield res if block_given?
-      rescue Mysql::Error => e
+      rescue Mysql2::Error => e
         $stderr.puts "MySQL Error #{e.errno}: #{e.error}" if !(e.errno == opts[:ignoreerr])
       ensure
         db.close if db

data/lib/dinrelay.rb

@@ -42,6 +42,7 @@ module SAAL
         @cache_timeout = opts[:cache_timeout] || opts['cache_timeout'] || DEFAULT_CACHE_TIMEOUT
         @cache = nil
         @cachehit = nil
+        @cachetime = nil
       end
 
       def state(num)
@@ -55,33 +56,13 @@ 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
 
       private
       def do_get(path)
-        begin
-          http = Net::HTTP.new(@host,@port)
-          # Timeout faster when the other side doesn't respond
-          http.open_timeout = @timeout
-          http.read_timeout = @timeout
-          req = Net::HTTP::Get.new(path)
-          req.basic_auth @user, @pass
-          response = http.request(req)
-          if response.code != "200"
-            #$stderr.puts "ERROR: Code #{response.code}"
-            #$stderr.puts response.body
-            return nil
-          end
-          return response
-        rescue Exception
-          return nil
-        end
+        SAAL::do_http_get(@host, @port, path, @user, @pass, @timeout)
       end
-
       def parse_index_html(str)
         doc = Nokogiri::HTML(str)
         outlets = doc.css('tr[bgcolor="#F4F4F4"]')

data/lib/envoy.rb

@@ -0,0 +1,287 @@
+require 'json'
+
+module SAAL
+  module Envoy
+    class PowerEnergyUnderlying < SensorUnderlying
+      def initialize(key, production)
+        @key = key
+        @production = production
+      end
+
+      def read(uncached = false)
+        @production.read_val(@key)
+      end
+    end
+
+    class PowerEnergy
+      DEFAULT_HOST = "envoy.local"
+      DEFAULT_TIMEOUT = 2
+      DEFAULT_CACHE_TIMEOUT = 50
+      DEFAULT_SOURCES = [
+        "production_inverters",
+        "production_phase1", "production_phase2", "production_phase3", "production_total",
+        "net_consumption_phase1", "net_consumption_phase2", "net_consumption_phase3", "net_consumption_total",
+        "total_consumption_phase1", "total_consumption_phase2", "total_consumption_phase3", "total_consumption_total",
+      ]
+      DEFAULT_TYPES = [
+        "w_now", "wh_lifetime", "va_now", "vah_lifetime",
+      ]
+      DEFAULT_PREFIX = "pv"
+
+      def initialize(defs, opts={})
+        @host = defs[:host] || defs['host'] || DEFAULT_HOST
+        @timeout = opts[:timeout] || opts['timeout'] || DEFAULT_TIMEOUT
+        @cache_timeout = opts[:cache_timeout] || opts['cache_timeout'] || DEFAULT_CACHE_TIMEOUT
+        @cache = nil
+        @cachetime = nil
+        @sources = defs[:sources] || defs['source'] || DEFAULT_SOURCES
+        @types = defs[:types] || defs['types'] || DEFAULT_TYPES
+        @prefix = defs[:prefix] || defs['prefix'] || DEFAULT_PREFIX
+      end
+
+      def read_val(name)
+        if !@cachetime or @cachetime < Time.now - @cache_timeout
+          @cache = read_all()
+          @cachetime = Time.now
+        end
+        return @cache ? @cache[name] : nil
+      end
+
+      def create_sensors
+        sensors = {}
+        @sources.product(@types).each do |source, type|
+          key = "#{@prefix}_#{source}_#{type}"
+          sensors[key] = PowerEnergyUnderlying.new(key, self)
+        end
+        sensors
+      end
+
+      private
+      def save_vals(dest, name, source)
+        {
+         "wNow" => "w_now",
+         "apprntPwr" => "va_now",
+         "whLifetime" => "wh_lifetime",
+         "vahLifetime" => "vah_lifetime",
+        }.each do |type, label|
+          dest["#{@prefix}_#{name}_#{label}"] = source[type]
+        end
+
+        # Hack around the fact that apprntPwr is broken on the total consumption
+        # calculation for the three-phase sum at least
+        # In those cases it seems to be missing a divide by three, so when the
+        # calculation for voltage and current alone is close do the extra divide
+        va_now = dest["#{@prefix}_#{name}_va_now"]
+        if va_now && !name.include?("phase")
+          voltage = source["rmsVoltage"]
+          current = source["rmsCurrent"]
+          if voltage && current
+            va_alt = voltage * current
+            if ((va_alt / va_now) - 1.0).abs < 0.05
+              dest["#{@prefix}_#{name}_va_now"] = va_now / 3.0
+            end
+          end
+        end
+      end
+
+      def read_all
+        response = SAAL::do_http_get(@host, 80, "/production.json?details=1", nil, nil, @timeout)
+        return nil if !response
+
+        values = JSON.parse(response.body)
+        outputs = {}
+
+        values["production"].each do |source|
+          type = source["type"]
+          case type
+          when "inverters"
+            save_vals(outputs, "production_inverters", source)
+          when "eim"
+            if source["lines"]
+              save_vals(outputs, "production_phase1", source["lines"][0])
+              save_vals(outputs, "production_phase2", source["lines"][1])
+              save_vals(outputs, "production_phase3", source["lines"][2])
+            end
+            save_vals(outputs, "production_total", source)
+          else
+            $stderr.puts "WARNING: ENVOY: don't know source type #{type}"
+          end
+        end
+
+        values["consumption"].each do |source|
+          type = {
+            "total-consumption" => "total",
+            "net-consumption" => "net",
+          }[source["measurementType"]] || "unknown";
+
+          if source["lines"]
+            save_vals(outputs, "#{type}_consumption_phase1", source["lines"][0])
+            save_vals(outputs, "#{type}_consumption_phase2", source["lines"][1])
+            save_vals(outputs, "#{type}_consumption_phase3", source["lines"][2])
+          end
+          save_vals(outputs, "#{type}_consumption_total", source)
+        end
+
+        outputs
+      end
+    end
+
+    class ACQualityUnderlying < SensorUnderlying
+      def initialize(key, production)
+        @key = key
+        @production = production
+      end
+
+      def read(uncached = false)
+        @production.read_val(@key)
+      end
+    end
+
+    class ACQuality
+      DEFAULT_HOST = "envoy.local"
+      DEFAULT_TIMEOUT = 2
+      DEFAULT_CACHE_TIMEOUT = 50
+      DEFAULT_SOURCES = ["total","phase1","phase2","phase3",]
+      DEFAULT_TYPES = ["frequency","voltage"]
+      DEFAULT_PREFIX = "ac"
+
+      def initialize(defs, opts={})
+        @host = defs[:host] || defs['host'] || DEFAULT_HOST
+        @timeout = opts[:timeout] || opts['timeout'] || DEFAULT_TIMEOUT
+        @cache_timeout = opts[:cache_timeout] || opts['cache_timeout'] || DEFAULT_CACHE_TIMEOUT
+        @cache = nil
+        @cachetime = nil
+        @sources = defs[:sources] || defs['source'] || DEFAULT_SOURCES
+        @types = defs[:types] || defs['types'] || DEFAULT_TYPES
+        @prefix = defs[:prefix] || defs['prefix'] || DEFAULT_PREFIX
+      end
+
+      def read_val(name)
+        if !@cachetime or @cachetime < Time.now - @cache_timeout
+          @cache = read_all()
+          @cachetime = Time.now
+        end
+        return @cache ? @cache[name] : nil
+      end
+
+      def create_sensors
+        sensors = {}
+        @sources.product(@types).each do |source, type|
+          key = "#{@prefix}_#{source}_#{type}"
+          sensors[key] = ACQualityUnderlying.new(key, self)
+        end
+        sensors
+      end
+
+      private
+      def save_vals(dest, name, source)
+        {
+         "voltage" => "voltage",
+         "freq" => "frequency",
+        }.each do |type, label|
+          dest["#{@prefix}_#{name}_#{label}"] = source[type]
+        end
+      end
+
+      def read_all
+        response = SAAL::do_http_get(@host, 80, "/ivp/meters/readings", nil, nil, @timeout)
+        return nil if !response
+
+        values = JSON.parse(response.body)
+        outputs = {}
+        source = values[0]
+        save_vals(outputs, "total", source)
+        if source["channels"]
+          save_vals(outputs, "phase1", source["channels"][0])
+          save_vals(outputs, "phase2", source["channels"][1])
+          save_vals(outputs, "phase3", source["channels"][2])
+        end
+
+        outputs
+      end
+    end
+
+    class InverterUnderlying < SensorUnderlying
+      def initialize(key, inverters)
+        @key = key
+        @inverters = inverters
+      end
+
+      def read(uncached = false)
+        @inverters.read_val(@key)
+      end
+    end
+
+    class Inverters
+      DEFAULT_TIMEOUT = 2
+      DEFAULT_CACHE_TIMEOUT = 50
+      DEFAULT_SOURCES = []
+      DEFAULT_TYPES = ["w_now"] # "last_report_date", "w_max"
+      DEFAULT_USER = nil
+      DEFAULT_PASSWORD = nil
+      DEFAULT_PREFIX = "inverters"
+      attr_reader :inverters
+
+      def initialize(defs, opts={})
+        @host = defs[:host] || defs['host'] || DEFAULT_HOST
+        @user = defs[:user] || defs['user'] || DEFAULT_USER
+        @password = defs[:password] || defs['password'] || DEFAULT_PASSWORD
+        @timeout = opts[:timeout] || opts['timeout'] || DEFAULT_TIMEOUT
+        @cache_timeout = opts[:cache_timeout] || opts['cache_timeout'] || DEFAULT_CACHE_TIMEOUT
+        @cache = nil
+        @cachetime = nil
+        @inverters_list = {}
+        @inverters = defs[:inverters] || defs['inverters'] || DEFAULT_SOURCES
+        @types = defs[:types] || defs['types'] || DEFAULT_TYPES
+        @prefix = defs[:prefix] || defs['prefix'] || DEFAULT_PREFIX
+      end
+
+      def read_val(name)
+        if !@cachetime or @cachetime < Time.now - @cache_timeout
+          @cache = read_all()
+          @cachetime = Time.now
+        end
+        return @cache ? @cache[name] : nil
+      end
+
+      def enumerate
+        read_val("foo") # Force a read to make sure the inverter serials are stored
+        @inverters_list.keys
+      end
+
+      def set_all_inverters!
+        @inverters = self.enumerate
+      end
+
+      def create_sensors
+        sensors = {}
+        @inverters.product(@types).each do |source, type|
+          key = "#{@prefix}_#{source}_#{type}"
+          sensors[key] = InverterUnderlying.new(key, self)
+        end
+        sensors
+      end
+
+      private
+      def read_all
+        response = SAAL::do_http_get_digest(@host, 80, "/api/v1/production/inverters", @user, @password, @timeout)
+        return nil if !response
+
+        values = JSON.parse(response.body)
+        inverters = {}
+        values.each do |inverter|
+          serial = inverter["serialNumber"]
+          @inverters_list[serial] = true
+          {"lastReportDate" => "last_report_date",
+           "lastReportWatts" => "w_now",
+           "maxReportWatts" => "w_max",
+          }.each do |type, label|
+            inverters["#{@prefix}_#{serial}_#{label}"] = inverter[type]
+          end
+        end
+
+        inverters
+      end
+    end
+  end
+end

data/lib/http.rb

@@ -0,0 +1,51 @@
+require 'uri'
+require 'net/http'
+require 'net/http/digest_auth'
+
+def SAAL::do_http_get(host, port, path, user, pass, timeout)
+  begin
+    http = Net::HTTP.new(host,port)
+    # Timeout faster when the other side doesn't respond
+    http.open_timeout = timeout
+    http.read_timeout = timeout
+    req = Net::HTTP::Get.new(path)
+    req.basic_auth(user, pass) if user && pass
+    response = http.request(req)
+    if response.code != "200"
+      #$stderr.puts "ERROR: Code #{response.code}"
+      #$stderr.puts response.body
+      return nil
+    end
+    return response
+  rescue Exception
+    return nil
+  end
+end
+
+def SAAL::do_http_get_digest(host, port, path, user, pass, timeout)
+  begin
+    uri = URI.parse "http://#{host}:#{port}/#{path}"
+    digest_auth = Net::HTTP::DigestAuth.new
+    uri.user = user
+    uri.password = pass
+    http = Net::HTTP.new(host,port)
+    # Timeout faster when the other side doesn't respond
+    http.open_timeout = timeout
+    http.read_timeout = timeout
+    req = Net::HTTP::Get.new(path)
+    response = http.request(req)
+    if response.code == "401" && user && pass
+      auth = digest_auth.auth_header uri, response['www-authenticate'], 'GET'
+      req.add_field 'Authorization', auth
+      response = http.request(req)
+    end
+    if response.code != "200"
+      #$stderr.puts "ERROR: Code #{response.code}"
+      #$stderr.puts response.body
+      return nil
+    end
+    return response
+  rescue Exception
+    return nil
+  end
+end

data/lib/outliercache.rb

@@ -41,7 +41,7 @@ module SAAL
     def valid_cache
       @compcache.sort!
       central = @compcache[1..(@compcache.size-2)]
-      sum = central.inject(0.0){|sum,el| sum+el}
+      sum = central.inject(0.0){|csum,el| csum+el}
       return false if sum == 0.0
       average = sum/central.size
       central.each do |el|

data/lib/saal.rb

@@ -1,5 +1,5 @@
 require 'yaml'
-require "mysql"
+require "mysql2"
 require 'ownet'
 require 'nokogiri'
 require 'erb'
@@ -10,7 +10,7 @@ module SAAL
     DBCONF = CONFDIR+"database.yml"
     CHARTSCONF = CONFDIR+"charts.yml"
 
-    VERSION = '0.2.23'
+    VERSION = '0.3.2'
 end
 
 require File.dirname(__FILE__)+'/dbstore.rb'
@@ -23,4 +23,6 @@ require File.dirname(__FILE__)+'/chart.rb'
 require File.dirname(__FILE__)+'/chart_data.rb'
 require File.dirname(__FILE__)+'/outliercache.rb'
 require File.dirname(__FILE__)+'/dinrelay.rb'
+require File.dirname(__FILE__)+'/envoy.rb'
+require File.dirname(__FILE__)+'/http.rb'
   

data/lib/sensors.rb

@@ -40,9 +40,29 @@ module SAAL
           defs.merge!('name' => outlet_descriptions[num])
           Sensor.new(dbstore, oname, DINRelay::Outlet.new(num.to_i, og), defs, opts)
         end
+      elsif defs['envoy_power_energy']
+        defs = defs['envoy_power_energy'].merge('prefix' => name)
+        pe = SAAL::Envoy::PowerEnergy::new(defs)
+        sensors = pe.create_sensors
+        return sensors.map do |name, underlying|
+          Sensor.new(dbstore, name, underlying, defs, opts)
+        end
+      elsif defs['envoy_ac_quality']
+        defs = defs['envoy_ac_quality'].merge('prefix' => name)
+        pe = SAAL::Envoy::ACQuality::new(defs)
+        sensors = pe.create_sensors
+        return sensors.map do |name, underlying|
+          Sensor.new(dbstore, name, underlying, defs, opts)
+        end
+      elsif defs['envoy_inverters']
+        defs = defs['envoy_inverters'].merge('prefix' => name)
+        pe = SAAL::Envoy::Inverters::new(defs)
+        sensors = pe.create_sensors
+        return sensors.map do |name, underlying|
+          Sensor.new(dbstore, name, underlying, defs, opts)
+        end
       else
-        raise UnknownSensorType, "Couldn't figure out a valid sensor type "
-                                 "from the configuration for #{name}"
+        $stderror.puts "WARNING: Couldn't figure out a valid sensor type for #{name}"
       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.23'
-  s.date              = '2013-05-16'
+  s.version           = '0.3.2'
+  s.date              = '2020-12-25'
 
   s.summary     = "Thin abstraction layer for interfacing and recording sensors (currently onewire) and actuators (currently dinrelay)"
   s.description = <<EOF
@@ -19,6 +19,7 @@ EOF
   s.authors  = ["Pedro Côrte-Real"]
   s.email    = 'pedro@pedrocr.net'
   s.homepage = 'https://github.com/pedrocr/saal'
+  s.licenses = 'LGPL-2.1'
 
   s.require_paths = %w[lib]
 
@@ -28,9 +29,10 @@ EOF
 
   s.executables = Dir.glob("bin/*").map{|f| f.gsub('bin/','')}
 
-  s.add_dependency('ownet', [">= 0.2.1"])
-  s.add_dependency('nokogiri')
-  s.add_dependency('mysql')
+  s.add_runtime_dependency 'ownet', "~>0.2"
+  s.add_runtime_dependency 'mysql2', "~>0.5"
+  s.add_runtime_dependency 'nokogiri', '~>1.8'
+  s.add_runtime_dependency 'net-http-digest_auth', '~>1.4'
 
   # = MANIFEST =
   s.files = %w[
@@ -44,6 +46,8 @@ EOF
     bin/saal_chart
     bin/saal_daemon
     bin/saal_dump_database
+    bin/saal_envoy_generate_config
+    bin/saal_envoy_read
     bin/saal_import_mysql
     bin/saal_readall
     lib/chart.rb
@@ -52,6 +56,8 @@ EOF
     lib/daemon.rb
     lib/dbstore.rb
     lib/dinrelay.rb
+    lib/envoy.rb
+    lib/http.rb
     lib/outliercache.rb
     lib/owsensor.rb
     lib/saal.rb

data/test/chart_data_test.rb

@@ -78,7 +78,7 @@ class TestChartData < Test::Unit::TestCase
                                         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")
+                            "_changing_timezone_test2","Europe/Lisbon")
 
   assert_alignment_interval(24, :hours, Time.utc(2010, 12, 29, 16, 0, 0),
                                         Time.utc(2010, 12, 30, 15, 59, 59),

data/test/chart_test.rb

@@ -16,7 +16,6 @@ class TestChart < Test::Unit::TestCase
 
   def test_average
     name = 'week'
-    defs = @defs[name]
     chart = @charts.find(name)    
     assert_equal ['Fri','Sat','Sun','Mon','Tue','Wed','Thu'], chart.periodnames
     chart.sensors.each {|s| s.mock_set(:average => 1)}
@@ -31,7 +30,6 @@ class TestChart < Test::Unit::TestCase
 
   def test_min_max_avg_1arity
     name = 'week'
-    defs = @defs[name]
     chart = @charts.find(name)    
     assert_equal ['Fri','Sat','Sun','Mon','Tue','Wed','Thu'], chart.periodnames
     v = {:minimum => 1.0, :maximum => 2.0, :average => 1.5}
@@ -43,7 +41,6 @@ class TestChart < Test::Unit::TestCase
   
   def test_min_max_0arity
     name = 'week'
-    defs = @defs[name]
     chart = @charts.find(name)    
     assert_equal ['Fri','Sat','Sun','Mon','Tue','Wed','Thu'], chart.periodnames
     v = {:minimum => 1.0, :maximum => 2.0, :average => 1.5}

data/test/daemon_test.rb

@@ -18,7 +18,7 @@ class TestDaemon < Test::Unit::TestCase
     end
 
     db_test_query("SELECT * FROM sensor_reads") do |res|
-      assert res.num_rows > 0, "No sensor reads in DB"
+      assert res.count > 0, "No sensor reads in DB"
     end
   end
 
@@ -38,7 +38,7 @@ class TestDaemon < Test::Unit::TestCase
     end
 
     db_test_query("SELECT * FROM sensor_reads") do |res|
-      assert res.num_rows == 0
+      assert res.count == 0
     end
   end
 end

data/test/dbstore_test.rb

@@ -9,8 +9,11 @@ class TestFileStore < Test::Unit::TestCase
     @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
+      assert_equal 1, res.count
+      row = res.first
+      assert_equal "test_sensor", row["sensor"]
+      assert_equal test_time, row["date"].to_i
+      assert_equal test_value, row["value"].to_f
     end
   end
 

data/test/dinrelay_test.rb

@@ -151,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)

data/test/sensors_test.rb

@@ -67,11 +67,11 @@ class TestSensors < Test::Unit::TestCase
     end
 
     db_test_query("SELECT * FROM sensor_reads") do |res|
-      assert_equal 1, res.num_rows
-      row = res.fetch_row
-      assert_equal "fake_temp", row[0]
-      assert_in_delta Time.now.utc.to_i, row[1].to_i, 100
-      assert_instance_of Float, row[2].to_f
+      assert_equal 1, res.count
+      row = res.first
+      assert_equal "fake_temp", row["sensor"]
+      assert_in_delta Time.now.utc.to_i, row["date"].to_i, 100
+      assert_instance_of Float, row["value"].to_f
     end
   end  
 end

data/test/test_db.yml

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

data/test/test_helper.rb

@@ -29,8 +29,7 @@ class Test::Unit::TestCase
   end
 
   def db_test_query(query)  
-    db = Mysql.new(TEST_DBOPTS['host'],TEST_DBOPTS['user'],
-                   TEST_DBOPTS['pass'],TEST_DBOPTS['db'])
+    db = Mysql2::Client.new(TEST_DBOPTS)
     res = db.query(query)
     yield res
     db.close

data/test/test_sensors.yml

@@ -1,7 +1,7 @@
 fake_temp:
   name: "A fake temperature sensor"
   onewire: 
-    serial: /10.4AEC29CDBAAB/temperature
+    serial: /10.67C6697351FF/temperature
 
 non_existant:
   name: "A non-existant sensor"

metadata

@@ -1,63 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: saal
 version: !ruby/object:Gem::Version
-  version: 0.2.23
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - Pedro Côrte-Real
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2020-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ownet
-  requirement: &77167490 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *77167490
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &77166790 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
-  version_requirements: *77166790
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: mysql
-  requirement: &77165610 !ruby/object:Gem::Requirement
-    none: false
+  name: net-http-digest_auth
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *77165610
-description: ! "A daemon and libraries to create an abstraction layer that interfaces
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: "A daemon and libraries to create an abstraction layer that interfaces
   with \nsensors and actuators, recording their state, responding to requests \nfor
   current and historical values, and allowing changes of state.\n"
 email: pedro@pedrocr.net
 executables:
-- saal_chart~
 - dinrelaystatus
-- saal_readall
-- saal_dump_database
-- saal_daemon
-- saal_chart
-- saal_daemon~
 - dinrelayset
 - saal_import_mysql
+- saal_dump_database
+- saal_readall
+- saal_chart
+- saal_daemon
+- saal_envoy_generate_config
+- saal_envoy_read
 extensions: []
 extra_rdoc_files:
 - README.rdoc
@@ -73,6 +95,8 @@ files:
 - bin/saal_chart
 - bin/saal_daemon
 - bin/saal_dump_database
+- bin/saal_envoy_generate_config
+- bin/saal_envoy_read
 - bin/saal_import_mysql
 - bin/saal_readall
 - lib/chart.rb
@@ -81,6 +105,8 @@ files:
 - lib/daemon.rb
 - lib/dbstore.rb
 - lib/dinrelay.rb
+- lib/envoy.rb
+- lib/http.rb
 - lib/outliercache.rb
 - lib/owsensor.rb
 - lib/saal.rb
@@ -104,34 +130,31 @@ files:
 - test/test_helper.rb
 - test/test_sensor_cleanups.yml
 - test/test_sensors.yml
-- bin/saal_chart~
-- bin/saal_daemon~
 homepage: https://github.com/pedrocr/saal
-licenses: []
-post_install_message: 
+licenses:
+- LGPL-2.1
+metadata: {}
+post_install_message:
 rdoc_options:
-- -S
-- -w 2
-- -N
-- -c utf8
+- "-S"
+- "-w 2"
+- "-N"
+- "-c utf8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 2
 summary: Thin abstraction layer for interfacing and recording sensors (currently onewire)
   and actuators (currently dinrelay)

data/bin/saal_chart~

@@ -1,90 +0,0 @@
-#!/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,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"
-  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/bin/saal_daemon~

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-
-SENSOR_INTERVAL = 60 # seconds between consecutive measurements of the sensors
-DBCONF = "/etc/saal/database.yml"
-SENSORSCONF = "/etc/saal/sensors.yml"
-
-require File.dirname(__FILE__)+'/../lib/saal.rb'
-
-def usage
-  $stderr.puts "Usage: saal_daemon <pidfile|--foreground>"
-end
-
-if ARGV.size != 1
-  usage
-  exit 2
-else
-  pidfile = ARGV[0]
-  foreground = (ARGV[0] == '--foreground')
-  d = SAAL::Daemon.new(:interval => SENSOR_INTERVAL,
-                       :sensorconf => SENSORSCONF,
-                       :dbconf => DBCONF,
-                       :foreground => foreground,
-                       :keep_stdin => true)
-  pid = d.run
-  if !foreground
-    File.open(pidfile, 'w') do |f|
-      f.write(pid)
-      f.close
-    end
-  end
-end