saal 0.2.25 → 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a86991bf6a2c0ddf03cab4c239953c2c4e819f5019145398f4b7a527e928852
+  data.tar.gz: de08c727c732e4afb86cafcdcadfeec1f16fb127d675714b03bf388956bc6646
+SHA512:
+  metadata.gz: db0fe9ccfd6e51da7bec292c9cd44c0b8c994ca238772cd817941f22f823f8ac8098ef005373e2f86dfcd9d121dc6470bdd3615ba961d1c514c620e8cf399095
+  data.tar.gz: fa64aa3d8cea43fc12e07db8d84def9ba45ca27655dbb95251e7b7c45e8c322b5c8ee0f58b02b4c63c9799f15a5db1316e0e174a6b246ee4725887d3ce12d823

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/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,152 @@
+#!/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 fdispd(val)
+  if val
+    Time.at(val.to_i).strftime("%Y-%m-%d %k:%M:%S")
+  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:#{fdispd(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

@@ -35,6 +35,32 @@ module SAAL
       db_range("AVG", sensor, from, to)
     end
 
+    def weighted_average(sensor, from, to)
+      total_time = 0
+      total_value = 0.0
+      previous_value = nil
+      start_time = nil
+      initialized = false
+      db_query "SELECT date,value FROM sensor_reads
+                       WHERE sensor = '#{db_quote(sensor.to_s)}'
+                         AND date >= #{from.to_s}
+                         AND date <= #{to.to_s}" do |r|
+        r.each do |row|
+          date = row["date"].to_i
+          value = row["value"].to_f
+          if start_time
+            elapsed = date - start_time
+            total_value += elapsed * previous_value
+            total_time += elapsed
+            initialized = true
+          end
+          start_time = date
+          previous_value = value
+        end
+      end
+      initialized ? total_value / total_time : nil
+    end
+
     def minimum(sensor, from, to)     
       db_range("MIN", sensor, from, to)
     end
@@ -46,54 +72,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/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 = 5
+      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