util-you.lua / last modification: 2020-01-30 14:16
if not modules then modules = { } end modules ['util-you'] = {
    version   = 1.002,
    comment   = "library for fetching data from youless kwh meter polling device",
    author    = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
    copyright = "PRAGMA ADE",
    license   = "see context related readme files"
}

-- See mtx-youless.lua and s-youless.mkiv for examples of usage.
--
-- todo: already calculate min, max and average per hour and discard
--       older data, or maybe a condense option
--
-- maybe just a special parser but who cares about speed here
--
-- curl -c pw.txt http://192.168.2.50/L?w=pwd
-- curl -b pw.txt http://192.168.2.50/V?...
--
-- the socket library barks on an (indeed) invalid header ... unfortunately we cannot
-- pass a password with each request ... although the youless is a rather nice gadget,
-- the weak part is in the http polling

require("util-jsn")

-- the library variant:

utilities         = utilities or { }
local youless     = { }
utilities.youless = youless

local lpegmatch  = lpeg.match
local formatters = string.formatters

local tonumber, type, next = tonumber, type, next

local round, div = math.round, math.div
local osdate, ostime = os.date, os.time

local report = logs.reporter("youless")
local trace  = false

-- dofile("http.lua")

local http = socket.http

-- f=j : json

local f_password    = formatters["http://%s/L?w=%s"]

local f_fetchers = {
    electricity = formatters["http://%s/V?%s=%i&f=j"],
    gas         = formatters["http://%s/W?%s=%i&f=j"],
    pulse       = formatters["http://%s/Z?%s=%i&f=j"],
}

local function fetch(url,password,what,i,category)
    local fetcher = f_fetchers[category or "electricity"]
    if not fetcher then
        report("invalid fetcher %a",category)
    else
        local url     = fetcher(url,what,i)
        local data, h = http.request(url)
        local result  = data and utilities.json.tolua(data)
        return result
    end
end

-- "123" " 23" "  1,234"

local tovalue = lpeg.Cs((lpeg.R("09") + lpeg.P(1)/"")^1) / tonumber

-- "2013-11-12T06:40:00"

local totime = (lpeg.C(4) / tonumber) * lpeg.P("-")
             * (lpeg.C(2) / tonumber) * lpeg.P("-")
             * (lpeg.C(2) / tonumber) * lpeg.P("T")
             * (lpeg.C(2) / tonumber) * lpeg.P(":")
             * (lpeg.C(2) / tonumber) * lpeg.P(":")
             * (lpeg.C(2) / tonumber)

local function collapsed(data,dirty)
    for list, parent in next, dirty do
        local t, n = { }, { }
        for k, v in next, list do
            local d = div(k,10) * 10
            t[d] = (t[d] or 0) + v
            n[d] = (n[d] or 0) + 1
        end
        for k, v in next, t do
            t[k] = round(t[k]/n[k])
        end
        parent[1][parent[2]] = t
    end
    return data
end

local function get(url,password,what,step,data,option,category)
    if not data then
        data = { }
    end
    local dirty = { }
    while true do
        local d = fetch(url,password,what,step,category)
        local v = d and d.val
        if v and #v > 0 then
            local c_year, c_month, c_day, c_hour, c_minute, c_seconds = lpegmatch(totime,d.tm)
            if c_year and c_seconds then
                local delta = tonumber(d.dt)
                local tnum = ostime {
                    year  = c_year,
                    month = c_month,
                    day   = c_day,
                    hour  = c_hour,
                    min   = c_minute,
                    sec   = c_seconds,
                }
                for i=1,#v do
                    local vi = v[i]
                    if vi ~= "*" then
                        local newvalue = lpegmatch(tovalue,vi)
                        if newvalue then
                            local t = tnum + (i-1)*delta
                         -- local current = osdate("%Y-%m-%dT%H:%M:%S",t)
                         -- local c_year, c_month, c_day, c_hour, c_minute, c_seconds = lpegmatch(totime,current)
                            local c = osdate("*t",tnum + (i-1)*delta)
                            local c_year    = c.year
                            local c_month   = c.month
                            local c_day     = c.day
                            local c_hour    = c.hour
                            local c_minute  = c.min
                            local c_seconds = c.sec
                            if c_year and c_seconds then
                                local years   = data.years      if not years   then years   = { } data.years      = years   end
                                local d_year  = years[c_year]   if not d_year  then d_year  = { } years[c_year]   = d_year  end
                                local months  = d_year.months   if not months  then months  = { } d_year.months   = months  end
                                local d_month = months[c_month] if not d_month then d_month = { } months[c_month] = d_month end
                                local days    = d_month.days    if not days    then days    = { } d_month.days    = days    end
                                local d_day   = days[c_day]     if not d_day   then d_day   = { } days[c_day]     = d_day   end
                                if option == "average" or option == "total" then
                                    if trace then
                                        local oldvalue = d_day[option]
                                        if oldvalue and oldvalue ~= newvalue then
                                            report("category %s, step %i, time %s: old %s %s updated to %s",category,step,osdate("%Y-%m-%dT%H:%M:%S",t),option,oldvalue,newvalue)
                                        end
                                    end
                                    d_day[option] = newvalue
                                elseif option == "value" then
                                    local hours  = d_day.hours   if not hours  then hours  = { } d_day.hours   = hours  end
                                    local d_hour = hours[c_hour] if not d_hour then d_hour = { } hours[c_hour] = d_hour end
                                    if trace then
                                        local oldvalue = d_hour[c_minute]
                                        if oldvalue and oldvalue ~= newvalue then
                                            report("category %s, step %i, time %s: old %s %s updated to %s",category,step,osdate("%Y-%m-%dT%H:%M:%S",t),"value",oldvalue,newvalue)
                                        end
                                    end
                                    d_hour[c_minute] = newvalue
                                    if not dirty[d_hour] then
                                        dirty[d_hour] = { hours, c_hour }
                                    end
                                else
                                    -- can't happen
                                end
                            end
                        end
                    end
                end
            end
        else
            return collapsed(data,dirty)
        end
        step = step + 1
    end
    return collapsed(data,dirty)
end

-- day of month (kwh)
--     url = http://192.168.1.14/V?m=2
--     m = the number of month (jan = 1, feb = 2, ..., dec = 12)

-- hour of day (watt)
--     url = http://192.168.1.14/V?d=1
--     d = the number of days ago (today = 0, yesterday = 1, etc.)

-- 10 minutes (watt)
--     url = http://192.168.1.14/V?w=1
--     w = 1 for the interval now till 8 hours ago.
--     w = 2 for the interval 8 till 16 hours ago.
--     w = 3 for the interval 16 till 24 hours ago.

-- 1 minute (watt)
--     url = http://192.168.1.14/V?h=1
--     h = 1 for the interval now till 30 minutes ago.
--     h = 2 for the interval 30 till 60 minutes ago

function youless.collect(specification)
    if type(specification) ~= "table" then
        return
    end
    local host     = specification.host     or ""
    local data     = specification.data     or { }
    local filename = specification.filename or ""
    local variant  = specification.variant  or "kwh"
    local detail   = specification.detail   or false
    local nobackup = specification.nobackup or false
    local password = specification.password or ""
    local oldstuff = false
    if host == "" then
        return
    end
    if filename == "" then
        return
    else
        data = table.load(filename) or data
    end
    if variant == "electricity" then
        get(host,password,"m",1,data,"total","electricity")
        if oldstuff then
            get(host,password,"d",1,data,"average","electricity")
        end
        get(host,password,"w",1,data,"value","electricity")
        if detail then
            get(host,password,"h",1,data,"value","electricity") -- todo: get this for calculating the precise max
        end
    elseif variant == "pulse" then
        -- It looks like the 'd' option returns the wrong values or at least not the same sort
        -- as the other ones, so we calculate the means ourselves. And 'w' is not consistent with
        -- that too, so ...
        get(host,password,"m",1,data,"total","pulse")
        if oldstuff then
            get(host,password,"d",1,data,"average","pulse")
        end
        detail = true
        get(host,password,"w",1,data,"value","pulse")
        if detail then
            get(host,password,"h",1,data,"value","pulse")
        end
    elseif variant == "gas" then
        get(host,password,"m",1,data,"total","gas")
        if oldstuff then
            get(host,password,"d",1,data,"average","gas")
        end
        get(host,password,"w",1,data,"value","gas")
        if detail then
            get(host,password,"h",1,data,"value","gas")
        end
    else
        return
    end
    local path = file.dirname(filename)
    local base = file.basename(filename)
    data.variant = variant
    data.host    = host
    data.updated = os.now()
    if nobackup then
        -- saved but with checking
        local tempname = file.join(path,"youless.tmp")
        table.save(tempname,data)
        local check = table.load(tempname)
        if type(check) == "table" then
            local keepname = file.replacesuffix(filename,"old")
            os.remove(keepname)
            if lfs.isfile(keepname) then
                report("error in removing %a",keepname)
            else
                os.rename(filename,keepname)
                os.rename(tempname,filename)
            end
        else
            report("error in saving %a",tempname)
        end
    else
        local keepname = file.join(path,formatters["%s-%s"](os.date("%Y-%m-%d-%H-%M-%S",os.time()),base))
        os.rename(filename,keepname)
        if lfs.isfile(filename) then
            report("error in renaming %a",filename)
        else
            table.save(filename,data)
        end
    end
    return data
end

-- local data = youless.collect {
--     host     = "192.168.2.50",
--     variant  = "electricity",
--     category = "electricity",
--     filename = "youless-electricity.lua"
-- }
--
-- inspect(data)

-- local data = youless.collect {
--     host     = "192.168.2.50",
--     variant  = "pulse",
--     category = "electricity",
--     filename = "youless-pulse.lua"
-- }
--
-- inspect(data)

-- local data = youless.collect {
--     host     = "192.168.2.50",
--     variant  = "gas",
--     category = "gas",
--     filename = "youless-gas.lua"
-- }
--
-- inspect(data)

-- We remain compatible so we stick to electricity and not unit fields.

function youless.analyze(data)
    if type(data) == "string" then
        data = table.load(data)
    end
    if type(data) ~= "table" then
        return false, "no data"
    end
    if not data.years then
        return false, "no years"
    end
    local variant = data.variant
    local unit, maxunit
    if variant == "electricity" or variant == "watt" then
        unit    = "watt"
        maxunit = "maxwatt"
    elseif variant == "gas" then
        unit    = "liters"
        maxunit = "maxliters"
    elseif variant == "pulse" then
        unit    = "watt"
        maxunit = "maxwatt"
    else
        return false, "invalid variant"
    end
    for y, year in next, data.years do
        local a_year, n_year, m_year = 0, 0, 0
        if year.months then
            for m, month in next, year.months do
                local a_month, n_month = 0, 0
                if month.days then
                    for d, day in next, month.days do
                        local a_day, n_day = 0, 0
                        if day.hours then
                            for h, hour in next, day.hours do
                                local a_hour, n_hour, m_hour = 0, 0, 0
                                for k, v in next, hour do
                                    if type(k) == "number" then
                                        a_hour = a_hour + v
                                        n_hour = n_hour + 1
                                        if v > m_hour then
                                            m_hour = v
                                        end
                                    end
                                end
                                n_day = n_day + n_hour
                                a_day = a_day + a_hour
                                hour[maxunit] = m_hour
                                hour[unit]    = a_hour / n_hour
                                if m_hour > m_year then
                                    m_year = m_hour
                                end
                            end
                        end
                        if n_day > 0 then
                            a_month = a_month + a_day
                            n_month = n_month + n_day
                            day[unit] = a_day / n_day
                        else
                            day[unit] = 0
                        end
                    end
                end
                if n_month > 0 then
                    a_year = a_year + a_month
                    n_year = n_year + n_month
                    month[unit] = a_month / n_month
                else
                    month[unit] = 0
                end
            end
        end
        if n_year > 0 then
            year[unit]    = a_year / n_year
            year[maxunit] = m_year
        else
            year[unit]    = 0
            year[maxunit] = 0
        end
    end
    return data
end