-- ======================
-- Description
-- ======================
--
-- Logic operates on temperature list (temperature value and err code) and returns one result depends of setting.option.
--
-- Temperatures with errors are not included in calculation (see setting.ok.err.codes).
--
-- Output returns value and err.
--
-- ======================
-- Parameters
-- ======================
--
-- SubLogic supports following variables:
--
-- input.values - input list of all values
--
-- setting.option - determinate how output is calculated
-- 0 - min value from input list
-- 1 - max value from input list
-- 2 - average value from input list
--
-- setting.ok.err.codes - err code list of temperatures which should be included in calculations.
-- err code "0" may be not defined. It is always calculated.
-- if this list is empty only values witch err code "0" is included in calculations
--
-- output.value - calculated value from input list
--
-- output.err - error code of calculated temperature. If all values has not acceptable errors it returns "8"
--
-- 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
-- ======================
--
-- 2017-10-18 ver 0.0.2.0
--
-- + powiadomienie w konsoli o nieznalezieniu pary value i err dla prefixa
--
-- 2017-06-07 ver 0.0.1.825
--
-- # obsługa automatycznego build'a
--
-- 2017-05-24 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";
SUPPORTED_SUBLOGIC_TYPE = "ListUtilsTemp";
SUPPORTED_SUBLOGIC_VERSION = "0.0.2";
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 inputValueList = getVarList("input.values");
local inputErrList = getVarList("input.errs");
local settingOption = getLogicValue("setting.option");
local settingOkErrCodes = getVarList("setting.ok.err.codes");
local outputValue = 0;
local outputErr = 8;
local firstrun = true;
local errOK = false;
local temps = 0;
local pairfound = false;
if (inputValueList ~= nil) and (inputErrList ~= nil) then
for valueName, valueValue in pairs(inputValueList) do
pairfound = false
for errName, errValue in pairs(inputErrList) do
if (valueName == errName) then
pairfound = true
errOK = false;
if (settingOkErrCodes ~= nil) then
for errOKCodeName, errOKCodeValue in pairs(settingOkErrCodes) do
if (errValue == errOKCodeValue) or (errValue == 0) then
errOK = true;
end
end;
else
if (errValue == 0) then
errOK = true;
end;
end
if (errOK == true) then
if (settingOption == 0) then
if (firstrun == true) then
outputValue = valueValue;
outputErr = errValue;
firstrun = false;
end
if valueValue < outputValue then
outputValue = valueValue;
outputErr = errValue;
end
elseif (settingOption == 1) then
if (firstrun == true) then
outputValue = valueValue;
outputErr = errValue;
firstrun = false;
end
if valueValue > outputValue then
outputValue = valueValue;
outputErr = errValue;
end
elseif (settingOption == 2) then
outputValue = outputValue + valueValue;
temps = temps + 1;
end
end
end
end
if (pairfound == false) then
print("Lua.ListUtilsTemp error: Pair for prefix not found: ", valueName);
end
end
if (settingOption == 2) then
if (temps > 0) then
outputValue = outputValue / temps;
outputErr = 0;
end
end
end
setLogicValue("output.value", outputValue);
setLogicValue("output.err", outputErr);
end
