#219 properly close out GUI on error on pocket and coordinator

coordinator/renderer.lua

@@ -2,29 +2,29 @@
 -- Graphics Rendering Control
 --
 
-local log       = require("scada-common.log")
-local util      = require("scada-common.util")
+local log        = require("scada-common.log")
+local util       = require("scada-common.util")
 
-local style     = require("coordinator.ui.style")
+local style      = require("coordinator.ui.style")
 
-local main_view = require("coordinator.ui.layout.main_view")
-local unit_view = require("coordinator.ui.layout.unit_view")
+local main_view  = require("coordinator.ui.layout.main_view")
+local unit_view  = require("coordinator.ui.layout.unit_view")
 
-local flasher   = require("graphics.flasher")
+local flasher    = require("graphics.flasher")
+
+local DisplayBox = require("graphics.elements.displaybox")
 
 local renderer = {}
 
 -- render engine
 local engine = {
-    monitors = nil,
-    dmesg_window = nil,
-    ui_ready = false
-}
-
--- UI layouts
-local ui = {
-    main_layout = nil,
-    unit_layouts = {}
+    monitors = nil,         ---@type monitors_struct|nil
+    dmesg_window = nil,     ---@type table|nil
+    ui_ready = false,
+    ui = {
+        main_display = nil, ---@type graphics_element|nil
+        unit_displays = {}
+    }
 }
 
 -- init a display to the "default", but set text scale to 0.5
@@ -57,10 +57,8 @@ function renderer.is_monitor_used(periph)
         if engine.monitors.primary == periph then
             return true
         else
-            for i = 1, #engine.monitors.unit_displays do
-                if engine.monitors.unit_displays[i] == periph then
-                    return true
-                end
+            for _, monitor in ipairs(engine.monitors.units) do
+                if monitor == periph then return true end
             end
         end
     end
@@ -74,7 +72,7 @@ function renderer.init_displays()
     _init_display(engine.monitors.primary)
 
     -- init unit displays
-    for _, monitor in pairs(engine.monitors.unit_displays) do
+    for _, monitor in ipairs(engine.monitors.units) do
         _init_display(monitor)
     end
 end
@@ -93,7 +91,7 @@ end
 function renderer.validate_unit_display_sizes()
     local valid = true
 
-    for id, monitor in pairs(engine.monitors.unit_displays) do
+    for id, monitor in ipairs(engine.monitors.units) do
         local w, h = monitor.getSize()
         if w ~= 79 or h ~= 52 then
             log.warning(util.c("RENDERER: unit ", id, " display resolution not 79 wide by 52 tall: ", w, ", ", h))
@@ -108,7 +106,6 @@ end
 function renderer.init_dmesg()
     local disp_x, disp_y = engine.monitors.primary.getSize()
     engine.dmesg_window = window.create(engine.monitors.primary, 1, 1, disp_x, disp_y)
-
     log.direct_dmesg(engine.dmesg_window)
 end
 
@@ -119,11 +116,13 @@ function renderer.start_ui()
         engine.dmesg_window.setVisible(false)
 
         -- show main view on main monitor
-        ui.main_layout = main_view(engine.monitors.primary)
+        engine.ui.main_display = DisplayBox{window=engine.monitors.primary,fg_bg=style.root}
+        main_view(engine.ui.main_display)
 
         -- show unit views on unit displays
-        for id, monitor in pairs(engine.monitors.unit_displays) do
-            table.insert(ui.unit_layouts, unit_view(monitor, id))
+        for i = 1, #engine.monitors.units do
+            engine.ui.unit_displays[i] = DisplayBox{window=engine.monitors.units[i],fg_bg=style.root}
+            unit_view(engine.ui.unit_displays[i], i)
         end
 
         -- start flasher callback task
@@ -136,29 +135,22 @@ end
 
 -- close out the UI
 function renderer.close_ui()
-    -- report ui as not ready
-    engine.ui_ready = false
-
     -- stop blinking indicators
     flasher.clear()
 
-    if engine.ui_ready then
-        -- hide to stop animation callbacks
-        ui.main_layout.hide()
-        for i = 1, #ui.unit_layouts do
-            ui.unit_layouts[i].hide()
-            engine.monitors.unit_displays[i].clear()
-        end
-    else
-        -- clear unit displays
-        for i = 1, #ui.unit_layouts do
-            engine.monitors.unit_displays[i].clear()
-        end
-    end
+    -- hide to stop animation callbacks
+    if engine.ui.main_display ~= nil then engine.ui.main_display.hide() end
+    for _, display in ipairs(engine.ui.unit_displays) do display.hide() end
+
+    -- report ui as not ready
+    engine.ui_ready = false
 
     -- clear root UI elements
-    ui.main_layout = nil
-    ui.unit_layouts = {}
+    engine.ui.main_display = nil
+    engine.ui.unit_displays = {}
+
+    -- clear unit monitors
+    for _, monitor in ipairs(engine.monitors.units) do monitor.clear() end
 
     -- re-draw dmesg
     engine.dmesg_window.setVisible(true)
@@ -173,13 +165,15 @@ function renderer.ui_ready() return engine.ui_ready end
 -- handle a touch event
 ---@param event mouse_interaction
 function renderer.handle_mouse(event)
-    if event.monitor == engine.monitors.primary_name then
-        ui.main_layout.handle_mouse(event)
-    else
-        for id, monitor in pairs(engine.monitors.unit_name_map) do
-            if event.monitor == monitor then
-                local layout = ui.unit_layouts[id]  ---@type graphics_element
-                layout.handle_mouse(event)
+    if engine.ui_ready then
+        if event.monitor == engine.monitors.primary_name then
+            engine.ui.main_display.handle_mouse(event)
+        else
+            for id, monitor in ipairs(engine.monitors.unit_name_map) do
+                if event.monitor == monitor then
+                    local layout = engine.ui.unit_displays[id]  ---@type graphics_element
+                    layout.handle_mouse(event)
+                end
             end
         end
     end

coordinator/startup.lua

@@ -20,7 +20,7 @@ local sounder      = require("coordinator.sounder")
 
 local apisessions  = require("coordinator.session.apisessions")
 
-local COORDINATOR_VERSION = "v0.13.5"
+local COORDINATOR_VERSION = "v0.13.6"
 
 local println = util.println
 local println_ts = util.println_ts

coordinator/ui/layout/main_view.lua

@@ -14,7 +14,6 @@ local unit_overview = require("coordinator.ui.components.unit_overview")
 
 local core          = require("graphics.core")
 
-local DisplayBox    = require("graphics.elements.displaybox")
 local TextBox       = require("graphics.elements.textbox")
 
 local DataIndicator = require("graphics.elements.indicators.data")
@@ -24,13 +23,11 @@ local TEXT_ALIGN = core.graphics.TEXT_ALIGN
 local cpair = core.graphics.cpair
 
 -- create new main view
----@param monitor table main viewscreen
-local function init(monitor)
+---@param main graphics_element main displaybox
+local function init(main)
     local facility = iocontrol.get_db().facility
     local units = iocontrol.get_db().units
 
-    local main = DisplayBox{window=monitor,fg_bg=style.root}
-
     -- window header message
     local header = TextBox{parent=main,y=1,text="Nuclear Generation Facility SCADA Coordinator",alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
     local ping = DataIndicator{parent=main,x=1,y=1,label="SVTT",format="%d",value=0,unit="ms",lu_colors=cpair(colors.lightGray, colors.white),width=12,fg_bg=style.header}
@@ -87,8 +84,6 @@ local function init(monitor)
     process_ctl(main, 2, cnc_bottom_align_start)
 
     imatrix(main, 131, cnc_bottom_align_start, facility.induction_data_tbl[1], facility.induction_ps_tbl[1])
-
-    return main
 end
 
 return init

coordinator/ui/layout/unit_view.lua

@@ -2,21 +2,13 @@
 -- Reactor Unit SCADA Coordinator GUI
 --
 
-local style       = require("coordinator.ui.style")
-
 local unit_detail = require("coordinator.ui.components.unit_detail")
 
-local DisplayBox  = require("graphics.elements.displaybox")
-
 -- create a unit view
----@param monitor table
+---@param main graphics_element main displaybox
 ---@param id integer
-local function init(monitor, id)
-    local main = DisplayBox{window=monitor,fg_bg=style.root}
-
+local function init(main, id)
     unit_detail(main, id)
-
-    return main
 end
 
 return init