From afc89ac7278ef7bfe276a960257179854c50e24e Mon Sep 17 00:00:00 2001 From: Mikayla Date: Sat, 13 Sep 2025 00:55:15 +0000 Subject: [PATCH] #629 code cleanup --- pocket/iocontrol.lua | 1 - pocket/iorx.lua | 1 - pocket/pocket.lua | 9 ++++----- pocket/ui/apps/comps.lua | 1 - pocket/ui/apps/dummy_app.lua | 29 ----------------------------- pocket/ui/apps/facility.lua | 2 +- pocket/ui/apps/guide.lua | 5 ----- pocket/ui/apps/process.lua | 4 ++-- pocket/ui/apps/unit.lua | 3 --- pocket/ui/docs.lua | 4 ++++ pocket/ui/main.lua | 2 -- pocket/ui/pages/dynamic_tank.lua | 6 +++++- pocket/ui/pages/facility_matrix.lua | 4 ++++ pocket/ui/pages/facility_sps.lua | 4 ++++ pocket/ui/pages/guide_section.lua | 6 +++++- pocket/ui/pages/home_page.lua | 2 -- pocket/ui/pages/unit_boiler.lua | 6 +++++- pocket/ui/pages/unit_reactor.lua | 6 +++++- pocket/ui/pages/unit_turbine.lua | 4 ++++ 19 files changed, 43 insertions(+), 56 deletions(-) delete mode 100644 pocket/ui/apps/dummy_app.lua diff --git a/pocket/iocontrol.lua b/pocket/iocontrol.lua index aeb2cd7..a710413 100644 --- a/pocket/iocontrol.lua +++ b/pocket/iocontrol.lua @@ -17,7 +17,6 @@ local ENERGY_UNITS = types.ENERGY_SCALE_UNITS local TEMP_SCALE = types.TEMP_SCALE local TEMP_UNITS = types.TEMP_SCALE_UNITS ----@todo nominal trip time is ping (0ms to 10ms usually) local WARN_TT = 40 local HIGH_TT = 80 diff --git a/pocket/iorx.lua b/pocket/iorx.lua index cbb2c01..bfcc1f9 100644 --- a/pocket/iorx.lua +++ b/pocket/iorx.lua @@ -60,7 +60,6 @@ local function _record_multiblock_status(faulted, data, ps) ps.publish("formed", data.formed) ps.publish("faulted", faulted) - ---@todo revisit this if data.build then for key, val in pairs(data.build) do ps.publish(key, val) end end diff --git a/pocket/pocket.lua b/pocket/pocket.lua index 5e227f3..128ad1c 100644 --- a/pocket/pocket.lua +++ b/pocket/pocket.lua @@ -88,7 +88,7 @@ local APP_ID = { -- core UI ROOT = 1, LOADER = 2, - -- main app pages + -- main apps UNITS = 3, FACILITY = 4, CONTROL = 5, @@ -97,12 +97,11 @@ local APP_ID = { GUIDE = 8, ABOUT = 9, RADMON = 10, - -- diagnostic app pages + -- diagnostic apps ALARMS = 11, COMPS = 12, - -- other - DUMMY = 13, - NUM_APPS = 13 + -- count + NUM_APPS = 12 } pocket.APP_ID = APP_ID diff --git a/pocket/ui/apps/comps.lua b/pocket/ui/apps/comps.lua index 5450118..91a9558 100644 --- a/pocket/ui/apps/comps.lua +++ b/pocket/ui/apps/comps.lua @@ -32,7 +32,6 @@ local border = core.border local APP_ID = pocket.APP_ID local lu_col = style.label_unit_pair - local box_label = cpair(colors.lightGray, colors.gray) -- new computer list page view diff --git a/pocket/ui/apps/dummy_app.lua b/pocket/ui/apps/dummy_app.lua deleted file mode 100644 index a564761..0000000 --- a/pocket/ui/apps/dummy_app.lua +++ /dev/null @@ -1,29 +0,0 @@ --- --- Placeholder App --- - -local iocontrol = require("pocket.iocontrol") -local pocket = require("pocket.pocket") - -local core = require("graphics.core") - -local Div = require("graphics.elements.Div") -local TextBox = require("graphics.elements.TextBox") - -local APP_ID = pocket.APP_ID - --- create placeholder app page ----@param root Container parent -local function create_pages(root) - local db = iocontrol.get_db() - - local main = Div{parent=root,x=1,y=1} - - db.nav.register_app(APP_ID.DUMMY, main).new_page(nil, function () end) - - TextBox{parent=main,text="This app is not implemented yet.",x=1,y=2,alignment=core.ALIGN.CENTER} - - TextBox{parent=main,text=" pretend something cool is here \x03",x=1,y=10,alignment=core.ALIGN.CENTER,fg_bg=core.cpair(colors.gray,colors.black)} -end - -return create_pages diff --git a/pocket/ui/apps/facility.lua b/pocket/ui/apps/facility.lua index 65b25e3..9763982 100644 --- a/pocket/ui/apps/facility.lua +++ b/pocket/ui/apps/facility.lua @@ -41,7 +41,7 @@ local grn_ind_s = style.icon_states.grn_ind_s -- new unit page view ---@param root Container parent local function new_view(root) - local db = iocontrol.get_db() + local db = iocontrol.get_db() local frame = Div{parent=root,x=1,y=1} diff --git a/pocket/ui/apps/guide.lua b/pocket/ui/apps/guide.lua index 88bf082..5e627f3 100644 --- a/pocket/ui/apps/guide.lua +++ b/pocket/ui/apps/guide.lua @@ -9,7 +9,6 @@ local iocontrol = require("pocket.iocontrol") local pocket = require("pocket.pocket") local docs = require("pocket.ui.docs") --- local style = require("pocket.ui.style") local guide_section = require("pocket.ui.pages.guide_section") @@ -31,10 +30,6 @@ local cpair = core.cpair local APP_ID = pocket.APP_ID --- local label = style.label --- local lu_col = style.label_unit_pair --- local text_fg = style.text_fg - -- new system guide view ---@param root Container parent local function new_view(root) diff --git a/pocket/ui/apps/process.lua b/pocket/ui/apps/process.lua index 6f04d60..ed03d71 100644 --- a/pocket/ui/apps/process.lua +++ b/pocket/ui/apps/process.lua @@ -194,7 +194,7 @@ local function new_view(root) TextBox{parent=c_div,y=1,text="Process Control",alignment=ALIGN.CENTER} - local u_stat = Rectangle{parent=c_div,border=border(1,colors.gray,true),thin=true,width=21,height=5,x=1,y=3,fg_bg=cpair(colors.black,colors.lightGray)} + local u_stat = Rectangle{parent=c_div,border=border(1,colors.gray,true),thin=true,width=21,height=5,x=1,y=3,fg_bg=cpair(colors.black,colors.lightGray)} local stat_line_1 = TextBox{parent=u_stat,x=1,y=1,text="UNKNOWN",alignment=ALIGN.CENTER} local stat_line_2 = TextBox{parent=u_stat,x=1,y=2,text="awaiting data...",height=2,alignment=ALIGN.CENTER,trim_whitespace=true,fg_bg=cpair(colors.gray,colors.lightGray)} @@ -210,7 +210,7 @@ local function new_view(root) end local start = HazardButton{parent=c_div,x=2,y=9,text="START",accent=colors.lightBlue,callback=_start_auto,timeout=3,fg_bg=hzd_fg_bg,dis_colors=dis_colors} - local stop = HazardButton{parent=c_div,x=13,y=9,text="STOP",accent=colors.red,callback=process.process_stop,timeout=3,fg_bg=hzd_fg_bg,dis_colors=dis_colors} + local stop = HazardButton{parent=c_div,x=13,y=9,text="STOP",accent=colors.red,callback=process.process_stop,timeout=3,fg_bg=hzd_fg_bg,dis_colors=dis_colors} db.facility.start_ack = start.on_response db.facility.stop_ack = stop.on_response diff --git a/pocket/ui/apps/unit.lua b/pocket/ui/apps/unit.lua index 304608e..6213f6b 100644 --- a/pocket/ui/apps/unit.lua +++ b/pocket/ui/apps/unit.lua @@ -312,8 +312,6 @@ local function new_view(root) c_emg.register(u_ps, "EmergencyCoolant", c_emg.update) c_mwrf.register(u_ps, "MaxWaterReturnFeed", c_mwrf.update) - -- rcs_div.line_break() - -- TextBox{parent=rcs_div,text="Mismatches",alignment=ALIGN.CENTER,fg_bg=label} local c_cfm = IconIndicator{parent=rcs_div,label="Coolant Feed",states=yel_ind_s} local c_brm = IconIndicator{parent=rcs_div,label="Boil Rate",states=yel_ind_s} local c_sfm = IconIndicator{parent=rcs_div,label="Steam Feed",states=yel_ind_s} @@ -323,7 +321,6 @@ local function new_view(root) c_sfm.register(u_ps, "SteamFeedMismatch", c_sfm.update) rcs_div.line_break() - -- TextBox{parent=rcs_div,text="Aggregate Checks",alignment=ALIGN.CENTER,fg_bg=label} if unit.num_boilers > 0 then local wll = IconIndicator{parent=rcs_div,label="Boiler Water Lo",states=red_ind_s} diff --git a/pocket/ui/docs.lua b/pocket/ui/docs.lua index 44219ea..ec395a7 100644 --- a/pocket/ui/docs.lua +++ b/pocket/ui/docs.lua @@ -1,3 +1,7 @@ +-- +-- All the text documentation used in the Guide app is defined in this file. +-- + local const = require("scada-common.constants") local docs = {} diff --git a/pocket/ui/main.lua b/pocket/ui/main.lua index 4ea44e1..83a6d9c 100644 --- a/pocket/ui/main.lua +++ b/pocket/ui/main.lua @@ -10,7 +10,6 @@ local pocket = require("pocket.pocket") local comps_app = require("pocket.ui.apps.comps") local control_app = require("pocket.ui.apps.control") local diag_apps = require("pocket.ui.apps.diag_apps") -local dummy_app = require("pocket.ui.apps.dummy_app") local facil_app = require("pocket.ui.apps.facility") local guide_app = require("pocket.ui.apps.guide") local loader_app = require("pocket.ui.apps.loader") @@ -78,7 +77,6 @@ local function init(main) sys_apps(page_div) diag_apps(page_div) comps_app(page_div) - dummy_app(page_div) -- verify all apps were created assert(util.table_len(db.nav.get_containers()) == APP_ID.NUM_APPS, "app IDs were not sequential or some apps weren't registered") diff --git a/pocket/ui/pages/dynamic_tank.lua b/pocket/ui/pages/dynamic_tank.lua index 17221a6..6604dfd 100644 --- a/pocket/ui/pages/dynamic_tank.lua +++ b/pocket/ui/pages/dynamic_tank.lua @@ -1,3 +1,7 @@ +-- +-- Dynamic Tank View +-- + local types = require("scada-common.types") local util = require("scada-common.util") @@ -16,7 +20,7 @@ local IconIndicator = require("graphics.elements.indicators.IconIndicator") local StateIndicator = require("graphics.elements.indicators.StateIndicator") local CONTAINER_MODE = types.CONTAINER_MODE -local COOLANT_TYPE = types.COOLANT_TYPE +local COOLANT_TYPE = types.COOLANT_TYPE local ALIGN = core.ALIGN local cpair = core.cpair diff --git a/pocket/ui/pages/facility_matrix.lua b/pocket/ui/pages/facility_matrix.lua index 77640b1..1d3c362 100644 --- a/pocket/ui/pages/facility_matrix.lua +++ b/pocket/ui/pages/facility_matrix.lua @@ -1,3 +1,7 @@ +-- +-- Induction Matrix View +-- + local iocontrol = require("pocket.iocontrol") local style = require("pocket.ui.style") diff --git a/pocket/ui/pages/facility_sps.lua b/pocket/ui/pages/facility_sps.lua index 1de23ca..2de3863 100644 --- a/pocket/ui/pages/facility_sps.lua +++ b/pocket/ui/pages/facility_sps.lua @@ -1,3 +1,7 @@ +-- +-- SPS View +-- + local iocontrol = require("pocket.iocontrol") local style = require("pocket.ui.style") diff --git a/pocket/ui/pages/guide_section.lua b/pocket/ui/pages/guide_section.lua index a3ea333..9bb1df2 100644 --- a/pocket/ui/pages/guide_section.lua +++ b/pocket/ui/pages/guide_section.lua @@ -1,3 +1,7 @@ +-- +-- A Guide App Subsection +-- + local log = require("scada-common.log") local util = require("scada-common.util") @@ -17,7 +21,7 @@ local LED = require("graphics.elements.indicators.LED") local ALIGN = core.ALIGN local cpair = core.cpair -local DOC_TYPE = docs.DOC_ITEM_TYPE +local DOC_TYPE = docs.DOC_ITEM_TYPE local LIST_TYPE = docs.DOC_LIST_TYPE -- new guide documentation section diff --git a/pocket/ui/pages/home_page.lua b/pocket/ui/pages/home_page.lua index 2af6f8a..bb962d5 100644 --- a/pocket/ui/pages/home_page.lua +++ b/pocket/ui/pages/home_page.lua @@ -9,11 +9,9 @@ local core = require("graphics.core") local AppMultiPane = require("graphics.elements.AppMultiPane") local Div = require("graphics.elements.Div") -local TextBox = require("graphics.elements.TextBox") local App = require("graphics.elements.controls.App") -local ALIGN = core.ALIGN local cpair = core.cpair local APP_ID = pocket.APP_ID diff --git a/pocket/ui/pages/unit_boiler.lua b/pocket/ui/pages/unit_boiler.lua index 1790268..344451c 100644 --- a/pocket/ui/pages/unit_boiler.lua +++ b/pocket/ui/pages/unit_boiler.lua @@ -1,3 +1,7 @@ +-- +-- Unit Boiler View +-- + local types = require("scada-common.types") local util = require("scada-common.util") @@ -13,8 +17,8 @@ local TextBox = require("graphics.elements.TextBox") local PushButton = require("graphics.elements.controls.PushButton") local DataIndicator = require("graphics.elements.indicators.DataIndicator") -local StateIndicator = require("graphics.elements.indicators.StateIndicator") local IconIndicator = require("graphics.elements.indicators.IconIndicator") +local StateIndicator = require("graphics.elements.indicators.StateIndicator") local VerticalBar = require("graphics.elements.indicators.VerticalBar") local ALIGN = core.ALIGN diff --git a/pocket/ui/pages/unit_reactor.lua b/pocket/ui/pages/unit_reactor.lua index a3333f5..30a8e36 100644 --- a/pocket/ui/pages/unit_reactor.lua +++ b/pocket/ui/pages/unit_reactor.lua @@ -1,3 +1,7 @@ +-- +-- Unit Reactor View +-- + local types = require("scada-common.types") local util = require("scada-common.util") @@ -13,8 +17,8 @@ local TextBox = require("graphics.elements.TextBox") local PushButton = require("graphics.elements.controls.PushButton") local DataIndicator = require("graphics.elements.indicators.DataIndicator") -local StateIndicator = require("graphics.elements.indicators.StateIndicator") local IconIndicator = require("graphics.elements.indicators.IconIndicator") +local StateIndicator = require("graphics.elements.indicators.StateIndicator") local VerticalBar = require("graphics.elements.indicators.VerticalBar") local ALIGN = core.ALIGN diff --git a/pocket/ui/pages/unit_turbine.lua b/pocket/ui/pages/unit_turbine.lua index 94541ad..9e9a79e 100644 --- a/pocket/ui/pages/unit_turbine.lua +++ b/pocket/ui/pages/unit_turbine.lua @@ -1,3 +1,7 @@ +-- +-- Unit Turbine View +-- + local util = require("scada-common.util") local iocontrol = require("pocket.iocontrol")