#572 added facility radiation alarm

2025-04-29 19:41:52 +00:00
parent 04c53c7074
commit eafd39fa35
8 changed files with 204 additions and 140 deletions
--- a/supervisor/alarm_ctl.lua
+++ b/supervisor/alarm_ctl.lua
@@ -0,0 +1,134 @@
+local log   = require("scada-common.log")
+local types = require("scada-common.types")
+local util  = require("scada-common.util")
+
+local ALARM_STATE = types.ALARM_STATE
+
+---@class alarm_def
+---@field state ALARM_INT_STATE internal alarm state
+---@field trip_time integer time (ms) when first tripped
+---@field hold_time integer time (s) to hold before tripping
+---@field id ALARM alarm ID
+---@field tier integer alarm urgency tier (0 = highest)
+
+local AISTATE_NAMES = {
+    "INACTIVE",
+    "TRIPPING",
+    "TRIPPED",
+    "ACKED",
+    "RING_BACK",
+    "RING_BACK_TRIPPING"
+}
+
+---@enum ALARM_INT_STATE
+local AISTATE = {
+    INACTIVE = 1,
+    TRIPPING = 2,
+    TRIPPED = 3,
+    ACKED = 4,
+    RING_BACK = 5,
+    RING_BACK_TRIPPING = 6
+}
+
+local alarm_ctl = {}
+
+alarm_ctl.AISTATE = AISTATE
+alarm_ctl.AISTATE_NAMES = AISTATE_NAMES
+
+-- update an alarm state given conditions
+---@param caller_tag string tag to use in log messages
+---@param alarm_states { [ALARM]: ALARM_STATE } unit instance
+---@param tripped boolean if the alarm condition is sti ll active
+---@param alarm alarm_def alarm table
+---@param no_ring_back boolean? true to skip the ring back state, returning to inactive instead
+---@return boolean new_trip if the alarm just changed to being tripped
+function alarm_ctl.update_alarm_state(caller_tag, alarm_states, tripped, alarm, no_ring_back)
+    local int_state = alarm.state
+    local ext_state = alarm_states[alarm.id]
+
+    -- alarm inactive
+    if int_state == AISTATE.INACTIVE then
+        if tripped then
+            alarm.trip_time = util.time_ms()
+            if alarm.hold_time > 0 then
+                alarm.state = AISTATE.TRIPPING
+                alarm_states[alarm.id] = ALARM_STATE.INACTIVE
+            else
+                alarm.state = AISTATE.TRIPPED
+                alarm_states[alarm.id] = ALARM_STATE.TRIPPED
+                log.info(util.c(caller_tag, " ALARM ", alarm.id, " (", types.ALARM_NAMES[alarm.id], "): TRIPPED [PRIORITY ",
+                    types.ALARM_PRIORITY_NAMES[alarm.tier],"]"))
+            end
+        else
+            alarm.trip_time = util.time_ms()
+            alarm_states[alarm.id] = ALARM_STATE.INACTIVE
+        end
+    -- alarm condition met, but not yet for required hold time
+    elseif (int_state == AISTATE.TRIPPING) or (int_state == AISTATE.RING_BACK_TRIPPING) then
+        if tripped then
+            local elapsed = util.time_ms() - alarm.trip_time
+            if elapsed > (alarm.hold_time * 1000) then
+                alarm.state = AISTATE.TRIPPED
+                alarm_states[alarm.id] = ALARM_STATE.TRIPPED
+                log.info(util.c(caller_tag, " ALARM ", alarm.id, " (", types.ALARM_NAMES[alarm.id], "): TRIPPED [PRIORITY ",
+                    types.ALARM_PRIORITY_NAMES[alarm.tier],"]"))
+            end
+        elseif int_state == AISTATE.RING_BACK_TRIPPING then
+            alarm.trip_time = 0
+            alarm.state = AISTATE.RING_BACK
+            alarm_states[alarm.id] = ALARM_STATE.RING_BACK
+        else
+            alarm.trip_time = 0
+            alarm.state = AISTATE.INACTIVE
+            alarm_states[alarm.id] = ALARM_STATE.INACTIVE
+        end
+    -- alarm tripped and alarming
+    elseif int_state == AISTATE.TRIPPED then
+        if tripped then
+            if ext_state == ALARM_STATE.ACKED then
+                -- was acked by coordinator
+                alarm.state = AISTATE.ACKED
+            end
+        else
+            alarm.state = AISTATE.RING_BACK
+            alarm_states[alarm.id] = ALARM_STATE.RING_BACK
+        end
+    -- alarm acknowledged but still tripped
+    elseif int_state == AISTATE.ACKED then
+        if not tripped then
+            if no_ring_back then
+                alarm.state = AISTATE.INACTIVE
+                alarm_states[alarm.id] = ALARM_STATE.INACTIVE
+            else
+                alarm.state = AISTATE.RING_BACK
+                alarm_states[alarm.id] = ALARM_STATE.RING_BACK
+            end
+        end
+    -- alarm no longer tripped, operator must reset to clear
+    elseif int_state == AISTATE.RING_BACK then
+        if tripped then
+            alarm.trip_time = util.time_ms()
+            if alarm.hold_time > 0 then
+                alarm.state = AISTATE.RING_BACK_TRIPPING
+            else
+                alarm.state = AISTATE.TRIPPED
+                alarm_states[alarm.id] = ALARM_STATE.TRIPPED
+            end
+        elseif ext_state == ALARM_STATE.INACTIVE then
+            -- was reset by coordinator
+            alarm.state = AISTATE.INACTIVE
+            alarm.trip_time = 0
+        end
+    else
+        log.error(util.c(caller_tag, " invalid alarm state for alarm ", alarm.id), true)
+    end
+
+    -- check for state change
+    if alarm.state ~= int_state then
+        local change_str = util.c(AISTATE_NAMES[int_state], " -> ", AISTATE_NAMES[alarm.state])
+        log.debug(util.c(caller_tag, " ALARM ", alarm.id, " (", types.ALARM_NAMES[alarm.id], "): ", change_str))
+        return alarm.state == AISTATE.TRIPPED
+    else return false end
+end
+
+return alarm_ctl