--    ======================
--    Description
--    ======================
--
--    Konfigurator interfejsu H4F8V1.
--
--    Umożliwia sterowanie 3 strefami grzewczymi A, F lub AF oraz wentylacją.
--
--    ======================
--    Parameters
--    ======================
--
--    SubLogic supports following variables:
--
--    setting.keylock                       - [RWS] (0..2) tryb blokady klawiatury, wartość fabryczna 0.
--                                            0 - menu oraz ustawienia temperatur/wentylacji są dostępne.
--                                            1 - wyłącza dostęp do menu nastaw, gdy jest ono załączone, można do niego wejść przez dłuższe przytrzymanie przycisku M.
--                                            2 - wyłącza wszystkie funkcje klawiatury, prócz przemieszczania się przyciskiem P pomiędzy strefami i wentylacją. Widoczny
--                                                jest symbol kłódki - t10.
--
--    setting.features.mask                 - [RWS] (1..15) maska bitowa załączająca poszczególne właściwości urządzenia. Wartość fabryczna: 0x01ff
--                                            0b0000000ABCDVWXYZ, gdzie: Z - bit strefy 1, Y - bit strefy 2, X - bit strefy 3, W - bit strefy 4.
--                                            ustawienie danego bitu oznacza załączenie obsługi danej funkcji w sterowniku.
--                                            Przełączenie pomiędzy kolejnymi strefami realizowane jest przez krótkie naciśnięcie P. Urządzenie sygnalizuje
--                                            aktualnie wyświetlaną strefę przez wyświetlanie cyfr 1, 2, 3, 4. (symbole t35..t37).
--                                            V - bit zezwalający na wejście do menu obsługi trybu wakacyjnego.
--                                            A - bit zezwalający ustawianie biegu wentylatora dla obejścia dla strefy 4
--                                            B - bit zezwalający ustawianie biegu wentylatora dla obejścia dla strefy 3
--                                            C - bit zezwalający ustawianie biegu wentylatora dla obejścia dla strefy 2
--                                            D - bit zezwalający ustawianie biegu wentylatora dla obejścia dla strefy 1
--
--    input.z1.t.value
--    input.z2.t.value
--    input.z3.t.value
--    input.z4.t.value                      - [RW] (-250..1000) - wejściowe wskazania temperatur dla stref 1, 2, 3, 4. temperatury te są ustawiane przez
--                                            zewnętrzną aplikację przy pomocy interfejsu modbus. Jeżeli setting.phy.t.X.zone.idx mają wartość indeksu danej strefy (1, 2, 3 lub 4)
--                                            wówczas lokalne wskazania input.t.X.value jest kopiowane do odpowiedniego rejestru input.zN.t.a.value. Wartość fabryczna: 0
--                                            Bieżące temperatury wyświetlane są w segmentach 12, 13 oraz 14 wyświetlacza. Jeżeli status danej temperatury jest różny od 0,
--                                            wówczas widoczny jest napis "err". Gdy wyświetlane są temperatury, wówczas widoczny jest napis "RT" - segment t31.
--
--    input.z1.t.err
--    input.z2.t.err
--    input.z3.t.err
--    input.z4.t.err                        - [RW] (0..8) - wejściowe statusy temperatur pomieszczenia dla stref 1, 2, 3 oraz 4. statusy te są ustawiane przez
--                                            zewnętrzną aplikację przy pomocy interfejsu modbus. Jeżeli setting.phy.t.X.zone.idx mają wartość indeksu danej strefy (1, 2, 3 lub 4)
--                                            wówczas lokalny status input.t.X.err jest kopiowany do odpowiedniego rejestru input.zN.t.err. Wartość fabryczna: 8
--
--    setting.z1.value
--    setting.z2.value
--    setting.z3.value
--    setting.z4.value                      - [RW] (0..1) - wyjście grzejnika dla stref. Wartość fabryczna: 0.
--                                            Stan wyjścia jest sygnalizowany poprzez symbol płomienia (t56).
--
--    setting.z1.vent.lev.mask
--    setting.z2.vent.lev.mask
--    setting.z3.vent.lev.mask
--    setting.z4.vent.lev.mask              - [RWS] (1..127) - dozwolone biegi wentylatora dla poszczególnych stref, możliwe do ustawienia z poziomu ekranu urządzenia.
--                                            są to maski bitowe, uwzględniające najmłodszych 7 bitów: XXXXXXXXX6543210, gdzie cyfra na danej pozycji to bieg wentylatora, przy
--                                            czym 0 oznacza bieg zerowy. rejestr ten nie może przyjąć wartości 0 - jakiś bieg musi być zdefiniowany dla wentylacji danej strefy.
--
--    setting.z1.max.vent.time
--    setting.z2.max.vent.time
--    setting.z3.max.vent.time
--    setting.z4.max.vent.time              - [RWS] (0.999) - maksymalny czas obejścia wentylacji dla poszczególnych stref.
--
--    setting.z1.symbol.mask
--    setting.z2.symbol.mask
--    setting.z3.symbol.mask
--    setting.z4.symbol.mask                - [RW] maska symbolu do wyświetlenia 0..65535.
--
--                                            1              0
--                                            5
--                                            XXXXXXXXXXXXXXXX
--                                            ||||||||||||||||
--                                            |||||||||||||||+== t14 - domek 1
--                                            ||||||||||||||+=== t15 - domek 2
--                                            |||||||||||||+==== t16 - domek 3
--                                            ||||||||||||+===== t17 - domek 4
--                                            |||||||||||+====== t20 - księżyc
--                                            ||||||||||+======= t18 - płatek śniegu
--                                            |||||||||+======== t47 - strzałki
--                                            ||||||||+========= t39 - ręka
--                                            |||||||+========== t31 - litery RT
--                                            ||||||+=========== t13 - wykrzyknik
--                                            |||||+============ t21 - napis SEC
--                                            ||||+============= t12 - zegarek
--                                            |||+============== t28 - litera A
--                                            ||+=============== t29 - litera F
--                                            |+================ t55 - napis STAGE
--                                            +================= t32 - litery FT
--
--    setting.dt.update.period              - co ten okres data i godzina z ibmanager jest synchronizowana z H4F6
--
--    counter.dt.update.downtime            - pozostały okres powiązany z setting.dt.update.period
--
--    Logic uses lua language to implement own behaviour
--
--    ======================
--    mandatory variables
--    ======================
--
--    Logic expects following mandatory variables:
--
--    reload.trigger                          - causes reloading lua script
--
--    memcnt                                  - current amount of memory used by lua in bytes
--
--    Logic expects following kv settings:
--
--    LuaScriptPath                           - path to the lua script - must be absolute
--
--    ======================
--    ChangeLog
--    ======================
--
--    2018-09-21 ver 0.0.0
--
--    # First release
--
-- user can use some functions provided by ibmanager.

-- ibmanager provides following functions to use:
--
-- function returns value of required ibmanager variable
-- @param fullName - string - variable name - name of variable of which value must be returned, for example "rs.0.id.255.input.t.0.value"
-- @return         - string or integer - variable value or "nil" if variable not exist or is not readable
--
-- getValue(fullName)


-- function set value of given ibmanager variable
-- @param fullName - string - variable name - name of variable of which value we want to set, for example "rs.0.id.255.input.t.0.value"
-- @param value    - string, int or boolean - value to set
-- @return         - nothing
--
-- setValue(fullName, value)


-- function returns value of required ibmanager variable
-- @param key      - placed in xml logic configuration file:
--                   * as attribute: Name, in Var, RemoteVar and ImportVar elements in the case of stand alone variables
--                   * as concatenation of two attributes: ListName.Postfix in VarListItem, RemoteVarListItem and ImportVarListItem elements
--                     in the case of variables that are placed in lists
-- @return         - string or integer - variable value or "nil" if variable not exist or is not readable
--
-- getLogicValue(key)


-- function set value of given ibmanager variable
-- @param key      - placed in xml logic configuration file:
--                   * as attribute: Name, in Var, RemoteVar and ImportVar elements in the case of stand alone variables
--                   * as concatenation of two attributes: ListName.Postfix in VarListItem, RemoteVarListItem and ImportVarListItem elements
--                     in the case of variables that are placed in lists
-- @param value    - string, int or boolean - value to set
-- @return         - nothing
--
-- setLogicValue(key, value)

-- function returns two sections of kvsettings from xml configuration file
-- returned value is two element table, each of these elements is table too.
-- indices of returned table are strings and equal "instance" and "global"
-- values of returned tables are tables and contain KVsettings for applicable section.
-- nested tables have form key = value, where key is index in nested table and value is value.
-- example: {"instance" = {"ikey1" = "ivalue1", "ikey2" = "gvalue2"}, "global" = {"gkey1" = "gvalue1", "gkey2" = "gvalue2", "gkey3" = "gvalue3"}}
-- @return          - two dimensional array - kvsettings for global and instance sections
-- getKvSettings()


-- function schedules alert to send.
-- rules are defined in separated alert configuration files and are described in ibmanager instruction manual
-- @param id - alert identifier - must be defined in current logic configuration file in section: <Alert Id="any_identifier" ...
-- scheduleAlert(id)

-- function cancels alert sending, if was previously scheduled. if not then only wakes up alerts handling thread, so if there is no need to call this function, then do not call it.
-- rules are defined in separated alert configuration files and are described in ibmanager instruction manual
-- @param id - alert identifier - must be defined in current logic configuration file in section: <Alert Id="any_identifier" ...
-- cancelAlert(name)

-- function returns table, containing Variables that belongs to required list.
-- @param listName - Name attribute of VarList, RemoteVarList or ImportVarList elemetnst in configurationfile
-- @return array of key-value pairs. Key - variable postfix, Value - Variable value
-- getVarList(listName)

-- function returns monotonic system clock value, that elapsed since specific epoch
-- returned time is expressed in milliseconds.
-- getClock()

-- function logs message to file, if defined in configuration file log level is less than passed to this function
-- @param logLevel - one of:
--        LogLevel.TraceLo
--        LogLevel.Trace
--        LogLevel.TraceHi
--        LogLevel.DebugLo
--        LogLevel.Debug
--        LogLevel.DebugHi
--        LogLevel.Info
--        LogLevel.Notice
--        LogLevel.Warning
--        LogLevel.Error
--        LogLevel.Critical
-- @param logMessage - string to log
-- log(logLevel, logMessage)


-- ibmanager provides following global variables:

-- logic type, (in this case it will always be "Lua") - the same as in logic configuration file in section: <Logic Type="Lua" ...
-- LOGIC_TYPE

-- logic version, the same as in logic configuration file in section: <Logic ... Version="x.y.z" ...
-- LOGIC_VERSION

-- logic sub-type, the same as in logic configuration file in section: <Logic ... SubType="Hysteresis" ...
-- LOGIC_SUBTYPE

-- logic sub-version, the same as in logic configuration file in section: <Logic ... SubVersion="x.y.z" ...
-- LOGIC_SUBVERSION

-- logic instance name - the same as in logic configuration file, in section: <Instance Name="0">
-- LOGIC_INSTANCE_NAME

-- add script directory to package path
package.path = package.path .. ";./logic/scripts/utils/?.lua";

-- use script - without .lua extension - delta class
require("State");
require("DownCounter");

g_counterDtUpdateDowntime = nil;

SUPPORTED_SUBLOGIC_TYPE = "Configh4f8v1";
SUPPORTED_SUBLOGIC_VERSION = "0.0.0";
g_versionChecked = false;

-- entry point to the logic
-- @param firstCall - tells if logic is called first time
-- @return        - nothing
function onLogicCall(firstCall)

  if not g_versionChecked then
    -- checking sublogic type and sublogic version
    if LOGIC_SUBTYPE ~= SUPPORTED_SUBLOGIC_TYPE then
      error("Wrong logic sub-type. expected " .. SUPPORTED_SUBLOGIC_TYPE .. " but used " .. LOGIC_SUBTYPE);
    end
    local versionWithoutBuild = string.match(LOGIC_SUBVERSION, "[0-9]+%.[0-9]+%.[0-9]+");
    if versionWithoutBuild ~= SUPPORTED_SUBLOGIC_VERSION then
      error("Wrong logic sub-version. expected " .. SUPPORTED_SUBLOGIC_VERSION .. " but used " .. LOGIC_SUBVERSION);
    end
    g_versionChecked = true;
  end

  local settingDtUpdatePeriod = getLogicValue("setting.dt.update.period");

  local counterDtUpdateDowntime = 0;

  if g_counterDtUpdateDowntime == nil or firstCall then
    g_counterDtUpdateDowntime = DownCounter.create();
  end
  g_counterDtUpdateDowntime:updateParams(settingDtUpdatePeriod * 1000);

  if g_counterDtUpdateDowntime:elapsed() or firstCall then
    g_counterDtUpdateDowntime:reset();

    setLogicValue("year", getValue("ibmanager.dt.year"));
    setLogicValue("month", getValue("ibmanager.dt.month"));
    setLogicValue("day", getValue("ibmanager.dt.mday"));
    setLogicValue("wday", getValue("ibmanager.dt.wday"));
    setLogicValue("hour", getValue("ibmanager.dt.hour"));
    setLogicValue("minute", getValue("ibmanager.dt.minute"));
    setLogicValue("second", getValue("ibmanager.dt.second"));
  end

  counterDtUpdateDowntime = g_counterDtUpdateDowntime:timeTo0() / 1000;
  counterDtUpdateDowntime = (counterDtUpdateDowntime < 0) and 0 or counterDtUpdateDowntime;

  setLogicValue("counter.dt.update.downtime", counterDtUpdateDowntime);

end
