User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
useful_programs [2019/09/17 08:23]
emozolyak [Bit functions]
useful_programs [2020/06/03 12:01] (current)
emozolyak [Other handy functions]
Line 140: Line 140:
  
 <code lua> <code lua>
-function DBG( ...) -- ... accepts multiple arguments in a table arg  +function DBG(...) 
- +local tc tabToStr 
-local table_sign ​'​|'​ -- if there is divider sign, the values will be grouped in 2 rows +  
-local table_sign_found = false        ​ +function align2s(s1, s2) -- appends space to smaller string ​ 
-local tab_s_index = 0  +    ​local d, s = (#s1 #s2)' ' ; local ad math.abs(d)
- +
-if ENABLE_DEBUG then -- should be global in the calling script  +
- +
-    -- find divider +
-    for i = 1#arg do  +
-        if arg[i] ​== table_sign then  +
-            table_sign_found = true  +
-            tab_s_index = i  +
-            break  +
-        end  +
-    end +
     ​     ​
-    if not table_sign_found then   +    if (d ~0then 
-        INFO(tabToStr(arg)) -- outputs table values in a single row  +
-    else  +
-        local header_t, value_t ​{}, {} -- prepare header and value rows +
-          +
-        for k = 1, tab_s_index - 1 do  +
-            header_t[k] = arg[k] +
-        end  +
-        for j = tab_s_index + 1, #arg do  +
-            value_t[j - tab_s_index] = tostring(arg[j]) +
-        end +
         ​         ​
-        if (#header_t ~#value_t) then  +        ​local Lp, Rp = 0, 0 
-             ERROR("column count differs!")+         
 +        ​if ((ad % 2) == 0) then  
 +            Lp = ad / 2 ; Rp = Lp ; INFO("even parts, L R = " ​.. Lp .. s .. Rp)
         else          else 
-            ​for g 1, #header_t do  +            ​Lp math.floor(ad / 2; Rp Lp + 1 ; INFO("​not even L R " ​.. Lp .. .. Rp)
-                local delta = #​header_t[g] - #value_t[g] -- makes aligment by adding spaces to shorter strings... +
-                if delta ~= 0 then  +
-                    if (delta > 0then  +
-                        value_t[g] ​value_t[g] ​.. string.rep(' ', delta)  +
-                    else  +
-                        header_t[g] = header_t[g] ​.. string.rep(' ', math.abs(delta))  +
-                    end  +
-                end  +
-            end -- for  +
-            INFO(tabToStr(header_t)) ; INFO(tabToStr(value_t))+
         end          end 
 +        return (((d > 0) and {s1, s:rep(Lp) .. s2 .. s:​rep(Rp)}) ​
 +                        or
 +             ​({s:​rep(Lp) .. s1 .. s:rep(Rp), s2}))
 +    else 
 +        return {s1, s2}
     end      end 
-end -- if ENABLE_DEBUG +end 
- +
-return true  +
-end -- DBG+
  
 +    if ENABLE_DEBUG then 
 +        local arg_str = tc(arg)
 +        local t_s_pos = string.find(arg_str,​ "​|"​) ​
 + 
 +        if not t_s_pos then 
 +            INFO(arg_str) ​ -- Just printing single line 
 +        else 
 +            local h_row, v_row = {}, {} 
 +            -- header ​
 +            for w in string.gmatch(arg[1],​ "​%S+"​) do
 +                h_row[#​h_row + 1] = w      ​
 +            end 
 +            -- values ​
 +            for i = 3, #arg do 
 +                v_row[#​v_row + 1] = tostring(arg[i])
 +            end 
 + 
 +            if (#h_row ~= #v_row) then 
 +                ERROR("​Inconsistent header and value rows in DBG!")
 +                INFO("​h_row:"​ .. tc(h_row)) ; INFO("​v_row"​ .. tc("​v_row"​))
 +                return ​
 +            else 
 +                for g = 1, #h_row do 
 +                    h_row[g], v_row[g] = unpack(align2s(h_row[g],​ v_row[g]))
 +                end 
 +            end 
 +            INFO(tc(h_row)) ; INFO(tc(v_row))
 +        end    ​
 +    end 
 +end  ​
 + 
 function tabToStr(t) ​ -- glue all and add spaces, use tostring to protect from nil and bool argument ​ function tabToStr(t) ​ -- glue all and add spaces, use tostring to protect from nil and bool argument ​
     local s = "" ​           ​     local s = "" ​           ​
     for i = 1, #t do      for i = 1, #t do 
-        s = s .. tostring(t[i]) .. ' ' ​+        ​local e = t[i] ; if (e == nil) then e = '​nil'​ end  
 +        ​s = s .. tostring(e) .. ' ' ​
     end -- for      end -- for 
     return s      return s 
-end +end
  
 </​code>​ </​code>​
Line 223: Line 228:
   end    end 
  
 +</​code>​
 +
 +For complex tables print, you can use the following function:
 +<code lua>
 +function tprint(t, indent)
 +    if not indent then indent = 0 end 
 +    for k, v in pairs(t) do 
 +        local formatting = string.rep('​ ', indent) .. k .. ': '
 +        if type(v) == "​table"​ then 
 +            ERROR(formatting) ​
 +            tprint(v, indent + 1) -- recursive call 
 +        else
 +            if type(v) == "​boolean"​ then 
 +                v = v and "​TRUE"​ or "​FALSE"​
 +            end 
 +            ERROR(formatting .. v) 
 +        end 
 +    end -- for 
 +end -- tprint ​
 </​code>​ </​code>​
  
Line 274: Line 298:
  
 <code lua> <code lua>
- function Timer (bool_input,​ onDelay, offDelay, tmrAlias)+function Timer (bool_input,​ onDelay, offDelay, tmrAlias)
 --                bool      sec to ON  sec to OFF  string alias --                bool      sec to ON  sec to OFF  string alias
 + 
 +local now , nowString, curTimeStamp,​ curTmrState =  ​
 +os.time(), os.date("​%c",​ now), R(tmrAlias),​ TRUE(tmrAlias .."​_out"​) ​    
  
-local now , nowString, curTimeStamp,​ curTmrState =  os.time() +    DBG("Timer State Stamp", "|", tmrAlias, ​curTmrState, os.date("​%c",​ curTimeStamp)) ​
-                                                    os.date("%c", ​now),  +
-                                                    R(tmrAlias), +
-                                                    TRUE(tmrAlias .."​_out"​) ​     +
-                                           +
-DEBUG("​curTimeStamp - ", os.date("​%c",​ curTimeStamp) ) +
-DEBUG ("cur "​..tmrAlias.."​ State =  "​..tostring(curTmrState)) ​                 +
 -- protects from malfunctions on very first run  -- protects from malfunctions on very first run 
 if curTimeStamp == 0 then  if curTimeStamp == 0 then 
-    ​DEBUG("​curTimeStamp was zero in this timer!"​)+    ​DBG("​curTimeStamp was zero in this timer!"​)
     WriteReg(tmrAlias,​ now)     WriteReg(tmrAlias,​ now)
     return nil, 0 -- countdown ​     return nil, 0 -- countdown ​
 end  end 
 + 
     -- in and output are equal                                                          -- in and output are equal                                                     
-    ​if (bool_input == curTmrState) then  + 
-        WriteReg(tmrAlias,​ now)                           DEBUG("​timer ​input match state "​) ​+if (bool_input == curTmrState) then  
 +        WriteReg(tmrAlias,​ now) ; DBG("​timer ​inputs ​match"​) ​
         return curTmrState,​ 0   -- as bool          return curTmrState,​ 0   -- as bool 
-    ​ +        ​ 
-    -- TON      +                            -- TON      
-    elseif bool_input then  +elseif bool_input then  
-         if ((now - GetReg(tmrAlias)) > onDelay) then  +         if ((now - curTimeStamp) > onDelay) then  
-             WriteReg(tmrAlias .."​_out", ​1 +             SET(tmrAlias .."​_out"​) ; WriteReg(tmrAliasnow; DBG("​detected ON state after delay"​)
-                                                        DEBUG("​detected ON state after delay (input, now, tmr, onDelay ):", bool_input, nowString, onDelay)+
              ​return true, 0  ​              ​return true, 0  ​
         else          else 
-            local countDown = onDelay - (now - curTimeStamp) +            local countDown = onDelay - (now - curTimeStamp) ​; DBG("​countdown to On in "countDown)
-            DEBUG("​countdown to On in " ​.. tmrAlias .. " "​.. ​countDown)+
             return curTmrState,​ countDown             return curTmrState,​ countDown
         end          end 
 + 
 +                            -- TOFF     
 +elseif not bool_input then 
     ​     ​
-    -- TOFF      +        ​if ((now - curTimeStamp) > offDelay) then    
-    elseif not bool_input then  +            ​RESET(tmrAlias .."​_out"​) ; WriteReg (tmrAliasnow; DBG("​detected OFF state after delay"​) 
-        ​if (now - GetReg ( tmrAlias ​) > offDelay) then    +            return false, 0   
-            ​WriteReg ​(tmrAlias .."​_out", ​0) +
-            DEBUG("​detected OFF state after delay (input, now, tmr, offDelay ):", bool_input, nowString, offDelay+
-            return false  +
         else          else 
-            local countDown = offDelay - (now - curTimeStamp) +            local countDown = offDelay - (now - curTimeStamp) ​; DBG("​countdown to OFF in "countDown)
-            DEBUG ("​countdown to OFF in " ​.. tmrAlias .." "​.. ​countDown)+
             return curTmrState,​ countDown             return curTmrState,​ countDown
         end          end 
Line 609: Line 627:
 To determine intermediate positions, a calculated value is used, determined from the characteristics of the 'full path time', which can also be determined experimentally.  ​ To determine intermediate positions, a calculated value is used, determined from the characteristics of the 'full path time', which can also be determined experimentally.  ​
  
-Below is a variant of 3-point control for a valve with 2 limit switches. ​+Below is a variant of 3-point control for a valve withoutlimit ​switches. ​
  
 <code lua> <code lua>
-function ​main (userId)+function ​valveControl(v) 
 +     
 +    local FULL_PATH_TIME = R(v .. "​pathTime"​) ; local KOEF = 100 / FULL_PATH_TIME 
 +    local HOMING_DELAY = R(v .. "​homingDelay"​) * 60 * 60 -- get seconds from hours  ​
     ​     ​
-       -- copy desired Tfeed to valve PID target temp. +    local auto, autoOpenCmd,​ autoCloseCmd,​ now =  
-    ​W ​( "HeatDistribution.targetTemperature", ​ ​R ​( "recalcFeedTemp" ))     ​+          TRUE("auto_mode"​),​ TRUE(v .. "openCmd"​)TRUE(v .. "closeCmd"), os.time() 
 +                     
 +local motionTmr = function() -- calc. path quant passed from last call 
  
-now = os.time() -- global ​+    local quant = 0 
 +    if (autoOpenCmd or autoCloseCmd) then  
 +          quant = (now - R(v .. "​motionTmr"​)) * KOEF ; SET(v .. "​valveStatus"​) -- opening  
 +           
 +          if autoCloseCmd ​ then   
 +              quant quant * (-1)          -- closing  
 +              UpdReg(v ​.. "​valveStatus",​ 2)  
 +          end  
 +    else  
 +          RESET(v .. "​valveStatus"​) 
 +          quant = 0  
 +    end  -- if motion  
 +    UpdReg(v .. "​motionTmr",​ now)     -- remember last call  
 +    return quant 
 +end -- motionTmr ​
  
-local manOpenCmd, manCloseCmd = R("​manOpenCmd"​),​ R("​manCloseCmd"​) ​    ​-- manual run flags +    local pos Limiter(Round(R(v .. "curPosition")) + motionTmr(), 0, 100) 
-local autoOpenCmd,​ autoCloseCmd ​R("​autoOpenCmd"​),​ R("​autoCloseCmd"​) -- cmds to control valve +    local sp = R(.. "posSetpoint"​) ​ 
-local openSw, closeSw = (R("valveOpenSw"​) ​== 1) , (R("​valveCloseSw"​) == 1) +
-local pullUpFlag, pullDownFlag = (R("​pullUpFlag"​) == 1 ), (R("​pullDownFlag"​) == 1 )  ;  +
- +
-local curPosition = Round(R("​valveCurPos"​) + MotionTimer(autoOpenCmd,​ autoCloseCmd,​ "​Tmr5"​)) ; DEBUG("​curPosition calc. as "​..curPosition) +
- +
-                -- filtering cur position and check limit sw +
-if (curPosition >= 100) or openSw then  +
-    curPosition = 100  +
-        if openSw then  +
-            W ("​pullUpFlag"​1 ) +
-            pullUpFlag = true  +
-        end  +
-end  +
- +
-if ((curPosition < 0) or closeSw) then  +
-    curPosition = 0  +
-        if closeSw then  +
-            W ("​pullDownFlag"​1 )  +
-            pullDownFlag = true  +
-        end  +
-end  +
-                            -- pulling +
-if (curPosition == 100) and not (openSw) and not pullUpFlag then  +
-    ​curPosition = 99  ;                                             ​DEBUG("​ pulling up")  +
-end  +
-if (curPosition == 0 ) and not (closeSw) and not pullDownFlag then  +
-    curPosition = 1   ; ​                                            ​DEBUG("​ pulling down")  +
-end  +
- +
-W ("​valveCurPos",​ curPosition) -- renew current position +
- +
-                                    -- AUTO MODE ----  +
-local valveSp ​= R ( "​valveSp"​ )  ;                                     ​DEBUG("​valveSp ​ "..valveSp) ​                                     +
-local positionError = (curPosition - valveSp) ​   +
- +
-if (positionError ~= 0) and ( autoOpenCmd ~= 1) and (autoCloseCmd ~= 1) then  +
-    -- reset pulling flags befor start  +
-    W ("pullDownFlag" ​, 0 ); W ("​pullUpFlag",​ 0) +
-end  +
- +
-if ( R ( "​distribAutoMode"​) == 1) then +
     ​     ​
-    ​W ("​manOpenCmd"​0 ) -- clear manual cmds +    ​local uShootoShoot = (pos < sp)(pos > sp
-    W ("​manCloseCmd"​0    ​+
     ​     ​
-    ​if (positionError ​== 0)  then  +    ​local homingOut ​TRUE(v .. "homingTmr_out") 
-        W ("autoOpenCmd", 0 ) +    ​local homing ​Timer(not homingOut, HOMING_DELAY,​ FULL_PATH_TIME * 2, v .. "homingTmr") 
-        W ("​autoCloseCmd",​ 0)  +    ​if not homingOut and homing ​then  
-    ​elseif (positionError > 0)   then  +        ​AddInfoMessage("Started homing for valve " .. v)
-                                    DEBUG("​GO DOWN because positionError ​"​..positionError) ; DEBUG(" math.abs error <= 0."..math.abs(positionError)) +
-        W ("autoOpenCmd",​ 0 ) +
-        W ("​autoCloseCmd",​ 1) -- GO DOWN +
-        ​ +
-    ​elseif (positionError < 0)  ​then  +
-                                    DEBUG("GO UP because positionError = "..positionError) ; DEBUG("​ math.abs error <= 0.5 "​..math.abs(positionError)) +
-        W ("​autoOpenCmd",​ 1 ) -- GO UP +
-        W ("​autoCloseCmd",​ 0)  +
-    else  +
-                                    DEBUG("​Undefined if !!! in valve control ")+
     end      end 
-                                  --- MANUAL MODE -----  
-else                ​ 
-                                  -- just copy manual cmd to valve auto cmd 
-    W ("​autoOpenCmd",​ manOpenCmd ) 
-    W ("​autoCloseCmd",​ manCloseCmd) 
     ​     ​
-     ​if ​not openSw then  +    OUT(auto and uShoot and not homing or (not auto and TRUE(v .. "​manOpenCmd"​)), ​v .. "openCmd") 
-        W ("​autoOpenCmd",​ manOpenCmd )  +    ​OUT(auto and oShoot or homing ​or (not auto and TRUE(.. "manCloseCmd")) ​v ​.. "closeCmd") 
-    else  +    ​UpdReg(.. "curPosition", ​pos)
-        W ("​manOpenCmd"​, 0 ) +
-        W ("​autoOpenCmd",​ 0 ) +
-        W ("​valveCurPos"​100) -- renew position after open limit sw +
-    end  +
-    if not closeSw then  +
-        W ("autoCloseCmd", manCloseCmd)  +
-    ​else  +
-        W ("​manCloseCmd",​ 0)  +
-        W ("​autoCloseCmd",​ 0)  +
-        W ("​valveCurPos",​ 0) -- renew position after close limit sw +
-    end  +
-    +
-end  +
- +
-end -- main  +
- +
-function MotionTimer(openCmd,​ downCmd, tmrAlias) +
- +
-local FULL_PATH_TIME = 180 -- sec. full path time +
-local KOEF = 100 / FULL_PATH_TIME +
-local quant = 0  +
---[[                 ​bool ​       string  +
-remembers start time +
-recalc. micro path from the previous call if was in motion +
-adds micro path to current position  +
---                                                  open = true                                       ]]  +
-    local motion = { flag = ((openCmd == 1) or (downCmd == 1)), dir = (openCmd == 1), lastTimeStamp = R(tmrAlias)} +
-    DEBUG("​ motion.flag = "​..tostring(motion.flag).." ​dir  ​"..tostring(motion.dir)..os.date("​%c"​lastTimeStamp))  +
-    local outAlias = tmrAlias.."_out" +
-    local curTmrState = (R(outAlias) == 1) ; DEBUG("​cur "​..tmrAlias.."​ State =  "​..tostring(curTmrState)) +
-                                                ​ +
-    ​if motion.flag then  +
-      quant = (now - R(tmrAlias)) * KOEF +
-          if not motion.dir then  +
-              quant = quant * (-1)  +
-          end  +
-                                                     ​DEBUG("​quant calculated as = "..quant) +
-      W (outAlias, 1) -- "in motion" ​flag +
-                                                     +
-    else  +
-                    DEBUG("​no motion lasts = ") +
-      W (outAlias0  +
-      quant = 0  +
-    end  -- if +
     ​     ​
-(tmrAliasnow)     -- rememeber last call time  +    DBG("auto sp pos autoOpenCmd autoCloseCmd uShoot oShoot ", '​|'​,  
-return quant +           auto, sp, Round(pos, 1), autoOpenCmd,​ autoCloseCmd,​ uShoot, oShoot) 
- +end
-end -- function ​+
 </​code>​ </​code>​
  
Line 834: Line 769:
             return false -- nothing happened ​             return false -- nothing happened ​
 end -- P_TRIG ​ end -- P_TRIG ​
 +
 +-- multiple ids or aliases read, returns table, have to be unpack() 'ed
 +-- usage: v1, v2, v3... = unpack(mRead(1,​ 2, 3, ...))
 +function mRead(...) ​
 +     local results = {} 
 +     for i = 1, #arg do 
 +         local param = arg[i]
 +        --  INFO("​processing " .. param .. " paramter"​)
 +          results[i] = GetReg(param)
 +     ​end ​
 +     if (#results == 1) then 
 +         ​return results[1]
 +     ​else ​
 +         ​return results
 +     ​end ​
 +end 
 </​code>​ </​code>​
  

Page Tools