-- -- Nuclear Generation Facility SCADA Coordinator -- require("/initenv").init_env() local crash = require("scada-common.crash") local log = require("scada-common.log") local network = require("scada-common.network") local ppm = require("scada-common.ppm") local tcd = require("scada-common.tcd") local util = require("scada-common.util") local core = require("graphics.core") local config = require("coordinator.config") local coordinator = require("coordinator.coordinator") local iocontrol = require("coordinator.iocontrol") local renderer = require("coordinator.renderer") local sounder = require("coordinator.sounder") local apisessions = require("coordinator.session.apisessions") local COORDINATOR_VERSION = "v0.17.1" local println = util.println local println_ts = util.println_ts local log_graphics = coordinator.log_graphics local log_sys = coordinator.log_sys local log_boot = coordinator.log_boot local log_comms = coordinator.log_comms local log_comms_connecting = coordinator.log_comms_connecting local log_crypto = coordinator.log_crypto ---------------------------------------- -- config validation ---------------------------------------- local cfv = util.new_validator() cfv.assert_channel(config.SVR_CHANNEL) cfv.assert_channel(config.CRD_CHANNEL) cfv.assert_channel(config.PKT_CHANNEL) cfv.assert_type_int(config.TRUSTED_RANGE) cfv.assert_type_num(config.SV_TIMEOUT) cfv.assert_min(config.SV_TIMEOUT, 2) cfv.assert_type_num(config.API_TIMEOUT) cfv.assert_min(config.API_TIMEOUT, 2) cfv.assert_type_int(config.NUM_UNITS) cfv.assert_type_num(config.SOUNDER_VOLUME) cfv.assert_type_bool(config.TIME_24_HOUR) cfv.assert_type_str(config.LOG_PATH) cfv.assert_type_int(config.LOG_MODE) assert(cfv.valid(), "bad config file: missing/invalid fields") ---------------------------------------- -- log init ---------------------------------------- log.init(config.LOG_PATH, config.LOG_MODE, config.LOG_DEBUG == true) log.info("========================================") log.info("BOOTING coordinator.startup " .. COORDINATOR_VERSION) log.info("========================================") println(">> SCADA Coordinator " .. COORDINATOR_VERSION .. " <<") crash.set_env("coordinator", COORDINATOR_VERSION) ---------------------------------------- -- main application ---------------------------------------- local function main() ---------------------------------------- -- system startup ---------------------------------------- -- mount connected devices ppm.mount_all() -- setup monitors local configured, monitors = coordinator.configure_monitors(config.NUM_UNITS) if not configured or monitors == nil then println("startup> monitor setup failed") log.fatal("monitor configuration failed") return end -- init renderer renderer.set_displays(monitors) renderer.init_displays() if not renderer.validate_main_display_width() then println("startup> main display must be 8 blocks wide") log.fatal("main display not wide enough") return elseif not renderer.validate_unit_display_sizes() then println("startup> one or more unit display dimensions incorrect; they must be 4x4 blocks") log.fatal("unit display dimensions incorrect") return end renderer.init_dmesg() -- lets get started! log.info("monitors ready, dmesg output incoming...") log_graphics("displays connected and reset") log_sys("system start on " .. os.date("%c")) log_boot("starting " .. COORDINATOR_VERSION) ---------------------------------------- -- setup alarm sounder subsystem ---------------------------------------- local speaker = ppm.get_device("speaker") if speaker == nil then log_boot("annunciator alarm speaker not found") println("startup> speaker not found") log.fatal("no annunciator alarm speaker found") return else local sounder_start = util.time_ms() log_boot("annunciator alarm speaker connected") sounder.init(speaker, config.SOUNDER_VOLUME) log_boot("tone generation took " .. (util.time_ms() - sounder_start) .. "ms") log_sys("annunciator alarm configured") end ---------------------------------------- -- setup communications ---------------------------------------- -- message authentication init if type(config.AUTH_KEY) == "string" then local init_time = network.init_mac(config.AUTH_KEY) log_crypto("HMAC init took " .. init_time .. "ms") end -- get the communications modem local modem = ppm.get_wireless_modem() if modem == nil then log_comms("wireless modem not found") println("startup> wireless modem not found") log.fatal("no wireless modem on startup") return else log_comms("wireless modem connected") end -- create connection watchdog local conn_watchdog = util.new_watchdog(config.SV_TIMEOUT) conn_watchdog.cancel() log.debug("startup> conn watchdog created") -- create network interface then setup comms local nic = network.nic(modem) local coord_comms = coordinator.comms(COORDINATOR_VERSION, nic, config.CRD_CHANNEL, config.SVR_CHANNEL, config.PKT_CHANNEL, config.TRUSTED_RANGE, conn_watchdog) log.debug("startup> comms init") log_comms("comms initialized") -- base loop clock (2Hz, 10 ticks) local MAIN_CLOCK = 0.5 local loop_clock = util.new_clock(MAIN_CLOCK) ---------------------------------------- -- connect to the supervisor ---------------------------------------- -- attempt to connect to the supervisor or exit local function init_connect_sv() local tick_waiting, task_done = log_comms_connecting("attempting to connect to configured supervisor on channel " .. config.SVR_CHANNEL) -- attempt to establish a connection with the supervisory computer if not coord_comms.sv_connect(60, tick_waiting, task_done) then log_sys("supervisor connection failed, shutting down...") log.fatal("failed to connect to supervisor") return false end return true end if not init_connect_sv() then println("startup> failed to connect to supervisor") log_sys("system shutdown") return else log_sys("supervisor connected, proceeding to UI start") end ---------------------------------------- -- start the UI ---------------------------------------- -- start up the UI ---@return boolean ui_ok started ok local function init_start_ui() log_graphics("starting UI...") local draw_start = util.time_ms() local ui_ok, message = pcall(renderer.start_ui) if not ui_ok then renderer.close_ui() log_graphics(util.c("UI crashed: ", message)) println_ts("UI crashed") log.fatal(util.c("GUI crashed with error ", message)) else log_graphics("first UI draw took " .. (util.time_ms() - draw_start) .. "ms") -- start clock loop_clock.start() end return ui_ok end local ui_ok = init_start_ui() ---------------------------------------- -- main event loop ---------------------------------------- local date_format = util.trinary(config.TIME_24_HOUR, "%X \x04 %A, %B %d %Y", "%r \x04 %A, %B %d %Y") if ui_ok then -- start connection watchdog conn_watchdog.feed() log.debug("startup> conn watchdog started") log_sys("system started successfully") end -- main event loop while ui_ok do local event, param1, param2, param3, param4, param5 = util.pull_event() -- handle event if event == "peripheral_detach" then local type, device = ppm.handle_unmount(param1) if type ~= nil and device ~= nil then if type == "modem" then -- we only really care if this is our wireless modem -- if it is another modem, handle other peripheral losses separately if nic.is_modem(device) then nic.disconnect() log_sys("comms modem disconnected") println_ts("wireless modem disconnected!") -- close out UI renderer.close_ui() -- alert user to status log_sys("awaiting comms modem reconnect...") else log_sys("non-comms modem disconnected") end elseif type == "monitor" then if renderer.is_monitor_used(device) then ---@todo will be handled properly in #249 -- "halt and catch fire" style handling local msg = "lost a configured monitor, system will now exit" println_ts(msg) log_sys(msg) break else log_sys("lost unused monitor, ignoring") end elseif type == "speaker" then local msg = "lost alarm sounder speaker" println_ts(msg) log_sys(msg) end end elseif event == "peripheral" then local type, device = ppm.mount(param1) if type ~= nil and device ~= nil then if type == "modem" then if device.isWireless() then -- reconnected modem nic.connect(device) log_sys("comms modem reconnected") println_ts("wireless modem reconnected.") -- re-init system if not init_connect_sv() then break end ui_ok = init_start_ui() else log_sys("wired modem reconnected") end -- elseif type == "monitor" then ---@todo will be handled properly in #249 -- not supported, system will exit on loss of in-use monitors elseif type == "speaker" then local msg = "alarm sounder speaker reconnected" println_ts(msg) log_sys(msg) sounder.reconnect(device) end end elseif event == "timer" then if loop_clock.is_clock(param1) then -- main loop tick -- iterate sessions apisessions.iterate_all() -- free any closed sessions apisessions.free_all_closed() -- update date and time string for main display iocontrol.get_db().facility.ps.publish("date_time", os.date(date_format)) loop_clock.start() elseif conn_watchdog.is_timer(param1) then -- supervisor watchdog timeout local msg = "supervisor server timeout" log_comms(msg) println_ts(msg) -- close connection, UI, and stop sounder coord_comms.close() renderer.close_ui() sounder.stop() if nic.connected() then -- try to re-connect to the supervisor if not init_connect_sv() then break end ui_ok = init_start_ui() end else -- a non-clock/main watchdog timer event -- check API watchdogs apisessions.check_all_watchdogs(param1) -- notify timer callback dispatcher tcd.handle(param1) end elseif event == "modem_message" then -- got a packet local packet = coord_comms.parse_packet(param1, param2, param3, param4, param5) coord_comms.handle_packet(packet) -- check if it was a disconnect if not coord_comms.is_linked() then log_comms("supervisor closed connection") -- close connection, UI, and stop sounder coord_comms.close() renderer.close_ui() sounder.stop() if nic.connected() then -- try to re-connect to the supervisor if not init_connect_sv() then break end ui_ok = init_start_ui() end end elseif event == "monitor_touch" then -- handle a monitor touch event renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3)) elseif event == "speaker_audio_empty" then -- handle speaker buffer emptied sounder.continue() end -- check for termination request if event == "terminate" or ppm.should_terminate() then println_ts("terminate requested, closing connections...") log_comms("terminate requested, closing supervisor connection...") coord_comms.close() log_comms("supervisor connection closed") log_comms("closing api sessions...") apisessions.close_all() log_comms("api sessions closed") break end end renderer.close_ui() sounder.stop() log_sys("system shutdown") println_ts("exited") log.info("exited") end if not xpcall(main, crash.handler) then pcall(renderer.close_ui) pcall(sounder.stop) crash.exit() else log.close() end