Merge pull request #420 from MikaylaFischler/devel

2024.02.19 Release

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: mikayla_f

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: enhancement
+labels: "enhancement,feature request"
 assignees: ''
 
 ---

.github/workflows/check.yml

@@ -5,12 +5,10 @@ on:
   push:
     branches:
       - main
-      - latest
       - devel
   pull_request:
     branches:
       - main
-      - latest
       - devel
 jobs:
   check:
@@ -28,4 +26,4 @@ jobs:
           # --no-max-line-length = Disable warnings for long line lengths
           # --exclude-files ...  = Exclude lockbox library (external) and config files
           # --globals ...        = Override all globals overridden in .vscode/settings.json AND 'os' since CraftOS 'os' differs from Lua's 'os'
-          args: . --no-max-line-length -i 121 512 542 --exclude-files ./lockbox/* ./*/config.lua --globals os _HOST bit colors fs http parallel periphemu peripheral read rs settings shell term textutils window
+          args: . --no-max-line-length -i 121 512 542 --exclude-files ./lockbox/* ./*/config.lua --globals os _HOST bit colors fs http keys parallel periphemu peripheral read rs settings shell term textutils window

.github/workflows/manifest.yml

@@ -6,7 +6,6 @@ on:
   push:
     branches:
       - main
-      - latest
       - devel
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -43,7 +42,7 @@ jobs:
       - name: Create outputs folders
         if: success() || failure()
         shell: bash
-        run: mkdir deploy; mkdir deploy/manifests; mkdir deploy/manifests/main deploy/manifests/latest deploy/manifests/devel
+        run: mkdir deploy; mkdir deploy/manifests; mkdir deploy/manifests/main deploy/manifests/devel
       - name: Generate manifest and shields for main branch
         id: manifest-main
         if: ${{ (success() || failure()) && steps.checkout-main.outcome == 'success' }}
@@ -51,21 +50,6 @@ jobs:
       - name: Save main's manifest
         if: ${{ (success() || failure()) && steps.manifest-main.outcome == 'success' }}
         run: mv install_manifest.json deploy/manifests/main
-      # Generate manifest for latest branch
-      - name: Checkout latest
-        id: checkout-latest
-        if: success() || failure()
-        uses: actions/checkout@v3
-        with:
-          ref: 'latest'
-          clean: false
-      - name: Generate manifest for latest
-        id: manifest-latest
-        if: ${{ (success() || failure()) && steps.checkout-latest.outcome == 'success' }}
-        run: python imgen.py
-      - name: Save latest's manifest
-        if: ${{ (success() || failure()) && steps.manifest-latest.outcome == 'success' }}
-        run: mv install_manifest.json deploy/manifests/latest
       # Generate manifest for devel branch
       - name: Checkout devel
         id: checkout-devel

.vscode/settings.json

@@ -5,6 +5,7 @@
         "colors",
         "fs",
         "http",
+        "keys",
         "parallel",
         "periphemu",
         "peripheral",
@@ -24,6 +25,7 @@
     },
     "Lua.hint.setType": true,
     "Lua.diagnostics.disable": [
-        "duplicate-set-field"
+        "duplicate-set-field",
+        "inject-field"
     ]
 }

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2022 - 2023 Mikayla Fischler
+Copyright © 2022 - 2024 Mikayla Fischler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -36,8 +36,9 @@ Mod Requirements:
 
 Mod Recommendations:
 - Advanced Peripherals (adds the capability to detect environmental radiation levels)
+- Immersive Engineering (provides bundled redstone, though any mod containing bundled redstone will do)
 
-v10.1+ is required due the complete support of CC:Tweaked added in Mekanism v10.1
+v10.1+ is required due to the complete support of CC:Tweaked added in Mekanism v10.1
 
 ## Installation
 

ccmsi.lua

@@ -1,7 +1,7 @@
 --[[
 CC-MEK-SCADA Installer Utility
 
-Copyright (c) 2023 Mikayla Fischler
+Copyright (c) 2023 - 2024 Mikayla Fischler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 associated documentation files (the "Software"), to deal in the Software without restriction,
@@ -18,7 +18,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 local function println(message) print(tostring(message)) end
 local function print(message) term.write(tostring(message)) end
 
-local CCMSI_VERSION = "v1.9a"
+local CCMSI_VERSION = "v1.14"
 
 local install_dir = "/.install-cache"
 local manifest_path = "https://mikaylafischler.github.io/cc-mek-scada/manifests/"
@@ -26,12 +26,13 @@ local repo_path = "http://raw.githubusercontent.com/MikaylaFischler/cc-mek-scada
 
 local opts = { ... }
 local mode, app, target
-local install_manifest = manifest_path .. "main/install_manifest.json"
+local install_manifest = manifest_path.."main/install_manifest.json"
 
 local function red() term.setTextColor(colors.red) end
 local function orange() term.setTextColor(colors.orange) end
 local function yellow() term.setTextColor(colors.yellow) end
 local function green() term.setTextColor(colors.green) end
+local function cyan() term.setTextColor(colors.cyan) end
 local function blue() term.setTextColor(colors.blue) end
 local function white() term.setTextColor(colors.white) end
 local function lgray() term.setTextColor(colors.lightGray) end
@@ -58,17 +59,17 @@ local function ask_y_n(question, default)
 end
 
 -- print out a white + blue text message
-local function pkg_message(message, package) white();print(message .. " ");blue();println(package);white() end
+local function pkg_message(message, package) white();print(message.." ");blue();println(package);white() end
 
 -- indicate actions to be taken based on package differences for installs/updates
 local function show_pkg_change(name, v)
     if v.v_local ~= nil then
         if v.v_local ~= v.v_remote then
-            print("[" .. name .. "] updating ");blue();print(v.v_local);white();print(" \xbb ");blue();println(v.v_remote);white()
+            print("["..name.."] updating ");blue();print(v.v_local);white();print(" \xbb ");blue();println(v.v_remote);white()
         elseif mode == "install" then
-            pkg_message("[" .. name .. "] reinstalling", v.v_local)
+            pkg_message("["..name.."] reinstalling", v.v_local)
         end
-    else pkg_message("[" .. name .. "] new install of", v.v_remote) end
+    else pkg_message("["..name.."] new install of", v.v_remote) end
     return v.v_local ~= v.v_remote
 end
 
@@ -89,7 +90,7 @@ local function get_remote_manifest()
     local response, error = http.get(install_manifest)
     if response == nil then
         orange();println("Failed to get installation manifest from GitHub, cannot update or install.")
-        red();println("HTTP error: " .. error);white()
+        red();println("HTTP error: "..error);white()
         return false, {}
     end
 
@@ -154,59 +155,56 @@ local function _clean_dir(dir, tree)
     if tree == nil then tree = {} end
     local ls = fs.list(dir)
     for _, val in pairs(ls) do
-        local path = dir .. "/" .. val
+        local path = dir.."/"..val
         if fs.isDir(path) then
             _clean_dir(path, tree[val])
-            if #fs.list(path) == 0 then fs.delete(path);println("deleted " .. path) end
-        elseif not _in_array(val, tree) then
+            if #fs.list(path) == 0 then fs.delete(path);println("deleted "..path) end
+        elseif (not _in_array(val, tree)) and (val ~= "config.lua" ) then
             fs.delete(path)
-            println("deleted " .. path)
+            println("deleted "..path)
         end
     end
 end
 
 -- go through app/common directories to delete unused files
 local function clean(manifest)
-    local root_ext = false
     local tree = gen_tree(manifest)
 
     table.insert(tree, "install_manifest.json")
     table.insert(tree, "ccmsi.lua")
-    table.insert(tree, "log.txt")
-
-    lgray()
+    table.insert(tree, "log.txt") ---@fixme fix after migration to settings files?
 
     local ls = fs.list("/")
     for _, val in pairs(ls) do
-        if fs.isDir(val) then
-            if tree[val] ~= nil then _clean_dir("/" .. val, tree[val]) end
-            if #fs.list(val) == 0 then fs.delete(val);println("deleted " .. val) end
-        elseif not _in_array(val, tree) then
-            root_ext = true
-            yellow();println(val .. " not used")
+        if fs.isDriveRoot(val) then
+            yellow();println("skipped mount '"..val.."'")
+        elseif fs.isDir(val) then
+            if tree[val] ~= nil then lgray();_clean_dir("/"..val, tree[val])
+            else white(); if ask_y_n("delete the unused directory '"..val.."'") then lgray();_clean_dir("/"..val) end end
+            if #fs.list(val) == 0 then fs.delete(val);lgray();println("deleted empty directory '"..val.."'") end
+        elseif not _in_array(val, tree) and (string.find(val, ".settings") == nil) then
+            white();if ask_y_n("delete the unused file '"..val.."'") then fs.delete(val);lgray();println("deleted "..val) end
         end
     end
 
     white()
-    if root_ext then println("Files in root directory won't be automatically deleted.") end
 end
 
 -- get and validate command line options
 
-println("-- CC Mekanism SCADA Installer " .. CCMSI_VERSION .. " --")
+println("-- CC Mekanism SCADA Installer "..CCMSI_VERSION.." --")
 
 if #opts == 0 or opts[1] == "help" then
     println("usage: ccmsi <mode> <app> <branch>")
     println("<mode>")
     lgray()
-    println(" check       - check latest versions avilable")
+    println(" check       - check latest versions available")
     yellow()
     println("               ccmsi check <branch> for target")
     lgray()
-    println(" install     - fresh install, overwrites config")
-    println(" update      - update files EXCEPT for config/logs")
-    println(" remove      - delete files EXCEPT for config/logs")
-    println(" purge       - delete files INCLUDING config/logs")
+    println(" install     - fresh install")
+    println(" update      - update files")
+    println(" uninstall   - delete files INCLUDING config/logs")
     white();println("<app>");lgray()
     println(" reactor-plc - reactor PLC firmware")
     println(" rtu         - RTU firmware")
@@ -215,10 +213,10 @@ if #opts == 0 or opts[1] == "help" then
     println(" pocket      - pocket application")
     println(" installer   - ccmsi installer (update only)")
     white();println("<branch>")
-    lgray();println(" main (default) | latest | devel");white()
+    lgray();println(" main (default) | devel");white()
     return
 else
-    mode = get_opt(opts[1], { "check", "install", "update", "remove", "purge" })
+    mode = get_opt(opts[1], { "check", "install", "update", "uninstall" })
     if mode == nil then
         red();println("Unrecognized mode.");white()
         return
@@ -235,14 +233,14 @@ else
 
     -- determine target
     if mode == "check" then target = opts[2] else target = opts[3] end
-    if (target ~= "main") and (target ~= "latest") and (target ~= "devel") then
+    if (target ~= "main") and (target ~= "devel") then
         if (target and target ~= "") then yellow();println("Unknown target, defaulting to 'main'");white() end
         target = "main"
     end
 
     -- set paths
-    install_manifest = manifest_path .. target .. "/install_manifest.json"
-    repo_path = repo_path .. target .. "/"
+    install_manifest = manifest_path..target.."/install_manifest.json"
+    repo_path = repo_path..target.."/"
 end
 
 -- run selected mode
@@ -262,23 +260,21 @@ if mode == "check" then
     -- list all versions
     for key, value in pairs(manifest.versions) do
         term.setTextColor(colors.purple)
-        print(string.format("%-14s", "[" .. key .. "]"))
+        print(string.format("%-14s", "["..key.."]"))
         if key == "installer" or (local_ok and (local_manifest.versions[key] ~= nil)) then
             blue();print(local_manifest.versions[key])
             if value ~= local_manifest.versions[key] then
                 white();print(" (")
-                term.setTextColor(colors.cyan)
-                print(value);white();println(" available)")
+                cyan();print(value);white();println(" available)")
             else green();println(" (up to date)") end
         else
             lgray();print("not installed");white();print(" (latest ")
-            term.setTextColor(colors.cyan)
-            print(value);white();println(")")
+            cyan();print(value);white();println(")")
         end
     end
 
     if manifest.versions.installer ~= local_manifest.versions.installer then
-        yellow();println("\nA newer version of the installer is available, it is recommended to update (use 'ccmsi update installer').");white()
+        yellow();println("\nA different version of the installer is available, it is recommended to update (use 'ccmsi update installer').");white()
     end
 elseif mode == "install" or mode == "update" then
     local update_installer = app == "installer"
@@ -310,19 +306,19 @@ elseif mode == "install" or mode == "update" then
         ver.lockbox.v_local = lmnf.versions.lockbox
 
         if lmnf.versions[app] == nil then
-            red();println("Another application is already installed, please purge it before installing a new application.");white()
+            red();println("Another application is already installed, please uninstall it before installing a new application.");white()
             return
         end
     end
 
     if manifest.versions.installer ~= CCMSI_VERSION then
-        if not update_installer then yellow();println("A newer version of the installer is available, it is recommended to update to it.");white() end
+        if not update_installer then yellow();println("A different version of the installer is available, it is recommended to update to it.");white() end
         if update_installer or ask_y_n("Would you like to update now") then
             lgray();println("GET ccmsi.lua")
-            local dl, err = http.get(repo_path .. "ccmsi.lua")
+            local dl, err = http.get(repo_path.."ccmsi.lua")
 
             if dl == nil then
-                red();println("HTTP Error " .. err)
+                red();println("HTTP Error "..err)
                 println("Installer download failed.");white()
             else
                 local handle = fs.open(debug.getinfo(1, "S").source:sub(2), "w") -- this file, regardless of name or location
@@ -346,12 +342,8 @@ elseif mode == "install" or mode == "update" then
     ver.lockbox.v_remote = manifest.versions.lockbox
 
     green()
-    if mode == "install" then
-        println("Installing " .. app .. " files...")
-    elseif mode == "update" then
-        println("Updating " .. app .. " files... (keeping old config.lua)")
-    end
-    white()
+    if mode == "install" then print("Installing ") else print("Updating ") end
+    println(app.." files...");white()
 
     ver.boot.changed = show_pkg_change("bootldr", ver.boot)
     ver.common.changed = show_pkg_change("common", ver.common)
@@ -377,7 +369,6 @@ elseif mode == "install" or mode == "update" then
     local file_list = manifest.files
     local size_list = manifest.sizes
     local dependencies = manifest.depends[app]
-    local config_file = app .. "/config.lua"
 
     table.insert(dependencies, app)
 
@@ -389,9 +380,10 @@ elseif mode == "install" or mode == "update" then
     -- check space constraints
     if space_available < space_required then
         single_file_mode = true
-        yellow();println("WARNING: Insufficient space available for a full download!");white()
-        println("Files can be downloaded one by one, so if you are replacing a current install this will not be a problem unless installation fails.")
-        if mode == "update" then println("If installation still fails, delete this device's log file or uninstall the app (not purge) and try again.") end
+        yellow();println("NOTICE: Insufficient space available for a full cached download!");white()
+        lgray();println("Files can instead be downloaded one by one. If you are replacing a current install this may corrupt your install ONLY if it fails (such as a sudden network issue). If that occurs, you can still try again.")
+        if mode == "update" then println("If installation still fails, delete this device's log file and/or any unrelated files you have on this computer then try again.") end
+        white();
         if not ask_y_n("Do you wish to continue", false) then
             println("Operation cancelled.")
             return
@@ -423,15 +415,15 @@ elseif mode == "install" or mode == "update" then
 
                 local files = file_list[dependency]
                 for _, file in pairs(files) do
-                    println("GET " .. file)
-                    local dl, err = http.get(repo_path .. file)
+                    println("GET "..file)
+                    local dl, err = http.get(repo_path..file)
 
                     if dl == nil then
-                        red();println("HTTP Error " .. err)
+                        red();println("HTTP Error "..err)
                         success = false
                         break
                     else
-                        local handle = fs.open(install_dir .. "/" .. file, "w")
+                        local handle = fs.open(install_dir.."/"..file, "w")
                         handle.write(dl.readAll())
                         handle.close()
                     end
@@ -450,11 +442,9 @@ elseif mode == "install" or mode == "update" then
 
                     local files = file_list[dependency]
                     for _, file in pairs(files) do
-                        if mode == "install" or file ~= config_file then
-                            local temp_file = install_dir .. "/" .. file
-                            if fs.exists(file) then fs.delete(file) end
-                            fs.move(temp_file, file)
-                        end
+                        local temp_file = install_dir.."/"..file
+                        if fs.exists(file) then fs.delete(file) end
+                        fs.move(temp_file, file)
                     end
                 end
             end
@@ -487,19 +477,17 @@ elseif mode == "install" or mode == "update" then
 
                 local files = file_list[dependency]
                 for _, file in pairs(files) do
-                    if mode == "install" or file ~= config_file then
-                        println("GET " .. file)
-                        local dl, err = http.get(repo_path .. file)
+                    println("GET "..file)
+                    local dl, err = http.get(repo_path..file)
 
-                        if dl == nil then
-                            red();println("HTTP Error " .. err)
-                            success = false
-                            break
-                        else
-                            local handle = fs.open("/" .. file, "w")
-                            handle.write(dl.readAll())
-                            handle.close()
-                        end
+                    if dl == nil then
+                        red();println("HTTP Error "..err)
+                        success = false
+                        break
+                    else
+                        local handle = fs.open("/"..file, "w")
+                        handle.write(dl.readAll())
+                        handle.close()
                     end
                 end
             end
@@ -521,22 +509,19 @@ elseif mode == "install" or mode == "update" then
             else println("Update failed, files may have been skipped.") end
         end
     end
-elseif mode == "remove" or mode == "purge" then
+elseif mode == "uninstall" then
     local ok, manifest = read_local_manifest()
     if not ok then
         red();println("Error parsing local installation manifest.");white()
         return
-    elseif mode == "remove" and manifest.versions[app] == nil then
-        red();println(app .. " is not installed, cannot remove.");white()
+    end
+
+    if manifest.versions[app] == nil then
+        red();println("Error: '"..app.."' is not installed.")
         return
     end
 
-    orange()
-    if mode == "remove" then
-        println("Removing all " .. app .. " files except for config and log...")
-    elseif mode == "purge" then
-        println("Purging all " .. app .. " files including config and log...")
-    end
+    orange();println("Uninstalling all "..app.." files...")
 
     -- ask for confirmation
     if not ask_y_n("Continue", false) then return end
@@ -546,76 +531,68 @@ elseif mode == "remove" or mode == "purge" then
 
     local file_list = manifest.files
     local dependencies = manifest.depends[app]
-    local config_file = app .. "/config.lua"
 
     table.insert(dependencies, app)
 
-    -- delete log file if purging
+    -- delete log file
+    local log_deleted = false
+    local settings_file = app..".settings"
+    local legacy_config_file = app.."/config.lua"
+
     lgray()
-    if mode == "purge" and fs.exists(config_file) then
-        local log_deleted = pcall(function ()
-            local config = require(app .. ".config")
+    if fs.exists(legacy_config_file) then
+        log_deleted = pcall(function ()
+            local config = require(app..".config")
             if fs.exists(config.LOG_PATH) then
                 fs.delete(config.LOG_PATH)
-                println("deleted log file " .. config.LOG_PATH)
+                println("deleted log file "..config.LOG_PATH)
             end
         end)
-
-        if not log_deleted then
-            red();println("Failed to delete log file.")
-            white();println("press any key to continue...")
-            any_key();lgray()
+    elseif fs.exists(settings_file) and settings.load(settings_file) then
+        local log = settings.get("LogPath")
+        if log ~= nil and fs.exists(log) then
+            log_deleted = true
+            fs.delete(log)
+            println("deleted log file "..log)
         end
     end
 
-    -- delete all files except config unless purging
+    if not log_deleted then
+        red();println("Failed to delete log file.")
+        white();println("press any key to continue...")
+        any_key();lgray()
+    end
+
+    -- delete all installed files
     for _, dependency in pairs(dependencies) do
         local files = file_list[dependency]
         for _, file in pairs(files) do
-            if mode == "purge" or file ~= config_file then
-                if fs.exists(file) then fs.delete(file);println("deleted " .. file) end
-            end
+            if fs.exists(file) then fs.delete(file);println("deleted "..file) end
         end
 
-        -- delete folders that we should be deleteing
-        if mode == "purge" or dependency ~= app then
-            local folder = files[1]
-            while true do
-                local dir = fs.getDir(folder)
-                if dir == "" or dir == ".." then break else folder = dir end
-            end
+        local folder = files[1]
+        while true do
+            local dir = fs.getDir(folder)
+            if dir == "" or dir == ".." then break else folder = dir end
+        end
 
-            if fs.isDir(folder) then
-                fs.delete(folder)
-                println("deleted directory " .. folder)
-            end
-        elseif dependency == app then
-            -- delete individual subdirectories so we can leave the config
-            for _, folder in pairs(files) do
-                while true do
-                    local dir = fs.getDir(folder)
-                    if dir == "" or dir == ".." or dir == app then break else folder = dir end
-                end
-
-                if folder ~= app and fs.isDir(folder) then
-                    fs.delete(folder);println("deleted app subdirectory " .. folder)
-                end
-            end
+        if fs.isDir(folder) then
+            fs.delete(folder)
+            println("deleted directory "..folder)
         end
     end
 
-    -- only delete manifest if purging
-    if mode == "purge" then
-        fs.delete("install_manifest.json")
-        println("deleted install_manifest.json")
-    else
-        -- remove all data from versions list to show nothing is installed
-        manifest.versions = {}
-        local imfile = fs.open("install_manifest.json", "w")
-        imfile.write(textutils.serializeJSON(manifest))
-        imfile.close()
+    if fs.exists(legacy_config_file) then
+        fs.delete(legacy_config_file);println("deleted "..legacy_config_file)
     end
 
+    if fs.exists(settings_file) then
+        fs.delete(settings_file);println("deleted "..settings_file)
+    end
+
+    fs.delete("install_manifest.json")
+    println("deleted install_manifest.json")
+
     green();println("Done!")
 end
 

configure.lua

@@ -0,0 +1,11 @@
+print("CONFIGURE> SCANNING FOR CONFIGURATOR...")
+
+if fs.exists("reactor-plc/configure.lua") then require("reactor-plc.configure").configure()
+elseif fs.exists("rtu/configure.lua") then require("rtu.configure").configure()
+elseif fs.exists("supervisor/configure.lua") then require("supervisor.configure").configure()
+elseif fs.exists("coordinator/configure.lua") then require("coordinator.configure").configure()
+elseif fs.exists("pocket/configure.lua") then require("pocket.configure").configure()
+else
+    print("CONFIGURE> NO CONFIGURATOR FOUND")
+    print("CONFIGURE> EXIT")
+end

coordinator/config.lua

@@ -1,41 +0,0 @@
-local config = {}
-
--- supervisor comms channel
-config.SVR_CHANNEL = 16240
--- coordinator comms channel
-config.CRD_CHANNEL = 16243
--- pocket comms channel
-config.PKT_CHANNEL = 16244
--- max trusted modem message distance (0 to disable check)
-config.TRUSTED_RANGE = 0
--- time in seconds (>= 2) before assuming a remote device is no longer active
-config.SV_TIMEOUT = 5
-config.API_TIMEOUT = 5
--- facility authentication key (do NOT use one of your passwords)
--- this enables verifying that messages are authentic
--- all devices on the same network must use the same key
--- config.AUTH_KEY = "SCADAfacility123"
-
--- expected number of reactor units, used only to require that number of unit monitors
-config.NUM_UNITS = 4
-
--- alarm sounder volume (0.0 to 3.0, 1.0 being standard max volume, this is the option given to to speaker.play())
--- note: alarm sine waves are at half saturation, so that multiple will be required to reach full scale
-config.SOUNDER_VOLUME = 1.0
-
--- true for 24 hour time on main view screen
-config.TIME_24_HOUR = true
-
--- disable flow view (for legacy layouts)
-config.DISABLE_FLOW_VIEW = false
-
--- log path
-config.LOG_PATH = "/log.txt"
--- log mode
---  0 = APPEND (adds to existing file on start)
---  1 = NEW (replaces existing file on start)
-config.LOG_MODE = 0
--- true to log verbose debug messages
-config.LOG_DEBUG = false
-
-return config

coordinator/coordinator.lua

@@ -9,16 +9,11 @@ local process     = require("coordinator.process")
 
 local apisessions = require("coordinator.session.apisessions")
 
-local dialog      = require("coordinator.ui.dialog")
-
-local print = util.print
-local println = util.println
-
 local PROTOCOL = comms.PROTOCOL
 local DEVICE_TYPE = comms.DEVICE_TYPE
 local ESTABLISH_ACK = comms.ESTABLISH_ACK
-local SCADA_MGMT_TYPE = comms.SCADA_MGMT_TYPE
-local SCADA_CRDN_TYPE = comms.SCADA_CRDN_TYPE
+local MGMT_TYPE = comms.MGMT_TYPE
+local CRDN_TYPE = comms.CRDN_TYPE
 local UNIT_COMMAND = comms.UNIT_COMMAND
 local FAC_COMMAND = comms.FAC_COMMAND
 
@@ -26,182 +21,152 @@ local LINK_TIMEOUT = 60.0
 
 local coordinator = {}
 
--- request the user to select a monitor
----@nodiscard
----@param names table available monitors
----@return boolean|string|nil
-local function ask_monitor(names)
-    println("available monitors:")
-    for i = 1, #names do
-        print(" " .. names[i])
-    end
-    println("")
-    println("select a monitor or type c to cancel")
+---@type crd_config
+local config = {}
 
-    local iface = dialog.ask_options(names, "c")
+coordinator.config = config
 
-    if iface ~= false and iface ~= nil then
-        util.filter_table(names, function (x) return x ~= iface end)
+-- load the coordinator configuration<br>
+-- status of 0 is OK, 1 is bad config, 2 is bad monitor config
+---@return 0|1|2 status, nil|monitors_struct|string monitors (or error message)
+function coordinator.load_config()
+    if not settings.load("/coordinator.settings") then return 1 end
+
+    config.UnitCount = settings.get("UnitCount")
+    config.SpeakerVolume = settings.get("SpeakerVolume")
+    config.Time24Hour = settings.get("Time24Hour")
+
+    config.DisableFlowView = settings.get("DisableFlowView")
+    config.MainDisplay = settings.get("MainDisplay")
+    config.FlowDisplay = settings.get("FlowDisplay")
+    config.UnitDisplays = settings.get("UnitDisplays")
+
+    config.SVR_Channel = settings.get("SVR_Channel")
+    config.CRD_Channel = settings.get("CRD_Channel")
+    config.PKT_Channel = settings.get("PKT_Channel")
+    config.SVR_Timeout = settings.get("SVR_Timeout")
+    config.API_Timeout = settings.get("API_Timeout")
+    config.TrustedRange = settings.get("TrustedRange")
+    config.AuthKey = settings.get("AuthKey")
+
+    config.LogMode = settings.get("LogMode")
+    config.LogPath = settings.get("LogPath")
+    config.LogDebug = settings.get("LogDebug")
+
+    local cfv = util.new_validator()
+
+    cfv.assert_type_int(config.UnitCount)
+    cfv.assert_range(config.UnitCount, 1, 4)
+    cfv.assert_type_bool(config.Time24Hour)
+
+    cfv.assert_type_bool(config.DisableFlowView)
+    cfv.assert_type_table(config.UnitDisplays)
+
+    cfv.assert_type_num(config.SpeakerVolume)
+    cfv.assert_range(config.SpeakerVolume, 0, 3)
+
+    cfv.assert_channel(config.SVR_Channel)
+    cfv.assert_channel(config.CRD_Channel)
+    cfv.assert_channel(config.PKT_Channel)
+
+    cfv.assert_type_num(config.SVR_Timeout)
+    cfv.assert_min(config.SVR_Timeout, 2)
+    cfv.assert_type_num(config.API_Timeout)
+    cfv.assert_min(config.API_Timeout, 2)
+
+    cfv.assert_type_num(config.TrustedRange)
+    cfv.assert_min(config.TrustedRange, 0)
+    cfv.assert_type_str(config.AuthKey)
+
+    if type(config.AuthKey) == "string" then
+        local len = string.len(config.AuthKey)
+        cfv.assert_eq(len == 0 or len >= 8, true)
     end
 
-    return iface
-end
+    cfv.assert_type_int(config.LogMode)
+    cfv.assert_range(config.LogMode, 0, 1)
+    cfv.assert_type_str(config.LogPath)
+    cfv.assert_type_bool(config.LogDebug)
+
+    -- Monitor Setup
 
--- configure monitor layout
----@param num_units integer number of units expected
----@param disable_flow_view boolean disable flow view (legacy)
----@return boolean success, monitors_struct? monitors
-function coordinator.configure_monitors(num_units, disable_flow_view)
     ---@class monitors_struct
     local monitors = {
-        primary = nil,
+        primary = nil,      ---@type table|nil
         primary_name = "",
-        flow = nil,
+        flow = nil,         ---@type table|nil
         flow_name = "",
         unit_displays = {},
         unit_name_map = {}
     }
 
-    local monitors_avail = ppm.get_monitor_list()
-    local names = {}
-    local available = {}
+    local mon_cfv = util.new_validator()
 
     -- get all interface names
-    for iface, _ in pairs(monitors_avail) do
-        table.insert(names, iface)
-        table.insert(available, iface)
-    end
+    local names = {}
+    for iface, _ in pairs(ppm.get_monitor_list()) do table.insert(names, iface) end
 
-    -- we need a certain number of monitors (1 per unit + 1 primary display + 1 flow display)
-    local num_displays_needed = num_units + util.trinary(disable_flow_view, 1, 2)
-    if #names < num_displays_needed then
-        local message = "not enough monitors connected (need " .. num_displays_needed .. ")"
-        println(message)
-        log.warning(message)
-        return false
-    end
+    local function setup_monitors()
+        mon_cfv.assert_type_str(config.MainDisplay)
+        if not config.DisableFlowView then mon_cfv.assert_type_str(config.FlowDisplay) end
+        mon_cfv.assert_eq(#config.UnitDisplays, config.UnitCount)
 
-    -- attempt to load settings
-    if not settings.load("/coord.settings") then
-        log.warning("configure_monitors(): failed to load coordinator settings file (may not exist yet)")
-    else
-        local _primary = settings.get("PRIMARY_DISPLAY")
-        local _flow = settings.get("FLOW_DISPLAY")
-        local _unitd = settings.get("UNIT_DISPLAYS")
+        if mon_cfv.valid() then
+            local w, h, _
 
-        -- filter out already assigned monitors
-        util.filter_table(available, function (x) return x ~= _primary end)
-        util.filter_table(available, function (x) return x ~= _flow end)
-        if type(_unitd) == "table" then
-            util.filter_table(available, function (x) return not util.table_contains(_unitd, x) end)
-        end
-    end
-
-    ---------------------
-    -- PRIMARY DISPLAY --
-    ---------------------
-
-    local iface_primary_display = settings.get("PRIMARY_DISPLAY")   ---@type boolean|string|nil
-
-    if not util.table_contains(names, iface_primary_display) then
-        println("primary display is not connected")
-        local response = dialog.ask_y_n("would you like to change it", true)
-        if response == false then return false end
-        iface_primary_display = nil
-    end
-
-    while iface_primary_display == nil and #available > 0 do
-        iface_primary_display = ask_monitor(available)
-    end
-
-    if type(iface_primary_display) ~= "string" then return false end
-
-    settings.set("PRIMARY_DISPLAY", iface_primary_display)
-    util.filter_table(available, function (x) return x ~= iface_primary_display end)
-
-    monitors.primary = ppm.get_periph(iface_primary_display)
-    monitors.primary_name = iface_primary_display
-
-    --------------------------
-    -- FLOW MONITOR DISPLAY --
-    --------------------------
-
-    if not disable_flow_view then
-        local iface_flow_display = settings.get("FLOW_DISPLAY")  ---@type boolean|string|nil
-
-        if not util.table_contains(names, iface_flow_display) then
-            println("flow monitor display is not connected")
-            local response = dialog.ask_y_n("would you like to change it", true)
-            if response == false then return false end
-            iface_flow_display = nil
-        end
-
-        while iface_flow_display == nil and #available > 0 do
-            iface_flow_display = ask_monitor(available)
-        end
-
-        if type(iface_flow_display) ~= "string" then return false end
-
-        settings.set("FLOW_DISPLAY", iface_flow_display)
-        util.filter_table(available, function (x) return x ~= iface_flow_display end)
-
-        monitors.flow = ppm.get_periph(iface_flow_display)
-        monitors.flow_name = iface_flow_display
-    end
-
-    -------------------
-    -- UNIT DISPLAYS --
-    -------------------
-
-    local unit_displays = settings.get("UNIT_DISPLAYS")
-
-    if unit_displays == nil then
-        unit_displays = {}
-        for i = 1, num_units do
-            local display = nil
-
-            while display == nil and #available > 0 do
-                println("please select monitor for unit #" .. i)
-                display = ask_monitor(available)
+            if not util.table_contains(names, config.MainDisplay) then
+                return 2, "Main monitor is not connected."
             end
 
-            if display == false then return false end
+            monitors.primary = ppm.get_periph(config.MainDisplay)
+            monitors.primary_name = config.MainDisplay
 
-            unit_displays[i] = display
-        end
-    else
-        -- make sure all displays are connected
-        for i = 1, num_units do
-            local display = unit_displays[i]
-
-            if not util.table_contains(names, display) then
-                println("unit #" .. i .. " display is not connected")
-                local response = dialog.ask_y_n("would you like to change it", true)
-                if response == false then return false end
-                display = nil
+            monitors.primary.setTextScale(0.5)
+            w, _ = ppm.monitor_block_size(monitors.primary.getSize())
+            if w ~= 8 then
+                return 2, util.c("Main monitor width is incorrect (was ", w, ", must be 8).")
             end
 
-            while display == nil and #available > 0 do
-                display = ask_monitor(available)
+            if not config.DisableFlowView then
+                if not util.table_contains(names, config.FlowDisplay) then
+                    return 2, "Flow monitor is not connected."
+                end
+
+                monitors.flow = ppm.get_periph(config.FlowDisplay)
+                monitors.flow_name = config.FlowDisplay
+
+                monitors.flow.setTextScale(0.5)
+                w, _ = ppm.monitor_block_size(monitors.flow.getSize())
+                if w ~= 8 then
+                    return 2, util.c("Flow monitor width is incorrect (was ", w, ", must be 8).")
+                end
             end
 
-            if display == false then return false end
+            for i = 1, config.UnitCount do
+                local display = config.UnitDisplays[i]
+                if type(display) ~= "string" or not util.table_contains(names, display) then
+                    return 2, "Unit " .. i .. " monitor is not connected."
+                end
 
-            unit_displays[i] = display
-        end
+                monitors.unit_displays[i] = ppm.get_periph(display)
+                monitors.unit_name_map[i] = display
+
+                monitors.unit_displays[i].setTextScale(0.5)
+                w, h = ppm.monitor_block_size(monitors.unit_displays[i].getSize())
+                if w ~= 4 or h ~= 4 then
+                    return 2, util.c("Unit ", i, " monitor size is incorrect (was ", w, " by ", h,", must be 4 by 4).")
+                end
+            end
+        else return 2, "Monitor configuration invalid." end
     end
 
-    settings.set("UNIT_DISPLAYS", unit_displays)
-    if not settings.save("/coord.settings") then
-        log.warning("configure_monitors(): failed to save coordinator settings file")
-    end
+    if cfv.valid() then
+        local ok, result, message = pcall(setup_monitors)
+        assert(ok, util.c("fatal error while trying to verify monitors: ", result))
+        if result == 2 then return 2, message end
+    else return 1 end
 
-    for i = 1, #unit_displays do
-        monitors.unit_displays[i] = ppm.get_periph(unit_displays[i])
-        monitors.unit_name_map[i] = unit_displays[i]
-    end
-
-    return true, monitors
+    return 0, monitors
 end
 
 -- dmesg print wrapper
@@ -246,13 +211,8 @@ end
 ---@nodiscard
 ---@param version string coordinator version
 ---@param nic nic network interface device
----@param num_units integer number of configured units for number of monitors, checked against SV
----@param crd_channel integer port of configured supervisor
----@param svr_channel integer listening port for supervisor replys
----@param pkt_channel integer listening port for pocket API
----@param range integer trusted device connection range
 ---@param sv_watchdog watchdog
-function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pkt_channel, range, sv_watchdog)
+function coordinator.comms(version, nic, sv_watchdog)
     local self = {
         sv_linked = false,
         sv_addr = comms.BROADCAST,
@@ -267,19 +227,19 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
         est_task_done = nil
     }
 
-    comms.set_trusted_range(range)
-
-    -- PRIVATE FUNCTIONS --
+    comms.set_trusted_range(config.TrustedRange)
 
     -- configure network channels
     nic.closeAll()
-    nic.open(crd_channel)
+    nic.open(config.CRD_Channel)
 
-    -- link nic to apisessions
-    apisessions.init(nic)
+    -- pass config to apisessions
+    apisessions.init(nic, config)
+
+    -- PRIVATE FUNCTIONS --
 
     -- send a packet to the supervisor
-    ---@param msg_type SCADA_MGMT_TYPE|SCADA_CRDN_TYPE
+    ---@param msg_type MGMT_TYPE|CRDN_TYPE
     ---@param msg table
     local function _send_sv(protocol, msg_type, msg)
         local s_pkt = comms.scada_packet()
@@ -296,7 +256,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
         pkt.make(msg_type, msg)
         s_pkt.make(self.sv_addr, self.sv_seq_num, protocol, pkt.raw_sendable())
 
-        nic.transmit(svr_channel, crd_channel, s_pkt)
+        nic.transmit(config.SVR_Channel, config.CRD_Channel, s_pkt)
         self.sv_seq_num = self.sv_seq_num + 1
     end
 
@@ -307,22 +267,22 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
         local s_pkt = comms.scada_packet()
         local m_pkt = comms.mgmt_packet()
 
-        m_pkt.make(SCADA_MGMT_TYPE.ESTABLISH, { ack })
+        m_pkt.make(MGMT_TYPE.ESTABLISH, { ack })
         s_pkt.make(packet.src_addr(), packet.seq_num() + 1, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
-        nic.transmit(pkt_channel, crd_channel, s_pkt)
+        nic.transmit(config.PKT_Channel, config.CRD_Channel, s_pkt)
         self.last_api_est_acks[packet.src_addr()] = ack
     end
 
     -- attempt connection establishment
     local function _send_establish()
-        _send_sv(PROTOCOL.SCADA_MGMT, SCADA_MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.CRDN })
+        _send_sv(PROTOCOL.SCADA_MGMT, MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.CRD })
     end
 
     -- keep alive ack
     ---@param srv_time integer
     local function _send_keep_alive_ack(srv_time)
-        _send_sv(PROTOCOL.SCADA_MGMT, SCADA_MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
+        _send_sv(PROTOCOL.SCADA_MGMT, MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
     end
 
     -- PUBLIC FUNCTIONS --
@@ -343,7 +303,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                 self.est_last = self.est_start
 
                 self.est_tick_waiting, self.est_task_done =
-                    coordinator.log_comms_connecting("attempting to connect to configured supervisor on channel " .. svr_channel)
+                    coordinator.log_comms_connecting("attempting to connect to configured supervisor on channel " .. config.SVR_Channel)
 
                 _send_establish()
             else
@@ -356,7 +316,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                 if abort then
                     coordinator.log_comms("supervisor connection attempt cancelled by user")
                 elseif self.sv_config_err then
-                    coordinator.log_comms("supervisor cooling configuration invalid, check supervisor config file")
+                    coordinator.log_comms("supervisor unit count does not match coordinator unit count, check configs")
                 elseif not self.sv_linked then
                     if self.last_est_ack == ESTABLISH_ACK.DENY then
                         coordinator.log_comms("supervisor connection attempt denied")
@@ -371,7 +331,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
 
                 ok = false
             elseif self.sv_config_err then
-                coordinator.log_comms("supervisor cooling configuration invalid, check supervisor config file")
+                coordinator.log_comms("supervisor unit count does not match coordinator unit count, check configs")
                 ok = false
             elseif (util.time_s() - self.est_last) > 1.0 then
                 _send_establish()
@@ -394,21 +354,21 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
         self.sv_linked = false
         self.sv_r_seq_num = nil
         iocontrol.fp_link_state(types.PANEL_LINK_STATE.DISCONNECTED)
-        _send_sv(PROTOCOL.SCADA_MGMT, SCADA_MGMT_TYPE.CLOSE, {})
+        _send_sv(PROTOCOL.SCADA_MGMT, MGMT_TYPE.CLOSE, {})
     end
 
     -- send a facility command
     ---@param cmd FAC_COMMAND command
     ---@param option any? optional option options for the optional options (like waste mode)
     function public.send_fac_command(cmd, option)
-        _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.FAC_CMD, { cmd, option })
+        _send_sv(PROTOCOL.SCADA_CRDN, CRDN_TYPE.FAC_CMD, { cmd, option })
     end
 
     -- send the auto process control configuration with a start command
-    ---@param config coord_auto_config configuration
-    function public.send_auto_start(config)
-        _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.FAC_CMD, {
-            FAC_COMMAND.START, config.mode, config.burn_target, config.charge_target, config.gen_target, config.limits
+    ---@param auto_cfg coord_auto_config configuration
+    function public.send_auto_start(auto_cfg)
+        _send_sv(PROTOCOL.SCADA_CRDN, CRDN_TYPE.FAC_CMD, {
+            FAC_COMMAND.START, auto_cfg.mode, auto_cfg.burn_target, auto_cfg.charge_target, auto_cfg.gen_target, auto_cfg.limits
         })
     end
 
@@ -417,7 +377,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
     ---@param unit integer unit ID
     ---@param option any? optional option options for the optional options (like burn rate)
     function public.send_unit_command(cmd, unit, option)
-        _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.UNIT_CMD, { cmd, unit, option })
+        _send_sv(PROTOCOL.SCADA_CRDN, CRDN_TYPE.UNIT_CMD, { cmd, unit, option })
     end
 
     -- parse a packet
@@ -426,7 +386,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
     ---@param reply_to integer
     ---@param message any
     ---@param distance integer
-    ---@return mgmt_frame|crdn_frame|capi_frame|nil packet
+    ---@return mgmt_frame|crdn_frame|nil packet
     function public.parse_packet(side, sender, reply_to, message, distance)
         local s_pkt = nic.receive(side, sender, reply_to, message, distance)
         local pkt = nil
@@ -444,12 +404,6 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                 if crdn_pkt.decode(s_pkt) then
                     pkt = crdn_pkt.get()
                 end
-            -- get as coordinator API packet
-            elseif s_pkt.protocol() == PROTOCOL.COORD_API then
-                local capi_pkt = comms.capi_packet()
-                if capi_pkt.decode(s_pkt) then
-                    pkt = capi_pkt.get()
-                end
             else
                 log.debug("attempted parse of illegal packet type " .. s_pkt.protocol(), true)
             end
@@ -459,7 +413,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
     end
 
     -- handle a packet
-    ---@param packet mgmt_frame|crdn_frame|capi_frame|nil
+    ---@param packet mgmt_frame|crdn_frame|nil
     ---@return boolean close_ui
     function public.handle_packet(packet)
         local was_linked = self.sv_linked
@@ -470,23 +424,23 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
             local src_addr = packet.scada_frame.src_addr()
             local protocol = packet.scada_frame.protocol()
 
-            if l_chan ~= crd_channel then
+            if l_chan ~= config.CRD_Channel then
                 log.debug("received packet on unconfigured channel " .. l_chan, true)
-            elseif r_chan == pkt_channel then
+            elseif r_chan == config.PKT_Channel then
                 if not self.sv_linked then
                     log.debug("discarding pocket API packet before linked to supervisor")
-                elseif protocol == PROTOCOL.COORD_API then
-                    ---@cast packet capi_frame
+                elseif protocol == PROTOCOL.SCADA_CRDN then
+                    ---@cast packet crdn_frame
                     -- look for an associated session
                     local session = apisessions.find_session(src_addr)
 
-                    -- API packet
+                    -- coordinator packet
                     if session ~= nil then
                         -- pass the packet onto the session handler
                         session.in_queue.push_packet(packet)
                     else
                         -- any other packet should be session related, discard it
-                        log.debug("discarding COORD_API packet without a known session")
+                        log.debug("discarding SCADA_CRDN packet without a known session")
                     end
                 elseif protocol == PROTOCOL.SCADA_MGMT then
                     ---@cast packet mgmt_frame
@@ -497,7 +451,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                     if session ~= nil then
                         -- pass the packet onto the session handler
                         session.in_queue.push_packet(packet)
-                    elseif packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                    elseif packet.type == MGMT_TYPE.ESTABLISH then
                         -- establish a new session
                         -- validate packet and continue
                         if packet.length == 3 and type(packet.data[1]) == "string" and type(packet.data[2]) == "string" then
@@ -532,7 +486,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                 else
                     log.debug("illegal packet type " .. protocol .. " on pocket channel", true)
                 end
-            elseif r_chan == svr_channel then
+            elseif r_chan == config.SVR_Channel then
                 -- check sequence number
                 if self.sv_r_seq_num == nil then
                     self.sv_r_seq_num = packet.scada_frame.seq_num()
@@ -553,7 +507,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                 if protocol == PROTOCOL.SCADA_CRDN then
                     ---@cast packet crdn_frame
                     if self.sv_linked then
-                        if packet.type == SCADA_CRDN_TYPE.INITIAL_BUILDS then
+                        if packet.type == CRDN_TYPE.INITIAL_BUILDS then
                             if packet.length == 2 then
                                 -- record builds
                                 local fac_builds = iocontrol.record_facility_builds(packet.data[1])
@@ -561,31 +515,31 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
 
                                 if fac_builds and unit_builds then
                                     -- acknowledge receipt of builds
-                                    _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.INITIAL_BUILDS, {})
+                                    _send_sv(PROTOCOL.SCADA_CRDN, CRDN_TYPE.INITIAL_BUILDS, {})
                                 else
                                     log.debug("received invalid INITIAL_BUILDS packet")
                                 end
                             else
                                 log.debug("INITIAL_BUILDS packet length mismatch")
                             end
-                        elseif packet.type == SCADA_CRDN_TYPE.FAC_BUILDS then
+                        elseif packet.type == CRDN_TYPE.FAC_BUILDS then
                             if packet.length == 1 then
                                 -- record facility builds
                                 if iocontrol.record_facility_builds(packet.data[1]) then
                                     -- acknowledge receipt of builds
-                                    _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.FAC_BUILDS, {})
+                                    _send_sv(PROTOCOL.SCADA_CRDN, CRDN_TYPE.FAC_BUILDS, {})
                                 else
                                     log.debug("received invalid FAC_BUILDS packet")
                                 end
                             else
                                 log.debug("FAC_BUILDS packet length mismatch")
                             end
-                        elseif packet.type == SCADA_CRDN_TYPE.FAC_STATUS then
+                        elseif packet.type == CRDN_TYPE.FAC_STATUS then
                             -- update facility status
                             if not iocontrol.update_facility_status(packet.data) then
                                 log.debug("received invalid FAC_STATUS packet")
                             end
-                        elseif packet.type == SCADA_CRDN_TYPE.FAC_CMD then
+                        elseif packet.type == CRDN_TYPE.FAC_CMD then
                             -- facility command acknowledgement
                             if packet.length >= 2 then
                                 local cmd = packet.data[1]
@@ -613,24 +567,24 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                             else
                                 log.debug("SCADA_CRDN facility command ack packet length mismatch")
                             end
-                        elseif packet.type == SCADA_CRDN_TYPE.UNIT_BUILDS then
+                        elseif packet.type == CRDN_TYPE.UNIT_BUILDS then
                             -- record builds
                             if packet.length == 1 then
                                 if iocontrol.record_unit_builds(packet.data[1]) then
                                     -- acknowledge receipt of builds
-                                    _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.UNIT_BUILDS, {})
+                                    _send_sv(PROTOCOL.SCADA_CRDN, CRDN_TYPE.UNIT_BUILDS, {})
                                 else
                                     log.debug("received invalid UNIT_BUILDS packet")
                                 end
                             else
                                 log.debug("UNIT_BUILDS packet length mismatch")
                             end
-                        elseif packet.type == SCADA_CRDN_TYPE.UNIT_STATUSES then
+                        elseif packet.type == CRDN_TYPE.UNIT_STATUSES then
                             -- update statuses
                             if not iocontrol.update_unit_statuses(packet.data) then
                                 log.debug("received invalid UNIT_STATUSES packet")
                             end
-                        elseif packet.type == SCADA_CRDN_TYPE.UNIT_CMD then
+                        elseif packet.type == CRDN_TYPE.UNIT_CMD then
                             -- unit command acknowledgement
                             if packet.length == 3 then
                                 local cmd = packet.data[1]
@@ -672,7 +626,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                 elseif protocol == PROTOCOL.SCADA_MGMT then
                     ---@cast packet mgmt_frame
                     if self.sv_linked then
-                        if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                        if packet.type == MGMT_TYPE.KEEP_ALIVE then
                             -- keep alive request received, echo back
                             if packet.length == 1 then
                                 local timestamp = packet.data[1]
@@ -690,7 +644,7 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                             else
                                 log.debug("SCADA keep alive packet length mismatch")
                             end
-                        elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                        elseif packet.type == MGMT_TYPE.CLOSE then
                             -- handle session close
                             sv_watchdog.cancel()
                             self.sv_addr = comms.BROADCAST
@@ -701,26 +655,26 @@ function coordinator.comms(version, nic, num_units, crd_channel, svr_channel, pk
                         else
                             log.debug("received unknown SCADA_MGMT packet type " .. packet.type)
                         end
-                    elseif packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                    elseif packet.type == MGMT_TYPE.ESTABLISH then
                         -- connection with supervisor established
                         if packet.length == 2 then
                             local est_ack = packet.data[1]
-                            local config = packet.data[2]
+                            local sv_config = packet.data[2]
 
                             if est_ack == ESTABLISH_ACK.ALLOW then
                                 -- reset to disconnected before validating
                                 iocontrol.fp_link_state(types.PANEL_LINK_STATE.DISCONNECTED)
 
-                                if type(config) == "table" and #config == 2 then
+                                if type(sv_config) == "table" and #sv_config == 2 then
                                     -- get configuration
 
                                     ---@class facility_conf
                                     local conf = {
-                                        num_units = config[1],  ---@type integer
-                                        cooling = config[2]     ---@type sv_cooling_conf
+                                        num_units = sv_config[1], ---@type integer
+                                        cooling = sv_config[2]    ---@type sv_cooling_conf
                                     }
 
-                                    if conf.num_units == num_units then
+                                    if conf.num_units == config.UnitCount then
                                         -- init io controller
                                         iocontrol.init(conf, public)
 

coordinator/iocontrol.lua

@@ -110,9 +110,9 @@ function iocontrol.init(conf, comms)
     -- determine tank information
     if io.facility.tank_mode == 0 then
         io.facility.tank_defs = {}
-        -- on facility tank mode 0, setup tank defs to match unit TANK option
+        -- on facility tank mode 0, setup tank defs to match unit tank option
         for i = 1, conf.num_units do
-            io.facility.tank_defs[i] = util.trinary(conf.cooling.r_cool[i].TANK, 1, 0)
+            io.facility.tank_defs[i] = util.trinary(conf.cooling.r_cool[i].TankConnection, 1, 0)
         end
 
         io.facility.tank_list = { table.unpack(io.facility.tank_defs) }
@@ -214,7 +214,7 @@ function iocontrol.init(conf, comms)
             num_boilers = 0,
             num_turbines = 0,
             num_snas = 0,
-            has_tank = conf.cooling.r_cool[i].TANK,
+            has_tank = conf.cooling.r_cool[i].TankConnection,
 
             control_state = false,
             burn_rate_cmd = 0.0,
@@ -295,13 +295,13 @@ function iocontrol.init(conf, comms)
         end
 
         -- create boiler tables
-        for _ = 1, conf.cooling.r_cool[i].BOILERS do
+        for _ = 1, conf.cooling.r_cool[i].BoilerCount do
             table.insert(entry.boiler_ps_tbl, psil.create())
             table.insert(entry.boiler_data_tbl, {})
         end
 
         -- create turbine tables
-        for _ = 1, conf.cooling.r_cool[i].TURBINES do
+        for _ = 1, conf.cooling.r_cool[i].TurbineCount do
             table.insert(entry.turbine_ps_tbl, psil.create())
             table.insert(entry.turbine_data_tbl, {})
         end
@@ -469,7 +469,7 @@ function iocontrol.record_unit_builds(builds)
 
     -- note: if not all units and RTUs are connected, some will be nil
     for id, build in pairs(builds) do
-        local unit = io.units[id]    ---@type ioctl_unit
+        local unit = io.units[id] ---@type ioctl_unit
 
         local log_header = util.c("iocontrol.record_unit_builds[UNIT ", id, "]: ")
 
@@ -694,8 +694,8 @@ function iocontrol.update_facility_status(status)
 
                 for id, sps in pairs(rtu_statuses.sps) do
                     if type(fac.sps_data_tbl[id]) == "table" then
-                        local data = fac.sps_data_tbl[id]   ---@type sps_session_db
-                        local ps   = fac.sps_ps_tbl[id]     ---@type psil
+                        local data = fac.sps_data_tbl[id] ---@type sps_session_db
+                        local ps   = fac.sps_ps_tbl[id]   ---@type psil
 
                         local rtu_faulted = _record_multiblock_status(sps, data, ps)
 
@@ -732,8 +732,8 @@ function iocontrol.update_facility_status(status)
 
                 for id, tank in pairs(rtu_statuses.tanks) do
                     if type(fac.tank_data_tbl[id]) == "table" then
-                        local data = fac.tank_data_tbl[id]  ---@type dynamicv_session_db
-                        local ps   = fac.tank_ps_tbl[id]    ---@type psil
+                        local data = fac.tank_data_tbl[id] ---@type dynamicv_session_db
+                        local ps   = fac.tank_ps_tbl[id]   ---@type psil
 
                         local rtu_faulted = _record_multiblock_status(tank, data, ps)
 
@@ -760,20 +760,34 @@ function iocontrol.update_facility_status(status)
             end
 
             -- environment detector status
-            if type(rtu_statuses.rad_mon) == "table" then
-                if #rtu_statuses.rad_mon > 0 then
-                    local rad_mon = rtu_statuses.rad_mon[1]
-                    local rtu_faulted = rad_mon[1]  ---@type boolean
-                    fac.radiation     = rad_mon[2]  ---@type number
+            if type(rtu_statuses.envds) == "table" then
+                local max_rad, max_reading, any_conn, any_faulted = 0, types.new_zero_radiation_reading(), false, false
 
-                    fac.ps.publish("rad_computed_status", util.trinary(rtu_faulted, 2, 3))
-                    fac.ps.publish("radiation", fac.radiation)
+                for _, envd in pairs(rtu_statuses.envds) do
+                    local rtu_faulted = envd[1] ---@type boolean
+                    local radiation   = envd[2] ---@type radiation_reading
+                    local rad_raw     = envd[3] ---@type number
+
+                    any_conn = true
+                    any_faulted = any_faulted or rtu_faulted
+
+                    if rad_raw > max_rad then
+                        max_rad = rad_raw
+                        max_reading = radiation
+                    end
+                end
+
+                if any_conn then
+                    fac.radiation = max_reading
+                    fac.ps.publish("rad_computed_status", util.trinary(any_faulted, 2, 3))
                 else
                     fac.radiation = types.new_zero_radiation_reading()
                     fac.ps.publish("rad_computed_status", 1)
                 end
+
+                fac.ps.publish("radiation", fac.radiation)
             else
-                log.debug(log_header .. "radiation monitor list not a table")
+                log.debug(log_header .. "environment detector list not a table")
                 valid = false
             end
         else
@@ -917,8 +931,8 @@ function iocontrol.update_unit_statuses(statuses)
 
                         for id, boiler in pairs(rtu_statuses.boilers) do
                             if type(unit.boiler_data_tbl[id]) == "table" then
-                                local data = unit.boiler_data_tbl[id]   ---@type boilerv_session_db
-                                local ps   = unit.boiler_ps_tbl[id]     ---@type psil
+                                local data = unit.boiler_data_tbl[id] ---@type boilerv_session_db
+                                local ps   = unit.boiler_ps_tbl[id]   ---@type psil
 
                                 local rtu_faulted = _record_multiblock_status(boiler, data, ps)
 
@@ -960,8 +974,8 @@ function iocontrol.update_unit_statuses(statuses)
 
                         for id, turbine in pairs(rtu_statuses.turbines) do
                             if type(unit.turbine_data_tbl[id]) == "table" then
-                                local data = unit.turbine_data_tbl[id]  ---@type turbinev_session_db
-                                local ps   = unit.turbine_ps_tbl[id]    ---@type psil
+                                local data = unit.turbine_data_tbl[id] ---@type turbinev_session_db
+                                local ps   = unit.turbine_ps_tbl[id]   ---@type psil
 
                                 local rtu_faulted = _record_multiblock_status(turbine, data, ps)
 
@@ -1033,9 +1047,9 @@ function iocontrol.update_unit_statuses(statuses)
 
                     -- solar neutron activator status info
                     if type(rtu_statuses.sna) == "table" then
-                        unit.num_snas      = rtu_statuses.sna[1]    ---@type integer
-                        unit.sna_prod_rate = rtu_statuses.sna[2]    ---@type number
-                        unit.sna_peak_rate = rtu_statuses.sna[3]    ---@type number
+                        unit.num_snas      = rtu_statuses.sna[1] ---@type integer
+                        unit.sna_prod_rate = rtu_statuses.sna[2] ---@type number
+                        unit.sna_peak_rate = rtu_statuses.sna[3] ---@type number
 
                         unit.unit_ps.publish("sna_count", unit.num_snas)
                         unit.unit_ps.publish("sna_prod_rate", unit.sna_prod_rate)
@@ -1048,16 +1062,28 @@ function iocontrol.update_unit_statuses(statuses)
                     end
 
                     -- environment detector status
-                    if type(rtu_statuses.rad_mon) == "table" then
-                        if #rtu_statuses.rad_mon > 0 then
-                            local rad_mon = rtu_statuses.rad_mon[1]
-                            -- local rtu_faulted = rad_mon[1]  ---@type boolean
-                            unit.radiation = rad_mon[2]  ---@type number
+                    if type(rtu_statuses.envds) == "table" then
+                        local max_rad, max_reading, any_conn = 0, types.new_zero_radiation_reading(), false
 
-                            unit.unit_ps.publish("radiation", unit.radiation)
+                        for _, envd in pairs(rtu_statuses.envds) do
+                            local radiation = envd[2] ---@type radiation_reading
+                            local rad_raw   = envd[3] ---@type number
+
+                            any_conn = true
+
+                            if rad_raw > max_rad then
+                                max_rad = rad_raw
+                                max_reading = radiation
+                            end
+                        end
+
+                        if any_conn then
+                            unit.radiation = max_reading
                         else
                             unit.radiation = types.new_zero_radiation_reading()
                         end
+
+                        unit.unit_ps.publish("radiation", unit.radiation)
                     else
                         log.debug(log_header .. "radiation monitor list not a table")
                         valid = false

coordinator/process.lua

@@ -19,15 +19,20 @@ local process = {}
 local self = {
     io = nil,       ---@type ioctl
     comms = nil,    ---@type coord_comms
-    ---@class coord_auto_config
-    config = {
-        mode = PROCESS.INACTIVE,
-        burn_target = 0.0,
-        charge_target = 0.0,
-        gen_target = 0.0,
-        limits = {},
-        waste_product = PRODUCT.PLUTONIUM,
-        pu_fallback = false
+    ---@class coord_control_states
+    control_states = {
+        ---@class coord_auto_config
+        process = {
+            mode = PROCESS.INACTIVE,
+            burn_target = 0.0,
+            charge_target = 0.0,
+            gen_target = 0.0,
+            limits = {},
+            waste_product = PRODUCT.PLUTONIUM,
+            pu_fallback = false
+        },
+        waste_modes = {},
+        priority_groups = {}
     }
 }
 
@@ -42,63 +47,64 @@ function process.init(iocontrol, coord_comms)
     self.io = iocontrol
     self.comms = coord_comms
 
+    local ctl_proc = self.control_states.process
+
     for i = 1, self.io.facility.num_units do
-        self.config.limits[i] = 0.1
+        ctl_proc.limits[i] = 0.1
     end
 
-    -- load settings
-    if not settings.load("/coord.settings") then
-        log.error("process.init(): failed to load coordinator settings file")
-    end
+    local ctrl_states = settings.get("ControlStates", {})
+    local config = ctrl_states.process  ---@type coord_auto_config
 
     -- facility auto control configuration
-    local config = settings.get("PROCESS")  ---@type coord_auto_config|nil
     if type(config) == "table" then
-        self.config.mode = config.mode
-        self.config.burn_target = config.burn_target
-        self.config.charge_target = config.charge_target
-        self.config.gen_target = config.gen_target
-        self.config.limits = config.limits
-        self.config.waste_product = config.waste_product
-        self.config.pu_fallback = config.pu_fallback
+        ctl_proc.mode = config.mode
+        ctl_proc.burn_target = config.burn_target
+        ctl_proc.charge_target = config.charge_target
+        ctl_proc.gen_target = config.gen_target
+        ctl_proc.limits = config.limits
+        ctl_proc.waste_product = config.waste_product
+        ctl_proc.pu_fallback = config.pu_fallback
 
-        self.io.facility.ps.publish("process_mode", self.config.mode)
-        self.io.facility.ps.publish("process_burn_target", self.config.burn_target)
-        self.io.facility.ps.publish("process_charge_target", self.config.charge_target)
-        self.io.facility.ps.publish("process_gen_target", self.config.gen_target)
-        self.io.facility.ps.publish("process_waste_product", self.config.waste_product)
-        self.io.facility.ps.publish("process_pu_fallback", self.config.pu_fallback)
+        self.io.facility.ps.publish("process_mode", ctl_proc.mode)
+        self.io.facility.ps.publish("process_burn_target", ctl_proc.burn_target)
+        self.io.facility.ps.publish("process_charge_target", ctl_proc.charge_target)
+        self.io.facility.ps.publish("process_gen_target", ctl_proc.gen_target)
+        self.io.facility.ps.publish("process_waste_product", ctl_proc.waste_product)
+        self.io.facility.ps.publish("process_pu_fallback", ctl_proc.pu_fallback)
 
-        for id = 1, math.min(#self.config.limits, self.io.facility.num_units) do
+        for id = 1, math.min(#ctl_proc.limits, self.io.facility.num_units) do
             local unit = self.io.units[id]   ---@type ioctl_unit
-            unit.unit_ps.publish("burn_limit", self.config.limits[id])
+            unit.unit_ps.publish("burn_limit", ctl_proc.limits[id])
         end
 
-        log.info("PROCESS: loaded auto control settings from coord.settings")
+        log.info("PROCESS: loaded auto control settings")
 
         -- notify supervisor of auto waste config
-        self.comms.send_fac_command(FAC_COMMAND.SET_WASTE_MODE, self.config.waste_product)
-        self.comms.send_fac_command(FAC_COMMAND.SET_PU_FB, self.config.pu_fallback)
+        self.comms.send_fac_command(FAC_COMMAND.SET_WASTE_MODE, ctl_proc.waste_product)
+        self.comms.send_fac_command(FAC_COMMAND.SET_PU_FB, ctl_proc.pu_fallback)
     end
 
     -- unit waste states
-    local waste_modes = settings.get("WASTE_MODES")  ---@type table|nil
+    local waste_modes = ctrl_states.waste_modes  ---@type table|nil
     if type(waste_modes) == "table" then
         for id, mode in pairs(waste_modes) do
+            self.control_states.waste_modes[id] = mode
             self.comms.send_unit_command(UNIT_COMMAND.SET_WASTE, id, mode)
         end
 
-        log.info("PROCESS: loaded unit waste mode settings from coord.settings")
+        log.info("PROCESS: loaded unit waste mode settings")
     end
 
     -- unit priority groups
-    local prio_groups = settings.get("PRIORITY_GROUPS") ---@type table|nil
+    local prio_groups = ctrl_states.priority_groups ---@type table|nil
     if type(prio_groups) == "table" then
         for id, group in pairs(prio_groups) do
+            self.control_states.priority_groups[id] = group
             self.comms.send_unit_command(UNIT_COMMAND.SET_GROUP, id, group)
         end
 
-        log.info("PROCESS: loaded priority groups settings from coord.settings")
+        log.info("PROCESS: loaded priority groups settings")
     end
 end
 
@@ -155,15 +161,10 @@ function process.set_unit_waste(id, mode)
     self.comms.send_unit_command(UNIT_COMMAND.SET_WASTE, id, mode)
     log.debug(util.c("PROCESS: UNIT[", id, "] SET WASTE ", mode))
 
-    local waste_mode = settings.get("WASTE_MODES")  ---@type table|nil
+    self.control_states.waste_modes[id] = mode
+    settings.set("ControlStates", self.control_states)
 
-    if type(waste_mode) ~= "table" then waste_mode = {} end
-
-    waste_mode[id] = mode
-
-    settings.set("WASTE_MODES", waste_mode)
-
-    if not settings.save("/coord.settings") then
+    if not settings.save("/coordinator.settings") then
         log.error("process.set_unit_waste(): failed to save coordinator settings file")
     end
 end
@@ -198,15 +199,10 @@ function process.set_group(unit_id, group_id)
     self.comms.send_unit_command(UNIT_COMMAND.SET_GROUP, unit_id, group_id)
     log.debug(util.c("PROCESS: UNIT[", unit_id, "] SET GROUP ", group_id))
 
-    local prio_groups = settings.get("PRIORITY_GROUPS") ---@type table|nil
+    self.control_states.priority_groups[unit_id] = group_id
+    settings.set("ControlStates", self.control_states)
 
-    if type(prio_groups) ~= "table" then prio_groups = {} end
-
-    prio_groups[unit_id] = group_id
-
-    settings.set("PRIORITY_GROUPS", prio_groups)
-
-    if not settings.save("/coord.settings") then
+    if not settings.save("/coordinator.settings") then
         log.error("process.set_group(): failed to save coordinator settings file")
     end
 end
@@ -217,20 +213,14 @@ end
 
 -- write auto process control to config file
 local function _write_auto_config()
-    -- attempt to load settings
-    if not settings.load("/coord.settings") then
-        log.warning("process._write_auto_config(): failed to load coordinator settings file")
-    end
-
     -- save config
-    settings.set("PROCESS", self.config)
-    local saved = settings.save("/coord.settings")
-
+    settings.set("ControlStates", self.control_states)
+    local saved = settings.save("/coordinator.settings")
     if not saved then
         log.warning("process._write_auto_config(): failed to save coordinator settings file")
     end
 
-    return not not saved
+    return saved
 end
 
 -- stop automatic process control
@@ -241,7 +231,7 @@ end
 
 -- start automatic process control
 function process.start_auto()
-    self.comms.send_auto_start(self.config)
+    self.comms.send_auto_start(self.control_states.process)
     log.debug("PROCESS: START AUTO CTL")
 end
 
@@ -253,7 +243,7 @@ function process.set_process_waste(product)
     log.debug(util.c("PROCESS: SET WASTE ", product))
 
     -- update config table and save
-    self.config.waste_product = product
+    self.control_states.process.waste_product = product
     _write_auto_config()
 end
 
@@ -265,7 +255,7 @@ function process.set_pu_fallback(enabled)
     log.debug(util.c("PROCESS: SET PU FALLBACK ", enabled))
 
     -- update config table and save
-    self.config.pu_fallback = enabled
+    self.control_states.process.pu_fallback = enabled
     _write_auto_config()
 end
 
@@ -279,11 +269,12 @@ function process.save(mode, burn_target, charge_target, gen_target, limits)
     log.debug("PROCESS: SAVE")
 
     -- update config table
-    self.config.mode = mode
-    self.config.burn_target = burn_target
-    self.config.charge_target = charge_target
-    self.config.gen_target = gen_target
-    self.config.limits = limits
+    local ctl_proc = self.control_states.process
+    ctl_proc.mode = mode
+    ctl_proc.burn_target = burn_target
+    ctl_proc.charge_target = charge_target
+    ctl_proc.gen_target = gen_target
+    ctl_proc.limits = limits
 
     -- save config
     self.io.facility.save_cfg_ack(_write_auto_config())
@@ -294,22 +285,23 @@ end
 function process.start_ack_handle(response)
     local ack = response[1]
 
-    self.config.mode = response[2]
-    self.config.burn_target = response[3]
-    self.config.charge_target = response[4]
-    self.config.gen_target = response[5]
+    local ctl_proc = self.control_states.process
+    ctl_proc.mode = response[2]
+    ctl_proc.burn_target = response[3]
+    ctl_proc.charge_target = response[4]
+    ctl_proc.gen_target = response[5]
 
     for i = 1, math.min(#response[6], self.io.facility.num_units) do
-        self.config.limits[i] = response[6][i]
+        ctl_proc.limits[i] = response[6][i]
 
         local unit = self.io.units[i]   ---@type ioctl_unit
-        unit.unit_ps.publish("burn_limit", self.config.limits[i])
+        unit.unit_ps.publish("burn_limit", ctl_proc.limits[i])
     end
 
-    self.io.facility.ps.publish("process_mode", self.config.mode)
-    self.io.facility.ps.publish("process_burn_target", self.config.burn_target)
-    self.io.facility.ps.publish("process_charge_target", self.config.charge_target)
-    self.io.facility.ps.publish("process_gen_target", self.config.gen_target)
+    self.io.facility.ps.publish("process_mode", ctl_proc.mode)
+    self.io.facility.ps.publish("process_burn_target", ctl_proc.burn_target)
+    self.io.facility.ps.publish("process_charge_target", ctl_proc.charge_target)
+    self.io.facility.ps.publish("process_gen_target", ctl_proc.gen_target)
 
     self.io.facility.start_ack(ack)
 end
@@ -317,14 +309,14 @@ end
 -- record waste product state after attempting to change it
 ---@param response WASTE_PRODUCT supervisor waste product state
 function process.waste_ack_handle(response)
-    self.config.waste_product = response
+    self.control_states.process.waste_product = response
     self.io.facility.ps.publish("process_waste_product", response)
 end
 
 -- record plutonium fallback state after attempting to change it
 ---@param response boolean supervisor plutonium fallback state
 function process.pu_fb_ack_handle(response)
-    self.config.pu_fallback = response
+    self.control_states.process.pu_fallback = response
     self.io.facility.ps.publish("process_pu_fallback", response)
 end
 

coordinator/renderer.lua

@@ -3,7 +3,6 @@
 --
 
 local log        = require("scada-common.log")
-local util       = require("scada-common.util")
 
 local iocontrol  = require("coordinator.iocontrol")
 
@@ -15,10 +14,12 @@ local panel_view = require("coordinator.ui.layout.front_panel")
 local main_view  = require("coordinator.ui.layout.main_view")
 local unit_view  = require("coordinator.ui.layout.unit_view")
 
+local core       = require("graphics.core")
 local flasher    = require("graphics.flasher")
 
 local DisplayBox = require("graphics.elements.displaybox")
 
+---@class coord_renderer
 local renderer = {}
 
 -- render engine
@@ -91,39 +92,6 @@ function renderer.init_displays()
     end
 end
 
--- check main display width
----@nodiscard
----@return boolean width_okay
-function renderer.validate_main_display_width()
-    local w, _ = engine.monitors.primary.getSize()
-    return w == 164
-end
-
--- check flow display width
----@nodiscard
----@return boolean width_okay
-function renderer.validate_flow_display_width()
-    local w, _ = engine.monitors.flow.getSize()
-    return w == 164
-end
-
--- check display sizes
----@nodiscard
----@return boolean valid all unit display dimensions OK
-function renderer.validate_unit_display_sizes()
-    local valid = true
-
-    for id, monitor in ipairs(engine.monitors.unit_displays) 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))
-            valid = false
-        end
-    end
-
-    return valid
-end
-
 -- initialize the dmesg output window
 function renderer.init_dmesg()
     local disp_x, disp_y = engine.monitors.primary.getSize()
@@ -131,19 +99,30 @@ function renderer.init_dmesg()
     log.direct_dmesg(engine.dmesg_window)
 end
 
--- start the coordinator front panel
-function renderer.start_fp()
+-- try to start the front panel
+---@return boolean success, any error_msg
+function renderer.try_start_fp()
+    local status, msg = true, nil
+
     if not engine.fp_ready then
         -- show front panel view on terminal
-        engine.ui.front_panel = DisplayBox{window=term.native(),fg_bg=style.fp.root}
-        panel_view(engine.ui.front_panel, #engine.monitors.unit_displays)
+        status, msg = pcall(function ()
+            engine.ui.front_panel = DisplayBox{window=term.native(),fg_bg=style.fp.root}
+            panel_view(engine.ui.front_panel, #engine.monitors.unit_displays)
+        end)
 
-        -- start flasher callback task
-        flasher.run()
-
-        -- report front panel as ready
-        engine.fp_ready = true
+        if status then
+            -- start flasher callback task and report ready
+            flasher.run()
+            engine.fp_ready = true
+        else
+            -- report fail and close front panel
+            msg = core.extract_assert_msg(msg)
+            renderer.close_fp()
+        end
     end
+
+    return status, msg
 end
 
 -- close out the front panel
@@ -176,36 +155,47 @@ function renderer.close_fp()
     end
 end
 
--- start the coordinator GUI
-function renderer.start_ui()
+-- try to start the main GUI
+---@return boolean success, any error_msg
+function renderer.try_start_ui()
+    local status, msg = true, nil
+
     if not engine.ui_ready then
         -- hide dmesg
         engine.dmesg_window.setVisible(false)
 
-        -- show main view on main monitor
-        if engine.monitors.primary ~= nil then
-            engine.ui.main_display = DisplayBox{window=engine.monitors.primary,fg_bg=style.root}
-            main_view(engine.ui.main_display)
+        status, msg = pcall(function ()
+            -- show main view on main monitor
+            if engine.monitors.primary ~= nil then
+                engine.ui.main_display = DisplayBox{window=engine.monitors.primary,fg_bg=style.root}
+                main_view(engine.ui.main_display)
+            end
+
+            -- show flow view on flow monitor
+            if engine.monitors.flow ~= nil then
+                engine.ui.flow_display = DisplayBox{window=engine.monitors.flow,fg_bg=style.root}
+                flow_view(engine.ui.flow_display)
+            end
+
+            -- show unit views on unit displays
+            for idx, display in pairs(engine.monitors.unit_displays) do
+                engine.ui.unit_displays[idx] = DisplayBox{window=display,fg_bg=style.root}
+                unit_view(engine.ui.unit_displays[idx], idx)
+            end
+        end)
+
+        if status then
+            -- start flasher callback task and report ready
+            flasher.run()
+            engine.ui_ready = true
+        else
+            -- report fail and close ui
+            msg = core.extract_assert_msg(msg)
+            renderer.close_ui()
         end
-
-        -- show flow view on flow monitor
-        if engine.monitors.flow ~= nil then
-            engine.ui.flow_display = DisplayBox{window=engine.monitors.flow,fg_bg=style.root}
-            flow_view(engine.ui.flow_display)
-        end
-
-        -- show unit views on unit displays
-        for idx, display in pairs(engine.monitors.unit_displays) do
-            engine.ui.unit_displays[idx] = DisplayBox{window=display,fg_bg=style.root}
-            unit_view(engine.ui.unit_displays[idx], idx)
-        end
-
-        -- start flasher callback task
-        flasher.run()
-
-        -- report ui as ready
-        engine.ui_ready = true
     end
+
+    return status, msg
 end
 
 -- close out the UI

coordinator/session/apisessions.lua

@@ -3,7 +3,6 @@ local log       = require("scada-common.log")
 local mqueue    = require("scada-common.mqueue")
 local util      = require("scada-common.util")
 
-local config    = require("coordinator.config")
 local iocontrol = require("coordinator.iocontrol")
 
 local pocket    = require("coordinator.session.pocket")
@@ -11,7 +10,8 @@ local pocket    = require("coordinator.session.pocket")
 local apisessions = {}
 
 local self = {
-    nic = nil,
+    nic = nil,    ---@type nic
+    config = nil, ---@type crd_config
     next_id = 0,
     sessions = {}
 }
@@ -32,7 +32,7 @@ local function _api_handle_outq(session)
         if msg ~= nil then
             if msg.qtype == mqueue.TYPE.PACKET then
                 -- handle a packet to be sent
-                self.nic.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message)
+                self.nic.transmit(self.config.PKT_Channel, self.config.CRD_Channel, msg.message)
             elseif msg.qtype == mqueue.TYPE.COMMAND then
                 -- handle instruction/notification
             elseif msg.qtype == mqueue.TYPE.DATA then
@@ -59,7 +59,7 @@ local function _shutdown(session)
     while session.out_queue.ready() do
         local msg = session.out_queue.pop()
         if msg ~= nil and msg.qtype == mqueue.TYPE.PACKET then
-            self.nic.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message)
+            self.nic.transmit(self.config.PKT_Channel, self.config.CRD_Channel, msg.message)
         end
     end
 
@@ -69,9 +69,11 @@ end
 -- PUBLIC FUNCTIONS --
 
 -- initialize apisessions
----@param nic nic
-function apisessions.init(nic)
+---@param nic nic network interface
+---@param config crd_config coordinator config
+function apisessions.init(nic, config)
     self.nic = nic
+    self.config = config
 end
 
 -- find a session by remote port
@@ -103,7 +105,7 @@ function apisessions.establish_session(source_addr, version)
 
     local id = self.next_id
 
-    pkt_s.instance = pocket.new_session(id, source_addr, pkt_s.in_queue, pkt_s.out_queue, config.API_TIMEOUT)
+    pkt_s.instance = pocket.new_session(id, source_addr, pkt_s.in_queue, pkt_s.out_queue, self.config.API_Timeout)
     table.insert(self.sessions, pkt_s)
 
     local mt = {

coordinator/session/pocket.lua

@@ -8,8 +8,8 @@ local iocontrol = require("coordinator.iocontrol")
 local pocket = {}
 
 local PROTOCOL = comms.PROTOCOL
--- local CAPI_TYPE = comms.CAPI_TYPE
-local SCADA_MGMT_TYPE = comms.SCADA_MGMT_TYPE
+-- local CRDN_TYPE = comms.CRDN_TYPE
+local MGMT_TYPE = comms.MGMT_TYPE
 
 -- retry time constants in ms
 -- local INITIAL_WAIT = 1500
@@ -72,22 +72,22 @@ function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
         iocontrol.fp_pkt_disconnected(id)
     end
 
-    -- send a CAPI packet
-    -----@param msg_type CAPI_TYPE
+    -- send a CRDN packet
+    -----@param msg_type CRDN_TYPE
     -----@param msg table
     -- local function _send(msg_type, msg)
     --     local s_pkt = comms.scada_packet()
-    --     local c_pkt = comms.capi_packet()
+    --     local c_pkt = comms.crdn_packet()
 
     --     c_pkt.make(msg_type, msg)
-    --     s_pkt.make(self.seq_num, PROTOCOL.COORD_API, c_pkt.raw_sendable())
+    --     s_pkt.make(self.seq_num, PROTOCOL.SCADA_CRDN, c_pkt.raw_sendable())
 
     --     out_queue.push_packet(s_pkt)
     --     self.seq_num = self.seq_num + 1
     -- end
 
     -- send a SCADA management packet
-    ---@param msg_type SCADA_MGMT_TYPE
+    ---@param msg_type MGMT_TYPE
     ---@param msg table
     local function _send_mgmt(msg_type, msg)
         local s_pkt = comms.scada_packet()
@@ -101,7 +101,7 @@ function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
     end
 
     -- handle a packet
-    ---@param pkt mgmt_frame|capi_frame
+    ---@param pkt mgmt_frame|crdn_frame
     local function _handle_packet(pkt)
         -- check sequence number
         if self.r_seq_num == nil then
@@ -117,17 +117,17 @@ function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
         self.conn_watchdog.feed()
 
         -- process packet
-        if pkt.scada_frame.protocol() == PROTOCOL.COORD_API then
-            ---@cast pkt capi_frame
+        if pkt.scada_frame.protocol() == PROTOCOL.SCADA_CRDN then
+            ---@cast pkt crdn_frame
 
             -- handle packet by type
             if pkt.type == nil then
             else
-                log.debug(log_header .. "handler received unsupported CAPI packet type " .. pkt.type)
+                log.debug(log_header .. "handler received unsupported CRDN packet type " .. pkt.type)
             end
         elseif pkt.scada_frame.protocol() == PROTOCOL.SCADA_MGMT then
             ---@cast pkt mgmt_frame
-            if pkt.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+            if pkt.type == MGMT_TYPE.KEEP_ALIVE then
                 -- keep alive reply
                 if pkt.length == 2 then
                     local srv_start = pkt.data[1]
@@ -146,7 +146,7 @@ function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
                 else
                     log.debug(log_header .. "SCADA keep alive packet length mismatch")
                 end
-            elseif pkt.type == SCADA_MGMT_TYPE.CLOSE then
+            elseif pkt.type == MGMT_TYPE.CLOSE then
                 -- close the session
                 _close()
             else
@@ -174,7 +174,7 @@ function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
     -- close the connection
     function public.close()
         _close()
-        _send_mgmt(SCADA_MGMT_TYPE.CLOSE, {})
+        _send_mgmt(MGMT_TYPE.CLOSE, {})
         log.info(log_header .. "session closed by server")
     end
 
@@ -229,7 +229,7 @@ function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
 
             periodics.keep_alive = periodics.keep_alive + elapsed
             if periodics.keep_alive >= PERIODICS.KEEP_ALIVE then
-                _send_mgmt(SCADA_MGMT_TYPE.KEEP_ALIVE, { util.time() })
+                _send_mgmt(MGMT_TYPE.KEEP_ALIVE, { util.time() })
                 periodics.keep_alive = 0
             end
 

coordinator/startup.lua

@@ -14,7 +14,7 @@ local util        = require("scada-common.util")
 
 local core        = require("graphics.core")
 
-local config      = require("coordinator.config")
+local configure   = require("coordinator.configure")
 local coordinator = require("coordinator.coordinator")
 local iocontrol   = require("coordinator.iocontrol")
 local renderer    = require("coordinator.renderer")
@@ -22,7 +22,7 @@ local sounder     = require("coordinator.sounder")
 
 local apisessions = require("coordinator.session.apisessions")
 
-local COORDINATOR_VERSION = "v1.0.9"
+local COORDINATOR_VERSION = "v1.2.2"
 
 local println = util.println
 local println_ts = util.println_ts
@@ -34,32 +34,34 @@ local log_comms = coordinator.log_comms
 local log_crypto = coordinator.log_crypto
 
 ----------------------------------------
--- config validation
+-- get configuration
 ----------------------------------------
 
-local cfv = util.new_validator()
+-- mount connected devices (required for monitor setup)
+ppm.mount_all()
 
-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)
+local loaded, monitors = coordinator.load_config()
+if loaded ~= 0 then
+    -- try to reconfigure (user action)
+    local success, error = configure.configure(loaded, monitors)
+    if success then
+        loaded, monitors = coordinator.load_config()
+        assert(loaded == 0, util.trinary(loaded == 1, "failed to load valid configuration", "monitor configuration invalid"))
+    else
+        assert(success, "coordinator configuration error: " .. error)
+    end
+end
 
-assert(cfv.valid(), "bad config file: missing/invalid fields")
+-- passed checks, good now
+---@cast monitors monitors_struct
+
+local config = coordinator.config
 
 ----------------------------------------
 -- log init
 ----------------------------------------
 
-log.init(config.LOG_PATH, config.LOG_MODE, config.LOG_DEBUG == true)
+log.init(config.LogPath, config.LogMode, config.LogDebug)
 
 log.info("========================================")
 log.info("BOOTING coordinator.startup " .. COORDINATOR_VERSION)
@@ -77,39 +79,16 @@ local function main()
     -- system startup
     ----------------------------------------
 
-    -- mount connected devices
+    -- re-mount devices now that logging is ready
     ppm.mount_all()
 
     -- report versions/init fp PSIL
     iocontrol.init_fp(COORDINATOR_VERSION, comms.version)
 
-    -- setup monitors
-    local configured, monitors = coordinator.configure_monitors(config.NUM_UNITS, config.DISABLE_FLOW_VIEW == true)
-    if not configured or monitors == nil then
-        println("startup> monitor setup failed")
-        log.fatal("monitor configuration failed")
-        return
-    end
-
     -- init renderer
-    renderer.legacy_disable_flow_view(config.DISABLE_FLOW_VIEW == true)
+    renderer.legacy_disable_flow_view(config.DisableFlowView)
     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 (config.DISABLE_FLOW_VIEW ~= true) and not renderer.validate_flow_display_width() then
-        println("startup> flow display must be 8 blocks wide")
-        log.fatal("flow 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!
@@ -132,7 +111,7 @@ local function main()
     else
         local sounder_start = util.time_ms()
         log_boot("annunciator alarm speaker connected")
-        sounder.init(speaker, config.SOUNDER_VOLUME)
+        sounder.init(speaker, config.SpeakerVolume)
         log_boot("tone generation took " .. (util.time_ms() - sounder_start) .. "ms")
         log_sys("annunciator alarm configured")
         iocontrol.fp_has_speaker(true)
@@ -143,8 +122,8 @@ local function main()
     ----------------------------------------
 
     -- message authentication init
-    if type(config.AUTH_KEY) == "string" then
-        local init_time = network.init_mac(config.AUTH_KEY)
+    if type(config.AuthKey) == "string" and string.len(config.AuthKey) > 0 then
+        local init_time = network.init_mac(config.AuthKey)
         log_crypto("HMAC init took " .. init_time .. "ms")
     end
 
@@ -161,14 +140,13 @@ local function main()
     end
 
     -- create connection watchdog
-    local conn_watchdog = util.new_watchdog(config.SV_TIMEOUT)
+    local conn_watchdog = util.new_watchdog(config.SVR_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.NUM_UNITS, config.CRD_CHANNEL,
-                                            config.SVR_CHANNEL, config.PKT_CHANNEL, config.TRUSTED_RANGE, conn_watchdog)
+    local coord_comms = coordinator.comms(COORDINATOR_VERSION, nic, conn_watchdog)
     log.debug("startup> comms init")
     log_comms("comms initialized")
 
@@ -182,9 +160,8 @@ local function main()
 
     log_graphics("starting front panel UI...")
 
-    local fp_ok, fp_message = pcall(renderer.start_fp)
+    local fp_ok, fp_message = renderer.try_start_fp()
     if not fp_ok then
-        renderer.close_fp()
         log_graphics(util.c("front panel UI error: ", fp_message))
         println_ts("front panel UI creation failed")
         log.fatal(util.c("front panel GUI render failed with error ", fp_message))
@@ -198,9 +175,8 @@ local function main()
 
         local draw_start = util.time_ms()
 
-        local ui_ok, ui_message = pcall(renderer.start_ui)
+        local ui_ok, ui_message = renderer.try_start_ui()
         if not ui_ok then
-            renderer.close_ui()
             log_graphics(util.c("main UI error: ", ui_message))
             log.fatal(util.c("main GUI render failed with error ", ui_message))
         else
@@ -216,7 +192,7 @@ local function main()
 
     local link_failed = false
     local ui_ok = true
-    local date_format = util.trinary(config.TIME_24_HOUR, "%X \x04 %A, %B %d %Y", "%r \x04 %A, %B %d %Y")
+    local date_format = util.trinary(config.Time24Hour, "%X \x04 %A, %B %d %Y", "%r \x04 %A, %B %d %Y")
 
     -- start clock
     loop_clock.start()
@@ -358,7 +334,7 @@ local function main()
                 sounder.stop()
             end
         elseif event == "monitor_touch" or event == "mouse_click" or event == "mouse_up" or
-               event == "mouse_drag" or event == "mouse_scroll" then
+               event == "mouse_drag" or event == "mouse_scroll" or event == "double_click" then
             -- handle a mouse event
             renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3))
         elseif event == "speaker_audio_empty" then

coordinator/ui/components/boiler.lua

@@ -12,20 +12,19 @@ local VerticalBar    = require("graphics.elements.indicators.vbar")
 local cpair = core.cpair
 local border = core.border
 
+local text_fg_bg = style.text_colors
+
 -- new boiler view
 ---@param root graphics_element parent
 ---@param x integer top left x
 ---@param y integer top left y
 ---@param ps psil ps interface
 local function new_view(root, x, y, ps)
-    local boiler = Rectangle{parent=root,border=border(1, colors.gray, true),width=31,height=7,x=x,y=y}
-
-    local text_fg_bg = cpair(colors.black, colors.lightGray)
-    local lu_col = cpair(colors.gray, colors.gray)
+    local boiler = Rectangle{parent=root,border=border(1,colors.gray,true),width=31,height=7,x=x,y=y}
 
     local status = StateIndicator{parent=boiler,x=9,y=1,states=style.boiler.states,value=1,min_width=12}
-    local temp   = DataIndicator{parent=boiler,x=5,y=3,lu_colors=lu_col,label="Temp:",unit="K",format="%10.2f",value=0,width=22,fg_bg=text_fg_bg}
-    local boil_r = DataIndicator{parent=boiler,x=5,y=4,lu_colors=lu_col,label="Boil:",unit="mB/t",format="%10.0f",value=0,commas=true,width=22,fg_bg=text_fg_bg}
+    local temp   = DataIndicator{parent=boiler,x=5,y=3,lu_colors=style.lu_col,label="Temp:",unit="K",format="%10.2f",value=0,width=22,fg_bg=text_fg_bg}
+    local boil_r = DataIndicator{parent=boiler,x=5,y=4,lu_colors=style.lu_col,label="Boil:",unit="mB/t",format="%10.0f",value=0,commas=true,width=22,fg_bg=text_fg_bg}
 
     status.register(ps, "computed_status", status.update)
     temp.register(ps, "temperature", temp.update)

coordinator/ui/components/imatrix.lua

@@ -16,7 +16,10 @@ local VerticalBar    = require("graphics.elements.indicators.vbar")
 local cpair = core.cpair
 local border = core.border
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
+
+local text_fg_bg = style.text_colors
+local lu_col = style.lu_colors
 
 -- new induction matrix view
 ---@param root graphics_element parent
@@ -31,14 +34,12 @@ local function new_view(root, x, y, data, ps, id)
 
     local matrix = Div{parent=root,fg_bg=style.root,width=33,height=24,x=x,y=y}
 
-    TextBox{parent=matrix,text=" ",width=33,height=1,x=1,y=1,fg_bg=cpair(colors.lightGray,colors.gray)}
-    TextBox{parent=matrix,text=title,alignment=TEXT_ALIGN.CENTER,width=33,height=1,x=1,y=2,fg_bg=cpair(colors.lightGray,colors.gray)}
+    TextBox{parent=matrix,text=" ",width=33,height=1,x=1,y=1,fg_bg=style.lg_gray}
+    TextBox{parent=matrix,text=title,alignment=ALIGN.CENTER,width=33,height=1,x=1,y=2,fg_bg=style.lg_gray}
 
     local rect = Rectangle{parent=matrix,border=border(1,colors.gray,true),width=33,height=22,x=1,y=3}
 
-    local text_fg_bg = cpair(colors.black, colors.lightGray)
     local label_fg_bg = cpair(colors.gray, colors.lightGray)
-    local lu_col = cpair(colors.gray, colors.gray)
 
     local status   = StateIndicator{parent=rect,x=10,y=1,states=style.imatrix.states,value=1,min_width=14}
     local energy   = PowerIndicator{parent=rect,x=7,y=3,lu_colors=lu_col,label="Energy:  ",format="%8.2f",value=0,width=26,fg_bg=text_fg_bg}

coordinator/ui/components/pkt_entry.lua

@@ -4,6 +4,8 @@
 
 local iocontrol     = require("coordinator.iocontrol")
 
+local style         = require("coordinator.ui.style")
+
 local core          = require("graphics.core")
 
 local Div           = require("graphics.elements.div")
@@ -11,10 +13,13 @@ local TextBox       = require("graphics.elements.textbox")
 
 local DataIndicator = require("graphics.elements.indicators.data")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 
+local text_fg_bg = style.text_colors
+local lg_wh = style.lg_white
+
 -- create a pocket list entry
 ---@param parent graphics_element parent
 ---@param id integer PKT session ID
@@ -23,22 +28,22 @@ local function init(parent, id)
 
     -- root div
     local root = Div{parent=parent,x=2,y=2,height=4,width=parent.get_width()-2,hidden=true}
-    local entry = Div{parent=root,x=2,y=1,height=3,fg_bg=cpair(colors.black,colors.white)}
+    local entry = Div{parent=root,x=2,y=1,height=3,fg_bg=style.bw_fg_bg}
 
     local ps_prefix = "pkt_" .. id .. "_"
 
-    TextBox{parent=entry,x=1,y=1,text="",width=8,height=1,fg_bg=cpair(colors.black,colors.lightGray)}
-    local pkt_addr = TextBox{parent=entry,x=1,y=2,text="@ C ??",alignment=TEXT_ALIGN.CENTER,width=8,height=1,fg_bg=cpair(colors.black,colors.lightGray),nav_active=cpair(colors.gray,colors.black)}
-    TextBox{parent=entry,x=1,y=3,text="",width=8,height=1,fg_bg=cpair(colors.black,colors.lightGray)}
+    TextBox{parent=entry,x=1,y=1,text="",width=8,height=1,fg_bg=text_fg_bg}
+    local pkt_addr = TextBox{parent=entry,x=1,y=2,text="@ C ??",alignment=ALIGN.CENTER,width=8,height=1,fg_bg=text_fg_bg,nav_active=cpair(colors.gray,colors.black)}
+    TextBox{parent=entry,x=1,y=3,text="",width=8,height=1,fg_bg=text_fg_bg}
     pkt_addr.register(ps, ps_prefix .. "addr", pkt_addr.set_value)
 
     TextBox{parent=entry,x=10,y=2,text="FW:",width=3,height=1}
-    local pkt_fw_v = TextBox{parent=entry,x=14,y=2,text=" ------- ",width=20,height=1,fg_bg=cpair(colors.lightGray,colors.white)}
+    local pkt_fw_v = TextBox{parent=entry,x=14,y=2,text=" ------- ",width=20,height=1,fg_bg=lg_wh}
     pkt_fw_v.register(ps, ps_prefix .. "fw", pkt_fw_v.set_value)
 
     TextBox{parent=entry,x=35,y=2,text="RTT:",width=4,height=1}
-    local pkt_rtt = DataIndicator{parent=entry,x=40,y=2,label="",unit="",format="%5d",value=0,width=5,fg_bg=cpair(colors.lightGray,colors.white)}
-    TextBox{parent=entry,x=46,y=2,text="ms",width=4,height=1,fg_bg=cpair(colors.lightGray,colors.white)}
+    local pkt_rtt = DataIndicator{parent=entry,x=40,y=2,label="",unit="",format="%5d",value=0,width=5,fg_bg=lg_wh}
+    TextBox{parent=entry,x=46,y=2,text="ms",width=4,height=1,fg_bg=lg_wh}
     pkt_rtt.register(ps, ps_prefix .. "rtt", pkt_rtt.update)
     pkt_rtt.register(ps, ps_prefix .. "rtt_color", pkt_rtt.recolor)
 

coordinator/ui/components/process_ctl.lua

@@ -23,7 +23,7 @@ local HazardButton      = require("graphics.elements.controls.hazard_button")
 local RadioButton       = require("graphics.elements.controls.radio_button")
 local SpinboxNumeric    = require("graphics.elements.controls.spinbox_numeric")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 local border = core.border
@@ -33,6 +33,8 @@ local lu_cpair = style.lu_colors
 local hzd_fg_bg  = style.hzd_fg_bg
 local dis_colors = style.dis_colors
 
+local gry_wht = style.gray_white
+
 local ind_grn = style.ind_grn
 local ind_yel = style.ind_yel
 local ind_red = style.ind_red
@@ -47,6 +49,10 @@ local period = core.flasher.PERIOD
 local function new_view(root, x, y)
     assert(root.get_height() >= (y + 24), "main display not of sufficient vertical resolution (add an additional row of monitors)")
 
+    local black = cpair(colors.black, colors.black)
+    local blk_brn = cpair(colors.black, colors.brown)
+    local blk_pur = cpair(colors.black, colors.purple)
+
     local facility = iocontrol.get_db().facility
     local units = iocontrol.get_db().units
 
@@ -116,35 +122,35 @@ local function new_view(root, x, y)
 
     local targets = Div{parent=proc,width=31,height=24,x=1,y=1}
 
-    local burn_tag = Div{parent=targets,x=1,y=1,width=8,height=4,fg_bg=cpair(colors.black,colors.purple)}
+    local burn_tag = Div{parent=targets,x=1,y=1,width=8,height=4,fg_bg=blk_pur}
     TextBox{parent=burn_tag,x=2,y=2,text="Burn Target",width=7,height=2}
 
-    local burn_target = Div{parent=targets,x=9,y=1,width=23,height=3,fg_bg=cpair(colors.gray,colors.white)}
-    local b_target = SpinboxNumeric{parent=burn_target,x=11,y=1,whole_num_precision=4,fractional_precision=1,min=0.1,arrow_fg_bg=cpair(colors.gray,colors.white),fg_bg=bw_fg_bg}
+    local burn_target = Div{parent=targets,x=9,y=1,width=23,height=3,fg_bg=gry_wht}
+    local b_target = SpinboxNumeric{parent=burn_target,x=11,y=1,whole_num_precision=4,fractional_precision=1,min=0.1,arrow_fg_bg=gry_wht,fg_bg=bw_fg_bg}
     TextBox{parent=burn_target,x=18,y=2,text="mB/t"}
-    local burn_sum = DataIndicator{parent=targets,x=9,y=4,label="",format="%18.1f",value=0,unit="mB/t",commas=true,lu_colors=cpair(colors.black,colors.black),width=23,fg_bg=cpair(colors.black,colors.brown)}
+    local burn_sum = DataIndicator{parent=targets,x=9,y=4,label="",format="%18.1f",value=0,unit="mB/t",commas=true,lu_colors=black,width=23,fg_bg=blk_brn}
 
     b_target.register(facility.ps, "process_burn_target", b_target.set_value)
     burn_sum.register(facility.ps, "burn_sum", burn_sum.update)
 
-    local chg_tag = Div{parent=targets,x=1,y=6,width=8,height=4,fg_bg=cpair(colors.black,colors.purple)}
+    local chg_tag = Div{parent=targets,x=1,y=6,width=8,height=4,fg_bg=blk_pur}
     TextBox{parent=chg_tag,x=2,y=2,text="Charge Target",width=7,height=2}
 
-    local chg_target = Div{parent=targets,x=9,y=6,width=23,height=3,fg_bg=cpair(colors.gray,colors.white)}
-    local c_target = SpinboxNumeric{parent=chg_target,x=2,y=1,whole_num_precision=15,fractional_precision=0,min=0,arrow_fg_bg=cpair(colors.gray,colors.white),fg_bg=bw_fg_bg}
+    local chg_target = Div{parent=targets,x=9,y=6,width=23,height=3,fg_bg=gry_wht}
+    local c_target = SpinboxNumeric{parent=chg_target,x=2,y=1,whole_num_precision=15,fractional_precision=0,min=0,arrow_fg_bg=gry_wht,fg_bg=bw_fg_bg}
     TextBox{parent=chg_target,x=18,y=2,text="MFE"}
-    local cur_charge = DataIndicator{parent=targets,x=9,y=9,label="",format="%19d",value=0,unit="MFE",commas=true,lu_colors=cpair(colors.black,colors.black),width=23,fg_bg=cpair(colors.black,colors.brown)}
+    local cur_charge = DataIndicator{parent=targets,x=9,y=9,label="",format="%19d",value=0,unit="MFE",commas=true,lu_colors=black,width=23,fg_bg=blk_brn}
 
     c_target.register(facility.ps, "process_charge_target", c_target.set_value)
     cur_charge.register(facility.induction_ps_tbl[1], "energy", function (j) cur_charge.update(util.joules_to_fe(j) / 1000000) end)
 
-    local gen_tag = Div{parent=targets,x=1,y=11,width=8,height=4,fg_bg=cpair(colors.black,colors.purple)}
+    local gen_tag = Div{parent=targets,x=1,y=11,width=8,height=4,fg_bg=blk_pur}
     TextBox{parent=gen_tag,x=2,y=2,text="Gen. Target",width=7,height=2}
 
-    local gen_target = Div{parent=targets,x=9,y=11,width=23,height=3,fg_bg=cpair(colors.gray,colors.white)}
-    local g_target = SpinboxNumeric{parent=gen_target,x=8,y=1,whole_num_precision=9,fractional_precision=0,min=0,arrow_fg_bg=cpair(colors.gray,colors.white),fg_bg=bw_fg_bg}
+    local gen_target = Div{parent=targets,x=9,y=11,width=23,height=3,fg_bg=gry_wht}
+    local g_target = SpinboxNumeric{parent=gen_target,x=8,y=1,whole_num_precision=9,fractional_precision=0,min=0,arrow_fg_bg=gry_wht,fg_bg=bw_fg_bg}
     TextBox{parent=gen_target,x=18,y=2,text="kFE/t"}
-    local cur_gen = DataIndicator{parent=targets,x=9,y=14,label="",format="%17d",value=0,unit="kFE/t",commas=true,lu_colors=cpair(colors.black,colors.black),width=23,fg_bg=cpair(colors.black,colors.brown)}
+    local cur_gen = DataIndicator{parent=targets,x=9,y=14,label="",format="%17d",value=0,unit="kFE/t",commas=true,lu_colors=black,width=23,fg_bg=blk_brn}
 
     g_target.register(facility.ps, "process_gen_target", g_target.set_value)
     cur_gen.register(facility.induction_ps_tbl[1], "last_input", function (j) cur_gen.update(util.round(util.joules_to_fe(j) / 1000)) end)
@@ -159,10 +165,10 @@ local function new_view(root, x, y)
 
     for i = 1, 4 do
         local unit
-        local tag_fg_bg = cpair(colors.gray,colors.white)
-        local lim_fg_bg = cpair(colors.lightGray,colors.white)
+        local tag_fg_bg = gry_wht
+        local lim_fg_bg = style.lg_white
         local ctl_fg    = colors.lightGray
-        local cur_fg_bg = cpair(colors.lightGray,colors.white)
+        local cur_fg_bg = style.lg_white
         local cur_lu    = colors.lightGray
 
         if i <= facility.num_units then
@@ -170,7 +176,7 @@ local function new_view(root, x, y)
             tag_fg_bg = cpair(colors.black,colors.lightBlue)
             lim_fg_bg = bw_fg_bg
             ctl_fg    = colors.gray
-            cur_fg_bg = cpair(colors.black,colors.brown)
+            cur_fg_bg = blk_brn
             cur_lu    = colors.black
         end
 
@@ -180,7 +186,7 @@ local function new_view(root, x, y)
         TextBox{parent=unit_tag,x=2,y=2,text="Unit "..i.." Limit",width=7,height=2}
 
         local lim_ctl = Div{parent=limit_div,x=9,y=_y,width=14,height=3,fg_bg=cpair(ctl_fg,colors.white)}
-        local lim = SpinboxNumeric{parent=lim_ctl,x=2,y=1,whole_num_precision=4,fractional_precision=1,min=0.1,arrow_fg_bg=cpair(colors.gray,colors.white),fg_bg=lim_fg_bg}
+        local lim = SpinboxNumeric{parent=lim_ctl,x=2,y=1,whole_num_precision=4,fractional_precision=1,min=0.1,arrow_fg_bg=gry_wht,fg_bg=lim_fg_bg}
         TextBox{parent=lim_ctl,x=9,y=2,text="mB/t",width=4,height=1}
 
         local cur_burn = DataIndicator{parent=limit_div,x=9,y=_y+3,label="",format="%7.1f",value=0,unit="mB/t",commas=false,lu_colors=cpair(cur_lu,cur_lu),width=14,fg_bg=cur_fg_bg}
@@ -203,8 +209,8 @@ local function new_view(root, x, y)
     local stat_div = Div{parent=proc,width=22,height=24,x=57,y=6}
 
     for i = 1, 4 do
-        local tag_fg_bg = cpair(colors.gray, colors.white)
-        local ind_fg_bg = cpair(colors.lightGray, colors.white)
+        local tag_fg_bg = gry_wht
+        local ind_fg_bg = style.lg_white
         local ind_off = colors.lightGray
 
         if i <= facility.num_units then
@@ -235,18 +241,18 @@ local function new_view(root, x, y)
     -------------------------
 
     local ctl_opts = { "Monitored Max Burn", "Combined Burn Rate", "Charge Level", "Generation Rate" }
-    local mode = RadioButton{parent=proc,x=34,y=1,options=ctl_opts,callback=function()end,radio_colors=cpair(colors.white,colors.black),radio_bg=colors.purple}
+    local mode = RadioButton{parent=proc,x=34,y=1,options=ctl_opts,callback=function()end,radio_colors=cpair(colors.gray,colors.white),select_color=colors.purple}
 
     mode.register(facility.ps, "process_mode", mode.set_value)
 
     local u_stat = Rectangle{parent=proc,border=border(1,colors.gray,true),thin=true,width=31,height=4,x=1,y=16,fg_bg=bw_fg_bg}
-    local stat_line_1 = TextBox{parent=u_stat,x=1,y=1,text="UNKNOWN",width=31,height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=bw_fg_bg}
-    local stat_line_2 = TextBox{parent=u_stat,x=1,y=2,text="awaiting data...",width=31,height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=cpair(colors.gray, colors.white)}
+    local stat_line_1 = TextBox{parent=u_stat,x=1,y=1,text="UNKNOWN",width=31,height=1,alignment=ALIGN.CENTER,fg_bg=bw_fg_bg}
+    local stat_line_2 = TextBox{parent=u_stat,x=1,y=2,text="awaiting data...",width=31,height=1,alignment=ALIGN.CENTER,fg_bg=gry_wht}
 
     stat_line_1.register(facility.ps, "status_line_1", stat_line_1.set_value)
     stat_line_2.register(facility.ps, "status_line_2", stat_line_2.set_value)
 
-    local auto_controls = Div{parent=proc,x=1,y=20,width=31,height=5,fg_bg=cpair(colors.gray,colors.white)}
+    local auto_controls = Div{parent=proc,x=1,y=20,width=31,height=5,fg_bg=gry_wht}
 
     -- save the automatic process control configuration without starting
     local function _save_cfg()
@@ -321,15 +327,15 @@ local function new_view(root, x, y)
 
     local waste_sel = Div{parent=proc,width=21,height=24,x=81,y=1}
 
-    TextBox{parent=waste_sel,text=" ",width=21,height=1,x=1,y=1,fg_bg=cpair(colors.black,colors.brown)}
-    TextBox{parent=waste_sel,text="WASTE PRODUCTION",alignment=TEXT_ALIGN.CENTER,width=21,height=1,x=1,y=2,fg_bg=cpair(colors.lightGray,colors.brown)}
+    TextBox{parent=waste_sel,text=" ",width=21,height=1,x=1,y=1,fg_bg=blk_brn}
+    TextBox{parent=waste_sel,text="WASTE PRODUCTION",alignment=ALIGN.CENTER,width=21,height=1,x=1,y=2,fg_bg=cpair(colors.lightGray,colors.brown)}
 
     local rect   = Rectangle{parent=waste_sel,border=border(1,colors.brown,true),width=21,height=22,x=1,y=3}
     local status = StateIndicator{parent=rect,x=2,y=1,states=style.waste.states,value=1,min_width=17}
 
     status.register(facility.ps, "current_waste_product", status.update)
 
-    local waste_prod = RadioButton{parent=rect,x=2,y=3,options=style.waste.options,callback=process.set_process_waste,radio_colors=cpair(colors.white,colors.black),radio_bg=colors.brown}
+    local waste_prod = RadioButton{parent=rect,x=2,y=3,options=style.waste.options,callback=process.set_process_waste,radio_colors=cpair(colors.gray,colors.white),select_color=colors.brown}
     local pu_fallback = Checkbox{parent=rect,x=2,y=7,label="Pu Fallback",callback=process.set_pu_fallback,box_fg_bg=cpair(colors.green,colors.black)}
 
     waste_prod.register(facility.ps, "process_waste_product", waste_prod.set_value)

coordinator/ui/components/reactor.lua

@@ -14,6 +14,9 @@ local StateIndicator = require("graphics.elements.indicators.state")
 local cpair = core.cpair
 local border = core.border
 
+local text_fg_bg = style.text_colors
+local lu_col = style.lu_colors
+
 -- create new reactor view
 ---@param root graphics_element parent
 ---@param x integer top left x
@@ -22,9 +25,6 @@ local border = core.border
 local function new_view(root, x, y, ps)
     local reactor = Rectangle{parent=root,border=border(1, colors.gray, true),width=30,height=7,x=x,y=y}
 
-    local text_fg_bg = cpair(colors.black, colors.lightGray)
-    local lu_col = cpair(colors.gray, colors.gray)
-
     local status    = StateIndicator{parent=reactor,x=6,y=1,states=style.reactor.states,value=1,min_width=16}
     local core_temp = DataIndicator{parent=reactor,x=2,y=3,lu_colors=lu_col,label="Core Temp:",unit="K",format="%10.2f",value=0,width=26,fg_bg=text_fg_bg}
     local burn_r    = DataIndicator{parent=reactor,x=2,y=4,lu_colors=lu_col,label="Burn Rate:",unit="mB/t",format="%10.2f",value=0,width=26,fg_bg=text_fg_bg}

coordinator/ui/components/turbine.lua

@@ -15,16 +15,16 @@ local VerticalBar    = require("graphics.elements.indicators.vbar")
 local cpair = core.cpair
 local border = core.border
 
+local text_fg_bg = style.text_colors
+local lu_col = style.lu_colors
+
 -- new turbine view
 ---@param root graphics_element parent
 ---@param x integer top left x
 ---@param y integer top left y
 ---@param ps psil ps interface
 local function new_view(root, x, y, ps)
-    local turbine = Rectangle{parent=root,border=border(1, colors.gray, true),width=23,height=7,x=x,y=y}
-
-    local text_fg_bg = cpair(colors.black, colors.lightGray)
-    local lu_col = cpair(colors.gray, colors.gray)
+    local turbine = Rectangle{parent=root,border=border(1,colors.gray,true),width=23,height=7,x=x,y=y}
 
     local status    = StateIndicator{parent=turbine,x=7,y=1,states=style.turbine.states,value=1,min_width=12}
     local prod_rate = PowerIndicator{parent=turbine,x=5,y=3,lu_colors=lu_col,label="",format="%10.2f",value=0,rate=true,width=16,fg_bg=text_fg_bg}

coordinator/ui/components/unit_detail.lua

@@ -2,6 +2,8 @@
 -- Reactor Unit SCADA Coordinator GUI
 --
 
+local types             = require("scada-common.types")
+
 local iocontrol         = require("coordinator.iocontrol")
 
 local style             = require("coordinator.ui.style")
@@ -26,7 +28,7 @@ local PushButton        = require("graphics.elements.controls.push_button")
 local RadioButton       = require("graphics.elements.controls.radio_button")
 local SpinboxNumeric    = require("graphics.elements.controls.spinbox_numeric")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 local border = core.border
@@ -34,6 +36,9 @@ local border = core.border
 local bw_fg_bg = style.bw_fg_bg
 local lu_cpair = style.lu_colors
 local hzd_fg_bg = style.hzd_fg_bg
+local dis_colors = style.dis_colors
+
+local gry_wht = style.gray_white
 
 local ind_grn = style.ind_grn
 local ind_yel = style.ind_yel
@@ -57,7 +62,7 @@ local function init(parent, id)
     local b_ps = unit.boiler_ps_tbl
     local t_ps = unit.turbine_ps_tbl
 
-    TextBox{parent=main,text="Reactor Unit #" .. id,alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
+    TextBox{parent=main,text="Reactor Unit #" .. id,alignment=ALIGN.CENTER,height=1,fg_bg=style.header}
 
     -----------------------------
     -- main stats and core map --
@@ -93,7 +98,7 @@ local function init(parent, id)
     waste.register(u_ps, "waste_fill", waste.update)
 
     ccool.register(u_ps, "ccool_type", function (type)
-        if type == "mekanism:sodium" then
+        if type == types.FLUID.SODIUM then
             ccool.recolor(cpair(colors.lightBlue, colors.gray))
         else
             ccool.recolor(cpair(colors.blue, colors.gray))
@@ -101,7 +106,7 @@ local function init(parent, id)
     end)
 
     hcool.register(u_ps, "hcool_type", function (type)
-        if type == "mekanism:superheated_sodium" then
+        if type == types.FLUID.SUPERHEATED_SODIUM then
             hcool.recolor(cpair(colors.orange, colors.gray))
         else
             hcool.recolor(cpair(colors.white, colors.gray))
@@ -129,8 +134,8 @@ local function init(parent, id)
     -------------------
 
     local u_stat = Rectangle{parent=main,border=border(1,colors.gray,true),thin=true,width=33,height=4,x=46,y=3,fg_bg=bw_fg_bg}
-    local stat_line_1 = TextBox{parent=u_stat,x=1,y=1,text="UNKNOWN",width=33,height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=bw_fg_bg}
-    local stat_line_2 = TextBox{parent=u_stat,x=1,y=2,text="awaiting data...",width=33,height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=cpair(colors.gray, colors.white)}
+    local stat_line_1 = TextBox{parent=u_stat,x=1,y=1,text="UNKNOWN",width=33,height=1,alignment=ALIGN.CENTER,fg_bg=bw_fg_bg}
+    local stat_line_2 = TextBox{parent=u_stat,x=1,y=2,text="awaiting data...",width=33,height=1,alignment=ALIGN.CENTER,fg_bg=gry_wht}
 
     stat_line_1.register(u_ps, "U_StatusLine1", stat_line_1.set_value)
     stat_line_2.register(u_ps, "U_StatusLine2", stat_line_2.set_value)
@@ -190,7 +195,7 @@ local function init(parent, id)
 
     -- RPS annunciator panel
 
-    TextBox{parent=main,text="REACTOR PROTECTION SYSTEM",fg_bg=cpair(colors.black,colors.cyan),alignment=TEXT_ALIGN.CENTER,width=33,height=1,x=46,y=8}
+    TextBox{parent=main,text="REACTOR PROTECTION SYSTEM",fg_bg=cpair(colors.black,colors.cyan),alignment=ALIGN.CENTER,width=33,height=1,x=46,y=8}
     local rps = Rectangle{parent=main,border=border(1,colors.cyan,true),thin=true,width=33,height=12,x=46,y=9}
     local rps_annunc = Div{parent=rps,width=31,height=10,x=2,y=1}
 
@@ -218,7 +223,7 @@ local function init(parent, id)
 
     -- cooling annunciator panel
 
-    TextBox{parent=main,text="REACTOR COOLANT SYSTEM",fg_bg=cpair(colors.black,colors.blue),alignment=TEXT_ALIGN.CENTER,width=33,height=1,x=46,y=22}
+    TextBox{parent=main,text="REACTOR COOLANT SYSTEM",fg_bg=cpair(colors.black,colors.blue),alignment=ALIGN.CENTER,width=33,height=1,x=46,y=22}
     local rcs = Rectangle{parent=main,border=border(1,colors.blue,true),thin=true,width=33,height=24,x=46,y=23}
     local rcs_annunc = Div{parent=rcs,width=27,height=22,x=3,y=1}
     local rcs_tags = Div{parent=rcs,width=2,height=16,x=1,y=7}
@@ -252,7 +257,7 @@ local function init(parent, id)
     if unit.num_boilers > 0 then
         TextBox{parent=rcs_tags,x=1,text="B1",width=2,height=1,fg_bg=bw_fg_bg}
         local b1_wll = IndicatorLight{parent=rcs_annunc,label="Water Level Low",colors=ind_red}
-        b1_wll.register(b_ps[1], "WasterLevelLow", b1_wll.update)
+        b1_wll.register(b_ps[1], "WaterLevelLow", b1_wll.update)
 
         TextBox{parent=rcs_tags,text="B1",width=2,height=1,fg_bg=bw_fg_bg}
         local b1_hr = IndicatorLight{parent=rcs_annunc,label="Heating Rate Low",colors=ind_yel}
@@ -268,7 +273,7 @@ local function init(parent, id)
 
         TextBox{parent=rcs_tags,text="B2",width=2,height=1,fg_bg=bw_fg_bg}
         local b2_wll = IndicatorLight{parent=rcs_annunc,label="Water Level Low",colors=ind_red}
-        b2_wll.register(b_ps[2], "WasterLevelLow", b2_wll.update)
+        b2_wll.register(b_ps[2], "WaterLevelLow", b2_wll.update)
 
         TextBox{parent=rcs_tags,text="B2",width=2,height=1,fg_bg=bw_fg_bg}
         local b2_hr = IndicatorLight{parent=rcs_annunc,label="Heating Rate Low",colors=ind_yel}
@@ -341,10 +346,8 @@ local function init(parent, id)
     -- reactor controls --
     ----------------------
 
-    local dis_colors = cpair(colors.white, colors.lightGray)
-
-    local burn_control = Div{parent=main,x=12,y=28,width=19,height=3,fg_bg=cpair(colors.gray,colors.white)}
-    local burn_rate = SpinboxNumeric{parent=burn_control,x=2,y=1,whole_num_precision=4,fractional_precision=1,min=0.1,arrow_fg_bg=cpair(colors.gray,colors.white),fg_bg=bw_fg_bg}
+    local burn_control = Div{parent=main,x=12,y=28,width=19,height=3,fg_bg=gry_wht}
+    local burn_rate = SpinboxNumeric{parent=burn_control,x=2,y=1,whole_num_precision=4,fractional_precision=1,min=0.1,arrow_fg_bg=gry_wht,fg_bg=bw_fg_bg}
     TextBox{parent=burn_control,x=9,y=2,text="mB/t"}
 
     local set_burn = function () unit.set_burn(burn_rate.get_value()) end
@@ -379,7 +382,7 @@ local function init(parent, id)
 
     reset.register(u_ps, "rps_tripped", function (active) if active then reset.enable() else reset.disable() end end)
 
-    TextBox{parent=main,text="WASTE PROCESSING",fg_bg=cpair(colors.black,colors.brown),alignment=TEXT_ALIGN.CENTER,width=33,height=1,x=46,y=48}
+    TextBox{parent=main,text="WASTE PROCESSING",fg_bg=cpair(colors.black,colors.brown),alignment=ALIGN.CENTER,width=33,height=1,x=46,y=48}
     local waste_proc = Rectangle{parent=main,border=border(1,colors.brown,true),thin=true,width=33,height=3,x=46,y=49}
     local waste_div = Div{parent=waste_proc,x=2,y=1,width=31,height=1}
 
@@ -467,20 +470,20 @@ local function init(parent, id)
     -- automatic control settings --
     --------------------------------
 
-    TextBox{parent=main,text="AUTO CTRL",fg_bg=cpair(colors.black,colors.purple),alignment=TEXT_ALIGN.CENTER,width=13,height=1,x=32,y=36}
+    TextBox{parent=main,text="AUTO CTRL",fg_bg=cpair(colors.black,colors.purple),alignment=ALIGN.CENTER,width=13,height=1,x=32,y=36}
     local auto_ctl = Rectangle{parent=main,border=border(1,colors.purple,true),thin=true,width=13,height=15,x=32,y=37}
     local auto_div = Div{parent=auto_ctl,width=13,height=15,x=1,y=1}
 
     local ctl_opts = { "Manual", "Primary", "Secondary", "Tertiary", "Backup" }
 
-    local group = RadioButton{parent=auto_div,options=ctl_opts,callback=function()end,radio_colors=cpair(colors.blue,colors.white),radio_bg=colors.gray}
+    local group = RadioButton{parent=auto_div,options=ctl_opts,callback=function()end,radio_colors=cpair(colors.gray,colors.white),select_color=colors.purple}
 
     group.register(u_ps, "auto_group_id", function (gid) group.set_value(gid + 1) end)
 
     auto_div.line_break()
 
     local function set_group() unit.set_group(group.get_value() - 1) end
-    local set_grp_btn = PushButton{parent=auto_div,text="SET",x=4,min_width=5,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=style.wh_gray,dis_fg_bg=cpair(colors.gray,colors.white),callback=set_group}
+    local set_grp_btn = PushButton{parent=auto_div,text="SET",x=4,min_width=5,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=style.wh_gray,dis_fg_bg=gry_wht,callback=set_group}
 
     auto_div.line_break()
 

coordinator/ui/components/unit_flow.lua

@@ -19,11 +19,10 @@ local DataIndicator     = require("graphics.elements.indicators.data")
 local IndicatorLight    = require("graphics.elements.indicators.light")
 local TriIndicatorLight = require("graphics.elements.indicators.trilight")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local sprintf = util.sprintf
 
-local cpair = core.cpair
 local border = core.border
 local pipe = core.pipe
 
@@ -31,6 +30,7 @@ local wh_gray = style.wh_gray
 local bw_fg_bg = style.bw_fg_bg
 local text_c = style.text_colors
 local lu_c = style.lu_colors
+local lg_gray = style.lg_gray
 
 local ind_grn = style.ind_grn
 local ind_wht = style.ind_wht
@@ -64,15 +64,13 @@ local function make(parent, x, y, wide, unit)
     -- bounding box div
     local root = Div{parent=parent,x=x,y=y,width=_wide(136, 114),height=height}
 
-    local lg_gray = cpair(colors.lightGray, colors.gray)
-
     ------------------
     -- COOLING LOOP --
     ------------------
 
     local reactor = Rectangle{parent=root,x=1,y=1,border=border(1,colors.gray,true),width=19,height=5,fg_bg=wh_gray}
-    TextBox{parent=reactor,y=1,text="FISSION REACTOR",alignment=TEXT_ALIGN.CENTER,height=1}
-    TextBox{parent=reactor,y=3,text="UNIT #"..unit.unit_id,alignment=TEXT_ALIGN.CENTER,height=1}
+    TextBox{parent=reactor,y=1,text="FISSION REACTOR",alignment=ALIGN.CENTER,height=1}
+    TextBox{parent=reactor,y=3,text="UNIT #"..unit.unit_id,alignment=ALIGN.CENTER,height=1}
     TextBox{parent=root,x=19,y=2,text="\x1b \x80 \x1a",width=1,height=3,fg_bg=lg_gray}
     TextBox{parent=root,x=3,y=5,text="\x19",width=1,height=1,fg_bg=lg_gray}
 
@@ -111,8 +109,8 @@ local function make(parent, x, y, wide, unit)
         hc_rate.register(unit.unit_ps, "heating_rate", hc_rate.update)
 
         local boiler = Rectangle{parent=root,x=_wide(47,40),y=1,border=border(1, colors.gray, true),width=19,height=5,fg_bg=wh_gray}
-        TextBox{parent=boiler,y=1,text="THERMO-ELECTRIC",alignment=TEXT_ALIGN.CENTER,height=1}
-        TextBox{parent=boiler,y=3,text=util.trinary(unit.num_boilers>1,"BOILERS","BOILER"),alignment=TEXT_ALIGN.CENTER,height=1}
+        TextBox{parent=boiler,y=1,text="THERMO-ELECTRIC",alignment=ALIGN.CENTER,height=1}
+        TextBox{parent=boiler,y=3,text=util.trinary(unit.num_boilers>1,"BOILERS","BOILER"),alignment=ALIGN.CENTER,height=1}
         TextBox{parent=root,x=_wide(47,40),y=2,text="\x1b \x80 \x1a",width=1,height=3,fg_bg=lg_gray}
         TextBox{parent=root,x=_wide(65,58),y=2,text="\x1b \x80 \x1a",width=1,height=3,fg_bg=lg_gray}
 
@@ -130,8 +128,8 @@ local function make(parent, x, y, wide, unit)
     end
 
     local turbine = Rectangle{parent=root,x=_wide(93,79),y=1,border=border(1, colors.gray, true),width=19,height=5,fg_bg=wh_gray}
-    TextBox{parent=turbine,y=1,text="STEAM TURBINE",alignment=TEXT_ALIGN.CENTER,height=1}
-    TextBox{parent=turbine,y=3,text=util.trinary(unit.num_turbines>1,"GENERATORS","GENERATOR"),alignment=TEXT_ALIGN.CENTER,height=1}
+    TextBox{parent=turbine,y=1,text="STEAM TURBINE",alignment=ALIGN.CENTER,height=1}
+    TextBox{parent=turbine,y=3,text=util.trinary(unit.num_turbines>1,"GENERATORS","GENERATOR"),alignment=ALIGN.CENTER,height=1}
     TextBox{parent=root,x=_wide(93,79),y=2,text="\x1b \x80 \x1a",width=1,height=3,fg_bg=lg_gray}
 
     for i = 1, unit.num_turbines do
@@ -177,8 +175,8 @@ local function make(parent, x, y, wide, unit)
 
     local function _machine(mx, my, name)
         local l = string.len(name) + 2
-        TextBox{parent=waste,x=mx,y=my,text=string.rep("\x8f",l),alignment=TEXT_ALIGN.CENTER,fg_bg=lg_gray,width=l,height=1}
-        TextBox{parent=waste,x=mx,y=my+1,text=name,alignment=TEXT_ALIGN.CENTER,fg_bg=wh_gray,width=l,height=1}
+        TextBox{parent=waste,x=mx,y=my,text=string.rep("\x8f",l),alignment=ALIGN.CENTER,fg_bg=lg_gray,width=l,height=1}
+        TextBox{parent=waste,x=mx,y=my+1,text=name,alignment=ALIGN.CENTER,fg_bg=wh_gray,width=l,height=1}
     end
 
     local waste_rate = DataIndicator{parent=waste,x=1,y=3,lu_colors=lu_c,label="",unit="mB/t",format="%7.2f",value=0,width=12,fg_bg=bw_fg_bg}
@@ -205,7 +203,7 @@ local function make(parent, x, y, wide, unit)
     _machine(_wide(97, 83), 4, "PRC [Po] \x1a");
     _machine(_wide(116, 94), 6, "SPENT WASTE \x1b")
 
-    TextBox{parent=waste,x=_wide(30,25),y=3,text="SNAs [Po]",alignment=TEXT_ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
+    TextBox{parent=waste,x=_wide(30,25),y=3,text="SNAs [Po]",alignment=ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
     local sna_po  = Rectangle{parent=waste,x=_wide(30,25),y=4,border=border(1,colors.gray,true),width=19,height=7,thin=true,fg_bg=bw_fg_bg}
     local sna_act = IndicatorLight{parent=sna_po,label="ACTIVE",colors=ind_grn}
     local sna_cnt = DataIndicator{parent=sna_po,x=12,y=1,lu_colors=lu_c,label="CNT",unit="",format="%2d",value=0,width=7}

coordinator/ui/components/unit_overview.lua

@@ -14,7 +14,7 @@ local Div          = require("graphics.elements.div")
 local PipeNetwork  = require("graphics.elements.pipenet")
 local TextBox      = require("graphics.elements.textbox")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local pipe = core.pipe
 
@@ -44,7 +44,7 @@ local function make(parent, x, y, unit)
     local root = Div{parent=parent,x=x,y=y,width=80,height=height}
 
     -- unit header message
-    TextBox{parent=root,text="Unit #"..unit.unit_id,alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
+    TextBox{parent=root,text="Unit #"..unit.unit_id,alignment=ALIGN.CENTER,height=1,fg_bg=style.header}
 
     -------------
     -- REACTOR --

coordinator/ui/dialog.lua

@@ -1,52 +0,0 @@
-local completion = require("cc.completion")
-
-local util       = require("scada-common.util")
-
-local print = util.print
-
-local dialog = {}
-
--- ask the user yes or no
----@nodiscard
----@param question string
----@param default boolean
----@return boolean|nil
-function dialog.ask_y_n(question, default)
-    print(question)
-
-    if default == true then
-        print(" (Y/n)? ")
-    else
-        print(" (y/N)? ")
-    end
-
-    local response = read(nil, nil)
-
-    if response == "" then
-        return default
-    elseif response == "Y" or response == "y" then
-        return true
-    elseif response == "N" or response == "n" then
-        return false
-    else
-        return nil
-    end
-end
-
--- ask the user for an input within a set of options
----@nodiscard
----@param options table
----@param cancel string
----@return boolean|string|nil
-function dialog.ask_options(options, cancel)
-    print("> ")
-    local response = read(nil, nil, function(text) return completion.choice(text, options) end)
-
-    if response == cancel then return false end
-
-    if util.table_contains(options, response) then
-        return response
-    else return nil end
-end
-
-return dialog

coordinator/ui/layout/flow_view.lua

@@ -25,7 +25,7 @@ local StateIndicator = require("graphics.elements.indicators.state")
 
 local CONTAINER_MODE = types.CONTAINER_MODE
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 local border = core.border
@@ -46,9 +46,9 @@ local function init(main)
     local tank_list = facility.tank_list
 
     -- window header message
-    local header = TextBox{parent=main,y=1,text="Facility Coolant and Waste Flow Monitor",alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
+    local header = TextBox{parent=main,y=1,text="Facility Coolant and Waste Flow Monitor",alignment=ALIGN.CENTER,height=1,fg_bg=style.header}
     -- max length example: "01:23:45 AM - Wednesday, September 28 2022"
-    local datetime = TextBox{parent=main,x=(header.get_width()-42),y=1,text="",alignment=TEXT_ALIGN.RIGHT,width=42,height=1,fg_bg=style.header}
+    local datetime = TextBox{parent=main,x=(header.get_width()-42),y=1,text="",alignment=ALIGN.RIGHT,width=42,height=1,fg_bg=style.header}
 
     datetime.register(facility.ps, "date_time", datetime.set_value)
 
@@ -261,7 +261,7 @@ local function init(main)
         if tank_defs[i] > 0 then
             local vy = 3 + y_ofs(i)
 
-            TextBox{parent=main,x=12,y=vy,text="\x10\x11",fg_bg=cpair(colors.black,colors.lightGray),width=2,height=1}
+            TextBox{parent=main,x=12,y=vy,text="\x10\x11",fg_bg=text_col,width=2,height=1}
 
             local conn = IndicatorLight{parent=main,x=9,y=vy+1,label=util.sprintf("PV%02d-EMC", i * 5),colors=style.ind_grn}
             local open = IndicatorLight{parent=main,x=9,y=vy+2,label="OPEN",colors=style.ind_wht}
@@ -288,8 +288,8 @@ local function init(main)
 
             local tank = Div{parent=main,x=3,y=7+y_offset,width=20,height=14}
 
-            TextBox{parent=tank,text=" ",height=1,x=1,y=1,fg_bg=cpair(colors.lightGray,colors.gray)}
-            TextBox{parent=tank,text="DYNAMIC TANK "..id,alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.wh_gray}
+            TextBox{parent=tank,text=" ",height=1,x=1,y=1,fg_bg=style.lg_gray}
+            TextBox{parent=tank,text="DYNAMIC TANK "..id,alignment=ALIGN.CENTER,height=1,fg_bg=style.wh_gray}
 
             local tank_box = Rectangle{parent=tank,border=border(1,colors.gray,true),width=20,height=12}
 
@@ -338,8 +338,8 @@ local function init(main)
 
     local sps = Div{parent=main,x=140,y=3,height=12}
 
-    TextBox{parent=sps,text=" ",width=24,height=1,x=1,y=1,fg_bg=cpair(colors.lightGray,colors.gray)}
-    TextBox{parent=sps,text="SPS",alignment=TEXT_ALIGN.CENTER,width=24,height=1,fg_bg=wh_gray}
+    TextBox{parent=sps,text=" ",width=24,height=1,x=1,y=1,fg_bg=style.lg_gray}
+    TextBox{parent=sps,text="SPS",alignment=ALIGN.CENTER,width=24,height=1,fg_bg=wh_gray}
 
     local sps_box = Rectangle{parent=sps,border=border(1,colors.gray,true),width=24,height=10}
 
@@ -361,8 +361,14 @@ local function init(main)
     -- statistics --
     ----------------
 
-    TextBox{parent=main,x=145,y=16,text="PROC. WASTE",alignment=TEXT_ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
-    local pr_waste  = Rectangle{parent=main,x=145,y=17,border=border(1,colors.gray,true),width=19,height=5,thin=true,fg_bg=bw_fg_bg}
+    TextBox{parent=main,x=145,y=16,text="RAW WASTE",alignment=ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
+    local raw_waste  = Rectangle{parent=main,x=145,y=17,border=border(1,colors.gray,true),width=19,height=3,thin=true,fg_bg=bw_fg_bg}
+    local sum_raw_waste = DataIndicator{parent=raw_waste,lu_colors=lu_col,label="SUM",unit="mB/t",format="%8.2f",value=0,width=17}
+
+    sum_raw_waste.register(facility.ps, "burn_sum", sum_raw_waste.update)
+
+    TextBox{parent=main,x=145,y=21,text="PROC. WASTE",alignment=ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
+    local pr_waste  = Rectangle{parent=main,x=145,y=22,border=border(1,colors.gray,true),width=19,height=5,thin=true,fg_bg=bw_fg_bg}
     local pu = DataIndicator{parent=pr_waste,lu_colors=lu_col,label="Pu",unit="mB/t",format="%9.3f",value=0,width=17}
     local po = DataIndicator{parent=pr_waste,lu_colors=lu_col,label="Po",unit="mB/t",format="%9.3f",value=0,width=17}
     local popl = DataIndicator{parent=pr_waste,lu_colors=lu_col,label="PoPl",unit="mB/t",format="%7.3f",value=0,width=17}
@@ -371,8 +377,8 @@ local function init(main)
     po.register(facility.ps, "po_rate", po.update)
     popl.register(facility.ps, "po_pl_rate", popl.update)
 
-    TextBox{parent=main,x=145,y=23,text="SPENT WASTE",alignment=TEXT_ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
-    local sp_waste  = Rectangle{parent=main,x=145,y=24,border=border(1,colors.gray,true),width=19,height=3,thin=true,fg_bg=bw_fg_bg}
+    TextBox{parent=main,x=145,y=28,text="SPENT WASTE",alignment=ALIGN.CENTER,width=19,height=1,fg_bg=wh_gray}
+    local sp_waste  = Rectangle{parent=main,x=145,y=29,border=border(1,colors.gray,true),width=19,height=3,thin=true,fg_bg=bw_fg_bg}
     local sum_sp_waste = DataIndicator{parent=sp_waste,lu_colors=lu_col,label="SUM",unit="mB/t",format="%8.3f",value=0,width=17}
 
     sum_sp_waste.register(facility.ps, "spent_waste_rate", sum_sp_waste.update)

coordinator/ui/layout/front_panel.lua

@@ -2,39 +2,41 @@
 -- Coordinator Front Panel GUI
 --
 
-local types         = require("scada-common.types")
-local util          = require("scada-common.util")
+local types     = require("scada-common.types")
+local util      = require("scada-common.util")
 
-local iocontrol     = require("coordinator.iocontrol")
+local iocontrol = require("coordinator.iocontrol")
 
-local pgi           = require("coordinator.ui.pgi")
-local style         = require("coordinator.ui.style")
+local pgi       = require("coordinator.ui.pgi")
+local style     = require("coordinator.ui.style")
 
-local pkt_entry     = require("coordinator.ui.components.pkt_entry")
+local pkt_entry = require("coordinator.ui.components.pkt_entry")
 
-local core          = require("graphics.core")
+local core      = require("graphics.core")
 
-local Div           = require("graphics.elements.div")
-local ListBox       = require("graphics.elements.listbox")
-local MultiPane     = require("graphics.elements.multipane")
-local TextBox       = require("graphics.elements.textbox")
+local Div       = require("graphics.elements.div")
+local ListBox   = require("graphics.elements.listbox")
+local MultiPane = require("graphics.elements.multipane")
+local TextBox   = require("graphics.elements.textbox")
 
-local TabBar        = require("graphics.elements.controls.tabbar")
+local TabBar    = require("graphics.elements.controls.tabbar")
 
-local LED           = require("graphics.elements.indicators.led")
-local RGBLED        = require("graphics.elements.indicators.ledrgb")
+local LED       = require("graphics.elements.indicators.led")
+local RGBLED    = require("graphics.elements.indicators.ledrgb")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 
+local led_grn = style.led_grn
+
 -- create new front panel view
 ---@param panel graphics_element main displaybox
 ---@param num_units integer number of units (number of unit monitors)
 local function init(panel, num_units)
     local ps = iocontrol.get_db().fp.ps
 
-    TextBox{parent=panel,y=1,text="SCADA COORDINATOR",alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.fp.header}
+    TextBox{parent=panel,y=1,text="SCADA COORDINATOR",alignment=ALIGN.CENTER,height=1,fg_bg=style.fp.header}
 
     local page_div = Div{parent=panel,x=1,y=3}
 
@@ -47,13 +49,13 @@ local function init(panel, num_units)
     local system = Div{parent=main_page,width=14,height=17,x=2,y=2}
 
     local status = LED{parent=system,label="STATUS",colors=cpair(colors.green,colors.red)}
-    local heartbeat = LED{parent=system,label="HEARTBEAT",colors=cpair(colors.green,colors.green_off)}
+    local heartbeat = LED{parent=system,label="HEARTBEAT",colors=led_grn}
     status.update(true)
     system.line_break()
 
     heartbeat.register(ps, "heartbeat", heartbeat.update)
 
-    local modem = LED{parent=system,label="MODEM",colors=cpair(colors.green,colors.green_off)}
+    local modem = LED{parent=system,label="MODEM",colors=led_grn}
     local network = RGBLED{parent=system,label="NETWORK",colors={colors.green,colors.red,colors.orange,colors.yellow,colors.gray}}
     network.update(types.PANEL_LINK_STATE.DISCONNECTED)
     system.line_break()
@@ -61,25 +63,25 @@ local function init(panel, num_units)
     modem.register(ps, "has_modem", modem.update)
     network.register(ps, "link_state", network.update)
 
-    local speaker = LED{parent=system,label="SPEAKER",colors=cpair(colors.green,colors.green_off)}
+    local speaker = LED{parent=system,label="SPEAKER",colors=led_grn}
     speaker.register(ps, "has_speaker", speaker.update)
 
 ---@diagnostic disable-next-line: undefined-field
     local comp_id = util.sprintf("(%d)", os.getComputerID())
-    TextBox{parent=system,x=9,y=4,width=6,height=1,text=comp_id,fg_bg=cpair(colors.lightGray,colors.ivory)}
+    TextBox{parent=system,x=9,y=4,width=6,height=1,text=comp_id,fg_bg=style.fp_label}
 
     local monitors = Div{parent=main_page,width=16,height=17,x=18,y=2}
 
-    local main_monitor = LED{parent=monitors,label="MAIN MONITOR",colors=cpair(colors.green,colors.green_off)}
+    local main_monitor = LED{parent=monitors,label="MAIN MONITOR",colors=led_grn}
     main_monitor.register(ps, "main_monitor", main_monitor.update)
 
-    local flow_monitor = LED{parent=monitors,label="FLOW MONITOR",colors=cpair(colors.green,colors.green_off)}
+    local flow_monitor = LED{parent=monitors,label="FLOW MONITOR",colors=led_grn}
     flow_monitor.register(ps, "flow_monitor", flow_monitor.update)
 
     monitors.line_break()
 
     for i = 1, num_units do
-        local unit_monitor = LED{parent=monitors,label="UNIT "..i.." MONITOR",colors=cpair(colors.green,colors.green_off)}
+        local unit_monitor = LED{parent=monitors,label="UNIT "..i.." MONITOR",colors=led_grn}
         unit_monitor.register(ps, "unit_monitor_" .. i, unit_monitor.update)
     end
 
@@ -87,9 +89,9 @@ local function init(panel, num_units)
     -- about footer
     --
 
-    local about   = Div{parent=main_page,width=15,height=3,x=1,y=16,fg_bg=cpair(colors.lightGray,colors.ivory)}
-    local fw_v    = TextBox{parent=about,x=1,y=1,text="FW: v00.00.00",alignment=TEXT_ALIGN.LEFT,height=1}
-    local comms_v = TextBox{parent=about,x=1,y=2,text="NT: v00.00.00",alignment=TEXT_ALIGN.LEFT,height=1}
+    local about   = Div{parent=main_page,width=15,height=3,x=1,y=16,fg_bg=style.fp_label}
+    local fw_v    = TextBox{parent=about,x=1,y=1,text="FW: v00.00.00",alignment=ALIGN.LEFT,height=1}
+    local comms_v = TextBox{parent=about,x=1,y=2,text="NT: v00.00.00",alignment=ALIGN.LEFT,height=1}
 
     fw_v.register(ps, "version", function (version) fw_v.set_value(util.c("FW: ", version)) end)
     comms_v.register(ps, "comms_version", function (version) comms_v.set_value(util.c("NT: v", version)) end)
@@ -101,7 +103,7 @@ local function init(panel, num_units)
     -- API page
 
     local api_page = Div{parent=page_div,x=1,y=1,hidden=true}
-    local api_list = ListBox{parent=api_page,x=1,y=1,height=17,width=51,scroll_height=1000,fg_bg=cpair(colors.black,colors.ivory),nav_fg_bg=cpair(colors.gray,colors.lightGray),nav_active=cpair(colors.black,colors.gray)}
+    local api_list = ListBox{parent=api_page,x=1,y=1,height=17,width=51,scroll_height=1000,fg_bg=style.fp_text,nav_fg_bg=cpair(colors.gray,colors.lightGray),nav_active=cpair(colors.black,colors.gray)}
     local _ = Div{parent=api_list,height=1,hidden=true} -- padding
 
     -- assemble page panes
@@ -111,11 +113,11 @@ local function init(panel, num_units)
     local page_pane = MultiPane{parent=page_div,x=1,y=1,panes=panes}
 
     local tabs = {
-        { name = "CRD", color = cpair(colors.black, colors.ivory) },
-        { name = "API", color = cpair(colors.black, colors.ivory) },
+        { name = "CRD", color = style.fp_text },
+        { name = "API", color = style.fp_text },
     }
 
-    TabBar{parent=panel,y=2,tabs=tabs,min_width=9,callback=page_pane.set_value,fg_bg=cpair(colors.black,colors.white)}
+    TabBar{parent=panel,y=2,tabs=tabs,min_width=9,callback=page_pane.set_value,fg_bg=style.bw_fg_bg}
 
     -- link pocket API list management to PGI
     pgi.link_elements(api_list, pkt_entry)

coordinator/ui/layout/main_view.lua

@@ -2,8 +2,6 @@
 -- Main SCADA Coordinator GUI
 --
 
-local util          = require("scada-common.util")
-
 local iocontrol     = require("coordinator.iocontrol")
 
 local style         = require("coordinator.ui.style")
@@ -18,9 +16,7 @@ local TextBox       = require("graphics.elements.textbox")
 
 local DataIndicator = require("graphics.elements.indicators.data")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
-
-local cpair = core.cpair
+local ALIGN = core.ALIGN
 
 -- create new main view
 ---@param main graphics_element main displaybox
@@ -29,10 +25,10 @@ local function init(main)
     local units = iocontrol.get_db().units
 
     -- 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}
+    local header = TextBox{parent=main,y=1,text="Nuclear Generation Facility SCADA Coordinator",alignment=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=style.lg_white,width=12,fg_bg=style.header}
     -- max length example: "01:23:45 AM - Wednesday, September 28 2022"
-    local datetime = TextBox{parent=main,x=(header.get_width()-42),y=1,text="",alignment=TEXT_ALIGN.RIGHT,width=42,height=1,fg_bg=style.header}
+    local datetime = TextBox{parent=main,x=(header.get_width()-42),y=1,text="",alignment=ALIGN.RIGHT,width=42,height=1,fg_bg=style.header}
 
     ping.register(facility.ps, "sv_ping", ping.update)
     datetime.register(facility.ps, "date_time", datetime.set_value)
@@ -77,7 +73,7 @@ local function init(main)
 
     assert(cnc_bottom_align_start >= cnc_y_start, "main display not of sufficient vertical resolution (add an additional row of monitors)")
 
-    TextBox{parent=main,y=cnc_bottom_align_start,text=util.strrep("\x8c", header.get_width()),alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=cpair(colors.lightGray,colors.gray)}
+    TextBox{parent=main,y=cnc_bottom_align_start,text=string.rep("\x8c", header.get_width()),alignment=ALIGN.CENTER,height=1,fg_bg=style.lg_gray}
 
     cnc_bottom_align_start = cnc_bottom_align_start + 2
 

coordinator/ui/style.lua

@@ -78,11 +78,19 @@ style.lu_colors = cpair(colors.gray, colors.gray)
 style.hzd_fg_bg  = style.wh_gray
 style.dis_colors = cpair(colors.white, colors.lightGray)
 
+style.lg_gray = cpair(colors.lightGray, colors.gray)
+style.lg_white = cpair(colors.lightGray, colors.white)
+style.gray_white = cpair(colors.gray, colors.white)
+
 style.ind_grn = cpair(colors.green, colors.gray)
 style.ind_yel = cpair(colors.yellow, colors.gray)
 style.ind_red = cpair(colors.red, colors.gray)
 style.ind_wht = style.wh_gray
 
+style.fp_text = cpair(colors.black, colors.ivory)
+style.fp_label = cpair(colors.lightGray, colors.ivory)
+style.led_grn = cpair(colors.green, colors.green_off)
+
 -- UI COMPONENTS --
 
 style.reactor = {

graphics/core.lua

@@ -7,19 +7,15 @@ local flasher = require("graphics.flasher")
 
 local core = {}
 
-core.version = "1.1.1"
+core.version = "2.1.1"
 
 core.flasher = flasher
 core.events = events
 
 -- Core Types
 
----@enum TEXT_ALIGN
-core.TEXT_ALIGN = {
-    LEFT = 1,
-    CENTER = 2,
-    RIGHT = 3
-}
+---@enum ALIGN
+core.ALIGN = { LEFT = 1, CENTER = 2, RIGHT = 3 }
 
 ---@class graphics_border
 ---@field width integer
@@ -35,11 +31,7 @@ core.TEXT_ALIGN = {
 ---@param even? boolean whether to pad width extra to account for rectangular pixels, defaults to false
 ---@return graphics_border
 function core.border(width, color, even)
-    return {
-        width = width,
-        color = color,
-        even = even or false    -- convert nil to false
-    }
+    return { width = width, color = color, even = even or false }
 end
 
 ---@class graphics_frame
@@ -56,12 +48,7 @@ end
 ---@param h integer
 ---@return graphics_frame
 function core.gframe(x, y, w, h)
-    return {
-        x = x,
-        y = y,
-        w = w,
-        h = h
-    }
+    return { x = x, y = y, w = w, h = h }
 end
 
 ---@class cpair
@@ -82,15 +69,9 @@ end
 function core.cpair(a, b)
     return {
         -- color pairs
-        color_a = a,
-        color_b = b,
-        blit_a = colors.toBlit(a),
-        blit_b = colors.toBlit(b),
+        color_a = a, color_b = b, blit_a = colors.toBlit(a), blit_b = colors.toBlit(b),
         -- aliases
-        fgd = a,
-        bkg = b,
-        blit_fgd = colors.toBlit(a),
-        blit_bkg = colors.toBlit(b)
+        fgd = a, bkg = b, blit_fgd = colors.toBlit(a), blit_bkg = colors.toBlit(b)
     }
 end
 
@@ -130,4 +111,215 @@ function core.pipe(x1, y1, x2, y2, color, thin, align_tr)
     }
 end
 
+-- Assertion Handling
+
+-- extract the custom element assert message, dropping the path to the element file
+function core.extract_assert_msg(msg)
+    return string.sub(msg, (string.find(msg, "@") or 0) + 1)
+end
+
+-- Interactive Field Manager
+
+---@param e graphics_base
+---@param max_len any
+---@param fg_bg any
+---@param dis_fg_bg any
+function core.new_ifield(e, max_len, fg_bg, dis_fg_bg)
+    local self = {
+        frame_start = 1,
+        visible_text = e.value,
+        cursor_pos = string.len(e.value) + 1,
+        selected_all = false
+    }
+
+    -- update visible text
+    local function _update_visible()
+        self.visible_text = string.sub(e.value, self.frame_start, self.frame_start + math.min(string.len(e.value), e.frame.w) - 1)
+    end
+
+    -- try shifting frame left
+    local function _try_lshift()
+        if self.frame_start > 1 then
+            self.frame_start = self.frame_start - 1
+            return true
+        end
+    end
+
+    -- try shifting frame right
+    local function _try_rshift()
+        if (self.frame_start + e.frame.w - 1) <= string.len(e.value) then
+            self.frame_start = self.frame_start + 1
+            return true
+        end
+    end
+
+    ---@class ifield
+    local public = {}
+
+    -- censor the display (for private info, for example) with the provided character<br>
+    -- disable by passing no argument
+    ---@param censor string? character to hide data with
+    function public.censor(censor)
+        if type(censor) == "string" and string.len(censor) == 1 then
+            self.censor = censor
+        else self.censor = nil end
+        public.show()
+    end
+
+    -- show the field
+    function public.show()
+        _update_visible()
+
+        if e.enabled then
+            e.w_set_bkg(fg_bg.bkg)
+            e.w_set_fgd(fg_bg.fgd)
+        elseif dis_fg_bg ~= nil then
+            e.w_set_bkg(dis_fg_bg.bkg)
+            e.w_set_fgd(dis_fg_bg.fgd)
+        end
+
+        -- clear and print
+        e.w_set_cur(1, 1)
+        e.w_write(string.rep(" ", e.frame.w))
+        e.w_set_cur(1, 1)
+
+        local function _write()
+            if self.censor then
+                e.w_write(string.rep(self.censor, string.len(self.visible_text)))
+            else
+                e.w_write(self.visible_text)
+            end
+        end
+
+        if e.is_focused() and e.enabled then
+            -- write text with cursor
+            if self.selected_all then
+                e.w_set_bkg(fg_bg.fgd)
+                e.w_set_fgd(fg_bg.bkg)
+                _write()
+            elseif self.cursor_pos >= (string.len(self.visible_text) + 1) then
+                -- write text with cursor at the end, no need to blit
+                _write()
+                e.w_set_fgd(colors.lightGray)
+                e.w_write("_")
+            else
+                local a, b = "", ""
+
+                if self.cursor_pos <= string.len(self.visible_text) then
+                    a = fg_bg.blit_bkg
+                    b = fg_bg.blit_fgd
+                end
+
+                local b_fgd = string.rep(fg_bg.blit_fgd, self.cursor_pos - 1) .. a .. string.rep(fg_bg.blit_fgd, string.len(self.visible_text) - self.cursor_pos)
+                local b_bkg = string.rep(fg_bg.blit_bkg, self.cursor_pos - 1) .. b .. string.rep(fg_bg.blit_bkg, string.len(self.visible_text) - self.cursor_pos)
+
+                if self.censor then
+                    e.w_blit(string.rep(self.censor, string.len(self.visible_text)), b_fgd, b_bkg)
+                else
+                    e.w_blit(self.visible_text, b_fgd, b_bkg)
+                end
+            end
+        else
+            self.selected_all = false
+
+            -- write text without cursor
+            _write()
+        end
+    end
+
+    -- move cursor to x
+    ---@param x integer
+    function public.move_cursor(x)
+        self.selected_all = false
+        self.cursor_pos = math.min(x, string.len(self.visible_text) + 1)
+        public.show()
+    end
+
+    -- select all text
+    function public.select_all()
+        self.selected_all = true
+        public.show()
+    end
+
+    -- set field value
+    ---@param val string
+    function public.set_value(val)
+        e.value = string.sub(val, 1, math.min(max_len, string.len(val)))
+        public.nav_end()
+    end
+
+    -- try to insert a character if there is space
+    ---@param char string
+    function public.try_insert_char(char)
+        -- limit length
+        if string.len(e.value) >= max_len then return end
+
+        -- replace if selected all, insert otherwise
+        if self.selected_all then
+            self.selected_all = false
+            self.cursor_pos = 2
+            self.frame_start = 1
+
+            e.value = char
+            public.show()
+        else
+            e.value = string.sub(e.value, 1, self.frame_start + self.cursor_pos - 2) .. char .. string.sub(e.value, self.frame_start + self.cursor_pos - 1, string.len(e.value))
+            _update_visible()
+            public.nav_right()
+        end
+    end
+
+    -- remove charcter before cursor if there is anything to remove, or delete all if selected all
+    function public.backspace()
+        if self.selected_all then
+            self.selected_all = false
+            e.value = ""
+            self.cursor_pos = 1
+            self.frame_start = 1
+            public.show()
+        else
+            if self.frame_start + self.cursor_pos > 2 then
+                e.value = string.sub(e.value, 1, self.frame_start + self.cursor_pos - 3) .. string.sub(e.value, self.frame_start + self.cursor_pos - 1, string.len(e.value))
+                if self.cursor_pos > 1 then
+                    self.cursor_pos = self.cursor_pos - 1
+                    public.show()
+                elseif _try_lshift() then public.show() end
+            end
+        end
+    end
+
+    -- move cursor left by one
+    function public.nav_left()
+        if self.cursor_pos > 1 then
+            self.cursor_pos = self.cursor_pos - 1
+            public.show()
+        elseif _try_lshift() then public.show() end
+    end
+
+    -- move cursor right by one
+    function public.nav_right()
+        if self.cursor_pos < math.min(string.len(self.visible_text) + 1, e.frame.w) then
+            self.cursor_pos = self.cursor_pos + 1
+            public.show()
+        elseif _try_rshift() then public.show() end
+    end
+
+    -- move cursor to the start
+    function public.nav_start()
+        self.cursor_pos = 1
+        self.frame_start = 1
+        public.show()
+    end
+
+    -- move cursor to the end
+    function public.nav_end()
+        self.frame_start = math.max(1, string.len(e.value) - e.frame.w + 2)
+        _update_visible()
+        self.cursor_pos = string.len(self.visible_text) + 1
+        public.show()
+    end
+
+    return public
+end
+
 return core

graphics/element.lua

@@ -2,8 +2,12 @@
 -- Generic Graphics Element
 --
 
+local util = require("scada-common.util")
+
 local core = require("graphics.core")
 
+local events = core.events
+
 local element = {}
 
 ---@class graphics_args_generic
@@ -17,6 +21,7 @@ local element = {}
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
 ---@field hidden? boolean true to hide on initial draw
+---@field can_focus? boolean true if this element can be focused, false by default
 
 ---@alias graphics_args graphics_args_generic
 ---|waiting_args
@@ -25,11 +30,14 @@ local element = {}
 ---|hazard_button_args
 ---|multi_button_args
 ---|push_button_args
+---|radio_2d_args
 ---|radio_button_args
 ---|sidebar_args
 ---|spinbox_args
 ---|switch_button_args
 ---|tabbar_args
+---|number_field_args
+---|text_field_args
 ---|alarm_indicator_light
 ---|core_map_args
 ---|data_indicator_args
@@ -59,6 +67,16 @@ local element = {}
 ---@field key string data key
 ---@field func function callback
 
+-- more detailed assert message for element verification
+---@param condition any assert condition
+---@param msg string assert message
+---@param callstack_offset? integer shift value to change targets of debug.getinfo()
+function element.assert(condition, msg, callstack_offset)
+    callstack_offset = callstack_offset or 0
+    local caller = debug.getinfo(3 + callstack_offset)
+    assert(condition, util.c(caller.source, ":", caller.currentline, "{", debug.getinfo(2 + callstack_offset).name, "}: ", msg))
+end
+
 -- a base graphics element, should not be created on its own
 ---@nodiscard
 ---@param args graphics_args arguments
@@ -67,14 +85,19 @@ local element = {}
 function element.new(args, child_offset_x, child_offset_y)
     local self = {
         id = nil,                                       ---@type element_id|nil
+        is_root = args.parent == nil,
         elem_type = debug.getinfo(2).name,
         define_completed = false,
         p_window = nil,                                 ---@type table
-        position = { x = 1, y = 1 },                    ---@type coordinate_2d
+        position = events.new_coord_2d(1, 1),
         bounds = { x1 = 1, y1 = 1, x2 = 1, y2 = 1 },    ---@class element_bounds
+        offset_x = 0,
+        offset_y = 0,
         next_y = 1,                                     -- next child y coordinate
         next_id = 0,                                    -- next child ID
         subscriptions = {},
+        button_down = { events.new_coord_2d(-1, -1), events.new_coord_2d(-1, -1), events.new_coord_2d(-1, -1) },
+        focused = false,
         mt = {}
     }
 
@@ -84,16 +107,16 @@ function element.new(args, child_offset_x, child_offset_y)
         value = nil,            ---@type any
         window = nil,           ---@type table
         content_window = nil,   ---@type table|nil
+        mouse_window_shift = { x = 0, y = 0 },
         fg_bg = core.cpair(colors.white, colors.black),
         frame = core.gframe(1, 1, 1, 1),
-        children = {}
+        children = {},
+        child_id_map = {}
     }
 
-    local name_brief = "graphics.element{" .. self.elem_type .. "}: "
-
     -- element as string
     function self.mt.__tostring()
-        return "graphics.element{" .. self.elem_type .. "} @ " .. tostring(self)
+        return util.c("graphics.element{", self.elem_type, "} @ ", self)
     end
 
     ---@class graphics_element
@@ -101,6 +124,69 @@ function element.new(args, child_offset_x, child_offset_y)
 
     setmetatable(public, self.mt)
 
+    -----------------------
+    -- PRIVATE FUNCTIONS --
+    -----------------------
+
+    -- use tab to jump to the next focusable field
+    ---@param reverse boolean
+    local function _tab_focusable(reverse)
+        local first_f = nil ---@type graphics_element|nil
+        local prev_f = nil  ---@type graphics_element|nil
+        local cur_f = nil   ---@type graphics_element|nil
+        local done = false
+
+        ---@param elem graphics_element
+        local function handle_element(elem)
+            if elem.is_visible() and elem.is_focusable() and elem.is_enabled() then
+                if first_f == nil then first_f = elem end
+
+                if cur_f == nil then
+                    if elem.is_focused() then
+                        cur_f = elem
+                        if (not done) and (reverse and prev_f ~= nil) then
+                            cur_f.unfocus()
+                            prev_f.focus()
+                            done = true
+                        end
+                    end
+                else
+                    if elem.is_focused() then
+                        elem.unfocus()
+                    elseif not (reverse or done) then
+                        cur_f.unfocus()
+                        elem.focus()
+                        done = true
+                    end
+                end
+
+                prev_f = elem
+            end
+        end
+
+        ---@param children table
+        local function traverse(children)
+            for i = 1, #children do
+                local child = children[i]   ---@type graphics_base
+                handle_element(child.get())
+                if child.get().is_visible() then traverse(child.children) end
+            end
+        end
+
+        traverse(protected.children)
+
+        -- if no element was focused, wrap focus
+        if first_f ~= nil and not done then
+            if reverse then
+                if cur_f ~= nil then cur_f.unfocus() end
+                if prev_f ~= nil then prev_f.focus() end
+            else
+                if cur_f ~= nil then cur_f.unfocus() end
+                first_f.focus()
+            end
+        end
+    end
+
     -------------------------
     -- PROTECTED FUNCTIONS --
     -------------------------
@@ -110,6 +196,10 @@ function element.new(args, child_offset_x, child_offset_y)
     ---@param offset_y integer y offset for mouse events
     ---@param next_y integer next line if no y was provided
     function protected.prepare_template(offset_x, offset_y, next_y)
+        -- record offsets in case there is a reposition
+        self.offset_x = offset_x
+        self.offset_y = offset_y
+
         -- get frame coordinates/size
         if args.gframe ~= nil then
             protected.frame.x = args.gframe.x
@@ -134,10 +224,10 @@ function element.new(args, child_offset_x, child_offset_y)
         end
 
         -- check frame
-        assert(f.x >= 1, name_brief .. "frame x not >= 1")
-        assert(f.y >= 1, name_brief .. "frame y not >= 1")
-        assert(f.w >= 1, name_brief .. "frame width not >= 1")
-        assert(f.h >= 1, name_brief .. "frame height not >= 1")
+        element.assert(f.x >= 1, "frame x not >= 1", 3)
+        element.assert(f.y >= 1, "frame y not >= 1", 3)
+        element.assert(f.w >= 1, "frame width not >= 1", 3)
+        element.assert(f.h >= 1, "frame height not >= 1", 3)
 
         -- create window
         protected.window = window.create(self.p_window, f.x, f.y, f.w, f.h, args.hidden ~= true)
@@ -166,6 +256,31 @@ function element.new(args, child_offset_x, child_offset_y)
         self.bounds.x2 = self.position.x + f.w - 1
         self.bounds.y1 = self.position.y
         self.bounds.y2 = self.position.y + f.h - 1
+
+        -- alias functions
+
+        -- window set cursor position
+        ---@param x integer
+        ---@param y integer
+        function protected.w_set_cur(x, y) protected.window.setCursorPos(x, y) end
+
+        -- set background color
+        ---@param c color
+        function protected.w_set_bkg(c) protected.window.setBackgroundColor(c) end
+
+        -- set foreground (text) color
+        ---@param c color
+        function protected.w_set_fgd(c) protected.window.setTextColor(c) end
+
+        -- write text
+        ---@param str string
+        function protected.w_write(str) protected.window.write(str) end
+
+        -- blit text
+        ---@param str string
+        ---@param fg string
+        ---@param bg string
+        function protected.w_blit(str, fg, bg) protected.window.blit(str, fg, bg) end
     end
 
     -- check if a coordinate relative to the parent is within the bounds of this element
@@ -186,85 +301,6 @@ function element.new(args, child_offset_x, child_offset_y)
         return in_x and in_y
     end
 
--- luacheck: push ignore
----@diagnostic disable: unused-local, unused-vararg
-
-    -- handle a child element having been added
-    ---@param id element_id element identifier
-    ---@param child graphics_element child element
-    function protected.on_added(id, child)
-    end
-
-    -- handle a child element having been removed
-    ---@param id element_id element identifier
-    function protected.on_removed(id)
-    end
-
-    -- handle a mouse event
-    ---@param event mouse_interaction mouse interaction event
-    function protected.handle_mouse(event)
-    end
-
-    -- handle data value changes
-    ---@vararg any value(s)
-    function protected.on_update(...)
-    end
-
-    -- callback on control press responses
-    ---@param result any
-    function protected.response_callback(result)
-    end
-
-    -- get value
-    ---@nodiscard
-    function protected.get_value()
-        return protected.value
-    end
-
-    -- set value
-    ---@param value any value to set
-    function protected.set_value(value)
-    end
-
-    -- set minimum input value
-    ---@param min integer minimum allowed value
-    function protected.set_min(min)
-    end
-
-    -- set maximum input value
-    ---@param max integer maximum allowed value
-    function protected.set_max(max)
-    end
-
-    -- enable the control
-    function protected.enable()
-    end
-
-    -- disable the control
-    function protected.disable()
-    end
-
-    -- custom recolor command, varies by element if implemented
-    ---@vararg cpair|color color(s)
-    function protected.recolor(...)
-    end
-
-    -- custom resize command, varies by element if implemented
-    ---@vararg integer sizing
-    function protected.resize(...)
-    end
-
--- luacheck: pop
----@diagnostic enable: unused-local, unused-vararg
-
-    -- start animations
-    function protected.start_anim()
-    end
-
-    -- stop animations
-    function protected.stop_anim()
-    end
-
     -- get public interface
     ---@nodiscard
     ---@return graphics_element element, element_id id
@@ -278,6 +314,111 @@ function element.new(args, child_offset_x, child_offset_y)
         return public, self.id
     end
 
+    -- protected version of public is_focused()
+    ---@nodiscard
+    ---@return boolean is_focused
+    function protected.is_focused() return self.focused end
+
+    -- defocus this element
+    function protected.defocus() public.unfocus_all() end
+
+    -- focus this element and take away focus from all other elements
+    function protected.take_focus() args.parent.__focus_child(public) end
+
+    -- action handlers --
+
+-- luacheck: push ignore
+---@diagnostic disable: unused-local, unused-vararg
+
+    -- handle a child element having been added
+    ---@param id element_id element identifier
+    ---@param child graphics_element child element
+    function protected.on_added(id, child) end
+
+    -- handle a child element having been removed
+    ---@param id element_id element identifier
+    function protected.on_removed(id) end
+
+    -- handle enabled
+    function protected.on_enabled() end
+
+    -- handle disabled
+    function protected.on_disabled() end
+
+    -- handle this element having been focused
+    function protected.on_focused() end
+
+    -- handle this element having been unfocused
+    function protected.on_unfocused() end
+
+    -- handle this element having had a child focused
+    ---@param child graphics_element
+    function protected.on_child_focused(child) end
+
+    -- handle this element having been shown
+    function protected.on_shown() end
+
+    -- handle this element having been hidden
+    function protected.on_hidden() end
+
+    -- handle a mouse event
+    ---@param event mouse_interaction mouse interaction event
+    function protected.handle_mouse(event) end
+
+    -- handle a keyboard event
+    ---@param event key_interaction key interaction event
+    function protected.handle_key(event) end
+
+    -- handle a paste event
+    ---@param text string pasted text
+    function protected.handle_paste(text) end
+
+    -- handle data value changes
+    ---@vararg any value(s)
+    function protected.on_update(...) end
+
+    -- callback on control press responses
+    ---@param result any
+    function protected.response_callback(result) end
+
+    -- accessors and control --
+
+    -- get value
+    ---@nodiscard
+    function protected.get_value() return protected.value end
+
+    -- set value
+    ---@param value any value to set
+    function protected.set_value(value) end
+
+    -- set minimum input value
+    ---@param min integer minimum allowed value
+    function protected.set_min(min) end
+
+    -- set maximum input value
+    ---@param max integer maximum allowed value
+    function protected.set_max(max) end
+
+    -- custom recolor command, varies by element if implemented
+    ---@vararg cpair|color color(s)
+    function protected.recolor(...) end
+
+    -- custom resize command, varies by element if implemented
+    ---@vararg integer sizing
+    function protected.resize(...) end
+
+-- luacheck: pop
+---@diagnostic enable: unused-local, unused-vararg
+
+    -- re-draw this element
+    function protected.redraw() end
+
+    -- start animations
+    function protected.start_anim() end
+
+    -- stop animations
+    function protected.stop_anim() end
+
     -----------
     -- SETUP --
     -----------
@@ -289,7 +430,7 @@ function element.new(args, child_offset_x, child_offset_y)
     end
 
     -- check window
-    assert(self.p_window, name_brief .. "no parent window provided")
+    element.assert(self.p_window, "no parent window provided", 1)
 
     -- prepare the template
     if args.parent == nil then
@@ -330,7 +471,7 @@ function element.new(args, child_offset_x, child_offset_y)
 
         -- delete all children
         for k, v in pairs(protected.children) do
-            v.delete()
+            v.get().delete()
             protected.children[k] = nil
         end
 
@@ -352,65 +493,94 @@ function element.new(args, child_offset_x, child_offset_y)
 
         self.next_y = child.frame.y + child.frame.h
 
-        local child_element = child.get()
-
         local id = key  ---@type string|integer|nil
         if id == nil then
             id = self.next_id
             self.next_id = self.next_id + 1
         end
 
-        protected.children[id] = child_element
+        table.insert(protected.children, child)
+
+        protected.child_id_map[id] = #protected.children
+
         return id
     end
 
     -- remove a child element
-    ---@param key element_id id
-    function public.__remove_child(key)
-        if protected.children[key] ~= nil then
-            protected.on_removed(key)
-            protected.children[key] = nil
+    ---@param id element_id id
+    function public.__remove_child(id)
+        local index = protected.child_id_map[id]
+        if protected.children[index] ~= nil then
+            protected.on_removed(id)
+            protected.children[index] = nil
+            protected.child_id_map[id] = nil
         end
     end
 
     -- actions to take upon a child element becoming ready (initial draw/construction completed)
     ---@param key element_id id
     ---@param child graphics_element
-    function public.__child_ready(key, child)
-        protected.on_added(key, child)
+    function public.__child_ready(key, child) protected.on_added(key, child) end
+
+    -- focus solely on this child
+    ---@param child graphics_element
+    function public.__focus_child(child)
+        if self.is_root then
+            public.unfocus_all()
+            child.focus()
+        else args.parent.__focus_child(child) end
+    end
+
+    -- a child was focused, used to make sure it is actually visible to the user in the content frame
+    ---@param child graphics_element
+    function public.__child_focused(child)
+        protected.on_child_focused(child)
+        if not self.is_root then args.parent.__child_focused(public) end
     end
 
     -- get a child element
     ---@nodiscard
     ---@param id element_id
     ---@return graphics_element
-    function public.get_child(id) return protected.children[id] end
+    function public.get_child(id) return protected.children[protected.child_id_map[id]].get() end
 
     -- remove a child element
     ---@param id element_id
     function public.remove(id)
-        if protected.children[id] ~= nil then
-            protected.children[id].delete()
+        local index = protected.child_id_map[id]
+        if protected.children[index] ~= nil then
+            protected.children[index].get().delete()
             protected.on_removed(id)
-            protected.children[id] = nil
+            protected.children[index] = nil
+            protected.child_id_map[id] = nil
         end
     end
 
+    -- remove all child elements and reset next y
+    function public.remove_all()
+        for i = 1, #protected.children do
+            local child = protected.children[i].get()   ---@type graphics_element
+            child.delete()
+            protected.on_removed(child.get_id())
+        end
+
+        self.next_y = 1
+        protected.children = {}
+        protected.child_id_map = {}
+    end
+
     -- attempt to get a child element by ID (does not include this element itself)
     ---@nodiscard
     ---@param id element_id
     ---@return graphics_element|nil element
     function public.get_element_by_id(id)
-        if protected.children[id] == nil then
+        local index = protected.child_id_map[id]
+        if protected.children[index] == nil then
             for _, child in pairs(protected.children) do
-                local elem = child.get_element_by_id(id)
+                local elem = child.get().get_element_by_id(id)
                 if elem ~= nil then return elem end
             end
-        else
-            return protected.children[id]
-        end
-
-        return nil
+        else return protected.children[index].get() end
     end
 
     -- AUTO-PLACEMENT --
@@ -422,89 +592,109 @@ function element.new(args, child_offset_x, child_offset_y)
 
     -- PROPERTIES --
 
-    -- get the foreground/background colors
+    -- get element id
     ---@nodiscard
-    ---@return cpair fg_bg
-    function public.get_fg_bg()
-        return protected.fg_bg
-    end
+    ---@return element_id
+    function public.get_id() return self.id end
 
     -- get element x
     ---@nodiscard
     ---@return integer x
-    function public.get_x()
-        return protected.frame.x
-    end
+    function public.get_x() return protected.frame.x end
 
     -- get element y
     ---@nodiscard
     ---@return integer y
-    function public.get_y()
-        return protected.frame.y
-    end
+    function public.get_y() return protected.frame.y end
 
     -- get element width
     ---@nodiscard
     ---@return integer width
-    function public.get_width()
-        return protected.frame.w
-    end
+    function public.get_width() return protected.frame.w end
 
     -- get element height
     ---@nodiscard
     ---@return integer height
-    function public.get_height()
-        return protected.frame.h
-    end
+    function public.get_height() return protected.frame.h end
+
+    -- get the foreground/background colors
+    ---@nodiscard
+    ---@return cpair fg_bg
+    function public.get_fg_bg() return protected.fg_bg end
 
     -- get the element value
     ---@nodiscard
     ---@return any value
-    function public.get_value()
-        return protected.get_value()
-    end
+    function public.get_value() return protected.get_value() end
 
     -- set the element value
     ---@param value any new value
-    function public.set_value(value)
-        protected.set_value(value)
-    end
+    function public.set_value(value) protected.set_value(value) end
 
     -- set minimum input value
     ---@param min integer minimum allowed value
-    function public.set_min(min)
-        protected.set_min(min)
-    end
+    function public.set_min(min) protected.set_min(min) end
 
     -- set maximum input value
     ---@param max integer maximum allowed value
-    function public.set_max(max)
-        protected.set_max(max)
-    end
+    function public.set_max(max) protected.set_max(max) end
+
+    -- check if this element is enabled
+    function public.is_enabled() return protected.enabled end
 
     -- enable the element
     function public.enable()
-        protected.enabled = true
-        protected.enable()
+        if not protected.enabled then
+            protected.enabled = true
+            protected.on_enabled()
+        end
     end
 
     -- disable the element
     function public.disable()
-        protected.enabled = false
-        protected.disable()
+        if protected.enabled then
+            protected.enabled = false
+            protected.on_disabled()
+            public.unfocus_all()
+        end
+    end
+
+    -- can this element be focused
+    function public.is_focusable() return args.can_focus end
+
+    -- is this element focused
+    function public.is_focused() return self.focused end
+
+    -- focus the element
+    function public.focus()
+        if args.can_focus and protected.enabled and not self.focused then
+            self.focused = true
+            protected.on_focused()
+            if not self.is_root then args.parent.__child_focused(public) end
+        end
+    end
+
+    -- unfocus this element
+    function public.unfocus()
+        if args.can_focus and self.focused then
+            self.focused = false
+            protected.on_unfocused()
+        end
+    end
+
+    -- unfocus this element and all its children
+    function public.unfocus_all()
+        public.unfocus()
+        for _, child in pairs(protected.children) do child.get().unfocus_all() end
     end
 
     -- custom recolor command, varies by element if implemented
     ---@vararg cpair|color color(s)
-    function public.recolor(...)
-        protected.recolor(...)
-    end
+    function public.recolor(...) protected.recolor(...) end
 
     -- resize attributes of the element value if supported
     ---@vararg number dimensions (element specific)
-    function public.resize(...)
-        protected.resize(...)
-    end
+    function public.resize(...) protected.resize(...) end
 
     -- reposition the element window<br>
     -- offsets relative to parent frame are where (1, 1) would be on top of the parent's top left corner
@@ -512,6 +702,19 @@ function element.new(args, child_offset_x, child_offset_y)
     ---@param y integer y position relative to parent frame
     function public.reposition(x, y)
         protected.window.reposition(x, y)
+
+        -- record position
+        self.position.x, self.position.y = protected.window.getPosition()
+
+        -- shift per parent child offset
+        self.position.x = self.position.x + self.offset_x
+        self.position.y = self.position.y + self.offset_y
+
+        -- calculate mouse event bounds
+        self.bounds.x1 = self.position.x
+        self.bounds.x2 = self.position.x + protected.frame.w - 1
+        self.bounds.y1 = self.position.y
+        self.bounds.y2 = self.position.y + protected.frame.h - 1
     end
 
     -- FUNCTION CALLBACKS --
@@ -525,26 +728,63 @@ function element.new(args, child_offset_x, child_offset_y)
             local ini_in = protected.in_window_bounds(x_ini, y_ini)
 
             if ini_in then
-                local event_T = core.events.mouse_transposed(event, self.position.x, self.position.y)
+                if event.type == events.MOUSE_CLICK.UP or event.type == events.MOUSE_CLICK.DRAG then
+                    -- make sure we don't handle mouse events that started before this element was made visible
+                    if (event.initial.x ~= self.button_down[event.button].x) or (event.initial.y ~= self.button_down[event.button].y) then
+                        return
+                    end
+                elseif event.type == events.MOUSE_CLICK.DOWN then
+                    self.button_down[event.button] = event.initial
+                end
 
-                -- handle the mouse event then pass to children
+                local event_T = events.mouse_transposed(event, self.position.x, self.position.y)
                 protected.handle_mouse(event_T)
-                for _, child in pairs(protected.children) do child.handle_mouse(event_T) end
+
+                -- shift child event if the content window has moved then pass to children
+                local c_event_T = events.mouse_transposed(event_T, protected.mouse_window_shift.x + 1, protected.mouse_window_shift.y + 1)
+                for _, child in pairs(protected.children) do child.get().handle_mouse(c_event_T) end
+            elseif event.type == events.MOUSE_CLICK.DOWN or event.type == events.MOUSE_CLICK.TAP then
+                -- clicked out, unfocus this element and children
+                public.unfocus_all()
             end
+        else
+            -- don't track clicks while hidden
+            self.button_down[event.button] = events.new_coord_2d(-1, -1)
+        end
+    end
+
+    -- handle a keyboard click if this element is visible and focused
+    ---@param event key_interaction keyboard interaction event
+    function public.handle_key(event)
+        if protected.window.isVisible() then
+            if self.is_root and (event.type == events.KEY_CLICK.DOWN) and (event.key == keys.tab) then
+                -- try to jump to the next/previous focusable field
+                _tab_focusable(event.shift)
+            else
+                -- handle the key event then pass to children
+                if self.focused then protected.handle_key(event) end
+                for _, child in pairs(protected.children) do child.get().handle_key(event) end
+            end
+        end
+    end
+
+    -- handle text paste
+    ---@param text string pasted text
+    function public.handle_paste(text)
+        if protected.window.isVisible() then
+            -- handle the paste event then pass to children
+            if self.focused then protected.handle_paste(text) end
+            for _, child in pairs(protected.children) do child.get().handle_paste(text) end
         end
     end
 
     -- draw the element given new data
     ---@vararg any new data
-    function public.update(...)
-        protected.on_update(...)
-    end
+    function public.update(...) protected.on_update(...) end
 
     -- on a control request response
     ---@param result any
-    function public.on_response(result)
-        protected.response_callback(result)
-    end
+    function public.on_response(result) protected.response_callback(result) end
 
     -- register a callback with a PSIL, allowing for automatic unregister on delete<br>
     -- do not use graphics elements directly with PSIL subscribe()
@@ -558,6 +798,9 @@ function element.new(args, child_offset_x, child_offset_y)
 
     -- VISIBILITY & ANIMATIONS --
 
+    -- check if this element is visible
+    function public.is_visible() return protected.window.isVisible() end
+
     -- show the element and enables animations by default
     ---@param animate? boolean true (default) to automatically resume animations
     function public.show(animate)
@@ -567,47 +810,54 @@ function element.new(args, child_offset_x, child_offset_y)
 
     -- hide the element and disables animations<br>
     -- this alone does not cause an element to be fully hidden, it only prevents updates from being shown<br>
+    ---@see graphics_element.redraw
     ---@see graphics_element.content_redraw
-    function public.hide()
+    ---@param clear? boolean true to visibly hide this element (redraws the parent)
+    function public.hide(clear)
         public.freeze_all() -- stop animations for efficiency/performance
+        public.unfocus_all()
         protected.window.setVisible(false)
+        if clear and args.parent then args.parent.redraw() end
     end
 
     -- start/resume animation(s)
-    function public.animate()
-        protected.start_anim()
-    end
+    function public.animate() protected.start_anim() end
 
     -- start/resume animation(s) for this element and all its children<br>
     -- only animates if a window is visible
     function public.animate_all()
         if protected.window.isVisible() then
             public.animate()
-            for _, child in pairs(protected.children) do child.animate_all() end
+            for _, child in pairs(protected.children) do child.get().animate_all() end
         end
     end
 
     -- freeze animation(s)
-    function public.freeze()
-        protected.stop_anim()
-    end
+    function public.freeze() protected.stop_anim() end
 
     -- freeze animation(s) for this element and all its children
     function public.freeze_all()
         public.freeze()
-        for _, child in pairs(protected.children) do child.freeze_all() end
+        for _, child in pairs(protected.children) do child.get().freeze_all() end
     end
 
-    -- re-draw the element
+    -- re-draw this element and all its children
     function public.redraw()
-        protected.window.redraw()
+        local bg, fg = protected.window.getBackgroundColor(), protected.window.getTextColor()
+        protected.window.setBackgroundColor(protected.fg_bg.bkg)
+        protected.window.setTextColor(protected.fg_bg.fgd)
+        protected.window.clear()
+        protected.window.setBackgroundColor(bg)
+        protected.window.setTextColor(fg)
+        protected.redraw()
+        for _, child in pairs(protected.children) do child.get().redraw() end
     end
 
     -- if a content window is set, clears it then re-draws all children
     function public.content_redraw()
         if protected.content_window ~= nil then
             protected.content_window.clear()
-            for _, child in pairs(protected.children) do child.redraw() end
+            for _, child in pairs(protected.children) do child.get().redraw() end
         end
     end
 

graphics/elements/animations/waiting.lua

@@ -36,49 +36,49 @@ local function waiting(args)
 
         if state >= 0 and state < 7 then
             -- top
-            e.window.setCursorPos(1 + math.floor(state / 2), 1)
+            e.w_set_cur(1 + math.floor(state / 2), 1)
             if state % 2 == 0 then
-                e.window.blit("\x8f", blit_fg, blit_bg)
+                e.w_blit("\x8f", blit_fg, blit_bg)
             else
-                e.window.blit("\x8a\x85", blit_fg_2x, blit_bg_2x)
+                e.w_blit("\x8a\x85", blit_fg_2x, blit_bg_2x)
             end
 
             -- bottom
-            e.window.setCursorPos(4 - math.ceil(state / 2), 3)
+            e.w_set_cur(4 - math.ceil(state / 2), 3)
             if state % 2 == 0 then
-                e.window.blit("\x8f", blit_fg, blit_bg)
+                e.w_blit("\x8f", blit_fg, blit_bg)
             else
-                e.window.blit("\x8a\x85", blit_fg_2x, blit_bg_2x)
+                e.w_blit("\x8a\x85", blit_fg_2x, blit_bg_2x)
             end
         else
             local st = state - 7
 
             -- right
             if st % 3 == 0 then
-                e.window.setCursorPos(4, 1 + math.floor(st / 3))
-                e.window.blit("\x83", blit_bg, blit_fg)
+                e.w_set_cur(4, 1 + math.floor(st / 3))
+                e.w_blit("\x83", blit_bg, blit_fg)
             elseif st % 3 == 1 then
-                e.window.setCursorPos(4, 1 + math.floor(st / 3))
-                e.window.blit("\x8f", blit_bg, blit_fg)
-                e.window.setCursorPos(4, 2 + math.floor(st / 3))
-                e.window.blit("\x83", blit_fg, blit_bg)
+                e.w_set_cur(4, 1 + math.floor(st / 3))
+                e.w_blit("\x8f", blit_bg, blit_fg)
+                e.w_set_cur(4, 2 + math.floor(st / 3))
+                e.w_blit("\x83", blit_fg, blit_bg)
             else
-                e.window.setCursorPos(4, 2 + math.floor(st / 3))
-                e.window.blit("\x8f", blit_fg, blit_bg)
+                e.w_set_cur(4, 2 + math.floor(st / 3))
+                e.w_blit("\x8f", blit_fg, blit_bg)
             end
 
             -- left
             if st % 3 == 0 then
-                e.window.setCursorPos(1, 3 - math.floor(st / 3))
-                e.window.blit("\x83", blit_fg, blit_bg)
-                e.window.setCursorPos(1, 2 - math.floor(st / 3))
-                e.window.blit("\x8f", blit_bg, blit_fg)
+                e.w_set_cur(1, 3 - math.floor(st / 3))
+                e.w_blit("\x83", blit_fg, blit_bg)
+                e.w_set_cur(1, 2 - math.floor(st / 3))
+                e.w_blit("\x8f", blit_bg, blit_fg)
             elseif st % 3 == 1 then
-                e.window.setCursorPos(1, 2 - math.floor(st / 3))
-                e.window.blit("\x83", blit_bg, blit_fg)
+                e.w_set_cur(1, 2 - math.floor(st / 3))
+                e.w_blit("\x83", blit_bg, blit_fg)
             else
-                e.window.setCursorPos(1, 2 - math.floor(st / 3))
-                e.window.blit("\x8f", blit_fg, blit_bg)
+                e.w_set_cur(1, 2 - math.floor(st / 3))
+                e.w_blit("\x8f", blit_fg, blit_bg)
             end
         end
 

graphics/elements/colormap.lua

@@ -1,7 +1,5 @@
 -- Color Map Graphics Element
 
-local util    = require("scada-common.util")
-
 local element = require("graphics.element")
 
 ---@class colormap_args
@@ -16,7 +14,7 @@ local element = require("graphics.element")
 ---@return graphics_element element, element_id id
 local function colormap(args)
     local bkg = "008877FFCCEE114455DD9933BBAA2266"
-    local spaces = util.spaces(32)
+    local spaces = string.rep(" ", 32)
 
     args.width = 32
     args.height = 1
@@ -25,8 +23,13 @@ local function colormap(args)
     local e = element.new(args)
 
     -- draw color map
-    e.window.setCursorPos(1, 1)
-    e.window.blit(spaces, bkg, bkg)
+    function e.redraw()
+        e.w_set_cur(1, 1)
+        e.w_blit(spaces, bkg, bkg)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/app.lua

@@ -5,7 +5,7 @@ local tcd     = require("scada-common.tcd")
 local core    = require("graphics.core")
 local element = require("graphics.element")
 
-local CLICK_TYPE = core.events.CLICK_TYPE
+local MOUSE_CLICK = core.events.MOUSE_CLICK
 
 ---@class app_button_args
 ---@field text string app icon text
@@ -24,22 +24,17 @@ local CLICK_TYPE = core.events.CLICK_TYPE
 ---@param args app_button_args
 ---@return graphics_element element, element_id id
 local function app_button(args)
-    assert(type(args.text) == "string", "graphics.elements.controls.app: text is a required field")
-    assert(type(args.title) == "string", "graphics.elements.controls.app: title is a required field")
-    assert(type(args.callback) == "function", "graphics.elements.controls.app: callback is a required field")
-    assert(type(args.app_fg_bg) == "table", "graphics.elements.controls.app: app_fg_bg is a required field")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.title) == "string", "title is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.app_fg_bg) == "table", "app_fg_bg is a required field")
 
     args.height = 4
-    args.width  = 5
+    args.width = 5
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- write app title, centered
-    e.window.setCursorPos(1, 4)
-    e.window.setCursorPos(math.floor((e.frame.w - string.len(args.title)) / 2) + 1, 4)
-    e.window.write(args.title)
-
     -- draw the app button
     local function draw()
         local fgd = args.app_fg_bg.fgd
@@ -51,36 +46,36 @@ local function app_button(args)
         end
 
         -- draw icon
-        e.window.setCursorPos(1, 1)
-        e.window.setTextColor(fgd)
-        e.window.setBackgroundColor(bkg)
-        e.window.write("\x9f\x83\x83\x83")
-        e.window.setTextColor(bkg)
-        e.window.setBackgroundColor(fgd)
-        e.window.write("\x90")
-        e.window.setTextColor(fgd)
-        e.window.setBackgroundColor(bkg)
-        e.window.setCursorPos(1, 2)
-        e.window.write("\x95   ")
-        e.window.setTextColor(bkg)
-        e.window.setBackgroundColor(fgd)
-        e.window.write("\x95")
-        e.window.setCursorPos(1, 3)
-        e.window.write("\x82\x8f\x8f\x8f\x81")
+        e.w_set_cur(1, 1)
+        e.w_set_fgd(fgd)
+        e.w_set_bkg(bkg)
+        e.w_write("\x9f\x83\x83\x83")
+        e.w_set_fgd(bkg)
+        e.w_set_bkg(fgd)
+        e.w_write("\x90")
+        e.w_set_fgd(fgd)
+        e.w_set_bkg(bkg)
+        e.w_set_cur(1, 2)
+        e.w_write("\x95   ")
+        e.w_set_fgd(bkg)
+        e.w_set_bkg(fgd)
+        e.w_write("\x95")
+        e.w_set_cur(1, 3)
+        e.w_write("\x82\x8f\x8f\x8f\x81")
 
         -- write the icon text
-        e.window.setCursorPos(3, 2)
-        e.window.setTextColor(fgd)
-        e.window.setBackgroundColor(bkg)
-        e.window.write(args.text)
+        e.w_set_cur(3, 2)
+        e.w_set_fgd(fgd)
+        e.w_set_bkg(bkg)
+        e.w_write(args.text)
     end
 
     -- draw the app button as pressed (if active_fg_bg set)
     local function show_pressed()
         if e.enabled and args.active_fg_bg ~= nil then
             e.value = true
-            e.window.setTextColor(args.active_fg_bg.fgd)
-            e.window.setBackgroundColor(args.active_fg_bg.bkg)
+            e.w_set_fgd(args.active_fg_bg.fgd)
+            e.w_set_bkg(args.active_fg_bg.bkg)
             draw()
         end
     end
@@ -89,8 +84,8 @@ local function app_button(args)
     local function show_unpressed()
         if e.enabled and args.active_fg_bg ~= nil then
             e.value = false
-            e.window.setTextColor(e.fg_bg.fgd)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
+            e.w_set_fgd(e.fg_bg.fgd)
+            e.w_set_bkg(e.fg_bg.bkg)
             draw()
         end
     end
@@ -99,14 +94,14 @@ local function app_button(args)
     ---@param event mouse_interaction mouse event
     function e.handle_mouse(event)
         if e.enabled then
-            if event.type == CLICK_TYPE.TAP then
+            if event.type == MOUSE_CLICK.TAP then
                 show_pressed()
                 -- show as unpressed in 0.25 seconds
                 if args.active_fg_bg ~= nil then tcd.dispatch(0.25, show_unpressed) end
                 args.callback()
-            elseif event.type == CLICK_TYPE.DOWN then
+            elseif event.type == MOUSE_CLICK.DOWN then
                 show_pressed()
-            elseif event.type == CLICK_TYPE.UP then
+            elseif event.type == MOUSE_CLICK.UP then
                 show_unpressed()
                 if e.in_frame_bounds(event.current.x, event.current.y) then
                     args.callback()
@@ -118,11 +113,18 @@ local function app_button(args)
     -- set the value (true simulates pressing the app button)
     ---@param val boolean new value
     function e.set_value(val)
-        if val then e.handle_mouse(core.events.mouse_generic(core.events.CLICK_TYPE.UP, 1, 1)) end
+        if val then e.handle_mouse(core.events.mouse_generic(core.events.MOUSE_CLICK.UP, 1, 1)) end
+    end
+
+    -- element redraw
+    function e.redraw()
+        e.w_set_cur(math.floor((e.frame.w - string.len(args.title)) / 2) + 1, 4)
+        e.w_write(args.title)
+        draw()
     end
 
     -- initial draw
-    draw()
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/checkbox.lua

@@ -6,7 +6,8 @@ local element = require("graphics.element")
 ---@class checkbox_args
 ---@field label string checkbox text
 ---@field box_fg_bg cpair colors for checkbox
----@field callback function function to call on press
+---@field default? boolean default value
+---@field callback? function function to call on press
 ---@field parent graphics_element
 ---@field id? string element id
 ---@field x? integer 1 if omitted
@@ -18,48 +19,75 @@ local element = require("graphics.element")
 ---@param args checkbox_args
 ---@return graphics_element element, element_id id
 local function checkbox(args)
-    assert(type(args.label) == "string", "graphics.elements.controls.checkbox: label is a required field")
-    assert(type(args.box_fg_bg) == "table", "graphics.elements.controls.checkbox: box_fg_bg is a required field")
-    assert(type(args.callback) == "function", "graphics.elements.controls.checkbox: callback is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.box_fg_bg) == "table", "box_fg_bg is a required field")
 
+    args.can_focus = true
     args.height = 1
-    args.width = 3 + string.len(args.label)
+    args.width = 2 + string.len(args.label)
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    e.value = false
+    e.value = args.default == true
 
     -- show the button state
     local function draw()
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if e.value then
             -- show as selected
-            e.window.setTextColor(args.box_fg_bg.bkg)
-            e.window.setBackgroundColor(args.box_fg_bg.fgd)
-            e.window.write("\x88")
-            e.window.setTextColor(args.box_fg_bg.fgd)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
-            e.window.write("\x95")
+            e.w_set_fgd(args.box_fg_bg.bkg)
+            e.w_set_bkg(args.box_fg_bg.fgd)
+            e.w_write("\x88")
+            e.w_set_fgd(args.box_fg_bg.fgd)
+            e.w_set_bkg(e.fg_bg.bkg)
+            e.w_write("\x95")
         else
             -- show as unselected
-            e.window.setTextColor(e.fg_bg.bkg)
-            e.window.setBackgroundColor(args.box_fg_bg.bkg)
-            e.window.write("\x88")
-            e.window.setTextColor(args.box_fg_bg.bkg)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
-            e.window.write("\x95")
+            e.w_set_fgd(e.fg_bg.bkg)
+            e.w_set_bkg(args.box_fg_bg.bkg)
+            e.w_write("\x88")
+            e.w_set_fgd(args.box_fg_bg.bkg)
+            e.w_set_bkg(e.fg_bg.bkg)
+            e.w_write("\x95")
+        end
+    end
+
+    -- write label text
+    local function draw_label()
+        if e.enabled and e.is_focused() then
+            e.w_set_cur(3, 1)
+            e.w_set_fgd(e.fg_bg.bkg)
+            e.w_set_bkg(e.fg_bg.fgd)
+            e.w_write(args.label)
+        else
+            e.w_set_cur(3, 1)
+            e.w_set_fgd(e.fg_bg.fgd)
+            e.w_set_bkg(e.fg_bg.bkg)
+            e.w_write(args.label)
         end
     end
 
     -- handle mouse interaction
     ---@param event mouse_interaction mouse event
     function e.handle_mouse(event)
-        if e.enabled and core.events.was_clicked(event.type) then
+        if e.enabled and core.events.was_clicked(event.type) and e.in_frame_bounds(event.current.x, event.current.y) then
             e.value = not e.value
             draw()
-            args.callback(e.value)
+            if type(args.callback) == "function" then args.callback(e.value) end
+        end
+    end
+
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == core.events.KEY_CLICK.DOWN then
+            if event.key == keys.space or event.key == keys.enter or event.key == keys.numPadEnter then
+                e.value = not e.value
+                draw()
+                if type(args.callback) == "function" then args.callback(e.value) end
+            end
         end
     end
 
@@ -70,14 +98,22 @@ local function checkbox(args)
         draw()
     end
 
-    -- write label text
-    e.window.setCursorPos(3, 1)
-    e.window.setTextColor(e.fg_bg.fgd)
-    e.window.setBackgroundColor(e.fg_bg.bkg)
-    e.window.write(args.label)
+    -- handle focus
+    e.on_focused = draw_label
+    e.on_unfocused = draw_label
+
+    -- handle enable
+    e.on_enabled = draw_label
+    e.on_disabled = draw_label
+
+    -- element redraw
+    function e.redraw()
+        draw()
+        draw_label()
+    end
 
     -- initial draw
-    draw()
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/hazard_button.lua

@@ -1,7 +1,6 @@
 -- Hazard-bordered Button Graphics Element
 
 local tcd     = require("scada-common.tcd")
-local util    = require("scada-common.util")
 
 local core    = require("graphics.core")
 local element = require("graphics.element")
@@ -22,47 +21,42 @@ local element = require("graphics.element")
 ---@param args hazard_button_args
 ---@return graphics_element element, element_id id
 local function hazard_button(args)
-    assert(type(args.text) == "string", "graphics.elements.controls.hazard_button: text is a required field")
-    assert(type(args.accent) == "number", "graphics.elements.controls.hazard_button: accent is a required field")
-    assert(type(args.callback) == "function", "graphics.elements.controls.hazard_button: callback is a required field")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.accent) == "number", "accent is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
 
-    -- static dimensions
     args.height = 3
     args.width = string.len(args.text) + 4
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- write the button text
-    e.window.setCursorPos(3, 2)
-    e.window.write(args.text)
-
     -- draw border
     ---@param accent color accent color
     local function draw_border(accent)
         -- top
-        e.window.setTextColor(accent)
-        e.window.setBackgroundColor(args.fg_bg.bkg)
-        e.window.setCursorPos(1, 1)
-        e.window.write("\x99" .. util.strrep("\x89", args.width - 2) .. "\x99")
+        e.w_set_fgd(accent)
+        e.w_set_bkg(args.fg_bg.bkg)
+        e.w_set_cur(1, 1)
+        e.w_write("\x99" .. string.rep("\x89", args.width - 2) .. "\x99")
 
         -- center left
-        e.window.setCursorPos(1, 2)
-        e.window.setTextColor(args.fg_bg.bkg)
-        e.window.setBackgroundColor(accent)
-        e.window.write("\x99")
+        e.w_set_cur(1, 2)
+        e.w_set_fgd(args.fg_bg.bkg)
+        e.w_set_bkg(accent)
+        e.w_write("\x99")
 
         -- center right
-        e.window.setTextColor(args.fg_bg.bkg)
-        e.window.setBackgroundColor(accent)
-        e.window.setCursorPos(args.width, 2)
-        e.window.write("\x99")
+        e.w_set_fgd(args.fg_bg.bkg)
+        e.w_set_bkg(accent)
+        e.w_set_cur(args.width, 2)
+        e.w_write("\x99")
 
         -- bottom
-        e.window.setTextColor(accent)
-        e.window.setBackgroundColor(args.fg_bg.bkg)
-        e.window.setCursorPos(1, 3)
-        e.window.write("\x99" .. util.strrep("\x98", args.width - 2) .. "\x99")
+        e.w_set_fgd(accent)
+        e.w_set_bkg(args.fg_bg.bkg)
+        e.w_set_cur(1, 3)
+        e.w_write("\x99" .. string.rep("\x98", args.width - 2) .. "\x99")
     end
 
     -- on request timeout: recursively calls itself to double flash button text
@@ -73,9 +67,9 @@ local function hazard_button(args)
 
         if n == 0 then
             -- go back off
-            e.window.setTextColor(args.fg_bg.fgd)
-            e.window.setCursorPos(3, 2)
-            e.window.write(args.text)
+            e.w_set_fgd(args.fg_bg.fgd)
+            e.w_set_cur(3, 2)
+            e.w_write(args.text)
         end
 
         if n >= 4 then
@@ -83,18 +77,18 @@ local function hazard_button(args)
         elseif n % 2 == 0 then
             -- toggle text color on after 0.25 seconds
             tcd.dispatch(0.25, function ()
-                e.window.setTextColor(args.accent)
-                e.window.setCursorPos(3, 2)
-                e.window.write(args.text)
+                e.w_set_fgd(args.accent)
+                e.w_set_cur(3, 2)
+                e.w_write(args.text)
                 on_timeout(n + 1)
                 on_timeout(n + 1)
             end)
         elseif n % 1 then
             -- toggle text color off after 0.25 seconds
             tcd.dispatch(0.25, function ()
-                e.window.setTextColor(args.fg_bg.fgd)
-                e.window.setCursorPos(3, 2)
-                e.window.write(args.text)
+                e.w_set_fgd(args.fg_bg.fgd)
+                e.w_set_cur(3, 2)
+                e.w_write(args.text)
                 on_timeout(n + 1)
             end)
         end
@@ -102,9 +96,9 @@ local function hazard_button(args)
 
     -- blink routine for success indication
     local function on_success()
-        e.window.setTextColor(args.fg_bg.fgd)
-        e.window.setCursorPos(3, 2)
-        e.window.write(args.text)
+        e.w_set_fgd(args.fg_bg.fgd)
+        e.w_set_cur(3, 2)
+        e.w_write(args.text)
     end
 
     -- blink routine for failure indication
@@ -115,9 +109,9 @@ local function hazard_button(args)
 
         if n == 0 then
             -- go back off
-            e.window.setTextColor(args.fg_bg.fgd)
-            e.window.setCursorPos(3, 2)
-            e.window.write(args.text)
+            e.w_set_fgd(args.fg_bg.fgd)
+            e.w_set_cur(3, 2)
+            e.w_write(args.text)
         end
 
         if n >= 2 then
@@ -125,17 +119,17 @@ local function hazard_button(args)
         elseif n % 2 == 0 then
             -- toggle text color on after 0.5 seconds
             tcd.dispatch(0.5, function ()
-                e.window.setTextColor(args.accent)
-                e.window.setCursorPos(3, 2)
-                e.window.write(args.text)
+                e.w_set_fgd(args.accent)
+                e.w_set_cur(3, 2)
+                e.w_write(args.text)
                 on_failure(n + 1)
             end)
         elseif n % 1 then
             -- toggle text color off after 0.25 seconds
             tcd.dispatch(0.25, function ()
-                e.window.setTextColor(args.fg_bg.fgd)
-                e.window.setCursorPos(3, 2)
-                e.window.write(args.text)
+                e.w_set_fgd(args.fg_bg.fgd)
+                e.w_set_cur(3, 2)
+                e.w_write(args.text)
                 on_failure(n + 1)
             end)
         end
@@ -147,9 +141,9 @@ local function hazard_button(args)
         if e.enabled then
             if core.events.was_clicked(event.type) then
                 -- change text color to indicate clicked
-                e.window.setTextColor(args.accent)
-                e.window.setCursorPos(3, 2)
-                e.window.write(args.text)
+                e.w_set_fgd(args.accent)
+                e.w_set_cur(3, 2)
+                e.w_write(args.text)
 
                 -- abort any other callbacks
                 tcd.abort(on_timeout)
@@ -159,7 +153,6 @@ local function hazard_button(args)
                 -- 1.5 second timeout
                 tcd.dispatch(1.5, on_timeout)
 
-                -- call the touch callback
                 args.callback()
             end
         end
@@ -175,29 +168,37 @@ local function hazard_button(args)
     -- set the value (true simulates pressing the button)
     ---@param val boolean new value
     function e.set_value(val)
-        if val then e.handle_mouse(core.events.mouse_generic(core.events.CLICK_TYPE.UP, 1, 1)) end
+        if val then e.handle_mouse(core.events.mouse_generic(core.events.MOUSE_CLICK.UP, 1, 1)) end
     end
 
     -- show the button as disabled
-    function e.disable()
+    function e.on_disabled()
         if args.dis_colors then
             draw_border(args.dis_colors.color_a)
-            e.window.setTextColor(args.dis_colors.color_b)
-            e.window.setCursorPos(3, 2)
-            e.window.write(args.text)
+            e.w_set_fgd(args.dis_colors.color_b)
+            e.w_set_cur(3, 2)
+            e.w_write(args.text)
         end
     end
 
     -- show the button as enabled
-    function e.enable()
+    function e.on_enabled()
         draw_border(args.accent)
-        e.window.setTextColor(args.fg_bg.fgd)
-        e.window.setCursorPos(3, 2)
-        e.window.write(args.text)
+        e.w_set_fgd(args.fg_bg.fgd)
+        e.w_set_cur(3, 2)
+        e.w_write(args.text)
     end
 
-    -- initial draw of border
-    draw_border(args.accent)
+    -- element redraw
+    function e.redraw()
+        -- write the button text and draw border
+        e.w_set_cur(3, 2)
+        e.w_write(args.text)
+        draw_border(args.accent)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/multi_button.lua

@@ -29,13 +29,11 @@ local element = require("graphics.element")
 ---@param args multi_button_args
 ---@return graphics_element element, element_id id
 local function multi_button(args)
-    assert(type(args.options) == "table", "graphics.elements.controls.multi_button: options is a required field")
-    assert(#args.options > 0, "graphics.elements.controls.multi_button: at least one option is required")
-    assert(type(args.callback) == "function", "graphics.elements.controls.multi_button: callback is a required field")
-    assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0),
-        "graphics.elements.controls.multi_button: default must be nil or a number > 0")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0),
-        "graphics.elements.controls.multi_button: min_width must be nil or a number > 0")
+    element.assert(type(args.options) == "table", "options is a required field")
+    element.assert(#args.options > 0, "at least one option is required")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "default must be nil or a number > 0")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     -- single line
     args.height = 1
@@ -71,23 +69,23 @@ local function multi_button(args)
     end
 
     -- show the button state
-    local function draw()
+    function e.redraw()
         for i = 1, #args.options do
             local opt = args.options[i] ---@type button_option
 
-            e.window.setCursorPos(opt._start_x, 1)
+            e.w_set_cur(opt._start_x, 1)
 
             if e.value == i then
                 -- show as pressed
-                e.window.setTextColor(opt.active_fg_bg.fgd)
-                e.window.setBackgroundColor(opt.active_fg_bg.bkg)
+                e.w_set_fgd(opt.active_fg_bg.fgd)
+                e.w_set_bkg(opt.active_fg_bg.bkg)
             else
                 -- show as unpressed
-                e.window.setTextColor(opt.fg_bg.fgd)
-                e.window.setBackgroundColor(opt.fg_bg.bkg)
+                e.w_set_fgd(opt.fg_bg.fgd)
+                e.w_set_bkg(opt.fg_bg.bkg)
             end
 
-            e.window.write(util.pad(opt.text, button_width))
+            e.w_write(util.pad(opt.text, button_width))
         end
     end
 
@@ -115,7 +113,7 @@ local function multi_button(args)
             -- tap always has identical coordinates, so this always passes for taps
             if button_ini == button_cur and button_cur ~= nil then
                 e.value = button_cur
-                draw()
+                e.redraw()
                 args.callback(e.value)
             end
         end
@@ -125,11 +123,11 @@ local function multi_button(args)
     ---@param val integer new value
     function e.set_value(val)
         e.value = val
-        draw()
+        e.redraw()
     end
 
     -- initial draw
-    draw()
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/push_button.lua

@@ -5,12 +5,16 @@ local tcd     = require("scada-common.tcd")
 local core    = require("graphics.core")
 local element = require("graphics.element")
 
-local CLICK_TYPE = core.events.CLICK_TYPE
+local ALIGN = core.ALIGN
+
+local MOUSE_CLICK = core.events.MOUSE_CLICK
+local KEY_CLICK = core.events.KEY_CLICK
 
 ---@class push_button_args
 ---@field text string button text
 ---@field callback function function to call on touch
 ---@field min_width? integer text length if omitted
+---@field alignment? ALIGN text align if min width > length
 ---@field active_fg_bg? cpair foreground/background colors when pressed
 ---@field dis_fg_bg? cpair foreground/background colors when disabled
 ---@field parent graphics_element
@@ -25,14 +29,15 @@ local CLICK_TYPE = core.events.CLICK_TYPE
 ---@param args push_button_args
 ---@return graphics_element element, element_id id
 local function push_button(args)
-    assert(type(args.text) == "string", "graphics.elements.controls.push_button: text is a required field")
-    assert(type(args.callback) == "function", "graphics.elements.controls.push_button: callback is a required field")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0),
-        "graphics.elements.controls.push_button: min_width must be nil or a number > 0")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     local text_width = string.len(args.text)
+    local alignment = args.alignment or ALIGN.CENTER
 
-    -- single line height, calculate width
+    -- set automatic settings
+    args.can_focus = true
     args.height = 1
     args.min_width = args.min_width or 0
     args.width = math.max(text_width, args.min_width)
@@ -40,25 +45,31 @@ local function push_button(args)
     -- create new graphics element base object
     local e = element.new(args)
 
-    local h_pad = math.floor((e.frame.w - text_width) / 2) + 1
+    local h_pad = 1
     local v_pad = math.floor(e.frame.h / 2) + 1
 
+    if alignment == ALIGN.CENTER then
+        h_pad = math.floor((e.frame.w - text_width) / 2) + 1
+    elseif alignment == ALIGN.RIGHT then
+        h_pad = (e.frame.w - text_width) + 1
+    end
+
     -- draw the button
-    local function draw()
+    function e.redraw()
         e.window.clear()
 
         -- write the button text
-        e.window.setCursorPos(h_pad, v_pad)
-        e.window.write(args.text)
+        e.w_set_cur(h_pad, v_pad)
+        e.w_write(args.text)
     end
 
     -- draw the button as pressed (if active_fg_bg set)
     local function show_pressed()
         if e.enabled and args.active_fg_bg ~= nil then
             e.value = true
-            e.window.setTextColor(args.active_fg_bg.fgd)
-            e.window.setBackgroundColor(args.active_fg_bg.bkg)
-            draw()
+            e.w_set_fgd(args.active_fg_bg.fgd)
+            e.w_set_bkg(args.active_fg_bg.bkg)
+            e.redraw()
         end
     end
 
@@ -66,9 +77,9 @@ local function push_button(args)
     local function show_unpressed()
         if e.enabled and args.active_fg_bg ~= nil then
             e.value = false
-            e.window.setTextColor(e.fg_bg.fgd)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
-            draw()
+            e.w_set_fgd(e.fg_bg.fgd)
+            e.w_set_bkg(e.fg_bg.bkg)
+            e.redraw()
         end
     end
 
@@ -76,14 +87,14 @@ local function push_button(args)
     ---@param event mouse_interaction mouse event
     function e.handle_mouse(event)
         if e.enabled then
-            if event.type == CLICK_TYPE.TAP then
+            if event.type == MOUSE_CLICK.TAP then
                 show_pressed()
                 -- show as unpressed in 0.25 seconds
                 if args.active_fg_bg ~= nil then tcd.dispatch(0.25, show_unpressed) end
                 args.callback()
-            elseif event.type == CLICK_TYPE.DOWN then
+            elseif event.type == MOUSE_CLICK.DOWN then
                 show_pressed()
-            elseif event.type == CLICK_TYPE.UP then
+            elseif event.type == MOUSE_CLICK.UP then
                 show_unpressed()
                 if e.in_frame_bounds(event.current.x, event.current.y) then
                     args.callback()
@@ -92,34 +103,49 @@ local function push_button(args)
         end
     end
 
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == KEY_CLICK.DOWN then
+            if event.key == keys.space or event.key == keys.enter or event.key == keys.numPadEnter then
+                args.callback()
+                e.defocus()
+            end
+        end
+    end
+
     -- set the value (true simulates pressing the button)
     ---@param val boolean new value
     function e.set_value(val)
-        if val then e.handle_mouse(core.events.mouse_generic(core.events.CLICK_TYPE.UP, 1, 1)) end
+        if val then e.handle_mouse(core.events.mouse_generic(core.events.MOUSE_CLICK.UP, 1, 1)) end
     end
 
     -- show butten as enabled
-    function e.enable()
+    function e.on_enabled()
         if args.dis_fg_bg ~= nil then
             e.value = false
-            e.window.setTextColor(e.fg_bg.fgd)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
-            draw()
+            e.w_set_fgd(e.fg_bg.fgd)
+            e.w_set_bkg(e.fg_bg.bkg)
+            e.redraw()
         end
     end
 
     -- show button as disabled
-    function e.disable()
+    function e.on_disabled()
         if args.dis_fg_bg ~= nil then
             e.value = false
-            e.window.setTextColor(args.dis_fg_bg.fgd)
-            e.window.setBackgroundColor(args.dis_fg_bg.bkg)
-            draw()
+            e.w_set_fgd(args.dis_fg_bg.fgd)
+            e.w_set_bkg(args.dis_fg_bg.bkg)
+            e.redraw()
         end
     end
 
+    -- handle focus
+    e.on_focused = show_pressed
+    e.on_unfocused = show_unpressed
+
     -- initial draw
-    draw()
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/radio_2d.lua

@@ -0,0 +1,203 @@
+-- 2D Radio Button Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class radio_2d_args
+---@field rows integer
+---@field columns integer
+---@field options table
+---@field radio_colors cpair radio button colors (inner & outer)
+---@field select_color? color color for radio button when selected
+---@field color_map? table colors for each radio button when selected
+---@field disable_color? color color for radio button when disabled
+---@field disable_fg_bg? cpair text colors when disabled
+---@field default? integer default state, defaults to options[1]
+---@field callback? function function to call on touch
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer auto incremented if omitted
+---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
+
+-- new 2D radio button list (latch selection, exclusively one color at a time)
+---@param args radio_2d_args
+---@return graphics_element element, element_id id
+local function radio_2d_button(args)
+    element.assert(type(args.options) == "table" and #args.options > 0, "options should be a table with length >= 1")
+    element.assert(util.is_int(args.rows) and util.is_int(args.columns), "rows/columns must be integers")
+    element.assert((args.rows * args.columns) >= #args.options, "rows x columns size insufficient for provided number of options")
+    element.assert(type(args.radio_colors) == "table", "radio_colors is a required field")
+    element.assert(type(args.select_color) == "number" or type(args.color_map) == "table", "select_color or color_map is required")
+    element.assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "default must be nil or a number > 0")
+
+    local array = {}
+    local col_widths = {}
+
+    local next_idx = 1
+    local total_width = 0
+    local max_rows = 1
+
+    local focused_opt = 1
+    local focus_x, focus_y = 1, 1
+
+    -- build table to display
+    for col = 1, args.columns do
+        local max_width = 0
+        array[col] = {}
+
+        for row = 1, args.rows do
+            local len = string.len(args.options[next_idx])
+            if len > max_width then max_width = len end
+            if row > max_rows then max_rows = row end
+
+            table.insert(array[col], { text = args.options[next_idx], id = next_idx, x_1 = 1 + total_width, x_2 = 2 + total_width + len })
+
+            next_idx = next_idx + 1
+            if next_idx > #args.options then break end
+        end
+
+        table.insert(col_widths, max_width + 3)
+        total_width = total_width + max_width + 3
+        if next_idx > #args.options then break end
+    end
+
+    args.can_focus = true
+    args.width = total_width
+    args.height = max_rows
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- selected option (convert nil to 1 if missing)
+    e.value = args.default or 1
+
+    -- draw the element
+    function e.redraw()
+        local col_x = 1
+
+        local radio_color_b = util.trinary(type(args.disable_color) == "number" and not e.enabled, args.disable_color, args.radio_colors.color_b)
+
+        for col = 1, #array do
+            for row = 1, #array[col] do
+                local opt = array[col][row]
+                local select_color = args.select_color
+
+                if type(args.color_map) == "table" and args.color_map[opt.id] then
+                    select_color = args.color_map[opt.id]
+                end
+
+                local inner_color = util.trinary((e.value == opt.id) and e.enabled, radio_color_b, args.radio_colors.color_a)
+                local outer_color = util.trinary((e.value == opt.id) and e.enabled, select_color, radio_color_b)
+
+                e.w_set_cur(col_x, row)
+
+                e.w_set_fgd(inner_color)
+                e.w_set_bkg(outer_color)
+                e.w_write("\x88")
+
+                e.w_set_fgd(outer_color)
+                e.w_set_bkg(e.fg_bg.bkg)
+                e.w_write("\x95")
+
+                if opt.id == focused_opt then
+                    focus_x, focus_y = row, col
+                end
+
+                -- write button text
+                if opt.id == focused_opt and e.is_focused() and e.enabled then
+                    e.w_set_fgd(e.fg_bg.bkg)
+                    e.w_set_bkg(e.fg_bg.fgd)
+                elseif type(args.disable_fg_bg) == "table" and not e.enabled then
+                    e.w_set_fgd(args.disable_fg_bg.fgd)
+                    e.w_set_bkg(args.disable_fg_bg.bkg)
+                else
+                    e.w_set_fgd(e.fg_bg.fgd)
+                    e.w_set_bkg(e.fg_bg.bkg)
+                end
+
+                e.w_write(opt.text)
+            end
+
+            col_x = col_x + col_widths[col]
+        end
+    end
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        if e.enabled and core.events.was_clicked(event.type) and (event.initial.y == event.current.y) then
+            -- determine what was pressed
+            for _, row in ipairs(array) do
+                local elem = row[event.current.y]
+                if elem ~= nil and event.initial.x >= elem.x_1 and event.initial.x <= elem.x_2 and event.current.x >= elem.x_1 and event.current.x <= elem.x_2 then
+                    e.value = elem.id
+                    focused_opt = elem.id
+                    e.redraw()
+                    if type(args.callback) == "function" then args.callback(e.value) end
+                    break
+                end
+            end
+        end
+    end
+
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == core.events.KEY_CLICK.DOWN or event.type == core.events.KEY_CLICK.HELD then
+            if event.type == core.events.KEY_CLICK.DOWN and (event.key == keys.space or event.key == keys.enter or event.key == keys.numPadEnter) then
+                e.value = focused_opt
+                e.redraw()
+                if type(args.callback) == "function" then args.callback(e.value) end
+            elseif event.key == keys.down then
+                if focused_opt < #args.options then
+                    focused_opt = focused_opt + 1
+                    e.redraw()
+                end
+            elseif event.key == keys.up then
+                if focused_opt > 1 then
+                    focused_opt = focused_opt - 1
+                    e.redraw()
+                end
+            elseif event.key == keys.right then
+                if array[focus_y + 1] and array[focus_y + 1][focus_x] then
+                    focused_opt = array[focus_y + 1][focus_x].id
+                else focused_opt = array[1][focus_x].id end
+                e.redraw()
+            elseif event.key == keys.left then
+                if array[focus_y - 1] and array[focus_y - 1][focus_x] then
+                    focused_opt = array[focus_y - 1][focus_x].id
+                    e.redraw()
+                elseif array[#array][focus_x] then
+                    focused_opt = array[#array][focus_x].id
+                    e.redraw()
+                end
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val integer new value
+    function e.set_value(val)
+        if type(val) == "number" and val > 0 and val <= #args.options then
+            e.value = val
+            e.redraw()
+        end
+    end
+
+    -- handle focus & enable
+    e.on_focused = e.redraw
+    e.on_unfocused = e.redraw
+    e.on_enabled = e.redraw
+    e.on_disabled = e.redraw
+
+    -- initial draw
+    e.redraw()
+
+    return e.complete()
+end
+
+return radio_2d_button

graphics/elements/controls/radio_button.lua

@@ -1,15 +1,19 @@
 -- Radio Button Graphics Element
 
+local util    = require("scada-common.util")
+
 local core    = require("graphics.core")
 local element = require("graphics.element")
 
+local KEY_CLICK = core.events.KEY_CLICK
+
 ---@class radio_button_args
 ---@field options table button options
----@field callback function function to call on touch
----@field radio_colors cpair colors for radio button center dot when active (a) or inactive (b)
----@field radio_bg color background color of radio button
+---@field radio_colors cpair radio button colors (inner & outer)
+---@field select_color color color for radio button border when selected
 ---@field default? integer default state, defaults to options[1]
 ---@field min_width? integer text length + 2 if omitted
+---@field callback? function function to call on touch
 ---@field parent graphics_element
 ---@field id? string element id
 ---@field x? integer 1 if omitted
@@ -21,16 +25,12 @@ local element = require("graphics.element")
 ---@param args radio_button_args
 ---@return graphics_element element, element_id id
 local function radio_button(args)
-    assert(type(args.options) == "table", "graphics.elements.controls.radio_button: options is a required field")
-    assert(#args.options > 0, "graphics.elements.controls.radio_button: at least one option is required")
-    assert(type(args.callback) == "function", "graphics.elements.controls.radio_button: callback is a required field")
-    assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0),
-        "graphics.elements.controls.radio_button: default must be nil or a number > 0")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0),
-        "graphics.elements.controls.radio_button: min_width must be nil or a number > 0")
-
-    -- one line per option
-    args.height = #args.options
+    element.assert(type(args.options) == "table", "options is a required field")
+    element.assert(#args.options > 0, "at least one option is required")
+    element.assert(type(args.radio_colors) == "table", "radio_colors is a required field")
+    element.assert(type(args.select_color) == "number", "select_color is a required field")
+    element.assert(type(args.default) == "nil" or (type(args.default) == "number" and args.default > 0), "default must be nil or a number > 0")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     -- determine widths
     local max_width = 1
@@ -43,41 +43,47 @@ local function radio_button(args)
 
     local button_text_width = math.max(max_width, args.min_width or 0)
 
+    -- set automatic args
+    args.can_focus = true
     args.width = button_text_width + 2
+    args.height = #args.options -- one line per option
 
     -- create new graphics element base object
     local e = element.new(args)
 
+    local focused_opt = 1
+
     -- button state (convert nil to 1 if missing)
     e.value = args.default or 1
 
     -- show the button state
-    local function draw()
+    function e.redraw()
         for i = 1, #args.options do
             local opt = args.options[i] ---@type string
 
-            e.window.setCursorPos(1, i)
+            local inner_color = util.trinary(e.value == i, args.radio_colors.color_b, args.radio_colors.color_a)
+            local outer_color = util.trinary(e.value == i, args.select_color, args.radio_colors.color_b)
 
-            if e.value == i then
-                -- show as selected
-                e.window.setTextColor(args.radio_colors.color_a)
-                e.window.setBackgroundColor(args.radio_bg)
-            else
-                -- show as unselected
-                e.window.setTextColor(args.radio_colors.color_b)
-                e.window.setBackgroundColor(args.radio_bg)
-            end
+            e.w_set_cur(1, i)
 
-            e.window.write("\x88")
+            e.w_set_fgd(inner_color)
+            e.w_set_bkg(outer_color)
+            e.w_write("\x88")
 
-            e.window.setTextColor(args.radio_bg)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
-            e.window.write("\x95")
+            e.w_set_fgd(outer_color)
+            e.w_set_bkg(e.fg_bg.bkg)
+            e.w_write("\x95")
 
             -- write button text
-            e.window.setTextColor(e.fg_bg.fgd)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
-            e.window.write(opt)
+            if i == focused_opt and e.is_focused() and e.enabled then
+                e.w_set_fgd(e.fg_bg.bkg)
+                e.w_set_bkg(e.fg_bg.fgd)
+            else
+                e.w_set_fgd(e.fg_bg.fgd)
+                e.w_set_bkg(e.fg_bg.bkg)
+            end
+
+            e.w_write(opt)
         end
     end
 
@@ -88,8 +94,31 @@ local function radio_button(args)
             -- determine what was pressed
             if args.options[event.current.y] ~= nil then
                 e.value = event.current.y
-                draw()
-                args.callback(e.value)
+                focused_opt = e.value
+                e.redraw()
+                if type(args.callback) == "function" then args.callback(e.value) end
+            end
+        end
+    end
+
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == KEY_CLICK.DOWN or event.type == KEY_CLICK.HELD then
+            if event.type == KEY_CLICK.DOWN and (event.key == keys.space or event.key == keys.enter or event.key == keys.numPadEnter) then
+                e.value = focused_opt
+                e.redraw()
+                if type(args.callback) == "function" then args.callback(e.value) end
+            elseif event.key == keys.down then
+                if focused_opt < #args.options then
+                    focused_opt = focused_opt + 1
+                    e.redraw()
+                end
+            elseif event.key == keys.up then
+                if focused_opt > 1 then
+                    focused_opt = focused_opt - 1
+                    e.redraw()
+                end
             end
         end
     end
@@ -97,12 +126,20 @@ local function radio_button(args)
     -- set the value
     ---@param val integer new value
     function e.set_value(val)
-        e.value = val
-        draw()
+        if type(val) == "number" and val > 0 and val <= #args.options then
+            e.value = val
+            e.redraw()
+        end
     end
 
+    -- handle focus & enable
+    e.on_focused = e.redraw
+    e.on_unfocused = e.redraw
+    e.on_enabled = e.redraw
+    e.on_disabled = e.redraw
+
     -- initial draw
-    draw()
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/sidebar.lua

@@ -1,11 +1,12 @@
 -- Sidebar Graphics Element
 
 local tcd     = require("scada-common.tcd")
+local util    = require("scada-common.util")
 
 local core    = require("graphics.core")
 local element = require("graphics.element")
 
-local CLICK_TYPE = core.events.CLICK_TYPE
+local MOUSE_CLICK = core.events.MOUSE_CLICK
 
 ---@class sidebar_tab
 ---@field char string character identifier
@@ -26,25 +27,28 @@ local CLICK_TYPE = core.events.CLICK_TYPE
 ---@param args sidebar_args
 ---@return graphics_element element, element_id id
 local function sidebar(args)
-    assert(type(args.tabs) == "table", "graphics.elements.controls.sidebar: tabs is a required field")
-    assert(#args.tabs > 0, "graphics.elements.controls.sidebar: at least one tab is required")
-    assert(type(args.callback) == "function", "graphics.elements.controls.sidebar: callback is a required field")
+    element.assert(type(args.tabs) == "table", "tabs is a required field")
+    element.assert(#args.tabs > 0, "at least one tab is required")
+    element.assert(type(args.callback) == "function", "callback is a required field")
 
-    -- always 3 wide
     args.width = 3
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    assert(e.frame.h >= (#args.tabs * 3), "graphics.elements.controls.sidebar: height insufficent to display all tabs")
+    element.assert(e.frame.h >= (#args.tabs * 3), "height insufficent to display all tabs")
 
     -- default to 1st tab
     e.value = 1
 
+    local was_pressed = false
+
     -- show the button state
-    ---@param pressed boolean if the currently selected tab should appear as actively pressed
+    ---@param pressed? boolean if the currently selected tab should appear as actively pressed
     ---@param pressed_idx? integer optional index to show as held (that is not yet selected)
     local function draw(pressed, pressed_idx)
+        pressed = util.trinary(pressed == nil, was_pressed, pressed)
+        was_pressed = pressed
         pressed_idx = pressed_idx or e.value
 
         for i = 1, #args.tabs do
@@ -52,27 +56,23 @@ local function sidebar(args)
 
             local y = ((i - 1) * 3) + 1
 
-            e.window.setCursorPos(1, y)
+            e.w_set_cur(1, y)
 
             if pressed and i == pressed_idx then
-                e.window.setTextColor(e.fg_bg.fgd)
-                e.window.setBackgroundColor(e.fg_bg.bkg)
+                e.w_set_fgd(e.fg_bg.fgd)
+                e.w_set_bkg(e.fg_bg.bkg)
             else
-                e.window.setTextColor(tab.color.fgd)
-                e.window.setBackgroundColor(tab.color.bkg)
+                e.w_set_fgd(tab.color.fgd)
+                e.w_set_bkg(tab.color.bkg)
             end
 
-            e.window.write("   ")
-            e.window.setCursorPos(1, y + 1)
+            e.w_write("   ")
+            e.w_set_cur(1, y + 1)
             if e.value == i then
-                -- show as selected
-                e.window.write(" " .. tab.char .. "\x10")
-            else
-                -- show as unselected
-                e.window.write(" " .. tab.char .. " ")
-            end
-            e.window.setCursorPos(1, y + 2)
-            e.window.write("   ")
+                e.w_write(" " .. tab.char .. "\x10")
+            else e.w_write(" " .. tab.char .. " ") end
+            e.w_set_cur(1, y + 2)
+            e.w_write("   ")
         end
     end
 
@@ -85,22 +85,22 @@ local function sidebar(args)
             local ini_idx = math.ceil(event.initial.y / 3)
 
             if args.tabs[cur_idx] ~= nil then
-                if event.type == CLICK_TYPE.TAP then
+                if event.type == MOUSE_CLICK.TAP then
                     e.value = cur_idx
                     draw(true)
                     -- show as unpressed in 0.25 seconds
                     tcd.dispatch(0.25, function () draw(false) end)
                     args.callback(e.value)
-                elseif event.type == CLICK_TYPE.DOWN then
+                elseif event.type == MOUSE_CLICK.DOWN then
                     draw(true, cur_idx)
-                elseif event.type == CLICK_TYPE.UP then
+                elseif event.type == MOUSE_CLICK.UP then
                     if cur_idx == ini_idx and e.in_frame_bounds(event.current.x, event.current.y) then
                         e.value = cur_idx
                         draw(false)
                         args.callback(e.value)
                     else draw(false) end
                 end
-            elseif event.type == CLICK_TYPE.UP then
+            elseif event.type == MOUSE_CLICK.UP then
                 draw(false)
             end
         end
@@ -113,8 +113,10 @@ local function sidebar(args)
         draw(false)
     end
 
-    -- initial draw
-    draw(false)
+    -- element redraw
+    e.redraw = draw
+
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/spinbox_numeric.lua

@@ -29,8 +29,8 @@ local function spinbox(args)
     local wn_prec = args.whole_num_precision
     local fr_prec = args.fractional_precision
 
-    assert(util.is_int(wn_prec), "graphics.element.controls.spinbox_numeric: whole number precision must be an integer")
-    assert(util.is_int(fr_prec), "graphics.element.controls.spinbox_numeric: fractional precision must be an integer")
+    element.assert(util.is_int(wn_prec), "whole number precision must be an integer")
+    element.assert(util.is_int(fr_prec), "fractional precision must be an integer")
 
     local fmt, fmt_init ---@type string, string
 
@@ -44,7 +44,7 @@ local function spinbox(args)
 
     local dec_point_x = args.whole_num_precision + 1
 
-    assert(type(args.arrow_fg_bg) == "table", "graphics.element.spinbox_numeric: arrow_fg_bg is a required field")
+    element.assert(type(args.arrow_fg_bg) == "table", "arrow_fg_bg is a required field")
 
     -- determine widths
     args.width = wn_prec + fr_prec + util.trinary(fr_prec > 0, 1, 0)
@@ -58,22 +58,20 @@ local function spinbox(args)
 
     -- draw the arrows
     local function draw_arrows(color)
-        e.window.setBackgroundColor(args.arrow_fg_bg.bkg)
-        e.window.setTextColor(color)
-        e.window.setCursorPos(1, 1)
-        e.window.write(util.strrep("\x1e", wn_prec))
-        e.window.setCursorPos(1, 3)
-        e.window.write(util.strrep("\x1f", wn_prec))
+        e.w_set_bkg(args.arrow_fg_bg.bkg)
+        e.w_set_fgd(color)
+        e.w_set_cur(1, 1)
+        e.w_write(string.rep("\x1e", wn_prec))
+        e.w_set_cur(1, 3)
+        e.w_write(string.rep("\x1f", wn_prec))
         if fr_prec > 0 then
-            e.window.setCursorPos(1 + wn_prec, 1)
-            e.window.write(" " .. util.strrep("\x1e", fr_prec))
-            e.window.setCursorPos(1 + wn_prec, 3)
-            e.window.write(" " .. util.strrep("\x1f", fr_prec))
+            e.w_set_cur(1 + wn_prec, 1)
+            e.w_write(" " .. string.rep("\x1e", fr_prec))
+            e.w_set_cur(1 + wn_prec, 3)
+            e.w_write(" " .. string.rep("\x1f", fr_prec))
         end
     end
 
-    draw_arrows(args.arrow_fg_bg.fgd)
-
     -- populate digits from current value
     local function set_digits()
         local initial_str = util.sprintf(fmt_init, e.value)
@@ -119,15 +117,12 @@ local function spinbox(args)
         end
 
         -- draw
-        e.window.setBackgroundColor(e.fg_bg.bkg)
-        e.window.setTextColor(e.fg_bg.fgd)
-        e.window.setCursorPos(1, 2)
-        e.window.write(util.sprintf(fmt, e.value))
+        e.w_set_bkg(e.fg_bg.bkg)
+        e.w_set_fgd(e.fg_bg.fgd)
+        e.w_set_cur(1, 2)
+        e.w_write(util.sprintf(fmt, e.value))
     end
 
-    -- init with the default value
-    show_num()
-
     -- handle mouse interaction
     ---@param event mouse_interaction mouse event
     function e.handle_mouse(event)
@@ -138,10 +133,8 @@ local function spinbox(args)
                 local idx = util.trinary(event.current.x > dec_point_x, event.current.x - 1, event.current.x)
                 if digits[idx] ~= nil then
                     if event.current.y == 1 then
-                        -- increment
                         digits[idx] = digits[idx] + 1
                     elseif event.current.y == 3 then
-                        -- decrement
                         digits[idx] = digits[idx] - 1
                     end
 
@@ -176,18 +169,19 @@ local function spinbox(args)
     end
 
     -- enable this input
-    function e.enable()
-        draw_arrows(args.arrow_fg_bg.fgd)
-    end
+    function e.on_enabled() draw_arrows(args.arrow_fg_bg.fgd) end
 
     -- disable this input
-    function e.disable()
-        draw_arrows(args.arrow_disable or colors.lightGray)
+    function e.on_disabled() draw_arrows(args.arrow_disable or colors.lightGray) end
+
+    -- element redraw
+    function e.redraw()
+        show_num()
+        draw_arrows(util.trinary(e.enabled, args.arrow_fg_bg.fgd, args.arrow_disable or colors.lightGray))
     end
 
-    -- default to zero, init digits table
-    e.value = 0
-    set_digits()
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/controls/switch_button.lua

@@ -21,15 +21,13 @@ local element = require("graphics.element")
 ---@param args switch_button_args
 ---@return graphics_element element, element_id id
 local function switch_button(args)
-    assert(type(args.text) == "string", "graphics.elements.controls.switch_button: text is a required field")
-    assert(type(args.callback) == "function", "graphics.elements.controls.switch_button: callback is a required field")
-    assert(type(args.active_fg_bg) == "table", "graphics.elements.controls.switch_button: active_fg_bg is a required field")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0),
-        "graphics.elements.controls.switch_button: min_width must be nil or a number > 0")
+    element.assert(type(args.text) == "string", "text is a required field")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.active_fg_bg) == "table", "active_fg_bg is a required field")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
     local text_width = string.len(args.text)
 
-    -- single line height, calculate width
     args.height = 1
     args.min_width = args.min_width or 0
     args.width = math.max(text_width, args.min_width)
@@ -37,44 +35,32 @@ local function switch_button(args)
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- button state (convert nil to false if missing)
     e.value = args.default or false
 
     local h_pad = math.floor((e.frame.w - text_width) / 2) + 1
     local v_pad = math.floor(e.frame.h / 2) + 1
 
     -- show the button state
-    local function draw_state()
+    function e.redraw()
         if e.value then
-            -- show as pressed
-            e.window.setTextColor(args.active_fg_bg.fgd)
-            e.window.setBackgroundColor(args.active_fg_bg.bkg)
+            e.w_set_fgd(args.active_fg_bg.fgd)
+            e.w_set_bkg(args.active_fg_bg.bkg)
         else
-            -- show as unpressed
-            e.window.setTextColor(e.fg_bg.fgd)
-            e.window.setBackgroundColor(e.fg_bg.bkg)
+            e.w_set_fgd(e.fg_bg.fgd)
+            e.w_set_bkg(e.fg_bg.bkg)
         end
 
-        -- clear to redraw background
         e.window.clear()
-
-        -- write the button text
-        e.window.setCursorPos(h_pad, v_pad)
-        e.window.write(args.text)
+        e.w_set_cur(h_pad, v_pad)
+        e.w_write(args.text)
     end
 
-    -- initial draw
-    draw_state()
-
     -- handle mouse interaction
     ---@param event mouse_interaction mouse event
     function e.handle_mouse(event)
         if e.enabled and core.events.was_clicked(event.type) then
-            -- toggle state
             e.value = not e.value
-            draw_state()
-
-            -- call the touch callback with state
+            e.redraw()
             args.callback(e.value)
         end
     end
@@ -82,11 +68,13 @@ local function switch_button(args)
     -- set the value
     ---@param val boolean new value
     function e.set_value(val)
-        -- set state
         e.value = val
-        draw_state()
+        e.redraw()
     end
 
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/controls/tabbar.lua

@@ -27,13 +27,11 @@ local element = require("graphics.element")
 ---@param args tabbar_args
 ---@return graphics_element element, element_id id
 local function tabbar(args)
-    assert(type(args.tabs) == "table", "graphics.elements.controls.tabbar: tabs is a required field")
-    assert(#args.tabs > 0, "graphics.elements.controls.tabbar: at least one tab is required")
-    assert(type(args.callback) == "function", "graphics.elements.controls.tabbar: callback is a required field")
-    assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0),
-        "graphics.elements.controls.tabbar: min_width must be nil or a number > 0")
+    element.assert(type(args.tabs) == "table", "tabs is a required field")
+    element.assert(#args.tabs > 0, "at least one tab is required")
+    element.assert(type(args.callback) == "function", "callback is a required field")
+    element.assert(type(args.min_width) == "nil" or (type(args.min_width) == "number" and args.min_width > 0), "min_width must be nil or a number > 0")
 
-    -- always 1 tall
     args.height = 1
 
     -- determine widths
@@ -50,7 +48,7 @@ local function tabbar(args)
     -- create new graphics element base object
     local e = element.new(args)
 
-    assert(e.frame.w >= (button_width * #args.tabs), "graphics.elements.controls.tabbar: width insufficent to display all tabs")
+    element.assert(e.frame.w >= (button_width * #args.tabs), "width insufficent to display all tabs")
 
     -- default to 1st tab
     e.value = 1
@@ -67,21 +65,21 @@ local function tabbar(args)
     end
 
     -- show the tab state
-    local function draw()
+    function e.redraw()
         for i = 1, #args.tabs do
             local tab = args.tabs[i]    ---@type tabbar_tab
 
-            e.window.setCursorPos(tab._start_x, 1)
+            e.w_set_cur(tab._start_x, 1)
 
             if e.value == i then
-                e.window.setTextColor(tab.color.fgd)
-                e.window.setBackgroundColor(tab.color.bkg)
+                e.w_set_fgd(tab.color.fgd)
+                e.w_set_bkg(tab.color.bkg)
             else
-                e.window.setTextColor(e.fg_bg.fgd)
-                e.window.setBackgroundColor(e.fg_bg.bkg)
+                e.w_set_fgd(e.fg_bg.fgd)
+                e.w_set_bkg(e.fg_bg.bkg)
             end
 
-            e.window.write(util.pad(tab.name, button_width))
+            e.w_write(util.pad(tab.name, button_width))
         end
     end
 
@@ -109,7 +107,7 @@ local function tabbar(args)
             -- tap always has identical coordinates, so this always passes for taps
             if tab_ini == tab_cur and tab_cur ~= nil then
                 e.value = tab_cur
-                draw()
+                e.redraw()
                 args.callback(e.value)
             end
         end
@@ -119,11 +117,11 @@ local function tabbar(args)
     ---@param val integer new value
     function e.set_value(val)
         e.value = val
-        draw()
+        e.redraw()
     end
 
     -- initial draw
-    draw()
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/form/number_field.lua

@@ -0,0 +1,197 @@
+-- Numeric Value Entry Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+local KEY_CLICK = core.events.KEY_CLICK
+local MOUSE_CLICK = core.events.MOUSE_CLICK
+
+---@class number_field_args
+---@field default? number default value, defaults to 0
+---@field min? number minimum, enforced on unfocus
+---@field max? number maximum, enforced on unfocus
+---@field max_chars? integer maximum number of characters, defaults to width
+---@field max_int_digits? integer maximum number of integer digits, enforced on unfocus
+---@field max_frac_digits? integer maximum number of fractional digits, enforced on unfocus
+---@field allow_decimal? boolean true to allow decimals
+---@field allow_negative? boolean true to allow negative numbers
+---@field dis_fg_bg? cpair foreground/background colors when disabled
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer auto incremented if omitted
+---@field width? integer parent width if omitted
+---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
+
+-- new numeric entry field
+---@param args number_field_args
+---@return graphics_element element, element_id id
+local function number_field(args)
+    element.assert(args.max_int_digits == nil or (util.is_int(args.max_int_digits) and args.max_int_digits > 0), "max_int_digits must be an integer greater than zero if supplied")
+    element.assert(args.max_frac_digits == nil or (util.is_int(args.max_frac_digits) and args.max_frac_digits > 0), "max_frac_digits must be an integer greater than zero if supplied")
+
+    args.height = 1
+    args.can_focus = true
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    local has_decimal = false
+
+    args.max_chars = args.max_chars or e.frame.w
+
+    -- set initial value
+    e.value = "" .. (args.default or 0)
+
+    -- make an interactive field manager
+    local ifield = core.new_ifield(e, args.max_chars, args.fg_bg, args.dis_fg_bg)
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        -- only handle if on an increment or decrement arrow
+        if e.enabled then
+            if core.events.was_clicked(event.type) then
+                e.take_focus()
+
+                if event.type == MOUSE_CLICK.UP and e.in_frame_bounds(event.current.x, event.current.y) then
+                    ifield.move_cursor(event.current.x)
+                end
+            elseif event.type == MOUSE_CLICK.DOUBLE_CLICK then
+                ifield.select_all()
+            end
+        end
+    end
+
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == KEY_CLICK.CHAR and string.len(e.value) < args.max_chars then
+            if tonumber(event.name) then
+                if e.value == 0 then e.value = "" end
+                ifield.try_insert_char(event.name)
+            end
+        elseif event.type == KEY_CLICK.DOWN or event.type == KEY_CLICK.HELD then
+            if (event.key == keys.backspace or event.key == keys.delete) and (string.len(e.value) > 0) then
+                ifield.backspace()
+                has_decimal = string.find(e.value, "%.") ~= nil
+            elseif (event.key == keys.period or event.key == keys.numPadDecimal) and (not has_decimal) and args.allow_decimal then
+                has_decimal = true
+                ifield.try_insert_char(".")
+            elseif (event.key == keys.minus or event.key == keys.numPadSubtract) and (string.len(e.value) == 0) and args.allow_negative then
+                ifield.set_value("-")
+            elseif event.key == keys.left then
+                ifield.nav_left()
+            elseif event.key == keys.right then
+                ifield.nav_right()
+            elseif event.key == keys.a and event.ctrl then
+                ifield.select_all()
+            elseif event.key == keys.home or event.key == keys.up then
+                ifield.nav_start()
+            elseif event.key == keys["end"] or event.key == keys.down then
+                ifield.nav_end()
+            end
+        end
+    end
+
+    -- set the value (must be a number)
+    ---@param val number number to show
+    function e.set_value(val)
+        if tonumber(val) then ifield.set_value("" .. tonumber(val)) end
+    end
+
+    -- set minimum input value
+    ---@param min integer minimum allowed value
+    function e.set_min(min)
+        args.min = min
+        e.on_unfocused()
+    end
+
+    -- set maximum input value
+    ---@param max integer maximum allowed value
+    function e.set_max(max)
+        args.max = max
+        e.on_unfocused()
+    end
+
+    -- replace text with pasted text if its a number
+    ---@param text string string pasted
+    function e.handle_paste(text)
+        if tonumber(text) then
+            ifield.set_value("" .. tonumber(text))
+        else
+            ifield.set_value("0")
+        end
+    end
+
+    -- handle unfocused
+    function e.on_unfocused()
+        local val = tonumber(e.value)
+        local max = tonumber(args.max)
+        local min = tonumber(args.min)
+
+        if type(val) == "number" then
+            if args.max_int_digits or args.max_frac_digits then
+                local str = e.value
+                local ceil = false
+
+                if string.find(str, "-") then str = string.sub(e.value, 2) end
+                local parts = util.strtok(str, ".")
+
+                if parts[1] and args.max_int_digits then
+                    if string.len(parts[1]) > args.max_int_digits then
+                        parts[1] = string.rep("9", args.max_int_digits)
+                        ceil = true
+                    end
+                end
+
+                if args.allow_decimal and args.max_frac_digits then
+                    if ceil then
+                        parts[2] = string.rep("9", args.max_frac_digits)
+                    elseif parts[2] and (string.len(parts[2]) > args.max_frac_digits) then
+                        -- add a half of the highest precision fractional value in order to round using floor
+                        local scaled = math.fmod(val, 1) * (10 ^ (args.max_frac_digits))
+                        local value = math.floor(scaled + 0.5)
+                        local unscaled = value * (10 ^ (-args.max_frac_digits))
+                        parts[2] = string.sub(tostring(unscaled), 3) -- remove starting "0."
+                    end
+                end
+
+                if parts[2] then parts[2] = "." .. parts[2] else parts[2] = "" end
+
+                val = tonumber((parts[1] or "") .. parts[2])
+            end
+
+            if type(args.max) == "number" and val > max then
+                e.value = "" .. max
+                ifield.nav_start()
+            elseif type(args.min) == "number" and val < min then
+                e.value = "" .. min
+                ifield.nav_start()
+            else
+                e.value = "" .. val
+                ifield.nav_end()
+            end
+        else
+            e.value = ""
+        end
+
+        ifield.show()
+    end
+
+    -- handle focus (not unfocus), enable, and redraw with show()
+    e.on_focused = ifield.show
+    e.on_enabled = ifield.show
+    e.on_disabled = ifield.show
+    e.redraw = ifield.show
+
+    -- initial draw
+    e.redraw()
+
+    return e.complete()
+end
+
+return number_field

graphics/elements/form/text_field.lua

@@ -0,0 +1,105 @@
+-- Text Value Entry Graphics Element
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+local KEY_CLICK = core.events.KEY_CLICK
+local MOUSE_CLICK = core.events.MOUSE_CLICK
+
+---@class text_field_args
+---@field value? string initial value
+---@field max_len? integer maximum string length
+---@field censor? string character to replace text with when printing to screen
+---@field dis_fg_bg? cpair foreground/background colors when disabled
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer auto incremented if omitted
+---@field width? integer parent width if omitted
+---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
+
+-- new text entry field
+---@param args text_field_args
+---@return graphics_element element, element_id id, function censor_ctl
+local function text_field(args)
+    args.height = 1
+    args.can_focus = true
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- set initial value
+    e.value = args.value or ""
+
+    -- make an interactive field manager
+    local ifield = core.new_ifield(e, args.max_len or e.frame.w, args.fg_bg, args.dis_fg_bg)
+
+    ifield.censor(args.censor)
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        -- only handle if on an increment or decrement arrow
+        if e.enabled then
+            if core.events.was_clicked(event.type) then
+                e.take_focus()
+
+                if event.type == MOUSE_CLICK.UP and e.in_frame_bounds(event.current.x, event.current.y) then
+                    ifield.move_cursor(event.current.x)
+                end
+            elseif event.type == MOUSE_CLICK.DOUBLE_CLICK then
+                ifield.select_all()
+            end
+        end
+    end
+
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == KEY_CLICK.CHAR then
+            ifield.try_insert_char(event.name)
+        elseif event.type == KEY_CLICK.DOWN or event.type == KEY_CLICK.HELD then
+            if (event.key == keys.backspace or event.key == keys.delete) then
+                ifield.backspace()
+            elseif event.key == keys.left then
+                ifield.nav_left()
+            elseif event.key == keys.right then
+                ifield.nav_right()
+            elseif event.key == keys.a and event.ctrl then
+                ifield.select_all()
+            elseif event.key == keys.home or event.key == keys.up then
+                ifield.nav_start()
+            elseif event.key == keys["end"] or event.key == keys.down then
+                ifield.nav_end()
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val string string to set
+    function e.set_value(val)
+        ifield.set_value(val)
+    end
+
+    -- replace text with pasted text
+    ---@param text string string to set
+    function e.handle_paste(text)
+        ifield.set_value(text)
+    end
+
+    -- handle focus, enable, and redraw with show()
+    e.on_focused = ifield.show
+    e.on_unfocused = ifield.show
+    e.on_enabled = ifield.show
+    e.on_disabled = ifield.show
+    e.redraw = ifield.show
+
+    -- initial draw
+    e.redraw()
+
+    local elem, id = e.complete()
+    return elem, id, ifield.censor
+end
+
+return text_field

graphics/elements/indicators/alight.lua

@@ -25,13 +25,13 @@ local flasher = require("graphics.flasher")
 ---@param args alarm_indicator_light
 ---@return graphics_element element, element_id id
 local function alarm_indicator_light(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.alight: label is a required field")
-    assert(type(args.c1) == "number", "graphics.elements.indicators.alight: c1 is a required field")
-    assert(type(args.c2) == "number", "graphics.elements.indicators.alight: c2 is a required field")
-    assert(type(args.c3) == "number", "graphics.elements.indicators.alight: c3 is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.c1) == "number", "c1 is a required field")
+    element.assert(type(args.c2) == "number", "c2 is a required field")
+    element.assert(type(args.c3) == "number", "c3 is a required field")
 
     if args.flash then
-        assert(util.is_int(args.period), "graphics.elements.indicators.alight: period is a required field if flash is enabled")
+        element.assert(util.is_int(args.period), "period is a required field if flash is enabled")
     end
 
     -- single line
@@ -51,19 +51,21 @@ local function alarm_indicator_light(args)
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = 1
+
     -- called by flasher when enabled
     local function flash_callback()
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if flash_on then
             if e.value == 2 then
-                e.window.blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
+                e.w_blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
             end
         else
             if e.value == 3 then
-                e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+                e.w_blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
             else
-                e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+                e.w_blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
             end
         end
 
@@ -76,7 +78,7 @@ local function alarm_indicator_light(args)
         local was_off = e.value ~= 2
 
         e.value = new_state
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if args.flash then
             if was_off and (new_state == 2) then
@@ -87,17 +89,17 @@ local function alarm_indicator_light(args)
                 flasher.stop(flash_callback)
 
                 if new_state == 3 then
-                    e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+                    e.w_blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
                 else
-                    e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+                    e.w_blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
                 end
             end
         elseif new_state == 2 then
-            e.window.blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
         elseif new_state == 3 then
-            e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
         else
-            e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
         end
     end
 
@@ -105,9 +107,14 @@ local function alarm_indicator_light(args)
     ---@param val integer indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- write label and initial indicator light
-    e.on_update(1)
-    e.window.write(args.label)
+    -- draw label and indicator light
+    function e.redraw()
+        e.on_update(e.value)
+        e.w_write(args.label)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/coremap.lua

@@ -18,8 +18,8 @@ local element = require("graphics.element")
 ---@param args core_map_args
 ---@return graphics_element element, element_id id
 local function core_map(args)
-    assert(util.is_int(args.reactor_l), "graphics.elements.indicators.coremap: reactor_l is a required field")
-    assert(util.is_int(args.reactor_w), "graphics.elements.indicators.coremap: reactor_w is a required field")
+    element.assert(util.is_int(args.reactor_l), "reactor_l is a required field")
+    element.assert(util.is_int(args.reactor_w), "reactor_w is a required field")
 
     -- require max dimensions
     args.width = 18
@@ -31,6 +31,8 @@ local function core_map(args)
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = 0
+
     local alternator = true
 
     local core_l = args.reactor_l - 2
@@ -47,25 +49,25 @@ local function core_map(args)
 
     -- create coordinate grid and frame
     local function draw_frame()
-        e.window.setTextColor(colors.white)
+        e.w_set_fgd(colors.white)
 
         for x = 0, (inner_width - 1) do
-            e.window.setCursorPos(x + start_x, 1)
-            e.window.write(util.sprintf("%X", x))
+            e.w_set_cur(x + start_x, 1)
+            e.w_write(util.sprintf("%X", x))
         end
 
         for y = 0, (inner_height - 1) do
-            e.window.setCursorPos(1, y + start_y)
-            e.window.write(util.sprintf("%X", y))
+            e.w_set_cur(1, y + start_y)
+            e.w_write(util.sprintf("%X", y))
         end
 
         -- even out bottom edge
-        e.window.setTextColor(e.fg_bg.bkg)
-        e.window.setBackgroundColor(args.parent.get_fg_bg().bkg)
-        e.window.setCursorPos(1, e.frame.h)
-        e.window.write(util.strrep("\x8f", e.frame.w))
-        e.window.setTextColor(e.fg_bg.fgd)
-        e.window.setBackgroundColor(e.fg_bg.bkg)
+        e.w_set_fgd(e.fg_bg.bkg)
+        e.w_set_bkg(args.parent.get_fg_bg().bkg)
+        e.w_set_cur(1, e.frame.h)
+        e.w_write(string.rep("\x8f", e.frame.w))
+        e.w_set_fgd(e.fg_bg.fgd)
+        e.w_set_bkg(e.fg_bg.bkg)
     end
 
     -- draw the core
@@ -102,13 +104,13 @@ local function core_map(args)
 
         -- draw pattern
         for y = start_y, inner_height + (start_y - 1) do
-            e.window.setCursorPos(start_x, y)
+            e.w_set_cur(start_x, y)
             for _ = 1, inner_width do
                 if alternator then
                     i = i + 1
-                    e.window.blit("\x07", text_c, back_c)
+                    e.w_blit("\x07", text_c, back_c)
                 else
-                    e.window.blit("\x07", "7", "8")
+                    e.w_blit("\x07", "7", "8")
                 end
 
                 alternator = not alternator
@@ -157,11 +159,14 @@ local function core_map(args)
         e.on_update(e.value)
     end
 
-    -- initial (one-time except for resize()) frame draw
-    draw_frame()
+    -- redraw both frame and core
+    function e.redraw()
+        draw_frame()
+        draw_core(e.value)
+    end
 
     -- initial draw
-    e.on_update(0)
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/data.lua

@@ -24,25 +24,17 @@ local element = require("graphics.element")
 ---@param args data_indicator_args
 ---@return graphics_element element, element_id id
 local function data(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.data: label is a required field")
-    assert(type(args.format) == "string", "graphics.elements.indicators.data: format is a required field")
-    assert(args.value ~= nil, "graphics.elements.indicators.data: value is a required field")
-    assert(util.is_int(args.width), "graphics.elements.indicators.data: width is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.format) == "string", "format is a required field")
+    element.assert(args.value ~= nil, "value is a required field")
+    element.assert(util.is_int(args.width), "width is a required field")
 
-    -- single line
     args.height = 1
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- label color
-    if args.lu_colors ~= nil then
-        e.window.setTextColor(args.lu_colors.color_a)
-    end
-
-    -- write label
-    e.window.setCursorPos(1, 1)
-    e.window.write(args.label)
+    e.value = args.value
 
     local value_color = e.fg_bg.fgd
     local label_len   = string.len(args.label)
@@ -60,25 +52,25 @@ local function data(args)
         e.value = value
 
         -- clear old data and label
-        e.window.setCursorPos(data_start, 1)
-        e.window.write(util.spaces(clear_width))
+        e.w_set_cur(data_start, 1)
+        e.w_write(util.spaces(clear_width))
 
         -- write data
         local data_str = util.sprintf(args.format, value)
-        e.window.setCursorPos(data_start, 1)
-        e.window.setTextColor(value_color)
+        e.w_set_cur(data_start, 1)
+        e.w_set_fgd(value_color)
         if args.commas then
-            e.window.write(util.comma_format(data_str))
+            e.w_write(util.comma_format(data_str))
         else
-            e.window.write(data_str)
+            e.w_write(data_str)
         end
 
         -- write label
         if args.unit ~= nil then
             if args.lu_colors ~= nil then
-                e.window.setTextColor(args.lu_colors.color_b)
+                e.w_set_fgd(args.lu_colors.color_b)
             end
-            e.window.write(" " .. args.unit)
+            e.w_write(" " .. args.unit)
         end
     end
 
@@ -93,8 +85,17 @@ local function data(args)
         e.on_update(e.value)
     end
 
-    -- initial value draw
-    e.on_update(args.value)
+    -- element redraw
+    function e.redraw()
+        if args.lu_colors ~= nil then e.w_set_fgd(args.lu_colors.color_a) end
+        e.w_set_cur(1, 1)
+        e.w_write(args.label)
+
+        e.on_update(e.value)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/hbar.lua

@@ -22,16 +22,17 @@ local element = require("graphics.element")
 ---@param args hbar_args
 ---@return graphics_element element, element_id id
 local function hbar(args)
-    -- properties/state
-    local last_num_bars = -1
-
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = 0.0
+
     -- bar width is width - 5 characters for " 100%" if showing percent
     local bar_width = util.trinary(args.show_percent, e.frame.w - 5, e.frame.w)
 
-    assert(bar_width > 0, "graphics.elements.indicators.hbar: too small for bar")
+    element.assert(bar_width > 0, "too small for bar")
+
+    local last_num_bars = -1
 
     -- determine bar colors
     local bar_bkg = e.fg_bg.blit_bkg
@@ -87,16 +88,16 @@ local function hbar(args)
 
             -- draw bar
             for y = 1, e.frame.h do
-                e.window.setCursorPos(1, y)
+                e.w_set_cur(1, y)
                 -- intentionally swapped fgd/bkg since we use spaces as fill, but they are the opposite
-                e.window.blit(spaces, bkg, fgd)
+                e.w_blit(spaces, bkg, fgd)
             end
         end
 
         -- update percentage
         if args.show_percent then
-            e.window.setCursorPos(bar_width + 2, math.max(1, math.ceil(e.frame.h / 2)))
-            e.window.write(util.sprintf("%3.0f%%", fraction * 100))
+            e.w_set_cur(bar_width + 2, math.max(1, math.ceil(e.frame.h / 2)))
+            e.w_write(util.sprintf("%3.0f%%", fraction * 100))
         end
     end
 
@@ -105,20 +106,21 @@ local function hbar(args)
     function e.recolor(bar_fg_bg)
         bar_bkg = bar_fg_bg.blit_bkg
         bar_fgd = bar_fg_bg.blit_fgd
-
-        -- re-draw
-        last_num_bars = 0
-        if type(e.value) == "number" then
-            e.on_update(e.value)
-        end
+        e.redraw()
     end
 
     -- set the percentage value
     ---@param val number 0.0 to 1.0
     function e.set_value(val) e.on_update(val) end
 
-    -- initialize to 0
-    e.on_update(0)
+    -- element redraw
+    function e.redraw()
+        last_num_bars = -1
+        e.on_update(e.value)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/icon.lua

@@ -1,7 +1,5 @@
 -- Icon Indicator Graphics Element
 
-local util    = require("scada-common.util")
-
 local element = require("graphics.element")
 
 ---@class icon_sym_color
@@ -25,18 +23,17 @@ local element = require("graphics.element")
 ---@param args icon_indicator_args
 ---@return graphics_element element, element_id id
 local function icon(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.icon: label is a required field")
-    assert(type(args.states) == "table", "graphics.elements.indicators.icon: states is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.states) == "table", "states is a required field")
 
-    -- single line
     args.height = 1
-
-    -- determine width
     args.width = math.max(args.min_label_width or 1, string.len(args.label)) + 4
 
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = args.value or 1
+
     -- state blit strings
     local state_blit_cmds = {}
     for i = 1, #args.states do
@@ -44,30 +41,34 @@ local function icon(args)
 
         table.insert(state_blit_cmds, {
             text = " " .. sym_color.symbol .. " ",
-            fgd = util.strrep(sym_color.color.blit_fgd, 3),
-            bkg = util.strrep(sym_color.color.blit_bkg, 3)
+            fgd = string.rep(sym_color.color.blit_fgd, 3),
+            bkg = string.rep(sym_color.color.blit_bkg, 3)
         })
     end
 
-    -- write label and initial indicator light
-    e.window.setCursorPos(5, 1)
-    e.window.write(args.label)
-
     -- on state change
     ---@param new_state integer indicator state
     function e.on_update(new_state)
         local blit_cmd = state_blit_cmds[new_state]
         e.value = new_state
-        e.window.setCursorPos(1, 1)
-        e.window.blit(blit_cmd.text, blit_cmd.fgd, blit_cmd.bkg)
+        e.w_set_cur(1, 1)
+        e.w_blit(blit_cmd.text, blit_cmd.fgd, blit_cmd.bkg)
     end
 
     -- set indicator state
     ---@param val integer indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- initial icon draw
-    e.on_update(args.value or 1)
+    -- element redraw
+    function e.redraw()
+        e.w_set_cur(5, 1)
+        e.w_write(args.label)
+
+        e.on_update(e.value)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/led.lua

@@ -23,33 +23,31 @@ local flasher = require("graphics.flasher")
 ---@param args indicator_led_args
 ---@return graphics_element element, element_id id
 local function indicator_led(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.led: label is a required field")
-    assert(type(args.colors) == "table", "graphics.elements.indicators.led: colors is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.colors) == "table", "colors is a required field")
 
     if args.flash then
-        assert(util.is_int(args.period), "graphics.elements.indicators.led: period is a required field if flash is enabled")
+        element.assert(util.is_int(args.period), "period is a required field if flash is enabled")
     end
 
-    -- single line
     args.height = 1
-
-    -- determine width
     args.width = math.max(args.min_label_width or 0, string.len(args.label)) + 2
 
-    -- flasher state
     local flash_on = true
 
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = false
+
     -- called by flasher when enabled
     local function flash_callback()
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if flash_on then
-            e.window.blit("\x8c", args.colors.blit_a, e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", args.colors.blit_a, e.fg_bg.blit_bkg)
         else
-            e.window.blit("\x8c", args.colors.blit_b, e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", args.colors.blit_b, e.fg_bg.blit_bkg)
         end
 
         flash_on = not flash_on
@@ -61,8 +59,8 @@ local function indicator_led(args)
             flash_on = true
             flasher.start(flash_callback, args.period)
         else
-            e.window.setCursorPos(1, 1)
-            e.window.blit("\x8c", args.colors.blit_a, e.fg_bg.blit_bkg)
+            e.w_set_cur(1, 1)
+            e.w_blit("\x8c", args.colors.blit_a, e.fg_bg.blit_bkg)
         end
     end
 
@@ -73,8 +71,8 @@ local function indicator_led(args)
             flasher.stop(flash_callback)
         end
 
-        e.window.setCursorPos(1, 1)
-        e.window.blit("\x8c", args.colors.blit_b, e.fg_bg.blit_bkg)
+        e.w_set_cur(1, 1)
+        e.w_blit("\x8c", args.colors.blit_b, e.fg_bg.blit_bkg)
     end
 
     -- on state change
@@ -88,13 +86,18 @@ local function indicator_led(args)
     ---@param val boolean indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- write label and initial indicator light
-    e.on_update(false)
-    if string.len(args.label) > 0 then
-        e.window.setCursorPos(3, 1)
-        e.window.write(args.label)
+    -- draw label and indicator light
+    function e.redraw()
+        e.on_update(e.value)
+        if string.len(args.label) > 0 then
+            e.w_set_cur(3, 1)
+            e.w_write(args.label)
+        end
     end
 
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/indicators/ledpair.lua

@@ -25,25 +25,20 @@ local flasher = require("graphics.flasher")
 ---@param args indicator_led_pair_args
 ---@return graphics_element element, element_id id
 local function indicator_led_pair(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.ledpair: label is a required field")
-    assert(type(args.off) == "number", "graphics.elements.indicators.ledpair: off is a required field")
-    assert(type(args.c1) == "number", "graphics.elements.indicators.ledpair: c1 is a required field")
-    assert(type(args.c2) == "number", "graphics.elements.indicators.ledpair: c2 is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.off) == "number", "off is a required field")
+    element.assert(type(args.c1) == "number", "c1 is a required field")
+    element.assert(type(args.c2) == "number", "c2 is a required field")
 
     if args.flash then
-        assert(util.is_int(args.period), "graphics.elements.indicators.ledpair: period is a required field if flash is enabled")
+        element.assert(util.is_int(args.period), "period is a required field if flash is enabled")
     end
 
-    -- single line
     args.height = 1
-
-    -- determine width
     args.width = math.max(args.min_label_width or 0, string.len(args.label)) + 2
 
-    -- flasher state
     local flash_on = true
 
-    -- blit translations
     local co = colors.toBlit(args.off)
     local c1 = colors.toBlit(args.c1)
     local c2 = colors.toBlit(args.c2)
@@ -51,21 +46,20 @@ local function indicator_led_pair(args)
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- init value for initial check in on_update
     e.value = 1
 
     -- called by flasher when enabled
     local function flash_callback()
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if flash_on then
             if e.value == 2 then
-                e.window.blit("\x8c", c1, e.fg_bg.blit_bkg)
+                e.w_blit("\x8c", c1, e.fg_bg.blit_bkg)
             elseif e.value == 3 then
-                e.window.blit("\x8c", c2, e.fg_bg.blit_bkg)
+                e.w_blit("\x8c", c2, e.fg_bg.blit_bkg)
             end
         else
-            e.window.blit("\x8c", co, e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", co, e.fg_bg.blit_bkg)
         end
 
         flash_on = not flash_on
@@ -77,7 +71,7 @@ local function indicator_led_pair(args)
         local was_off = e.value <= 1
 
         e.value = new_state
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if args.flash then
             if was_off and (new_state > 1) then
@@ -86,15 +80,14 @@ local function indicator_led_pair(args)
             elseif new_state <= 1 then
                 flash_on = false
                 flasher.stop(flash_callback)
-
-                e.window.blit("\x8c", co, e.fg_bg.blit_bkg)
+                e.w_blit("\x8c", co, e.fg_bg.blit_bkg)
             end
         elseif new_state == 2 then
-            e.window.blit("\x8c", c1, e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", c1, e.fg_bg.blit_bkg)
         elseif new_state == 3 then
-            e.window.blit("\x8c", c2, e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", c2, e.fg_bg.blit_bkg)
         else
-            e.window.blit("\x8c", co, e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", co, e.fg_bg.blit_bkg)
         end
     end
 
@@ -102,13 +95,18 @@ local function indicator_led_pair(args)
     ---@param val integer indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- write label and initial indicator light
-    e.on_update(1)
-    if string.len(args.label) > 0 then
-        e.window.setCursorPos(3, 1)
-        e.window.write(args.label)
+    -- draw label and indicator light
+    function e.redraw()
+        e.on_update(e.value)
+        if string.len(args.label) > 0 then
+            e.w_set_cur(3, 1)
+            e.w_write(args.label)
+        end
     end
 
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/indicators/ledrgb.lua

@@ -18,28 +18,24 @@ local element = require("graphics.element")
 ---@param args indicator_led_rgb_args
 ---@return graphics_element element, element_id id
 local function indicator_led_rgb(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.ledrgb: label is a required field")
-    assert(type(args.colors) == "table", "graphics.elements.indicators.ledrgb: colors is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.colors) == "table", "colors is a required field")
 
-    -- single line
     args.height = 1
-
-    -- determine width
     args.width = math.max(args.min_label_width or 0, string.len(args.label)) + 2
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- init value for initial check in on_update
     e.value = 1
 
     -- on state change
     ---@param new_state integer indicator state
     function e.on_update(new_state)
         e.value = new_state
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
         if type(args.colors[new_state]) == "number" then
-            e.window.blit("\x8c", colors.toBlit(args.colors[new_state]), e.fg_bg.blit_bkg)
+            e.w_blit("\x8c", colors.toBlit(args.colors[new_state]), e.fg_bg.blit_bkg)
         end
     end
 
@@ -47,13 +43,18 @@ local function indicator_led_rgb(args)
     ---@param val integer indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- write label and initial indicator light
-    e.on_update(1)
-    if string.len(args.label) > 0 then
-        e.window.setCursorPos(3, 1)
-        e.window.write(args.label)
+    -- draw label and indicator light
+    function e.redraw()
+        e.on_update(e.value)
+        if string.len(args.label) > 0 then
+            e.w_set_cur(3, 1)
+            e.w_write(args.label)
+        end
     end
 
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/indicators/light.lua

@@ -23,33 +23,31 @@ local flasher = require("graphics.flasher")
 ---@param args indicator_light_args
 ---@return graphics_element element, element_id id
 local function indicator_light(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.light: label is a required field")
-    assert(type(args.colors) == "table", "graphics.elements.indicators.light: colors is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.colors) == "table", "colors is a required field")
 
     if args.flash then
-        assert(util.is_int(args.period), "graphics.elements.indicators.light: period is a required field if flash is enabled")
+        element.assert(util.is_int(args.period), "period is a required field if flash is enabled")
     end
 
-    -- single line
     args.height = 1
-
-    -- determine width
     args.width = math.max(args.min_label_width or 1, string.len(args.label)) + 2
 
-    -- flasher state
     local flash_on = true
 
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = false
+
     -- called by flasher when enabled
     local function flash_callback()
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if flash_on then
-            e.window.blit(" \x95", "0" .. args.colors.blit_a, args.colors.blit_a .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. args.colors.blit_a, args.colors.blit_a .. e.fg_bg.blit_bkg)
         else
-            e.window.blit(" \x95", "0" .. args.colors.blit_b, args.colors.blit_b .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. args.colors.blit_b, args.colors.blit_b .. e.fg_bg.blit_bkg)
         end
 
         flash_on = not flash_on
@@ -61,8 +59,8 @@ local function indicator_light(args)
             flash_on = true
             flasher.start(flash_callback, args.period)
         else
-            e.window.setCursorPos(1, 1)
-            e.window.blit(" \x95", "0" .. args.colors.blit_a, args.colors.blit_a .. e.fg_bg.blit_bkg)
+            e.w_set_cur(1, 1)
+            e.w_blit(" \x95", "0" .. args.colors.blit_a, args.colors.blit_a .. e.fg_bg.blit_bkg)
         end
     end
 
@@ -73,8 +71,8 @@ local function indicator_light(args)
             flasher.stop(flash_callback)
         end
 
-        e.window.setCursorPos(1, 1)
-        e.window.blit(" \x95", "0" .. args.colors.blit_b, args.colors.blit_b .. e.fg_bg.blit_bkg)
+        e.w_set_cur(1, 1)
+        e.w_blit(" \x95", "0" .. args.colors.blit_b, args.colors.blit_b .. e.fg_bg.blit_bkg)
     end
 
     -- on state change
@@ -88,10 +86,15 @@ local function indicator_light(args)
     ---@param val boolean indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- write label and initial indicator light
-    e.on_update(false)
-    e.window.setCursorPos(3, 1)
-    e.window.write(args.label)
+    -- draw label and indicator light
+    function e.redraw()
+        e.on_update(false)
+        e.w_set_cur(3, 1)
+        e.w_write(args.label)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/power.lua

@@ -9,7 +9,7 @@ local element = require("graphics.element")
 ---@field format string power format override (lua string format)
 ---@field rate boolean? whether to append /t to the end (power per tick)
 ---@field lu_colors? cpair label foreground color (a), unit foreground color (b)
----@field value any default value
+---@field value number default value
 ---@field parent graphics_element
 ---@field id? string element id
 ---@field x? integer 1 if omitted
@@ -23,26 +23,17 @@ local element = require("graphics.element")
 ---@param args power_indicator_args
 ---@return graphics_element element, element_id id
 local function power(args)
-    assert(args.value ~= nil, "graphics.elements.indicators.power: value is a required field")
-    assert(util.is_int(args.width), "graphics.elements.indicators.power: width is a required field")
+    element.assert(type(args.value) == "number", "value is a required field")
+    element.assert(util.is_int(args.width), "width is a required field")
 
-    -- single line
     args.height = 1
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- label color
-    if args.lu_colors ~= nil then
-        e.window.setTextColor(args.lu_colors.color_a)
-    end
+    e.value = args.value
 
-    -- write label
-    e.window.setCursorPos(1, 1)
-    e.window.write(args.label)
-
-    local data_start = string.len(args.label) + 2
-    if string.len(args.label) == 0 then data_start = 1 end
+    local data_start = 0
 
     -- on state change
     ---@param value any new value
@@ -52,13 +43,13 @@ local function power(args)
         local data_str, unit = util.power_format(value, false, args.format)
 
         -- write data
-        e.window.setCursorPos(data_start, 1)
-        e.window.setTextColor(e.fg_bg.fgd)
-        e.window.write(util.comma_format(data_str))
+        e.w_set_cur(data_start, 1)
+        e.w_set_fgd(e.fg_bg.fgd)
+        e.w_write(util.comma_format(data_str))
 
         -- write unit
         if args.lu_colors ~= nil then
-            e.window.setTextColor(args.lu_colors.color_b)
+            e.w_set_fgd(args.lu_colors.color_b)
         end
 
         -- append per tick if rate is set
@@ -70,15 +61,27 @@ local function power(args)
             if unit == "FE" then unit = "FE " end
         end
 
-        e.window.write(" " .. unit)
+        e.w_write(" " .. unit)
     end
 
     -- set the value
     ---@param val any new value
     function e.set_value(val) e.on_update(val) end
 
-    -- initial value draw
-    e.on_update(args.value)
+    -- element redraw
+    function e.redraw()
+        if args.lu_colors ~= nil then e.w_set_fgd(args.lu_colors.color_a) end
+        e.w_set_cur(1, 1)
+        e.w_write(args.label)
+
+        data_start = string.len(args.label) + 2
+        if string.len(args.label) == 0 then data_start = 1 end
+
+        e.on_update(e.value)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/rad.lua

@@ -10,7 +10,7 @@ local element = require("graphics.element")
 ---@field format string data format (lua string format)
 ---@field commas? boolean whether to use commas if a number is given (default to false)
 ---@field lu_colors? cpair label foreground color (a), unit foreground color (b)
----@field value any default value
+---@field value? radiation_reading default value
 ---@field parent graphics_element
 ---@field id? string element id
 ---@field x? integer 1 if omitted
@@ -24,24 +24,16 @@ local element = require("graphics.element")
 ---@param args rad_indicator_args
 ---@return graphics_element element, element_id id
 local function rad(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.rad: label is a required field")
-    assert(type(args.format) == "string", "graphics.elements.indicators.rad: format is a required field")
-    assert(util.is_int(args.width), "graphics.elements.indicators.rad: width is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.format) == "string", "format is a required field")
+    element.assert(util.is_int(args.width), "width is a required field")
 
-    -- single line
     args.height = 1
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- label color
-    if args.lu_colors ~= nil then
-        e.window.setTextColor(args.lu_colors.color_a)
-    end
-
-    -- write label
-    e.window.setCursorPos(1, 1)
-    e.window.write(args.label)
+    e.value = args.value or types.new_zero_radiation_reading()
 
     local label_len = string.len(args.label)
     local data_start = 1
@@ -58,32 +50,41 @@ local function rad(args)
         e.value = value.radiation
 
         -- clear old data and label
-        e.window.setCursorPos(data_start, 1)
-        e.window.write(util.spaces(clear_width))
+        e.w_set_cur(data_start, 1)
+        e.w_write(util.spaces(clear_width))
 
         -- write data
         local data_str = util.sprintf(args.format, e.value)
-        e.window.setCursorPos(data_start, 1)
-        e.window.setTextColor(e.fg_bg.fgd)
+        e.w_set_cur(data_start, 1)
+        e.w_set_fgd(e.fg_bg.fgd)
         if args.commas then
-            e.window.write(util.comma_format(data_str))
+            e.w_write(util.comma_format(data_str))
         else
-            e.window.write(data_str)
+            e.w_write(data_str)
         end
 
         -- write unit
         if args.lu_colors ~= nil then
-            e.window.setTextColor(args.lu_colors.color_b)
+            e.w_set_fgd(args.lu_colors.color_b)
         end
-        e.window.write(" " .. value.unit)
+        e.w_write(" " .. value.unit)
     end
 
     -- set the value
     ---@param val any new value
     function e.set_value(val) e.on_update(val) end
 
-    -- initial value draw
-    e.on_update(types.new_zero_radiation_reading())
+    -- element redraw
+    function e.redraw()
+        if args.lu_colors ~= nil then e.w_set_fgd(args.lu_colors.color_a) end
+        e.w_set_cur(1, 1)
+        e.w_write(args.label)
+
+        e.on_update(e.value)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/state.lua

@@ -25,16 +25,12 @@ local element = require("graphics.element")
 ---@param args state_indicator_args
 ---@return graphics_element element, element_id id
 local function state_indicator(args)
-    assert(type(args.states) == "table", "graphics.elements.indicators.state: states is a required field")
+    element.assert(type(args.states) == "table", "states is a required field")
 
-    -- determine height
     if util.is_int(args.height) then
-        assert(args.height % 2 == 1, "graphics.elements.indicators.state: height should be an odd number")
-    else
-        args.height = 1
-    end
+        element.assert(args.height % 2 == 1, "height should be an odd number")
+    else args.height = 1 end
 
-    -- initial guess at width
     args.width = args.min_width or 1
 
     -- state blit strings
@@ -42,7 +38,6 @@ local function state_indicator(args)
     for i = 1, #args.states do
         local state_def = args.states[i]    ---@type state_text_color
 
-        -- re-determine width
         if string.len(state_def.text) > args.width then
             args.width = string.len(state_def.text)
         end
@@ -51,21 +46,28 @@ local function state_indicator(args)
 
         table.insert(state_blit_cmds, {
             text = text,
-            fgd = util.strrep(state_def.color.blit_fgd, string.len(text)),
-            bkg = util.strrep(state_def.color.blit_bkg, string.len(text))
+            fgd = string.rep(state_def.color.blit_fgd, string.len(text)),
+            bkg = string.rep(state_def.color.blit_bkg, string.len(text))
         })
     end
 
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = args.value or 1
+
+    -- element redraw
+    function e.redraw()
+        local blit_cmd = state_blit_cmds[e.value]
+        e.w_set_cur(1, 1)
+        e.w_blit(blit_cmd.text, blit_cmd.fgd, blit_cmd.bkg)
+    end
+
     -- on state change
     ---@param new_state integer indicator state
     function e.on_update(new_state)
-        local blit_cmd = state_blit_cmds[new_state]
         e.value = new_state
-        e.window.setCursorPos(1, 1)
-        e.window.blit(blit_cmd.text, blit_cmd.fgd, blit_cmd.bkg)
+        e.redraw()
     end
 
     -- set indicator state
@@ -73,7 +75,7 @@ local function state_indicator(args)
     function e.set_value(val) e.on_update(val) end
 
     -- initial draw
-    e.on_update(args.value or 1)
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/trilight.lua

@@ -25,47 +25,41 @@ local flasher = require("graphics.flasher")
 ---@param args tristate_indicator_light_args
 ---@return graphics_element element, element_id id
 local function tristate_indicator_light(args)
-    assert(type(args.label) == "string", "graphics.elements.indicators.trilight: label is a required field")
-    assert(type(args.c1) == "number", "graphics.elements.indicators.trilight: c1 is a required field")
-    assert(type(args.c2) == "number", "graphics.elements.indicators.trilight: c2 is a required field")
-    assert(type(args.c3) == "number", "graphics.elements.indicators.trilight: c3 is a required field")
+    element.assert(type(args.label) == "string", "label is a required field")
+    element.assert(type(args.c1) == "number", "c1 is a required field")
+    element.assert(type(args.c2) == "number", "c2 is a required field")
+    element.assert(type(args.c3) == "number", "c3 is a required field")
 
     if args.flash then
-        assert(util.is_int(args.period), "graphics.elements.indicators.trilight: period is a required field if flash is enabled")
+        element.assert(util.is_int(args.period), "period is a required field if flash is enabled")
     end
 
-    -- single line
     args.height = 1
-
-    -- determine width
     args.width = math.max(args.min_label_width or 1, string.len(args.label)) + 2
 
-    -- flasher state
-    local flash_on = true
-
-    -- blit translations
-    local c1 = colors.toBlit(args.c1)
-    local c2 = colors.toBlit(args.c2)
-    local c3 = colors.toBlit(args.c3)
-
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- init value for initial check in on_update
     e.value = 1
 
+    local flash_on = true
+
+    local c1 = colors.toBlit(args.c1)
+    local c2 = colors.toBlit(args.c2)
+    local c3 = colors.toBlit(args.c3)
+
     -- called by flasher when enabled
     local function flash_callback()
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if flash_on then
             if e.value == 2 then
-                e.window.blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
+                e.w_blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
             elseif e.value == 3 then
-                e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+                e.w_blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
             end
         else
-            e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
         end
 
         flash_on = not flash_on
@@ -77,7 +71,7 @@ local function tristate_indicator_light(args)
         local was_off = e.value <= 1
 
         e.value = new_state
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         if args.flash then
             if was_off and (new_state > 1) then
@@ -87,14 +81,14 @@ local function tristate_indicator_light(args)
                 flash_on = false
                 flasher.stop(flash_callback)
 
-                e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+                e.w_blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
             end
         elseif new_state == 2 then
-            e.window.blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c2, c2 .. e.fg_bg.blit_bkg)
         elseif new_state == 3 then
-            e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
         else
-            e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+            e.w_blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
         end
     end
 
@@ -102,9 +96,14 @@ local function tristate_indicator_light(args)
     ---@param val integer indicator state
     function e.set_value(val) e.on_update(val) end
 
-    -- write label and initial indicator light
-    e.on_update(1)
-    e.window.write(args.label)
+    -- draw light and label
+    function e.redraw()
+        e.on_update(1)
+        e.w_write(args.label)
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/indicators/vbar.lua

@@ -20,18 +20,18 @@ local element = require("graphics.element")
 ---@param args vbar_args
 ---@return graphics_element element, element_id id
 local function vbar(args)
-    -- properties/state
-    local last_num_bars = -1
-
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- blit strings
-    local fgd = util.strrep(e.fg_bg.blit_fgd, e.frame.w)
-    local bkg = util.strrep(e.fg_bg.blit_bkg, e.frame.w)
+    e.value = 0.0
+
+    local last_num_bars = -1
+
+    local fgd = string.rep(e.fg_bg.blit_fgd, e.frame.w)
+    local bkg = string.rep(e.fg_bg.blit_bkg, e.frame.w)
     local spaces = util.spaces(e.frame.w)
-    local one_third = util.strrep("\x8f", e.frame.w)
-    local two_thirds = util.strrep("\x83", e.frame.w)
+    local one_third = string.rep("\x8f", e.frame.w)
+    local two_thirds = string.rep("\x83", e.frame.w)
 
     -- handle data changes
     ---@param fraction number 0.0 to 1.0
@@ -52,54 +52,55 @@ local function vbar(args)
         if num_bars ~= last_num_bars then
             last_num_bars = num_bars
 
-            -- start bottom up
             local y = e.frame.h
-
-            -- start at base of vertical bar
-            e.window.setCursorPos(1, y)
+            e.w_set_cur(1, y)
 
             -- fill percentage
             for _ = 1, num_bars / 3 do
-                e.window.blit(spaces, bkg, fgd)
+                e.w_blit(spaces, bkg, fgd)
                 y = y - 1
-                e.window.setCursorPos(1, y)
+                e.w_set_cur(1, y)
             end
 
             -- add fractional bar if needed
             if num_bars % 3 == 1 then
-                e.window.blit(one_third, bkg, fgd)
+                e.w_blit(one_third, bkg, fgd)
                 y = y - 1
             elseif num_bars % 3 == 2 then
-                e.window.blit(two_thirds, bkg, fgd)
+                e.w_blit(two_thirds, bkg, fgd)
                 y = y - 1
             end
 
             -- fill the rest blank
             while y > 0 do
-                e.window.setCursorPos(1, y)
-                e.window.blit(spaces, fgd, bkg)
+                e.w_set_cur(1, y)
+                e.w_blit(spaces, fgd, bkg)
                 y = y - 1
             end
         end
     end
 
-    -- change bar color
-    ---@param fg_bg cpair new bar colors
-    function e.recolor(fg_bg)
-        fgd = util.strrep(fg_bg.blit_fgd, e.frame.w)
-        bkg = util.strrep(fg_bg.blit_bkg, e.frame.w)
-
-        -- re-draw
-        last_num_bars = 0
-        if type(e.value) == "number" then
-            e.on_update(e.value)
-        end
-    end
-
     -- set the percentage value
     ---@param val number 0.0 to 1.0
     function e.set_value(val) e.on_update(val) end
 
+    -- element redraw
+    function e.redraw()
+        last_num_bars = -1
+        e.on_update(e.value)
+    end
+
+    -- change bar color
+    ---@param fg_bg cpair new bar colors
+    function e.recolor(fg_bg)
+        fgd = string.rep(fg_bg.blit_fgd, e.frame.w)
+        bkg = string.rep(fg_bg.blit_bkg, e.frame.w)
+        e.redraw()
+    end
+
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/listbox.lua

@@ -5,7 +5,8 @@ local tcd     = require("scada-common.tcd")
 local core    = require("graphics.core")
 local element = require("graphics.element")
 
-local CLICK_TYPE = core.events.CLICK_TYPE
+local KEY_CLICK = core.events.KEY_CLICK
+local MOUSE_CLICK = core.events.MOUSE_CLICK
 
 ---@class listbox_args
 ---@field scroll_height integer height of internal scrolling container (must fit all elements vertically tiled)
@@ -33,6 +34,8 @@ local CLICK_TYPE = core.events.CLICK_TYPE
 ---@param args listbox_args
 ---@return graphics_element element, element_id id
 local function listbox(args)
+    args.can_focus = true
+
     -- create new graphics element base object
     local e = element.new(args)
 
@@ -63,34 +66,34 @@ local function listbox(args)
 
         -- draw up/down arrows
         if pressed_arrow == 1 then
-            e.window.setTextColor(active_fg_bg.fgd)
-            e.window.setBackgroundColor(active_fg_bg.bkg)
-            e.window.setCursorPos(e.frame.w, 1)
-            e.window.write("\x1e")
-            e.window.setTextColor(nav_fg_bg.fgd)
-            e.window.setBackgroundColor(nav_fg_bg.bkg)
-            e.window.setCursorPos(e.frame.w, e.frame.h)
-            e.window.write("\x1f")
+            e.w_set_fgd(active_fg_bg.fgd)
+            e.w_set_bkg(active_fg_bg.bkg)
+            e.w_set_cur(e.frame.w, 1)
+            e.w_write("\x1e")
+            e.w_set_fgd(nav_fg_bg.fgd)
+            e.w_set_bkg(nav_fg_bg.bkg)
+            e.w_set_cur(e.frame.w, e.frame.h)
+            e.w_write("\x1f")
         elseif pressed_arrow == -1 then
-            e.window.setTextColor(nav_fg_bg.fgd)
-            e.window.setBackgroundColor(nav_fg_bg.bkg)
-            e.window.setCursorPos(e.frame.w, 1)
-            e.window.write("\x1e")
-            e.window.setTextColor(active_fg_bg.fgd)
-            e.window.setBackgroundColor(active_fg_bg.bkg)
-            e.window.setCursorPos(e.frame.w, e.frame.h)
-            e.window.write("\x1f")
+            e.w_set_fgd(nav_fg_bg.fgd)
+            e.w_set_bkg(nav_fg_bg.bkg)
+            e.w_set_cur(e.frame.w, 1)
+            e.w_write("\x1e")
+            e.w_set_fgd(active_fg_bg.fgd)
+            e.w_set_bkg(active_fg_bg.bkg)
+            e.w_set_cur(e.frame.w, e.frame.h)
+            e.w_write("\x1f")
         else
-            e.window.setTextColor(nav_fg_bg.fgd)
-            e.window.setBackgroundColor(nav_fg_bg.bkg)
-            e.window.setCursorPos(e.frame.w, 1)
-            e.window.write("\x1e")
-            e.window.setCursorPos(e.frame.w, e.frame.h)
-            e.window.write("\x1f")
+            e.w_set_fgd(nav_fg_bg.fgd)
+            e.w_set_bkg(nav_fg_bg.bkg)
+            e.w_set_cur(e.frame.w, 1)
+            e.w_write("\x1e")
+            e.w_set_cur(e.frame.w, e.frame.h)
+            e.w_write("\x1f")
         end
 
-        e.window.setTextColor(e.fg_bg.fgd)
-        e.window.setBackgroundColor(e.fg_bg.bkg)
+        e.w_set_fgd(e.fg_bg.fgd)
+        e.w_set_bkg(e.fg_bg.bkg)
     end
 
     -- render the scroll bar and re-cacluate height & bounds
@@ -115,23 +118,23 @@ local function listbox(args)
         for i = 2, e.frame.h - 1 do
             if (i >= offset and i < (bar_height + offset)) and (bar_height ~= max_bar_height) then
                 if args.nav_fg_bg ~= nil then
-                    e.window.setBackgroundColor(args.nav_fg_bg.fgd)
+                    e.w_set_bkg(args.nav_fg_bg.fgd)
                 else
-                    e.window.setBackgroundColor(e.fg_bg.fgd)
+                    e.w_set_bkg(e.fg_bg.fgd)
                 end
             else
                 if args.nav_fg_bg ~= nil then
-                    e.window.setBackgroundColor(args.nav_fg_bg.bkg)
+                    e.w_set_bkg(args.nav_fg_bg.bkg)
                 else
-                    e.window.setBackgroundColor(e.fg_bg.bkg)
+                    e.w_set_bkg(e.fg_bg.bkg)
                 end
             end
 
-            e.window.setCursorPos(e.frame.w, i)
-            e.window.write(" ")
+            e.w_set_cur(e.frame.w, i)
+            if e.is_focused() then e.w_write("\x7f") else e.w_write(" ") end
         end
 
-        e.window.setBackgroundColor(e.fg_bg.bkg)
+        e.w_set_bkg(e.fg_bg.bkg)
     end
 
     -- update item y positions and move elements
@@ -158,6 +161,9 @@ local function listbox(args)
         scroll_frame.reposition(1, 1 + scroll_offset)
         scroll_frame.setVisible(true)
 
+        -- shift mouse events
+        e.mouse_window_shift.y = scroll_offset
+
         draw_bar()
     end
 
@@ -219,30 +225,60 @@ local function listbox(args)
         end
     end
 
+    -- handle focus
+    e.on_focused = draw_bar
+    e.on_unfocused = draw_bar
+
+    -- handle a child in the list being focused, make sure it is visible
+    function e.on_child_focused(child)
+        for i = 1, #list do
+            local item = list[i]    ---@type listbox_item
+            if item.e == child then
+                if (item.y + scroll_offset) <= 0 then
+                    scroll_offset = 1 - item.y
+                    update_positions()
+                    draw_bar()
+                elseif (item.y + scroll_offset) == 1 then
+                    -- do nothing, it's right at the top (if the bottom doesn't fit we can't easily fix that)
+                elseif ((item.h + item.y - 1) + scroll_offset) > e.frame.h then
+                    scroll_offset = 1 - ((item.h + item.y) - e.frame.h)
+                    update_positions()
+                    draw_bar()
+                end
+
+                return
+            end
+        end
+    end
+
     -- handle mouse interaction
     ---@param event mouse_interaction mouse event
     function e.handle_mouse(event)
         if e.enabled then
-            if event.type == CLICK_TYPE.TAP then
+            if event.type == MOUSE_CLICK.TAP then
                 if event.current.x == e.frame.w then
                     if event.current.y == 1 or event.current.y < bar_bounds[1] then
-                        draw_arrows(1)
                         scroll_up()
-                        if args.nav_active ~= nil then tcd.dispatch(0.25, function () draw_arrows(0) end) end
+                        if event.current.y == 1 then
+                            draw_arrows(1)
+                            if args.nav_active ~= nil then tcd.dispatch(0.25, function () draw_arrows(0) end) end
+                        end
                     elseif event.current.y == e.frame.h or event.current.y > bar_bounds[2] then
-                        draw_arrows(-1)
                         scroll_down()
-                        if args.nav_active ~= nil then tcd.dispatch(0.25, function () draw_arrows(0) end) end
+                        if event.current.y == e.frame.h then
+                            draw_arrows(-1)
+                            if args.nav_active ~= nil then tcd.dispatch(0.25, function () draw_arrows(0) end) end
+                        end
                     end
                 end
-            elseif event.type == CLICK_TYPE.DOWN then
+            elseif event.type == MOUSE_CLICK.DOWN then
                 if event.current.x == e.frame.w then
                     if event.current.y == 1 or event.current.y < bar_bounds[1] then
-                        draw_arrows(1)
                         scroll_up()
+                        if event.current.y == 1 then draw_arrows(1) end
                     elseif event.current.y == e.frame.h or event.current.y > bar_bounds[2] then
-                        draw_arrows(-1)
                         scroll_down()
+                        if event.current.y == e.frame.h then draw_arrows(-1) end
                     else
                         -- clicked on bar
                         holding_bar = true
@@ -250,10 +286,10 @@ local function listbox(args)
                         mouse_last_y = event.current.y
                     end
                 end
-            elseif event.type == CLICK_TYPE.UP then
+            elseif event.type == MOUSE_CLICK.UP then
                 holding_bar = false
                 draw_arrows(0)
-            elseif event.type == CLICK_TYPE.DRAG then
+            elseif event.type == MOUSE_CLICK.DRAG then
                 if holding_bar then
                     -- if mouse is within vertical frame, including the grip point
                     if event.current.y > (1 + bar_grip_pos) and event.current.y <= ((e.frame.h - bar_height) + bar_grip_pos) then
@@ -266,16 +302,40 @@ local function listbox(args)
                         mouse_last_y = event.current.y
                     end
                 end
-            elseif event.type == CLICK_TYPE.SCROLL_DOWN then
+            elseif event.type == MOUSE_CLICK.SCROLL_DOWN then
                 scroll_down()
-            elseif event.type == CLICK_TYPE.SCROLL_UP then
+            elseif event.type == MOUSE_CLICK.SCROLL_UP then
                 scroll_up()
             end
         end
     end
 
-    draw_arrows(0)
-    draw_bar()
+    -- handle keyboard interaction
+    ---@param event key_interaction key event
+    function e.handle_key(event)
+        if event.type == KEY_CLICK.DOWN or event.type == KEY_CLICK.HELD then
+            if event.key == keys.up then
+                scroll_up()
+            elseif event.key == keys.down then
+                scroll_down()
+            elseif event.key == keys.home then
+                scroll_offset = 0
+                update_positions()
+            elseif event.key == keys["end"] then
+                scroll_offset = max_down_scroll
+                update_positions()
+            end
+        end
+    end
+
+    -- element redraw
+    function e.redraw()
+        draw_arrows(0)
+        draw_bar()
+    end
+
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/multipane.lua

@@ -19,23 +19,30 @@ local element = require("graphics.element")
 ---@param args multipane_args
 ---@return graphics_element element, element_id id
 local function multipane(args)
-    assert(type(args.panes) == "table", "graphics.elements.multipane: panes is a required field")
+    element.assert(type(args.panes) == "table", "panes is a required field")
 
     -- create new graphics element base object
     local e = element.new(args)
 
+    e.value = 1
+
+    -- show the selected pane
+    function e.redraw()
+        for i = 1, #args.panes do args.panes[i].hide() end
+        args.panes[e.value].show()
+    end
+
     -- select which pane is shown
     ---@param value integer pane to show
     function e.set_value(value)
         if (e.value ~= value) and (value > 0) and (value <= #args.panes) then
             e.value = value
-
-            for i = 1, #args.panes do args.panes[i].hide() end
-            args.panes[value].show()
+            e.redraw()
         end
     end
 
-    e.set_value(1)
+    -- initial draw
+    e.redraw()
 
     return e.complete()
 end

graphics/elements/pipenet.lua

@@ -24,12 +24,11 @@ local element = require("graphics.element")
 ---@param args pipenet_args
 ---@return graphics_element element, element_id id
 local function pipenet(args)
-    assert(type(args.pipes) == "table", "graphics.elements.indicators.pipenet: pipes is a required field")
+    element.assert(type(args.pipes) == "table", "pipes is a required field")
 
     args.width = 0
     args.height = 0
 
-    -- determine width/height
     for i = 1, #args.pipes do
         local pipe = args.pipes[i]  ---@type pipe
 
@@ -57,8 +56,8 @@ local function pipenet(args)
         if any_thin then break end
     end
 
-    if not any_thin then
-        -- draw all pipes
+    -- draw all pipes by drawing out lines
+    local function vector_draw()
         for p = 1, #args.pipes do
             local pipe = args.pipes[p]  ---@type pipe
 
@@ -73,7 +72,7 @@ local function pipenet(args)
                 y_step = util.trinary(pipe.y1 == pipe.y2, 0, y_step)
             end
 
-            e.window.setCursorPos(x, y)
+            e.w_set_cur(x, y)
 
             local c = core.cpair(pipe.color, e.fg_bg.bkg)
 
@@ -84,24 +83,24 @@ local function pipenet(args)
                         if i == pipe.w then
                             -- corner
                             if y_step > 0 then
-                                e.window.blit("\x93", c.blit_bkg, c.blit_fgd)
+                                e.w_blit("\x93", c.blit_bkg, c.blit_fgd)
                             else
-                                e.window.blit("\x8e", c.blit_fgd, c.blit_bkg)
+                                e.w_blit("\x8e", c.blit_fgd, c.blit_bkg)
                             end
                         else
-                            e.window.blit("\x8c", c.blit_fgd, c.blit_bkg)
+                            e.w_blit("\x8c", c.blit_fgd, c.blit_bkg)
                         end
                     else
                         if i == pipe.w and y_step > 0 then
                             -- corner
-                            e.window.blit(" ", c.blit_bkg, c.blit_fgd)
+                            e.w_blit(" ", c.blit_bkg, c.blit_fgd)
                         else
-                            e.window.blit("\x8f", c.blit_fgd, c.blit_bkg)
+                            e.w_blit("\x8f", c.blit_fgd, c.blit_bkg)
                         end
                     end
 
                     x = x + x_step
-                    e.window.setCursorPos(x, y)
+                    e.w_set_cur(x, y)
                 end
 
                 -- back up one
@@ -109,12 +108,12 @@ local function pipenet(args)
 
                 for _ = 1, pipe.h - 1 do
                     y = y + y_step
-                    e.window.setCursorPos(x, y)
+                    e.w_set_cur(x, y)
 
                     if pipe.thin then
-                        e.window.blit("\x95", c.blit_bkg, c.blit_fgd)
+                        e.w_blit("\x95", c.blit_bkg, c.blit_fgd)
                     else
-                        e.window.blit(" ", c.blit_bkg, c.blit_fgd)
+                        e.w_blit(" ", c.blit_bkg, c.blit_fgd)
                     end
                 end
             else
@@ -124,26 +123,26 @@ local function pipenet(args)
                         if i == pipe.h then
                             -- corner
                             if y_step < 0 then
-                                e.window.blit("\x97", c.blit_bkg, c.blit_fgd)
+                                e.w_blit("\x97", c.blit_bkg, c.blit_fgd)
                             elseif y_step > 0 then
-                                e.window.blit("\x8d", c.blit_fgd, c.blit_bkg)
+                                e.w_blit("\x8d", c.blit_fgd, c.blit_bkg)
                             else
-                                e.window.blit("\x8c", c.blit_fgd, c.blit_bkg)
+                                e.w_blit("\x8c", c.blit_fgd, c.blit_bkg)
                             end
                         else
-                            e.window.blit("\x95", c.blit_fgd, c.blit_bkg)
+                            e.w_blit("\x95", c.blit_fgd, c.blit_bkg)
                         end
                     else
                         if i == pipe.h and y_step < 0 then
                             -- corner
-                            e.window.blit("\x83", c.blit_bkg, c.blit_fgd)
+                            e.w_blit("\x83", c.blit_bkg, c.blit_fgd)
                         else
-                            e.window.blit(" ", c.blit_bkg, c.blit_fgd)
+                            e.w_blit(" ", c.blit_bkg, c.blit_fgd)
                         end
                     end
 
                     y = y + y_step
-                    e.window.setCursorPos(x, y)
+                    e.w_set_cur(x, y)
                 end
 
                 -- back up one
@@ -151,21 +150,119 @@ local function pipenet(args)
 
                 for _ = 1, pipe.w - 1 do
                     x = x + x_step
-                    e.window.setCursorPos(x, y)
+                    e.w_set_cur(x, y)
 
                     if pipe.thin then
-                        e.window.blit("\x8c", c.blit_fgd, c.blit_bkg)
+                        e.w_blit("\x8c", c.blit_fgd, c.blit_bkg)
                     else
-                        e.window.blit("\x83", c.blit_bkg, c.blit_fgd)
+                        e.w_blit("\x83", c.blit_bkg, c.blit_fgd)
                     end
                 end
             end
         end
-    else
-        -- build map if using thin pipes, easist way to check adjacent blocks (cannot 'cheat' like with standard width)
+    end
+
+    -- draw a particular map cell
+    ---@param map table 2D cell map
+    ---@param x integer x coord
+    ---@param y integer y coord
+    local function draw_map_cell(map, x, y)
+        local entry = map[x][y] ---@type _pipe_map_entry already confirmed not false
+        local char
+        local invert = false
+
+        local function check(cx, cy)
+            return (map[cx] ~= nil) and (map[cx][cy] ~= nil) and (map[cx][cy] ~= false) and (map[cx][cy].fg == entry.fg)
+        end
+
+        if entry.thin then
+            if check(x - 1, y) then -- if left
+                if check(x, y - 1) then -- if above
+                    if check(x + 1, y) then -- if right
+                        if check(x, y + 1) then -- if below
+                            char = util.trinary(entry.atr, "\x91", "\x9d")
+                            invert = entry.atr
+                        else -- not below
+                            char = util.trinary(entry.atr, "\x8e", "\x8d")
+                        end
+                    else -- not right
+                        if check(x, y + 1) then -- if below
+                            char = util.trinary(entry.atr, "\x91", "\x95")
+                            invert = entry.atr
+                        else -- not below
+                            char = util.trinary(entry.atr, "\x8e", "\x85")
+                        end
+                    end
+                elseif check(x, y + 1) then-- not above, if below
+                    if check(x + 1, y) then -- if right
+                        char = util.trinary(entry.atr, "\x93", "\x9c")
+                        invert = entry.atr
+                    else -- not right
+                        char = util.trinary(entry.atr, "\x93", "\x94")
+                        invert = entry.atr
+                    end
+                else -- not above, not below
+                    char = "\x8c"
+                end
+            elseif check(x + 1, y) then -- not left, if right
+                if check(x, y - 1) then -- if above
+                    if check(x, y + 1) then -- if below
+                        char = util.trinary(entry.atr, "\x95", "\x9d")
+                        invert = entry.atr
+                    else -- not below
+                        char = util.trinary(entry.atr, "\x8a", "\x8d")
+                    end
+                else -- not above
+                    if check(x, y + 1) then -- if below
+                        char = util.trinary(entry.atr, "\x97", "\x9c")
+                        invert = entry.atr
+                    else -- not below
+                        char = "\x8c"
+                    end
+                end
+            else -- not left, not right
+                char = "\x95"
+                invert = entry.atr
+            end
+        else
+            if check(x, y - 1) then -- above
+                -- not below and (if left or right)
+                if (not check(x, y + 1)) and (check(x - 1, y) or check(x + 1, y)) then
+                    char = util.trinary(entry.atr, "\x8f", " ")
+                    invert = not entry.atr
+                else -- not below w/ sides only
+                    char = " "
+                    invert = true
+                end
+            elseif check(x, y + 1) then -- not above, if below
+                -- if left or right
+                if (check(x - 1, y) or check(x + 1, y)) then
+                    char = "\x83"
+                    invert = true
+                else -- not left or right
+                    char = " "
+                    invert = true
+                end
+            else -- not above, not below
+                char = util.trinary(entry.atr, "\x8f", "\x83")
+                invert = not entry.atr
+            end
+        end
+
+        e.w_set_cur(x, y)
+
+        if invert then
+            e.w_blit(char, entry.bg, entry.fg)
+        else
+            e.w_blit(char, entry.fg, entry.bg)
+        end
+    end
+
+    -- draw all pipes by assembling and marking up a 2D map<br>
+    -- this is an easy way to check adjacent blocks, which is required to properly draw thin pipes
+    local function map_draw()
         local map = {}
 
-        -- allocate map
         for x = 1, args.width do
             table.insert(map, {})
             for _ = 1, args.height do table.insert(map[x], false) end
@@ -215,101 +312,19 @@ local function pipenet(args)
         -- render
         for x = 1, args.width do
             for y = 1, args.height do
-                local entry = map[x][y] ---@type _pipe_map_entry|false
-                local char
-                local invert = false
-
-                if entry ~= false then
-                    local function check(cx, cy)
-                        return (map[cx] ~= nil) and (map[cx][cy] ~= nil) and (map[cx][cy] ~= false) and (map[cx][cy].fg == entry.fg)
-                    end
-
-                    if entry.thin then
-                        if check(x - 1, y) then -- if left
-                            if check(x, y - 1) then -- if above
-                                if check(x + 1, y) then -- if right
-                                    if check(x, y + 1) then -- if below
-                                        char = util.trinary(entry.atr, "\x91", "\x9d")
-                                        invert = entry.atr
-                                    else -- not below
-                                        char = util.trinary(entry.atr, "\x8e", "\x8d")
-                                    end
-                                else -- not right
-                                    if check(x, y + 1) then -- if below
-                                        char = util.trinary(entry.atr, "\x91", "\x95")
-                                        invert = entry.atr
-                                    else -- not below
-                                        char = util.trinary(entry.atr, "\x8e", "\x85")
-                                    end
-                                end
-                            elseif check(x, y + 1) then-- not above, if below
-                                if check(x + 1, y) then -- if right
-                                    char = util.trinary(entry.atr, "\x93", "\x9c")
-                                    invert = entry.atr
-                                else -- not right
-                                    char = util.trinary(entry.atr, "\x93", "\x94")
-                                    invert = entry.atr
-                                end
-                            else -- not above, not below
-                                char = "\x8c"
-                            end
-                        elseif check(x + 1, y) then -- not left, if right
-                            if check(x, y - 1) then -- if above
-                                if check(x, y + 1) then -- if below
-                                    char = util.trinary(entry.atr, "\x95", "\x9d")
-                                    invert = entry.atr
-                                else -- not below
-                                    char = util.trinary(entry.atr, "\x8a", "\x8d")
-                                end
-                            else -- not above
-                                if check(x, y + 1) then -- if below
-                                    char = util.trinary(entry.atr, "\x97", "\x9c")
-                                    invert = entry.atr
-                                else -- not below
-                                    char = "\x8c"
-                                end
-                            end
-                        else -- not left, not right
-                            char = "\x95"
-                            invert = entry.atr
-                        end
-                    else
-                        if check(x, y - 1) then -- above
-                            -- not below and (if left or right)
-                            if (not check(x, y + 1)) and (check(x - 1, y) or check(x + 1, y)) then
-                                char = util.trinary(entry.atr, "\x8f", " ")
-                                invert = not entry.atr
-                            else -- not below w/ sides only
-                                char = " "
-                                invert = true
-                            end
-                        elseif check(x, y + 1) then -- not above, if below
-                            -- if left or right
-                            if (check(x - 1, y) or check(x + 1, y)) then
-                                char = "\x83"
-                                invert = true
-                            else -- not left or right
-                                char = " "
-                                invert = true
-                            end
-                        else -- not above, not below
-                            char = util.trinary(entry.atr, "\x8f", "\x83")
-                            invert = not entry.atr
-                        end
-                    end
-
-                    e.window.setCursorPos(x, y)
-
-                    if invert then
-                        e.window.blit(char, entry.bg, entry.fg)
-                    else
-                        e.window.blit(char, entry.fg, entry.bg)
-                    end
-                end
+                if map[x][y] ~= false then draw_map_cell(map, x, y) end
             end
         end
     end
 
+    -- element redraw
+    function e.redraw()
+        if any_thin then map_draw() else vector_draw() end
+    end
+
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/rectangle.lua

@@ -22,7 +22,7 @@ local element = require("graphics.element")
 ---@param args rectangle_args
 ---@return graphics_element element, element_id id
 local function rectangle(args)
-    assert(args.border ~= nil or args.thin ~= true, "graphics.elements.rectangle: thin requires border to be provided")
+    element.assert(args.border ~= nil or args.thin ~= true, "thin requires border to be provided")
 
     -- if thin, then width will always need to be 1
     if args.thin == true then
@@ -56,7 +56,7 @@ local function rectangle(args)
     -- draw bordered box if requested
     -- element constructor will have drawn basic colored rectangle regardless
     if args.border ~= nil then
-        e.window.setCursorPos(1, 1)
+        e.w_set_cur(1, 1)
 
         local border_width = offset_x
         local border_height = offset_y
@@ -65,50 +65,50 @@ local function rectangle(args)
         local inner_width = e.frame.w - width_x2
 
         -- check dimensions
-        assert(width_x2 <= e.frame.w, "graphics.elements.rectangle: border too thick for width")
-        assert(width_x2 <= e.frame.h, "graphics.elements.rectangle: border too thick for height")
+        element.assert(width_x2 <= e.frame.w, "border too thick for width")
+        element.assert(width_x2 <= e.frame.h, "border too thick for height")
 
         -- form the basic line strings and top/bottom blit strings
         local spaces = util.spaces(e.frame.w)
-        local blit_fg = util.strrep(e.fg_bg.blit_fgd, e.frame.w)
+        local blit_fg = string.rep(e.fg_bg.blit_fgd, e.frame.w)
         local blit_fg_sides = blit_fg
         local blit_bg_sides = ""
-        local blit_bg_top_bot = util.strrep(border_blit, e.frame.w)
+        local blit_bg_top_bot = string.rep(border_blit, e.frame.w)
 
         -- partial bars
         local p_a, p_b, p_s
         if args.thin == true then
             if args.even_inner == true then
-                p_a = "\x9c" .. util.strrep("\x8c", inner_width) .. "\x93"
-                p_b = "\x8d" .. util.strrep("\x8c", inner_width) .. "\x8e"
+                p_a = "\x9c" .. string.rep("\x8c", inner_width) .. "\x93"
+                p_b = "\x8d" .. string.rep("\x8c", inner_width) .. "\x8e"
             else
-                p_a = "\x97" .. util.strrep("\x83", inner_width) .. "\x94"
-                p_b = "\x8a" .. util.strrep("\x8f", inner_width) .. "\x85"
+                p_a = "\x97" .. string.rep("\x83", inner_width) .. "\x94"
+                p_b = "\x8a" .. string.rep("\x8f", inner_width) .. "\x85"
             end
 
             p_s = "\x95" .. util.spaces(inner_width) .. "\x95"
         else
             if args.even_inner == true then
-                p_a = util.strrep("\x83", inner_width + width_x2)
-                p_b = util.strrep("\x8f", inner_width + width_x2)
+                p_a = string.rep("\x83", inner_width + width_x2)
+                p_b = string.rep("\x8f", inner_width + width_x2)
             else
-                p_a = util.spaces(border_width) .. util.strrep("\x8f", inner_width) .. util.spaces(border_width)
-                p_b = util.spaces(border_width) .. util.strrep("\x83", inner_width) .. util.spaces(border_width)
+                p_a = util.spaces(border_width) .. string.rep("\x8f", inner_width) .. util.spaces(border_width)
+                p_b = util.spaces(border_width) .. string.rep("\x83", inner_width) .. util.spaces(border_width)
             end
 
             p_s = spaces
         end
 
-        local p_inv_fg = util.strrep(border_blit, border_width) .. util.strrep(e.fg_bg.blit_bkg, inner_width) ..
-                            util.strrep(border_blit, border_width)
-        local p_inv_bg = util.strrep(e.fg_bg.blit_bkg, border_width) .. util.strrep(border_blit, inner_width) ..
-                            util.strrep(e.fg_bg.blit_bkg, border_width)
+        local p_inv_fg = string.rep(border_blit, border_width) .. string.rep(e.fg_bg.blit_bkg, inner_width) ..
+                            string.rep(border_blit, border_width)
+        local p_inv_bg = string.rep(e.fg_bg.blit_bkg, border_width) .. string.rep(border_blit, inner_width) ..
+                            string.rep(e.fg_bg.blit_bkg, border_width)
 
         if args.thin == true then
-            p_inv_fg = e.fg_bg.blit_bkg .. util.strrep(e.fg_bg.blit_bkg, inner_width) .. util.strrep(border_blit, border_width)
-            p_inv_bg = border_blit .. util.strrep(border_blit, inner_width) .. util.strrep(e.fg_bg.blit_bkg, border_width)
+            p_inv_fg = e.fg_bg.blit_bkg .. string.rep(e.fg_bg.blit_bkg, inner_width) .. string.rep(border_blit, border_width)
+            p_inv_bg = border_blit .. string.rep(border_blit, inner_width) .. string.rep(e.fg_bg.blit_bkg, border_width)
 
-            blit_fg_sides = border_blit .. util.strrep(e.fg_bg.blit_bkg, inner_width) .. e.fg_bg.blit_bkg
+            blit_fg_sides = border_blit .. string.rep(e.fg_bg.blit_bkg, inner_width) .. e.fg_bg.blit_bkg
         end
 
         -- form the body blit strings (sides are border, inside is normal)
@@ -126,64 +126,69 @@ local function rectangle(args)
         end
 
         -- draw rectangle with borders
-        for y = 1, e.frame.h do
-            e.window.setCursorPos(1, y)
-            -- top border
-            if y <= border_height then
-                -- partial pixel fill
-                if args.border.even and y == border_height then
-                    if args.thin == true then
-                        e.window.blit(p_a, p_inv_bg, p_inv_fg)
-                    else
-                        local _fg = util.trinary(args.even_inner == true, util.strrep(e.fg_bg.blit_bkg, e.frame.w), p_inv_bg)
-                        local _bg = util.trinary(args.even_inner == true, blit_bg_top_bot, p_inv_fg)
+        function e.redraw()
+            for y = 1, e.frame.h do
+                e.w_set_cur(1, y)
+                -- top border
+                if y <= border_height then
+                    -- partial pixel fill
+                    if args.border.even and y == border_height then
+                        if args.thin == true then
+                            e.w_blit(p_a, p_inv_bg, p_inv_fg)
+                        else
+                            local _fg = util.trinary(args.even_inner == true, string.rep(e.fg_bg.blit_bkg, e.frame.w), p_inv_bg)
+                            local _bg = util.trinary(args.even_inner == true, blit_bg_top_bot, p_inv_fg)
 
-                        if width_x2 % 3 == 1 then
-                            e.window.blit(p_b, _fg, _bg)
-                        elseif width_x2 % 3 == 2 then
-                            e.window.blit(p_a, _fg, _bg)
-                        else
-                            -- skip line
-                            e.window.blit(spaces, blit_fg, blit_bg_sides)
-                        end
-                    end
-                else
-                    e.window.blit(spaces, blit_fg, blit_bg_top_bot)
-                end
-            -- bottom border
-            elseif y > (e.frame.h - border_width) then
-                -- partial pixel fill
-                if args.border.even and y == ((e.frame.h - border_width) + 1) then
-                    if args.thin == true then
-                        if args.even_inner == true then
-                            e.window.blit(p_b, blit_bg_top_bot, util.strrep(e.fg_bg.blit_bkg, e.frame.w))
-                        else
-                            e.window.blit(p_b, util.strrep(e.fg_bg.blit_bkg, e.frame.w), blit_bg_top_bot)
+                            if width_x2 % 3 == 1 then
+                                e.w_blit(p_b, _fg, _bg)
+                            elseif width_x2 % 3 == 2 then
+                                e.w_blit(p_a, _fg, _bg)
+                            else
+                                -- skip line
+                                e.w_blit(spaces, blit_fg, blit_bg_sides)
+                            end
                         end
                     else
-                        local _fg = util.trinary(args.even_inner == true, blit_bg_top_bot, p_inv_fg)
-                        local _bg = util.trinary(args.even_inner == true, util.strrep(e.fg_bg.blit_bkg, e.frame.w), blit_bg_top_bot)
-
-                        if width_x2 % 3 == 1 then
-                            e.window.blit(p_a, _fg, _bg)
-                        elseif width_x2 % 3 == 2 then
-                            e.window.blit(p_b, _fg, _bg)
+                        e.w_blit(spaces, blit_fg, blit_bg_top_bot)
+                    end
+                -- bottom border
+                elseif y > (e.frame.h - border_width) then
+                    -- partial pixel fill
+                    if args.border.even and y == ((e.frame.h - border_width) + 1) then
+                        if args.thin == true then
+                            if args.even_inner == true then
+                                e.w_blit(p_b, blit_bg_top_bot, string.rep(e.fg_bg.blit_bkg, e.frame.w))
+                            else
+                                e.w_blit(p_b, string.rep(e.fg_bg.blit_bkg, e.frame.w), blit_bg_top_bot)
+                            end
                         else
-                            -- skip line
-                            e.window.blit(spaces, blit_fg, blit_bg_sides)
+                            local _fg = util.trinary(args.even_inner == true, blit_bg_top_bot, p_inv_fg)
+                            local _bg = util.trinary(args.even_inner == true, string.rep(e.fg_bg.blit_bkg, e.frame.w), blit_bg_top_bot)
+
+                            if width_x2 % 3 == 1 then
+                                e.w_blit(p_a, _fg, _bg)
+                            elseif width_x2 % 3 == 2 then
+                                e.w_blit(p_b, _fg, _bg)
+                            else
+                                -- skip line
+                                e.w_blit(spaces, blit_fg, blit_bg_sides)
+                            end
                         end
+                    else
+                        e.w_blit(spaces, blit_fg, blit_bg_top_bot)
                     end
                 else
-                    e.window.blit(spaces, blit_fg, blit_bg_top_bot)
-                end
-            else
-                if args.thin == true then
-                    e.window.blit(p_s, blit_fg_sides, blit_bg_sides)
-                else
-                    e.window.blit(p_s, blit_fg, blit_bg_sides)
+                    if args.thin == true then
+                        e.w_blit(p_s, blit_fg_sides, blit_bg_sides)
+                    else
+                        e.w_blit(p_s, blit_fg, blit_bg_sides)
+                    end
                 end
             end
         end
+
+        -- initial draw of border
+        e.redraw()
     end
 
     return e.complete()

graphics/elements/textbox.lua

@@ -5,11 +5,11 @@ local util    = require("scada-common.util")
 local core    = require("graphics.core")
 local element = require("graphics.element")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 ---@class textbox_args
 ---@field text string text to show
----@field alignment? TEXT_ALIGN text alignment, left by default
+---@field alignment? ALIGN text alignment, left by default
 ---@field parent graphics_element
 ---@field id? string element id
 ---@field x? integer 1 if omitted
@@ -24,19 +24,20 @@ local TEXT_ALIGN = core.TEXT_ALIGN
 ---@param args textbox_args
 ---@return graphics_element element, element_id id
 local function textbox(args)
-    assert(type(args.text) == "string", "graphics.elements.textbox: text is a required field")
+    element.assert(type(args.text) == "string", "text is a required field")
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    local alignment = args.alignment or TEXT_ALIGN.LEFT
+    e.value = args.text
+
+    local alignment = args.alignment or ALIGN.LEFT
 
     -- draw textbox
+    function e.redraw()
+        e.window.clear()
 
-    local function display_text(text)
-        e.value = text
-
-        local lines = util.strwrap(text, e.frame.w)
+        local lines = util.strwrap(e.value, e.frame.w)
 
         for i = 1, #lines do
             if i > e.frame.h then break end
@@ -44,27 +45,28 @@ local function textbox(args)
             local len = string.len(lines[i])
 
             -- use cursor position to align this line
-            if alignment == TEXT_ALIGN.CENTER then
-                e.window.setCursorPos(math.floor((e.frame.w - len) / 2) + 1, i)
-            elseif alignment == TEXT_ALIGN.RIGHT then
-                e.window.setCursorPos((e.frame.w - len) + 1, i)
+            if alignment == ALIGN.CENTER then
+                e.w_set_cur(math.floor((e.frame.w - len) / 2) + 1, i)
+            elseif alignment == ALIGN.RIGHT then
+                e.w_set_cur((e.frame.w - len) + 1, i)
             else
-                e.window.setCursorPos(1, i)
+                e.w_set_cur(1, i)
             end
 
-            e.window.write(lines[i])
+            e.w_write(lines[i])
         end
     end
 
-    display_text(args.text)
-
     -- set the string value and re-draw the text
     ---@param val string value
     function e.set_value(val)
-        e.window.clear()
-        display_text(val)
+        e.value = val
+        e.redraw()
     end
 
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/elements/tiling.lua

@@ -22,13 +22,11 @@ local element = require("graphics.element")
 ---@param args tiling_args
 ---@return graphics_element element, element_id id
 local function tiling(args)
-    assert(type(args.fill_c) == "table", "graphics.elements.tiling: fill_c is a required field")
+    element.assert(type(args.fill_c) == "table", "fill_c is a required field")
 
     -- create new graphics element base object
     local e = element.new(args)
 
-    -- draw tiling box
-
     local fill_a = args.fill_c.blit_a
     local fill_b = args.fill_c.blit_b
 
@@ -38,13 +36,9 @@ local function tiling(args)
     local start_y = 1
     local inner_width = math.floor(e.frame.w / util.trinary(even, 2, 1))
     local inner_height = e.frame.h
-    local alternator = true
 
     -- border
     if args.border_c ~= nil then
-        e.window.setBackgroundColor(args.border_c)
-        e.window.clear()
-
         start_x = 1 + util.trinary(even, 2, 1)
         start_y = 2
 
@@ -53,35 +47,48 @@ local function tiling(args)
     end
 
     -- check dimensions
-    assert(inner_width > 0, "graphics.elements.tiling: inner_width <= 0")
-    assert(inner_height > 0, "graphics.elements.tiling: inner_height <= 0")
-    assert(start_x <= inner_width, "graphics.elements.tiling: start_x > inner_width")
-    assert(start_y <= inner_height, "graphics.elements.tiling: start_y > inner_height")
+    element.assert(inner_width > 0, "inner_width <= 0")
+    element.assert(inner_height > 0, "inner_height <= 0")
+    element.assert(start_x <= inner_width, "start_x > inner_width")
+    element.assert(start_y <= inner_height, "start_y > inner_height")
 
-    -- create pattern
-    for y = start_y, inner_height + (start_y - 1) do
-        e.window.setCursorPos(start_x, y)
-        for _ = 1, inner_width do
-            if alternator then
-                if even then
-                    e.window.blit("  ", "00", fill_a .. fill_a)
-                else
-                    e.window.blit(" ", "0", fill_a)
-                end
-            else
-                if even then
-                    e.window.blit("  ", "00", fill_b .. fill_b)
-                else
-                    e.window.blit(" ", "0", fill_b)
-                end
-            end
+    -- draw tiling box
+    function e.redraw()
+        local alternator = true
 
-            alternator = not alternator
+        if args.border_c ~= nil then
+            e.w_set_bkg(args.border_c)
+            e.window.clear()
         end
 
-        if inner_width % 2 == 0 then alternator = not alternator end
+        -- draw pattern
+        for y = start_y, inner_height + (start_y - 1) do
+            e.w_set_cur(start_x, y)
+            for _ = 1, inner_width do
+                if alternator then
+                    if even then
+                        e.w_blit("  ", "00", fill_a .. fill_a)
+                    else
+                        e.w_blit(" ", "0", fill_a)
+                    end
+                else
+                    if even then
+                        e.w_blit("  ", "00", fill_b .. fill_b)
+                    else
+                        e.w_blit(" ", "0", fill_b)
+                    end
+                end
+
+                alternator = not alternator
+            end
+
+            if inner_width % 2 == 0 then alternator = not alternator end
+        end
     end
 
+    -- initial draw
+    e.redraw()
+
     return e.complete()
 end
 

graphics/events.lua

@@ -4,46 +4,77 @@
 
 local util = require("scada-common.util")
 
+local DOUBLE_CLICK_MS = 500
+
 local events = {}
 
 ---@enum CLICK_BUTTON
-events.CLICK_BUTTON = {
+local CLICK_BUTTON = {
     GENERIC = 0,
     LEFT_BUTTON = 1,
     RIGHT_BUTTON = 2,
     MID_BUTTON = 3
 }
 
----@enum CLICK_TYPE
-events.CLICK_TYPE = {
+events.CLICK_BUTTON = CLICK_BUTTON
+
+---@enum MOUSE_CLICK
+local MOUSE_CLICK = {
     TAP = 1,            -- screen tap (complete click)
     DOWN = 2,           -- button down
     UP = 3,             -- button up (completed a click)
     DRAG = 4,           -- mouse dragged
     SCROLL_DOWN = 5,    -- scroll down
-    SCROLL_UP = 6       -- scroll up
+    SCROLL_UP = 6,      -- scroll up
+    DOUBLE_CLICK = 7    -- double left click
 }
 
+events.MOUSE_CLICK = MOUSE_CLICK
+
+---@enum KEY_CLICK
+local KEY_CLICK = {
+    DOWN = 1,
+    HELD = 2,
+    UP = 3,
+    CHAR = 4
+}
+
+events.KEY_CLICK = KEY_CLICK
+
 -- create a new 2D coordinate
 ---@param x integer
 ---@param y integer
 ---@return coordinate_2d
 local function _coord2d(x, y) return { x = x, y = y } end
 
+events.new_coord_2d = _coord2d
+
 ---@class mouse_interaction
 ---@field monitor string
 ---@field button CLICK_BUTTON
----@field type CLICK_TYPE
+---@field type MOUSE_CLICK
 ---@field initial coordinate_2d
 ---@field current coordinate_2d
 
+---@class key_interaction
+---@field type KEY_CLICK
+---@field key number key code
+---@field name string key character name
+---@field shift boolean shift held
+---@field ctrl boolean ctrl held
+---@field alt boolean alt held
+
 local handler = {
     -- left, right, middle button down tracking
-    button_down = {
-        _coord2d(0, 0),
-        _coord2d(0, 0),
-        _coord2d(0, 0)
-    }
+    button_down = { _coord2d(0, 0), _coord2d(0, 0), _coord2d(0, 0) },
+    -- keyboard modifiers
+    shift = false,
+    alt = false,
+    ctrl = false,
+    -- double click tracking
+    dc_start = 0,
+    dc_step = 1,
+    dc_coord = _coord2d(0, 0)
 }
 
 -- create a new monitor touch mouse interaction event
@@ -55,8 +86,8 @@ local handler = {
 local function _monitor_touch(monitor, x, y)
     return {
         monitor = monitor,
-        button = events.CLICK_BUTTON.GENERIC,
-        type = events.CLICK_TYPE.TAP,
+        button = CLICK_BUTTON.GENERIC,
+        type = MOUSE_CLICK.TAP,
         initial = _coord2d(x, y),
         current = _coord2d(x, y)
     }
@@ -65,7 +96,7 @@ end
 -- create a new mouse button mouse interaction event
 ---@nodiscard
 ---@param button CLICK_BUTTON mouse button
----@param type CLICK_TYPE click type
+---@param type MOUSE_CLICK click type
 ---@param x1 integer initial x
 ---@param y1 integer initial y
 ---@param x2 integer current x
@@ -83,14 +114,14 @@ end
 
 -- create a new generic mouse interaction event
 ---@nodiscard
----@param type CLICK_TYPE
+---@param type MOUSE_CLICK
 ---@param x integer
 ---@param y integer
 ---@return mouse_interaction
 function events.mouse_generic(type, x, y)
     return {
         monitor = "",
-        button = events.CLICK_BUTTON.GENERIC,
+        button = CLICK_BUTTON.GENERIC,
         type = type,
         initial = _coord2d(x, y),
         current = _coord2d(x, y)
@@ -115,8 +146,8 @@ end
 
 -- check if an event qualifies as a click (tap or up)
 ---@nodiscard
----@param t CLICK_TYPE
-function events.was_clicked(t) return t == events.CLICK_TYPE.TAP or t == events.CLICK_TYPE.UP end
+---@param t MOUSE_CLICK
+function events.was_clicked(t) return t == MOUSE_CLICK.TAP or t == MOUSE_CLICK.UP end
 
 -- create a new mouse event to pass onto graphics renderer<br>
 -- supports: mouse_click, mouse_up, mouse_drag, mouse_scroll, and monitor_touch
@@ -126,35 +157,97 @@ function events.was_clicked(t) return t == events.CLICK_TYPE.TAP or t == events.
 ---@param y integer y coordinate
 ---@return mouse_interaction|nil
 function events.new_mouse_event(event_type, opt, x, y)
+    local h = handler
+
     if event_type == "mouse_click" then
         ---@cast opt 1|2|3
-        handler.button_down[opt] = _coord2d(x, y)
-        return _mouse_event(opt, events.CLICK_TYPE.DOWN, x, y, x, y)
+
+        local init = true
+
+        if opt == 1 and (h.dc_step % 2) == 1 then
+            if h.dc_step ~= 1 and h.dc_coord.x == x and h.dc_coord.y == y and (util.time_ms() - h.dc_start) < DOUBLE_CLICK_MS then
+                init = false
+                h.dc_step = h.dc_step + 1
+            end
+        end
+
+        if init then
+            h.dc_start = util.time_ms()
+            h.dc_coord = _coord2d(x, y)
+            h.dc_step = 2
+        end
+
+        h.button_down[opt] = _coord2d(x, y)
+        return _mouse_event(opt, MOUSE_CLICK.DOWN, x, y, x, y)
     elseif event_type == "mouse_up" then
         ---@cast opt 1|2|3
-        local initial = handler.button_down[opt]    ---@type coordinate_2d
-        return _mouse_event(opt, events.CLICK_TYPE.UP, initial.x, initial.y, x, y)
+
+        if opt == 1 and (h.dc_step % 2) == 0 and h.dc_coord.x == x and h.dc_coord.y == y and
+                (util.time_ms() - h.dc_start) < DOUBLE_CLICK_MS then
+            if h.dc_step == 4 then
+                util.push_event("double_click", 1, x, y)
+                h.dc_step = 1
+            else h.dc_step = h.dc_step + 1 end
+        else h.dc_step = 1 end
+
+        local initial = h.button_down[opt]    ---@type coordinate_2d
+        return _mouse_event(opt, MOUSE_CLICK.UP, initial.x, initial.y, x, y)
     elseif event_type == "monitor_touch" then
         ---@cast opt string
         return _monitor_touch(opt, x, y)
     elseif event_type == "mouse_drag" then
         ---@cast opt 1|2|3
-        local initial = handler.button_down[opt]    ---@type coordinate_2d
-        return _mouse_event(opt, events.CLICK_TYPE.DRAG, initial.x, initial.y, x, y)
+        local initial = h.button_down[opt]    ---@type coordinate_2d
+        return _mouse_event(opt, MOUSE_CLICK.DRAG, initial.x, initial.y, x, y)
     elseif event_type == "mouse_scroll" then
         ---@cast opt 1|-1
-        local scroll_direction = util.trinary(opt == 1, events.CLICK_TYPE.SCROLL_DOWN, events.CLICK_TYPE.SCROLL_UP)
-        return _mouse_event(events.CLICK_BUTTON.GENERIC, scroll_direction, x, y, x, y)
+        local scroll_direction = util.trinary(opt == 1, MOUSE_CLICK.SCROLL_DOWN, MOUSE_CLICK.SCROLL_UP)
+        return _mouse_event(CLICK_BUTTON.GENERIC, scroll_direction, x, y, x, y)
+    elseif event_type == "double_click" then
+        return _mouse_event(CLICK_BUTTON.LEFT_BUTTON, MOUSE_CLICK.DOUBLE_CLICK, x, y, x, y)
     end
 end
 
--- create a new key event to pass onto graphics renderer<br>
+-- create a new keyboard interaction event
+---@nodiscard
+---@param click_type KEY_CLICK key click type
+---@param key integer|string keyboard key code or character for 'char' event
+---@return key_interaction
+local function _key_event(click_type, key)
+    local name = key
+    if type(key) == "number" then name = keys.getName(key) end
+    return { type = click_type, key = key, name = name, shift = handler.shift, ctrl = handler.ctrl, alt = handler.alt }
+end
+
+-- create a new keyboard event to pass onto graphics renderer<br>
 -- supports: char, key, and key_up
----@param event_type os_event
-function events.new_key_event(event_type)
+---@param event_type os_event OS event to handle
+---@param key integer keyboard key code
+---@param held boolean? if the key is being held (for 'key' event)
+---@return key_interaction|nil
+function events.new_key_event(event_type, key, held)
     if event_type == "char" then
+        return _key_event(KEY_CLICK.CHAR, key)
     elseif event_type == "key" then
+        if key == keys.leftShift or key == keys.rightShift then
+            handler.shift = true
+        elseif key == keys.leftCtrl or key == keys.rightCtrl then
+            handler.ctrl = true
+        elseif key == keys.leftAlt or key == keys.rightAlt then
+            handler.alt = true
+        else
+            return _key_event(util.trinary(held, KEY_CLICK.HELD, KEY_CLICK.DOWN), key)
+        end
     elseif event_type == "key_up" then
+        if key == keys.leftShift or key == keys.rightShift then
+            handler.shift = false
+        elseif key == keys.leftCtrl or key == keys.rightCtrl then
+            handler.ctrl = false
+        elseif key == keys.leftAlt or key == keys.rightAlt then
+            handler.alt = false
+        else
+            return _key_event(KEY_CLICK.UP, key)
+        end
     end
 end
 

imgen.py

@@ -60,7 +60,7 @@ def make_manifest(size):
         },
         "files" : {
             # common files
-            "system" : [ "initenv.lua", "startup.lua" ],
+            "system" : [ "initenv.lua", "startup.lua", "configure.lua", "LICENSE" ],
             "common" : list_files("./scada-common"),
             "graphics" : list_files("./graphics"),
             "lockbox" : list_files("./lockbox"),
@@ -82,7 +82,7 @@ def make_manifest(size):
             # manifest file estimate
             "manifest" : size,
             # common files
-            "system" : os.path.getsize("initenv.lua") + os.path.getsize("startup.lua"),
+            "system" : os.path.getsize("initenv.lua") + os.path.getsize("startup.lua") + os.path.getsize("configure.lua"),
             "common" : dir_size("./scada-common"),
             "graphics" : dir_size("./graphics"),
             "lockbox" : dir_size("./lockbox"),

initenv.lua

@@ -1,18 +1,8 @@
---
--- Initialize the Post-Boot Module Environment
---
-
 return {
-    -- initialize booted environment
-    init_env = function ()
-        local _require = require("cc.require")
-        local _env = setmetatable({}, { __index = _ENV })
-
-        -- overwrite require/package globals
-        require, package = _require.make(_env, "/")
-
-        -- reset terminal
-        term.clear()
-        term.setCursorPos(1, 1)
-    end
+-- initialize booted environment
+init_env = function ()
+    local _require, _env = require("cc.require"), setmetatable({}, { __index = _ENV })
+    require, package = _require.make(_env, "/")
+    term.clear(); term.setCursorPos(1, 1)
+end
 }

lockbox/digest/md5.lua

@@ -1,5 +1,3 @@
-require("lockbox").insecure();
-
 local Bit = require("lockbox.util.bit");
 local String = require("string");
 local Math = require("math");

lockbox/digest/sha1.lua

@@ -1,5 +1,3 @@
-require("lockbox").insecure();
-
 local Bit = require("lockbox.util.bit");
 local String = require("string");
 local Math = require("math");

lockbox/init.lua

@@ -1,25 +1,6 @@
-local Lockbox = {};
+local Lockbox = {}
 
 -- cc-mek-scada lockbox version
-Lockbox.version = "1.0"
+Lockbox.version = "1.1"
 
---[[
-package.path =  "./?.lua;"
-                .. "./cipher/?.lua;"
-                .. "./digest/?.lua;"
-                .. "./kdf/?.lua;"
-                .. "./mac/?.lua;"
-                .. "./padding/?.lua;"
-                .. "./test/?.lua;"
-                .. "./util/?.lua;"
-                .. package.path;
---]]
-Lockbox.ALLOW_INSECURE = true;
-
-Lockbox.insecure = function()
-    assert(Lockbox.ALLOW_INSECURE,
-            "This module is insecure!  It should not be used in production." ..
-            "If you really want to use it, set Lockbox.ALLOW_INSECURE to true before importing it");
-end
-
-return Lockbox;
+return Lockbox

lockbox/mac/hmac.lua

@@ -8,7 +8,7 @@ local HMAC = function()
 
     local public = {};
     local blockSize = 64;
-    local Digest = nil;
+    local Digest;
     local outerPadding = {};
     local innerPadding = {}
     local digest;

lockbox/util/array.lua

@@ -1,4 +1,3 @@
-
 local String = require("string");
 local Bit = require("lockbox.util.bit");
 local Queue = require("lockbox.util.queue");

pocket/config.lua

@@ -1,27 +0,0 @@
-local config = {}
-
--- supervisor comms channel
-config.SVR_CHANNEL = 16240
--- coordinator comms channel
-config.CRD_CHANNEL = 16243
--- pocket comms channel
-config.PKT_CHANNEL = 16244
--- max trusted modem message distance (0 to disable check)
-config.TRUSTED_RANGE = 0
--- time in seconds (>= 2) before assuming a remote device is no longer active
-config.COMMS_TIMEOUT = 5
--- facility authentication key (do NOT use one of your passwords)
--- this enables verifying that messages are authentic
--- all devices on the same network must use the same key
--- config.AUTH_KEY = "SCADAfacility123"
-
--- log path
-config.LOG_PATH = "/log.txt"
--- log mode
---  0 = APPEND (adds to existing file on start)
---  1 = NEW (replaces existing file on start)
-config.LOG_MODE = 0
--- true to log verbose debug messages
-config.LOG_DEBUG = false
-
-return config

pocket/configure.lua

@@ -0,0 +1,578 @@
+--
+-- Configuration GUI
+--
+
+local log         = require("scada-common.log")
+local tcd         = require("scada-common.tcd")
+local util        = require("scada-common.util")
+
+local core        = require("graphics.core")
+
+local DisplayBox  = require("graphics.elements.displaybox")
+local Div         = require("graphics.elements.div")
+local ListBox     = require("graphics.elements.listbox")
+local MultiPane   = require("graphics.elements.multipane")
+local TextBox     = require("graphics.elements.textbox")
+
+local CheckBox    = require("graphics.elements.controls.checkbox")
+local PushButton  = require("graphics.elements.controls.push_button")
+local RadioButton = require("graphics.elements.controls.radio_button")
+
+local NumberField = require("graphics.elements.form.number_field")
+local TextField   = require("graphics.elements.form.text_field")
+
+local println = util.println
+local tri = util.trinary
+
+local cpair = core.cpair
+
+local LEFT = core.ALIGN.LEFT
+local CENTER = core.ALIGN.CENTER
+local RIGHT = core.ALIGN.RIGHT
+
+-- changes to the config data/format to let the user know
+local changes = {}
+
+---@class pkt_configurator
+local configurator = {}
+
+local style = {}
+
+style.root = cpair(colors.black, colors.lightGray)
+style.header = cpair(colors.white, colors.gray)
+
+style.colors = {
+    { c = colors.red,       hex = 0xdf4949 },
+    { c = colors.orange,    hex = 0xffb659 },
+    { c = colors.yellow,    hex = 0xfffc79 },
+    { c = colors.lime,      hex = 0x80ff80 },
+    { c = colors.green,     hex = 0x4aee8a },
+    { c = colors.cyan,      hex = 0x34bac8 },
+    { c = colors.lightBlue, hex = 0x6cc0f2 },
+    { c = colors.blue,      hex = 0x0096ff },
+    { c = colors.purple,    hex = 0xb156ee },
+    { c = colors.pink,      hex = 0xf26ba2 },
+    { c = colors.magenta,   hex = 0xf9488a },
+    { c = colors.lightGray, hex = 0xcacaca },
+    { c = colors.gray,      hex = 0x575757 }
+}
+
+local bw_fg_bg = cpair(colors.black, colors.white)
+local g_lg_fg_bg = cpair(colors.gray, colors.lightGray)
+local nav_fg_bg = bw_fg_bg
+local btn_act_fg_bg = cpair(colors.white, colors.gray)
+local dis_fg_bg = cpair(colors.lightGray,colors.white)
+
+local tool_ctl = {
+    ask_config = false,
+    has_config = false,
+    viewing_config = false,
+    importing_legacy = false,
+
+    view_cfg = nil,         ---@type graphics_element
+    settings_apply = nil,   ---@type graphics_element
+
+    set_networked = nil,    ---@type function
+    bundled_emcool = nil,   ---@type function
+    gen_summary = nil,      ---@type function
+    show_current_cfg = nil, ---@type function
+    load_legacy = nil,      ---@type function
+
+    show_auth_key = nil,    ---@type function
+    show_key_btn = nil,     ---@type graphics_element
+    auth_key_textbox = nil, ---@type graphics_element
+    auth_key_value = ""
+}
+
+---@class pkt_config
+local tmp_cfg = {
+    SVR_Channel = nil,  ---@type integer
+    CRD_Channel = nil,  ---@type integer
+    PKT_Channel = nil,  ---@type integer
+    ConnTimeout = nil,  ---@type number
+    TrustedRange = nil, ---@type number
+    AuthKey = nil,      ---@type string|nil
+    LogMode = 0,
+    LogPath = "",
+    LogDebug = false,
+}
+
+---@class pkt_config
+local ini_cfg = {}
+---@class pkt_config
+local settings_cfg = {}
+
+-- all settings fields, their nice names, and their default values
+local fields = {
+    { "SVR_Channel", "SVR Channel", 16240 },
+    { "CRD_Channel", "CRD Channel", 16243 },
+    { "PKT_Channel", "PKT Channel", 16244 },
+    { "ConnTimeout", "Connection Timeout", 5 },
+    { "TrustedRange", "Trusted Range", 0 },
+    { "AuthKey", "Facility Auth Key" , ""},
+    { "LogMode", "Log Mode", log.MODE.APPEND },
+    { "LogPath", "Log Path", "/log.txt" },
+    { "LogDebug","Log Debug Messages", false }
+}
+
+-- load data from the settings file
+---@param target pkt_config
+---@param raw boolean? true to not use default values
+local function load_settings(target, raw)
+    for _, v in pairs(fields) do settings.unset(v[1]) end
+
+    local loaded = settings.load("/pocket.settings")
+
+    for _, v in pairs(fields) do target[v[1]] = settings.get(v[1], tri(raw, nil, v[3])) end
+
+    return loaded
+end
+
+-- create the config view
+---@param display graphics_element
+local function config_view(display)
+---@diagnostic disable-next-line: undefined-field
+    local function exit() os.queueEvent("terminate") end
+
+    TextBox{parent=display,y=1,text="Pocket Configurator",alignment=CENTER,height=1,fg_bg=style.header}
+
+    local root_pane_div = Div{parent=display,x=1,y=2}
+
+    local main_page = Div{parent=root_pane_div,x=1,y=1}
+    local net_cfg = Div{parent=root_pane_div,x=1,y=1}
+    local log_cfg = Div{parent=root_pane_div,x=1,y=1}
+    local summary = Div{parent=root_pane_div,x=1,y=1}
+    local changelog = Div{parent=root_pane_div,x=1,y=1}
+
+    local main_pane = MultiPane{parent=root_pane_div,x=1,y=1,panes={main_page,net_cfg,log_cfg,summary,changelog}}
+
+    -- Main Page
+
+    local y_start = 7
+
+    TextBox{parent=main_page,x=2,y=2,height=4,text="Welcome to the Pocket configurator! Please select one of the following options."}
+
+    if tool_ctl.ask_config then
+        TextBox{parent=main_page,x=2,y=y_start,height=4,width=49,text="Please configure before starting up.",fg_bg=cpair(colors.red,colors.lightGray)}
+        y_start = y_start + 3
+    end
+
+    local function view_config()
+        tool_ctl.viewing_config = true
+        tool_ctl.gen_summary(settings_cfg)
+        tool_ctl.settings_apply.hide(true)
+        main_pane.set_value(4)
+    end
+
+    if fs.exists("/pocket/config.lua") then
+        PushButton{parent=main_page,x=2,y=y_start,min_width=22,text="Import Legacy Config",callback=function()tool_ctl.load_legacy()end,fg_bg=cpair(colors.black,colors.cyan),active_fg_bg=btn_act_fg_bg}
+        y_start = y_start + 2
+    end
+
+    PushButton{parent=main_page,x=2,y=y_start,min_width=18,text="Configure Device",callback=function()main_pane.set_value(2)end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg}
+    tool_ctl.view_cfg = PushButton{parent=main_page,x=2,y=y_start+2,min_width=20,text="View Configuration",callback=view_config,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg,dis_fg_bg=dis_fg_bg}
+
+    if not tool_ctl.has_config then tool_ctl.view_cfg.disable() end
+
+    PushButton{parent=main_page,x=2,y=18,min_width=6,text="Exit",callback=exit,fg_bg=cpair(colors.black,colors.red),active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=main_page,x=14,y=18,min_width=12,text="Change Log",callback=function()main_pane.set_value(5)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#region Network
+
+    local net_c_1 = Div{parent=net_cfg,x=2,y=4,width=24}
+    local net_c_2 = Div{parent=net_cfg,x=2,y=4,width=24}
+    local net_c_3 = Div{parent=net_cfg,x=2,y=4,width=24}
+    local net_c_4 = Div{parent=net_cfg,x=2,y=4,width=24}
+
+    local net_pane = MultiPane{parent=net_cfg,x=1,y=4,panes={net_c_1,net_c_2,net_c_3,net_c_4}}
+
+    TextBox{parent=net_cfg,x=1,y=2,height=1,text=" Network Configuration",fg_bg=cpair(colors.black,colors.lightBlue)}
+
+    TextBox{parent=net_c_1,x=1,y=1,height=1,text="Set network channels."}
+    TextBox{parent=net_c_1,x=1,y=3,height=4,text="Each of the named channels must be the same within a particular SCADA network.",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_1,x=1,y=8,height=1,width=18,text="Supervisor Channel"}
+    local svr_chan = NumberField{parent=net_c_1,x=1,y=9,width=7,default=ini_cfg.SVR_Channel,min=1,max=65535,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_1,x=9,y=9,height=4,text="[SVR_CHANNEL]",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_1,x=1,y=10,height=1,width=19,text="Coordinator Channel"}
+    local crd_chan = NumberField{parent=net_c_1,x=1,y=11,width=7,default=ini_cfg.CRD_Channel,min=1,max=65535,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_1,x=9,y=11,height=4,text="[CRD_CHANNEL]",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_1,x=1,y=12,height=1,width=14,text="Pocket Channel"}
+    local pkt_chan = NumberField{parent=net_c_1,x=1,y=13,width=7,default=ini_cfg.PKT_Channel,min=1,max=65535,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_1,x=9,y=13,height=4,text="[PKT_CHANNEL]",fg_bg=g_lg_fg_bg}
+
+    local chan_err = TextBox{parent=net_c_1,x=1,y=14,height=1,width=24,text="Please set all channels.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_channels()
+        local svr_c, crd_c, pkt_c = tonumber(svr_chan.get_value()), tonumber(crd_chan.get_value()), tonumber(pkt_chan.get_value())
+        if svr_c ~= nil and crd_c ~= nil and pkt_c ~= nil then
+            tmp_cfg.SVR_Channel, tmp_cfg.CRD_Channel, tmp_cfg.PKT_Channel = svr_c, crd_c, pkt_c
+            net_pane.set_value(2)
+            chan_err.hide(true)
+        else chan_err.show() end
+    end
+
+    PushButton{parent=net_c_1,x=1,y=15,text="\x1b Back",callback=function()main_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=net_c_1,x=19,y=15,text="Next \x1a",callback=submit_channels,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=net_c_2,x=1,y=1,height=1,text="Set connection timeout."}
+    TextBox{parent=net_c_2,x=1,y=3,height=7,text="You generally should not need to modify this. On slow servers, you can try to increase this to make the system wait longer before assuming a disconnection.",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_2,x=1,y=11,height=1,width=19,text="Connection Timeout"}
+    local timeout = NumberField{parent=net_c_2,x=1,y=12,width=7,default=ini_cfg.ConnTimeout,min=2,max=25,max_chars=6,max_frac_digits=2,allow_decimal=true,fg_bg=bw_fg_bg}
+
+    TextBox{parent=net_c_2,x=9,y=12,height=2,text="seconds\n(default 5)",fg_bg=g_lg_fg_bg}
+
+    local ct_err = TextBox{parent=net_c_2,x=1,y=14,height=1,width=24,text="Please set timeout.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_timeouts()
+        local timeout_val = tonumber(timeout.get_value())
+        if timeout_val ~= nil then
+            tmp_cfg.ConnTimeout = timeout_val
+            net_pane.set_value(3)
+            ct_err.hide(true)
+        else ct_err.show() end
+    end
+
+    PushButton{parent=net_c_2,x=1,y=15,text="\x1b Back",callback=function()net_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=net_c_2,x=19,y=15,text="Next \x1a",callback=submit_timeouts,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=net_c_3,x=1,y=1,height=1,text="Set the trusted range."}
+    TextBox{parent=net_c_3,x=1,y=3,height=4,text="Setting this to a value larger than 0 prevents connections with devices that many blocks away.",fg_bg=g_lg_fg_bg}
+    TextBox{parent=net_c_3,x=1,y=8,height=4,text="This is optional. You can disable this functionality by setting the value to 0.",fg_bg=g_lg_fg_bg}
+
+    local range = NumberField{parent=net_c_3,x=1,y=13,width=10,default=ini_cfg.TrustedRange,min=0,max_chars=20,allow_decimal=true,fg_bg=bw_fg_bg}
+
+    local tr_err = TextBox{parent=net_c_3,x=1,y=14,height=1,width=24,text="Set the trusted range.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_tr()
+        local range_val = tonumber(range.get_value())
+        if range_val ~= nil then
+            tmp_cfg.TrustedRange = range_val
+            net_pane.set_value(4)
+            tr_err.hide(true)
+        else tr_err.show() end
+    end
+
+    PushButton{parent=net_c_3,x=1,y=15,text="\x1b Back",callback=function()net_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=net_c_3,x=19,y=15,text="Next \x1a",callback=submit_tr,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=net_c_4,x=1,y=1,height=4,text="Optionally, set the facility authentication key. Do NOT use one of your passwords."}
+    TextBox{parent=net_c_4,x=1,y=6,height=6,text="This enables verifying that messages are authentic, so it is intended for security on multiplayer servers.",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_4,x=1,y=12,height=1,text="Facility Auth Key"}
+    local key, _, censor = TextField{parent=net_c_4,x=1,y=13,max_len=64,value=ini_cfg.AuthKey,width=24,height=1,fg_bg=bw_fg_bg}
+
+    local function censor_key(enable) censor(util.trinary(enable, "*", nil)) end
+
+    -- declare back first so tabbing makes sense visually
+    PushButton{parent=net_c_4,x=1,y=15,text="\x1b Back",callback=function()net_pane.set_value(3)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    local hide_key = CheckBox{parent=net_c_4,x=8,y=15,label="Hide Key",box_fg_bg=cpair(colors.lightBlue,colors.black),callback=censor_key}
+
+    hide_key.set_value(true)
+    censor_key(true)
+
+    local key_err = TextBox{parent=net_c_4,x=1,y=14,height=1,width=24,text="Length must be > 7.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_auth()
+        local v = key.get_value()
+        if string.len(v) == 0 or string.len(v) >= 8 then
+            tmp_cfg.AuthKey = key.get_value()
+            main_pane.set_value(3)
+            key_err.hide(true)
+        else key_err.show() end
+    end
+
+    PushButton{parent=net_c_4,x=19,y=15,text="Next \x1a",callback=submit_auth,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#endregion
+
+    --#region Logging
+
+    local log_c_1 = Div{parent=log_cfg,x=2,y=4,width=24}
+
+    TextBox{parent=log_cfg,x=1,y=2,height=1,text=" Logging Configuration",fg_bg=cpair(colors.black,colors.pink)}
+
+    TextBox{parent=log_c_1,x=1,y=1,height=1,text="Configure logging below."}
+
+    TextBox{parent=log_c_1,x=1,y=3,height=1,text="Log File Mode"}
+    local mode = RadioButton{parent=log_c_1,x=1,y=4,default=ini_cfg.LogMode+1,options={"Append on Startup","Replace on Startup"},callback=function()end,radio_colors=cpair(colors.lightGray,colors.black),select_color=colors.pink}
+
+    TextBox{parent=log_c_1,x=1,y=7,height=1,text="Log File Path"}
+    local path = TextField{parent=log_c_1,x=1,y=8,width=24,height=1,value=ini_cfg.LogPath,max_len=128,fg_bg=bw_fg_bg}
+
+    local en_dbg = CheckBox{parent=log_c_1,x=1,y=10,default=ini_cfg.LogDebug,label="Enable Debug Messages",box_fg_bg=cpair(colors.pink,colors.black)}
+    TextBox{parent=log_c_1,x=3,y=11,height=4,text="This results in much larger log files. Use only as needed.",fg_bg=g_lg_fg_bg}
+
+    local path_err = TextBox{parent=log_c_1,x=1,y=14,height=1,width=24,text="Provide a log file path.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_log()
+        if path.get_value() ~= "" then
+            path_err.hide(true)
+            tmp_cfg.LogMode = mode.get_value() - 1
+            tmp_cfg.LogPath = path.get_value()
+            tmp_cfg.LogDebug = en_dbg.get_value()
+            tool_ctl.gen_summary(tmp_cfg)
+            tool_ctl.viewing_config = false
+            tool_ctl.importing_legacy = false
+            tool_ctl.settings_apply.show()
+            main_pane.set_value(4)
+        else path_err.show() end
+    end
+
+    PushButton{parent=log_c_1,x=1,y=15,text="\x1b Back",callback=function()main_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=log_c_1,x=19,y=15,text="Next \x1a",callback=submit_log,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#endregion
+
+    --#region Summary and Saving
+
+    local sum_c_1 = Div{parent=summary,x=2,y=4,width=24}
+    local sum_c_2 = Div{parent=summary,x=2,y=4,width=24}
+    local sum_c_3 = Div{parent=summary,x=2,y=4,width=24}
+    local sum_c_4 = Div{parent=summary,x=2,y=4,width=24}
+
+    local sum_pane = MultiPane{parent=summary,x=1,y=4,panes={sum_c_1,sum_c_2,sum_c_3,sum_c_4}}
+
+    TextBox{parent=summary,x=1,y=2,height=1,text=" Summary",fg_bg=cpair(colors.black,colors.green)}
+
+    local setting_list = ListBox{parent=sum_c_1,x=1,y=1,height=11,width=24,scroll_height=100,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)}
+
+    local function back_from_summary()
+        if tool_ctl.viewing_config or tool_ctl.importing_legacy then
+            main_pane.set_value(1)
+            tool_ctl.viewing_config = false
+            tool_ctl.importing_legacy = false
+            tool_ctl.settings_apply.show()
+        else
+            main_pane.set_value(3)
+        end
+    end
+
+    ---@param element graphics_element
+    ---@param data any
+    local function try_set(element, data)
+        if data ~= nil then element.set_value(data) end
+    end
+
+    local function save_and_continue()
+        for k, v in pairs(tmp_cfg) do settings.set(k, v) end
+
+        if settings.save("/pocket.settings") then
+            load_settings(settings_cfg, true)
+            load_settings(ini_cfg)
+
+            try_set(svr_chan, ini_cfg.SVR_Channel)
+            try_set(crd_chan, ini_cfg.CRD_Channel)
+            try_set(pkt_chan, ini_cfg.PKT_Channel)
+            try_set(timeout, ini_cfg.ConnTimeout)
+            try_set(range, ini_cfg.TrustedRange)
+            try_set(key, ini_cfg.AuthKey)
+            try_set(mode, ini_cfg.LogMode)
+            try_set(path, ini_cfg.LogPath)
+            try_set(en_dbg, ini_cfg.LogDebug)
+
+            tool_ctl.view_cfg.enable()
+
+            if tool_ctl.importing_legacy then
+                tool_ctl.importing_legacy = false
+                sum_pane.set_value(3)
+            else
+                sum_pane.set_value(2)
+            end
+        else
+            sum_pane.set_value(4)
+        end
+    end
+
+    PushButton{parent=sum_c_1,x=1,y=15,text="\x1b Back",callback=back_from_summary,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    tool_ctl.show_key_btn = PushButton{parent=sum_c_1,x=1,y=13,min_width=17,text="Unhide Auth Key",callback=function()tool_ctl.show_auth_key()end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg,dis_fg_bg=dis_fg_bg}
+    tool_ctl.settings_apply = PushButton{parent=sum_c_1,x=18,y=15,min_width=7,text="Apply",callback=save_and_continue,fg_bg=cpair(colors.black,colors.green),active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=sum_c_2,x=1,y=1,height=1,text="Settings saved!"}
+
+    local function go_home()
+        main_pane.set_value(1)
+        net_pane.set_value(1)
+        sum_pane.set_value(1)
+    end
+
+    PushButton{parent=sum_c_2,x=1,y=15,min_width=6,text="Home",callback=go_home,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=sum_c_2,x=19,y=15,min_width=6,text="Exit",callback=exit,fg_bg=cpair(colors.black,colors.red),active_fg_bg=cpair(colors.white,colors.gray)}
+
+    TextBox{parent=sum_c_3,x=1,y=1,height=4,text="The old config.lua file will now be deleted, then the configurator will exit."}
+
+    local function delete_legacy()
+        fs.delete("/pocket/config.lua")
+        exit()
+    end
+
+    PushButton{parent=sum_c_3,x=1,y=15,min_width=8,text="Cancel",callback=go_home,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=sum_c_3,x=19,y=15,min_width=6,text="OK",callback=delete_legacy,fg_bg=cpair(colors.black,colors.green),active_fg_bg=cpair(colors.white,colors.gray)}
+
+    TextBox{parent=sum_c_4,x=1,y=1,height=8,text="Failed to save the settings file.\n\nThere may not be enough space for the modification or server file permissions may be denying writes."}
+    PushButton{parent=sum_c_4,x=1,y=15,min_width=6,text="Home",callback=go_home,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=sum_c_4,x=19,y=15,min_width=6,text="Exit",callback=exit,fg_bg=cpair(colors.black,colors.red),active_fg_bg=cpair(colors.white,colors.gray)}
+
+    --#endregion
+
+    -- Config Change Log
+
+    local cl = Div{parent=changelog,x=2,y=4,width=24}
+
+    TextBox{parent=changelog,x=1,y=2,height=1,text=" Config Change Log",fg_bg=bw_fg_bg}
+
+    local c_log = ListBox{parent=cl,x=1,y=1,height=13,width=24,scroll_height=100,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)}
+
+    for _, change in ipairs(changes) do
+        TextBox{parent=c_log,text=change[1],height=1,fg_bg=bw_fg_bg}
+        for _, v in ipairs(change[2]) do
+            local e = Div{parent=c_log,height=#util.strwrap(v,21)}
+            TextBox{parent=e,y=1,x=1,text="- ",height=1,fg_bg=cpair(colors.gray,colors.white)}
+            TextBox{parent=e,y=1,x=3,text=v,height=e.get_height(),fg_bg=cpair(colors.gray,colors.white)}
+        end
+    end
+
+    PushButton{parent=cl,x=1,y=15,text="\x1b Back",callback=function()main_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    -- set tool functions now that we have the elements
+
+    -- load a legacy config file
+    function tool_ctl.load_legacy()
+        local config = require("pocket.config")
+
+        tmp_cfg.SVR_Channel = config.SVR_CHANNEL
+        tmp_cfg.CRD_Channel = config.CRD_CHANNEL
+        tmp_cfg.PKT_Channel = config.PKT_CHANNEL
+        tmp_cfg.ConnTimeout = config.COMMS_TIMEOUT
+        tmp_cfg.TrustedRange = config.TRUSTED_RANGE
+        tmp_cfg.AuthKey = config.AUTH_KEY or ""
+
+        tmp_cfg.LogMode = config.LOG_MODE
+        tmp_cfg.LogPath = config.LOG_PATH
+        tmp_cfg.LogDebug = config.LOG_DEBUG or false
+
+        tool_ctl.gen_summary(tmp_cfg)
+        sum_pane.set_value(1)
+        main_pane.set_value(4)
+        tool_ctl.importing_legacy = true
+    end
+
+    -- expose the auth key on the summary page
+    function tool_ctl.show_auth_key()
+        tool_ctl.show_key_btn.disable()
+        tool_ctl.auth_key_textbox.set_value(tool_ctl.auth_key_value)
+    end
+
+    -- generate the summary list
+    ---@param cfg pkt_config
+    function tool_ctl.gen_summary(cfg)
+        setting_list.remove_all()
+
+        local alternate = false
+        local inner_width = setting_list.get_width() - 1
+
+        tool_ctl.show_key_btn.enable()
+        tool_ctl.auth_key_value = cfg.AuthKey or "" -- to show auth key
+
+        for i = 1, #fields do
+            local f = fields[i]
+            local height = 1
+            local label_w = string.len(f[2])
+            local val_max_w = (inner_width - label_w) - 1
+            local raw = cfg[f[1]]
+            local val = util.strval(raw)
+
+            if f[1] == "AuthKey" then val = string.rep("*", string.len(val))
+            elseif f[1] == "LogMode" then val = util.trinary(raw == log.MODE.APPEND, "append", "replace") end
+
+            if val == "nil" then val = "<not set>" end
+
+            local c = util.trinary(alternate, g_lg_fg_bg, cpair(colors.gray,colors.white))
+            alternate = not alternate
+
+            if string.len(val) > val_max_w then
+                local lines = util.strwrap(val, inner_width)
+                height = #lines + 1
+            end
+
+            local line = Div{parent=setting_list,height=height,fg_bg=c}
+            TextBox{parent=line,text=f[2],width=string.len(f[2]),fg_bg=cpair(colors.black,line.get_fg_bg().bkg)}
+
+            local textbox
+            if height > 1 then
+                textbox = TextBox{parent=line,x=1,y=2,text=val,height=height-1,alignment=LEFT}
+            else
+                textbox = TextBox{parent=line,x=label_w+1,y=1,text=val,alignment=RIGHT}
+            end
+
+            if f[1] == "AuthKey" then tool_ctl.auth_key_textbox = textbox end
+        end
+    end
+end
+
+-- reset terminal screen
+local function reset_term()
+    term.setTextColor(colors.white)
+    term.setBackgroundColor(colors.black)
+    term.clear()
+    term.setCursorPos(1, 1)
+end
+
+-- run the pcoket configurator
+---@param ask_config? boolean indicate if this is being called by the startup app due to an invalid configuration
+function configurator.configure(ask_config)
+    tool_ctl.ask_config = ask_config == true
+
+    load_settings(settings_cfg, true)
+    tool_ctl.has_config = load_settings(ini_cfg)
+
+    reset_term()
+
+    -- set overridden colors
+    for i = 1, #style.colors do
+        term.setPaletteColor(style.colors[i].c, style.colors[i].hex)
+    end
+
+    local status, error = pcall(function ()
+        local display = DisplayBox{window=term.current(),fg_bg=style.root}
+        config_view(display)
+
+        while true do
+            local event, param1, param2, param3 = util.pull_event()
+
+            -- handle event
+            if event == "timer" then
+                tcd.handle(param1)
+            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" or event == "double_click" then
+                local m_e = core.events.new_mouse_event(event, param1, param2, param3)
+                if m_e then display.handle_mouse(m_e) end
+            elseif event == "char" or event == "key" or event == "key_up" then
+                local k_e = core.events.new_key_event(event, param1, param2)
+                if k_e then display.handle_key(k_e) end
+            elseif event == "paste" then
+                display.handle_paste(param1)
+            end
+
+            if event == "terminate" then return end
+        end
+    end)
+
+    -- restore colors
+    for i = 1, #style.colors do
+        local r, g, b = term.nativePaletteColor(style.colors[i].c)
+        term.setPaletteColor(style.colors[i].c, r, g, b)
+    end
+
+    reset_term()
+    if not status then
+        println("configurator error: " .. error)
+    end
+
+    return status, error
+end
+
+return configurator

pocket/pocket.lua

@@ -7,23 +7,63 @@ local iocontrol = require("pocket.iocontrol")
 local PROTOCOL = comms.PROTOCOL
 local DEVICE_TYPE = comms.DEVICE_TYPE
 local ESTABLISH_ACK = comms.ESTABLISH_ACK
-local SCADA_MGMT_TYPE = comms.SCADA_MGMT_TYPE
+local MGMT_TYPE = comms.MGMT_TYPE
 
 local LINK_STATE = iocontrol.LINK_STATE
 
 local pocket = {}
 
+---@type pkt_config
+local config = {}
+
+pocket.config = config
+
+-- load the pocket configuration
+function pocket.load_config()
+    if not settings.load("/pocket.settings") then return false end
+
+    config.SVR_Channel = settings.get("SVR_Channel")
+    config.CRD_Channel = settings.get("CRD_Channel")
+    config.PKT_Channel = settings.get("PKT_Channel")
+    config.ConnTimeout = settings.get("ConnTimeout")
+    config.TrustedRange = settings.get("TrustedRange")
+    config.AuthKey = settings.get("AuthKey")
+
+    config.LogMode = settings.get("LogMode")
+    config.LogPath = settings.get("LogPath")
+    config.LogDebug = settings.get("LogDebug")
+
+    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_num(config.ConnTimeout)
+    cfv.assert_min(config.ConnTimeout, 2)
+    cfv.assert_type_num(config.TrustedRange)
+    cfv.assert_min(config.TrustedRange, 0)
+    cfv.assert_type_str(config.AuthKey)
+
+    if type(config.AuthKey) == "string" then
+        local len = string.len(config.AuthKey)
+        cfv.assert(len == 0 or len >= 8)
+    end
+
+    cfv.assert_type_int(config.LogMode)
+    cfv.assert_range(config.LogMode, 0, 1)
+    cfv.assert_type_str(config.LogPath)
+    cfv.assert_type_bool(config.LogDebug)
+
+    return cfv.valid()
+end
+
 -- pocket coordinator + supervisor communications
 ---@nodiscard
 ---@param version string pocket version
 ---@param nic nic network interface device
----@param pkt_channel integer pocket comms channel
----@param svr_channel integer supervisor access channel
----@param crd_channel integer coordinator access channel
----@param range integer trusted device connection range
 ---@param sv_watchdog watchdog
 ---@param api_watchdog watchdog
-function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range, sv_watchdog, api_watchdog)
+function pocket.comms(version, nic, sv_watchdog, api_watchdog)
     local self = {
         sv = {
             linked = false,
@@ -42,16 +82,16 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
         establish_delay_counter = 0
     }
 
-    comms.set_trusted_range(range)
+    comms.set_trusted_range(config.TrustedRange)
 
     -- PRIVATE FUNCTIONS --
 
     -- configure network channels
     nic.closeAll()
-    nic.open(pkt_channel)
+    nic.open(config.PKT_Channel)
 
     -- send a management packet to the supervisor
-    ---@param msg_type SCADA_MGMT_TYPE
+    ---@param msg_type MGMT_TYPE
     ---@param msg table
     local function _send_sv(msg_type, msg)
         local s_pkt = comms.scada_packet()
@@ -60,12 +100,12 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
         pkt.make(msg_type, msg)
         s_pkt.make(self.sv.addr, self.sv.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
 
-        nic.transmit(svr_channel, pkt_channel, s_pkt)
+        nic.transmit(config.SVR_Channel, config.PKT_Channel, s_pkt)
         self.sv.seq_num = self.sv.seq_num + 1
     end
 
     -- send a management packet to the coordinator
-    ---@param msg_type SCADA_MGMT_TYPE
+    ---@param msg_type MGMT_TYPE
     ---@param msg table
     local function _send_crd(msg_type, msg)
         local s_pkt = comms.scada_packet()
@@ -74,30 +114,30 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
         pkt.make(msg_type, msg)
         s_pkt.make(self.api.addr, self.api.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
 
-        nic.transmit(crd_channel, pkt_channel, s_pkt)
+        nic.transmit(config.CRD_Channel, config.PKT_Channel, s_pkt)
         self.api.seq_num = self.api.seq_num + 1
     end
 
     -- attempt supervisor connection establishment
     local function _send_sv_establish()
-        _send_sv(SCADA_MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.PKT })
+        _send_sv(MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.PKT })
     end
 
     -- attempt coordinator API connection establishment
     local function _send_api_establish()
-        _send_crd(SCADA_MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.PKT })
+        _send_crd(MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.PKT })
     end
 
     -- keep alive ack to supervisor
     ---@param srv_time integer
     local function _send_sv_keep_alive_ack(srv_time)
-        _send_sv(SCADA_MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
+        _send_sv(MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
     end
 
     -- keep alive ack to coordinator
     ---@param srv_time integer
     local function _send_api_keep_alive_ack(srv_time)
-        _send_crd(SCADA_MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
+        _send_crd(MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
     end
 
     -- PUBLIC FUNCTIONS --
@@ -111,7 +151,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
         self.sv.linked = false
         self.sv.r_seq_num = nil
         self.sv.addr = comms.BROADCAST
-        _send_sv(SCADA_MGMT_TYPE.CLOSE, {})
+        _send_sv(MGMT_TYPE.CLOSE, {})
     end
 
     -- close connection to coordinator API server
@@ -120,7 +160,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
         self.api.linked = false
         self.api.r_seq_num = nil
         self.api.addr = comms.BROADCAST
-        _send_crd(SCADA_MGMT_TYPE.CLOSE, {})
+        _send_crd(MGMT_TYPE.CLOSE, {})
     end
 
     -- close the connections to the servers
@@ -157,21 +197,21 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
 
     -- supervisor get active alarm tones
     function public.diag__get_alarm_tones()
-        if self.sv.linked then _send_sv(SCADA_MGMT_TYPE.DIAG_TONE_GET, {}) end
+        if self.sv.linked then _send_sv(MGMT_TYPE.DIAG_TONE_GET, {}) end
     end
 
     -- supervisor test alarm tones by tone
     ---@param id TONE|0 tone ID, or 0 to stop all
     ---@param state boolean tone state
     function public.diag__set_alarm_tone(id, state)
-        if self.sv.linked then _send_sv(SCADA_MGMT_TYPE.DIAG_TONE_SET, { id, state }) end
+        if self.sv.linked then _send_sv(MGMT_TYPE.DIAG_TONE_SET, { id, state }) end
     end
 
     -- supervisor test alarm tones by alarm
     ---@param id ALARM|0 alarm ID, 0 to stop all
     ---@param state boolean alarm state
     function public.diag__set_alarm(id, state)
-        if self.sv.linked then _send_sv(SCADA_MGMT_TYPE.DIAG_ALARM_SET, { id, state }) end
+        if self.sv.linked then _send_sv(MGMT_TYPE.DIAG_ALARM_SET, { id, state }) end
     end
 
     -- parse a packet
@@ -180,7 +220,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
     ---@param reply_to integer
     ---@param message any
     ---@param distance integer
-    ---@return mgmt_frame|capi_frame|nil packet
+    ---@return mgmt_frame|crdn_frame|nil packet
     function public.parse_packet(side, sender, reply_to, message, distance)
         local s_pkt = nic.receive(side, sender, reply_to, message, distance)
         local pkt = nil
@@ -192,11 +232,11 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                 if mgmt_pkt.decode(s_pkt) then
                     pkt = mgmt_pkt.get()
                 end
-            -- get as coordinator API packet
-            elseif s_pkt.protocol() == PROTOCOL.COORD_API then
-                local capi_pkt = comms.capi_packet()
-                if capi_pkt.decode(s_pkt) then
-                    pkt = capi_pkt.get()
+            -- get as coordinator packet
+            elseif s_pkt.protocol() == PROTOCOL.SCADA_CRDN then
+                local crdn_pkt = comms.crdn_packet()
+                if crdn_pkt.decode(s_pkt) then
+                    pkt = crdn_pkt.get()
                 end
             else
                 log.debug("attempted parse of illegal packet type " .. s_pkt.protocol(), true)
@@ -207,7 +247,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
     end
 
     -- handle a packet
-    ---@param packet mgmt_frame|capi_frame|nil
+    ---@param packet mgmt_frame|crdn_frame|nil
     function public.handle_packet(packet)
         local diag = iocontrol.get_db().diag
 
@@ -217,9 +257,9 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
             local protocol = packet.scada_frame.protocol()
             local src_addr = packet.scada_frame.src_addr()
 
-            if l_chan ~= pkt_channel then
+            if l_chan ~= config.PKT_Channel then
                 log.debug("received packet on unconfigured channel " .. l_chan, true)
-            elseif r_chan == crd_channel then
+            elseif r_chan == config.CRD_Channel then
                 -- check sequence number
                 if self.api.r_seq_num == nil then
                     self.api.r_seq_num = packet.scada_frame.seq_num()
@@ -240,7 +280,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                 if protocol == PROTOCOL.SCADA_MGMT then
                     ---@cast packet mgmt_frame
                     if self.api.linked then
-                        if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                        if packet.type == MGMT_TYPE.KEEP_ALIVE then
                             -- keep alive request received, echo back
                             if packet.length == 1 then
                                 local timestamp = packet.data[1]
@@ -256,7 +296,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                             else
                                 log.debug("coordinator SCADA keep alive packet length mismatch")
                             end
-                        elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                        elseif packet.type == MGMT_TYPE.CLOSE then
                             -- handle session close
                             api_watchdog.cancel()
                             self.api.linked = false
@@ -266,7 +306,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                         else
                             log.debug("received unknown SCADA_MGMT packet type " .. packet.type .. " from coordinator")
                         end
-                    elseif packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                    elseif packet.type == MGMT_TYPE.ESTABLISH then
                         -- connection with coordinator established
                         if packet.length == 1 then
                             local est_ack = packet.data[1]
@@ -308,7 +348,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                 else
                     log.debug("illegal packet type " .. protocol .. " from coordinator", true)
                 end
-            elseif r_chan == svr_channel then
+            elseif r_chan == config.SVR_Channel then
                 -- check sequence number
                 if self.sv.r_seq_num == nil then
                     self.sv.r_seq_num = packet.scada_frame.seq_num()
@@ -330,7 +370,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                 if protocol == PROTOCOL.SCADA_MGMT then
                     ---@cast packet mgmt_frame
                     if self.sv.linked then
-                        if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                        if packet.type == MGMT_TYPE.KEEP_ALIVE then
                             -- keep alive request received, echo back
                             if packet.length == 1 then
                                 local timestamp = packet.data[1]
@@ -346,14 +386,14 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                             else
                                 log.debug("supervisor SCADA keep alive packet length mismatch")
                             end
-                        elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                        elseif packet.type == MGMT_TYPE.CLOSE then
                             -- handle session close
                             sv_watchdog.cancel()
                             self.sv.linked = false
                             self.sv.r_seq_num = nil
                             self.sv.addr = comms.BROADCAST
                             log.info("supervisor server connection closed by remote host")
-                        elseif packet.type == SCADA_MGMT_TYPE.DIAG_TONE_GET then
+                        elseif packet.type == MGMT_TYPE.DIAG_TONE_GET then
                             if packet.length == 8 then
                                 for i = 1, #packet.data do
                                     diag.tone_test.tone_indicators[i].update(packet.data[i] == true)
@@ -361,7 +401,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                             else
                                 log.debug("supervisor SCADA diag alarm states packet length mismatch")
                             end
-                        elseif packet.type == SCADA_MGMT_TYPE.DIAG_TONE_SET then
+                        elseif packet.type == MGMT_TYPE.DIAG_TONE_SET then
                             if packet.length == 1 and packet.data[1] == false then
                                 diag.tone_test.ready_warn.set_value("testing denied")
                                 log.debug("supervisor SCADA diag tone set failed")
@@ -380,7 +420,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                             else
                                 log.debug("supervisor SCADA diag tone set packet length/type mismatch")
                             end
-                        elseif packet.type == SCADA_MGMT_TYPE.DIAG_ALARM_SET then
+                        elseif packet.type == MGMT_TYPE.DIAG_ALARM_SET then
                             if packet.length == 1 and packet.data[1] == false then
                                 diag.tone_test.ready_warn.set_value("testing denied")
                                 log.debug("supervisor SCADA diag alarm set failed")
@@ -401,7 +441,7 @@ function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range
                         else
                             log.debug("received unknown SCADA_MGMT packet type " .. packet.type .. " from supervisor")
                         end
-                    elseif packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                    elseif packet.type == MGMT_TYPE.ESTABLISH then
                         -- connection with supervisor established
                         if packet.length == 1 then
                             local est_ack = packet.data[1]

pocket/renderer.lua

@@ -5,18 +5,23 @@
 local main_view  = require("pocket.ui.main")
 local style      = require("pocket.ui.style")
 
+local core       = require("graphics.core")
 local flasher    = require("graphics.flasher")
 
 local DisplayBox = require("graphics.elements.displaybox")
 
+---@class pocket_renderer
 local renderer = {}
 
 local ui = {
     display = nil
 }
 
--- start the pocket GUI
-function renderer.start_ui()
+-- try to start the pocket GUI
+---@return boolean success, any error_msg
+function renderer.try_start_ui()
+    local status, msg = true, nil
+
     if ui.display == nil then
         -- reset screen
         term.setTextColor(colors.white)
@@ -30,12 +35,22 @@ function renderer.start_ui()
         end
 
         -- init front panel view
-        ui.display = DisplayBox{window=term.current(),fg_bg=style.root}
-        main_view(ui.display)
+        status, msg = pcall(function ()
+            ui.display = DisplayBox{window=term.current(),fg_bg=style.root}
+            main_view(ui.display)
+        end)
 
-        -- start flasher callback task
-        flasher.run()
+        if status then
+            -- start flasher callback task
+            flasher.run()
+        else
+            -- report fail and close ui
+            msg = core.extract_assert_msg(msg)
+            renderer.close_ui()
+        end
     end
+
+    return status, msg
 end
 
 -- close out the UI

pocket/startup.lua

@@ -13,38 +13,37 @@ local util      = require("scada-common.util")
 
 local core      = require("graphics.core")
 
-local config    = require("pocket.config")
+local configure = require("pocket.configure")
 local iocontrol = require("pocket.iocontrol")
 local pocket    = require("pocket.pocket")
 local renderer  = require("pocket.renderer")
 
-local POCKET_VERSION = "v0.6.0-alpha"
+local POCKET_VERSION = "v0.7.0-alpha"
 
 local println = util.println
 local println_ts = util.println_ts
 
 ----------------------------------------
--- config validation
+-- get configuration
 ----------------------------------------
 
-local cfv = util.new_validator()
+if not pocket.load_config() then
+    -- try to reconfigure (user action)
+    local success, error = configure.configure(true)
+    if success then
+        assert(pocket.load_config(), "failed to load valid configuration")
+    else
+        assert(success, "pocket configuration error: " .. error)
+    end
+end
 
-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.COMMS_TIMEOUT)
-cfv.assert_min(config.COMMS_TIMEOUT, 2)
-cfv.assert_type_str(config.LOG_PATH)
-cfv.assert_type_int(config.LOG_MODE)
-
-assert(cfv.valid(), "bad config file: missing/invalid fields")
+local config = pocket.config
 
 ----------------------------------------
 -- log init
 ----------------------------------------
 
-log.init(config.LOG_PATH, config.LOG_MODE, config.LOG_DEBUG == true)
+log.init(config.LogPath, config.LogMode, config.LogDebug)
 
 log.info("========================================")
 log.info("BOOTING pocket.startup " .. POCKET_VERSION)
@@ -69,8 +68,8 @@ local function main()
     ----------------------------------------
 
     -- message authentication init
-    if type(config.AUTH_KEY) == "string" then
-        network.init_mac(config.AUTH_KEY)
+    if type(config.AuthKey) == "string" and string.len(config.AuthKey) > 0 then
+        network.init_mac(config.AuthKey)
     end
 
     iocontrol.report_link_state(iocontrol.LINK_STATE.UNLINKED)
@@ -85,8 +84,8 @@ local function main()
 
     -- create connection watchdogs
     local conn_wd = {
-        sv = util.new_watchdog(config.COMMS_TIMEOUT),
-        api = util.new_watchdog(config.COMMS_TIMEOUT)
+        sv = util.new_watchdog(config.ConnTimeout),
+        api = util.new_watchdog(config.ConnTimeout)
     }
 
     conn_wd.sv.cancel()
@@ -96,8 +95,7 @@ local function main()
 
     -- create network interface then setup comms
     local nic = network.nic(modem)
-    local pocket_comms = pocket.comms(POCKET_VERSION, nic, config.PKT_CHANNEL, config.SVR_CHANNEL,
-                                        config.CRD_CHANNEL, config.TRUSTED_RANGE, conn_wd.sv, conn_wd.api)
+    local pocket_comms = pocket.comms(POCKET_VERSION, nic, conn_wd.sv, conn_wd.api)
     log.debug("startup> comms init")
 
     -- base loop clock (2Hz, 10 ticks)
@@ -111,9 +109,8 @@ local function main()
     -- start the UI
     ----------------------------------------
 
-    local ui_ok, message = pcall(renderer.start_ui)
+    local ui_ok, message = renderer.try_start_ui()
     if not ui_ok then
-        renderer.close_ui()
         println(util.c("UI error: ", message))
         log.error(util.c("startup> GUI render failed with error ", message))
     else
@@ -171,7 +168,8 @@ local function main()
                 -- got a packet
                 local packet = pocket_comms.parse_packet(param1, param2, param3, param4, param5)
                 pocket_comms.handle_packet(packet)
-            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" then
+            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" or
+                   event == "double_click" then
                 -- handle a monitor touch event
                 renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3))
             end

pocket/ui/components/conn_waiting.lua

@@ -11,7 +11,7 @@ local TextBox     = require("graphics.elements.textbox")
 
 local WaitingAnim = require("graphics.elements.animations.waiting")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 
@@ -29,10 +29,10 @@ local function init(parent, y, is_api)
 
     if is_api then
         WaitingAnim{parent=box,x=waiting_x,y=1,fg_bg=cpair(colors.blue,style.root.bkg)}
-        TextBox{parent=box,text="Connecting to API",alignment=TEXT_ALIGN.CENTER,y=5,height=1,fg_bg=cpair(colors.white,style.root.bkg)}
+        TextBox{parent=box,text="Connecting to API",alignment=ALIGN.CENTER,y=5,height=1,fg_bg=cpair(colors.white,style.root.bkg)}
     else
         WaitingAnim{parent=box,x=waiting_x,y=1,fg_bg=cpair(colors.green,style.root.bkg)}
-        TextBox{parent=box,text="Connecting to Supervisor",alignment=TEXT_ALIGN.CENTER,y=5,height=1,fg_bg=cpair(colors.white,style.root.bkg)}
+        TextBox{parent=box,text="Connecting to Supervisor",alignment=ALIGN.CENTER,y=5,height=1,fg_bg=cpair(colors.white,style.root.bkg)}
     end
 
     return root

pocket/ui/main.lua

@@ -26,7 +26,7 @@ local Sidebar      = require("graphics.elements.controls.sidebar")
 local LINK_STATE = iocontrol.LINK_STATE
 local NAV_PAGE   = iocontrol.NAV_PAGE
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 
@@ -37,7 +37,7 @@ local function init(main)
     local ps  = iocontrol.get_db().ps
 
     -- window header message
-    TextBox{parent=main,y=1,text="",alignment=TEXT_ALIGN.LEFT,height=1,fg_bg=style.header}
+    TextBox{parent=main,y=1,text="",alignment=ALIGN.LEFT,height=1,fg_bg=style.header}
 
     --
     -- root panel panes (connection screens + main screen)

pocket/ui/pages/boiler_page.lua

@@ -7,14 +7,14 @@ local TextBox = require("graphics.elements.textbox")
 
 -- local cpair = core.cpair
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 -- new boiler page view
 ---@param root graphics_element parent
 local function new_view(root)
     local main = Div{parent=root,x=1,y=1}
 
-    TextBox{parent=main,text="BOILERS",x=1,y=1,height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=main,text="BOILERS",x=1,y=1,height=1,alignment=ALIGN.CENTER}
 
     return main
 end

pocket/ui/pages/diag_page.lua

@@ -17,7 +17,7 @@ local cpair = core.cpair
 
 local NAV_PAGE = iocontrol.NAV_PAGE
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 -- new diagnostics page view
 ---@param root graphics_element parent
@@ -28,7 +28,7 @@ local function new_view(root)
 
     local diag_home = Div{parent=main,x=1,y=1}
 
-    TextBox{parent=diag_home,text="Diagnostic Apps",x=1,y=2,height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=diag_home,text="Diagnostic Apps",x=1,y=2,height=1,alignment=ALIGN.CENTER}
 
     local alarm_test = Div{parent=main,x=1,y=1}
 
@@ -63,15 +63,15 @@ local function new_view(root)
 
     local audio = Div{parent=alarm_test,x=1,y=1}
 
-    TextBox{parent=audio,y=1,text="Alarm Sounder Tests",height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=audio,y=1,text="Alarm Sounder Tests",height=1,alignment=ALIGN.CENTER}
 
-    ttest.ready_warn = TextBox{parent=audio,y=2,text="",height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=cpair(colors.yellow,colors.black)}
+    ttest.ready_warn = TextBox{parent=audio,y=2,text="",height=1,alignment=ALIGN.CENTER,fg_bg=cpair(colors.yellow,colors.black)}
 
     PushButton{parent=audio,x=13,y=18,text="\x11 BACK",min_width=8,fg_bg=cpair(colors.black,colors.lightGray),active_fg_bg=c_wht_gray,callback=navigate_diag}
 
     local tones = Div{parent=audio,x=2,y=3,height=10,width=8,fg_bg=cpair(colors.black,colors.yellow)}
 
-    TextBox{parent=tones,text="Tones",height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=audio.get_fg_bg()}
+    TextBox{parent=tones,text="Tones",height=1,alignment=ALIGN.CENTER,fg_bg=audio.get_fg_bg()}
 
     local test_btns = {}
     test_btns[1] = SwitchButton{parent=tones,text="TEST 1",min_width=8,active_fg_bg=c_wht_gray,callback=ttest.test_1}
@@ -94,7 +94,7 @@ local function new_view(root)
 
     local alarms = Div{parent=audio,x=11,y=3,height=15,fg_bg=cpair(colors.lightGray,colors.black)}
 
-    TextBox{parent=alarms,text="Alarms (\x13)",height=1,alignment=TEXT_ALIGN.CENTER,fg_bg=audio.get_fg_bg()}
+    TextBox{parent=alarms,text="Alarms (\x13)",height=1,alignment=ALIGN.CENTER,fg_bg=audio.get_fg_bg()}
 
     local alarm_btns = {}
     alarm_btns[1] = Checkbox{parent=alarms,label="BREACH",min_width=15,box_fg_bg=c_red_gray,callback=ttest.test_breach}
@@ -121,7 +121,7 @@ local function new_view(root)
 
     local states = Div{parent=audio,x=2,y=14,height=5,width=8}
 
-    TextBox{parent=states,text="States",height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=states,text="States",height=1,alignment=ALIGN.CENTER}
     local t_1 = IndicatorLight{parent=states,label="1",colors=c_blue_gray}
     local t_2 = IndicatorLight{parent=states,label="2",colors=c_blue_gray}
     local t_3 = IndicatorLight{parent=states,label="3",colors=c_blue_gray}

pocket/ui/pages/reactor_page.lua

@@ -7,14 +7,14 @@ local TextBox = require("graphics.elements.textbox")
 
 -- local cpair = core.cpair
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 -- new reactor page view
 ---@param root graphics_element parent
 local function new_view(root)
     local main = Div{parent=root,x=1,y=1}
 
-    TextBox{parent=main,text="REACTOR",x=1,y=1,height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=main,text="REACTOR",x=1,y=1,height=1,alignment=ALIGN.CENTER}
 
     return main
 end

pocket/ui/pages/turbine_page.lua

@@ -7,14 +7,14 @@ local TextBox = require("graphics.elements.textbox")
 
 -- local cpair = core.cpair
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 -- new turbine page view
 ---@param root graphics_element parent
 local function new_view(root)
     local main = Div{parent=root,x=1,y=1}
 
-    TextBox{parent=main,text="TURBINES",x=1,y=1,height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=main,text="TURBINES",x=1,y=1,height=1,alignment=ALIGN.CENTER}
 
     return main
 end

pocket/ui/pages/unit_page.lua

@@ -7,14 +7,14 @@ local TextBox = require("graphics.elements.textbox")
 
 -- local cpair = core.cpair
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 -- new unit page view
 ---@param root graphics_element parent
 local function new_view(root)
     local main = Div{parent=root,x=1,y=1}
 
-    TextBox{parent=main,text="UNITS",x=1,y=1,height=1,alignment=TEXT_ALIGN.CENTER}
+    TextBox{parent=main,text="UNITS",x=1,y=1,height=1,alignment=ALIGN.CENTER}
 
     return main
 end

reactor-plc/config.lua

@@ -1,34 +0,0 @@
-local config = {}
-
--- set to false to run in offline mode (safety regulation only)
-config.NETWORKED = true
--- unique reactor ID
-config.REACTOR_ID = 1
-
--- for offline mode, this redstone interface will turn off (open a valve)
--- when emergency coolant is needed due to low coolant
--- config.EMERGENCY_COOL = { side = "right", color = nil }
-
--- supervisor comms channel
-config.SVR_CHANNEL = 16240
--- PLC comms channel
-config.PLC_CHANNEL = 16241
--- max trusted modem message distance (0 to disable check)
-config.TRUSTED_RANGE = 0
--- time in seconds (>= 2) before assuming a remote device is no longer active
-config.COMMS_TIMEOUT = 5
--- facility authentication key (do NOT use one of your passwords)
--- this enables verifying that messages are authentic
--- all devices on the same network must use the same key
--- config.AUTH_KEY = "SCADAfacility123"
-
--- log path
-config.LOG_PATH = "/log.txt"
--- log mode
---  0 = APPEND (adds to existing file on start)
---  1 = NEW (replaces existing file on start)
-config.LOG_MODE = 0
--- true to log verbose debug messages
-config.LOG_DEBUG = false
-
-return config

reactor-plc/configure.lua

@@ -0,0 +1,709 @@
+--
+-- Configuration GUI
+--
+
+local log         = require("scada-common.log")
+local rsio        = require("scada-common.rsio")
+local tcd         = require("scada-common.tcd")
+local util        = require("scada-common.util")
+
+local core        = require("graphics.core")
+
+local DisplayBox  = require("graphics.elements.displaybox")
+local Div         = require("graphics.elements.div")
+local ListBox     = require("graphics.elements.listbox")
+local MultiPane   = require("graphics.elements.multipane")
+local TextBox     = require("graphics.elements.textbox")
+
+local CheckBox    = require("graphics.elements.controls.checkbox")
+local PushButton  = require("graphics.elements.controls.push_button")
+local Radio2D     = require("graphics.elements.controls.radio_2d")
+local RadioButton = require("graphics.elements.controls.radio_button")
+
+local NumberField = require("graphics.elements.form.number_field")
+local TextField   = require("graphics.elements.form.text_field")
+
+local println = util.println
+local tri = util.trinary
+
+local cpair = core.cpair
+
+local LEFT = core.ALIGN.LEFT
+local CENTER = core.ALIGN.CENTER
+local RIGHT = core.ALIGN.RIGHT
+
+-- changes to the config data/format to let the user know
+local changes = {
+    {"v1.6.2", { "AuthKey minimum length is now 8 (if set)" } },
+    {"v1.6.8", { "ConnTimeout can now have a fractional part" } }
+}
+
+---@class plc_configurator
+local configurator = {}
+
+local style = {}
+
+style.root = cpair(colors.black, colors.lightGray)
+style.header = cpair(colors.white, colors.gray)
+
+style.colors = {
+    { c = colors.red,       hex = 0xdf4949 },
+    { c = colors.orange,    hex = 0xffb659 },
+    { c = colors.yellow,    hex = 0xfffc79 },
+    { c = colors.lime,      hex = 0x80ff80 },
+    { c = colors.green,     hex = 0x4aee8a },
+    { c = colors.cyan,      hex = 0x34bac8 },
+    { c = colors.lightBlue, hex = 0x6cc0f2 },
+    { c = colors.blue,      hex = 0x0096ff },
+    { c = colors.purple,    hex = 0xb156ee },
+    { c = colors.pink,      hex = 0xf26ba2 },
+    { c = colors.magenta,   hex = 0xf9488a },
+    { c = colors.lightGray, hex = 0xcacaca },
+    { c = colors.gray,      hex = 0x575757 }
+}
+
+local bw_fg_bg = cpair(colors.black, colors.white)
+local g_lg_fg_bg = cpair(colors.gray, colors.lightGray)
+local nav_fg_bg = bw_fg_bg
+local btn_act_fg_bg = cpair(colors.white, colors.gray)
+
+local tool_ctl = {
+    ask_config = false,
+    has_config = false,
+    viewing_config = false,
+    importing_legacy = false,
+
+    view_cfg = nil,         ---@type graphics_element
+    settings_apply = nil,   ---@type graphics_element
+
+    set_networked = nil,    ---@type function
+    bundled_emcool = nil,   ---@type function
+    gen_summary = nil,      ---@type function
+    show_current_cfg = nil, ---@type function
+    load_legacy = nil,      ---@type function
+
+    show_auth_key = nil,    ---@type function
+    show_key_btn = nil,     ---@type graphics_element
+    auth_key_textbox = nil, ---@type graphics_element
+    auth_key_value = ""
+}
+
+---@class plc_config
+local tmp_cfg = {
+    Networked = false,
+    UnitID = 0,
+    EmerCoolEnable = false,
+    EmerCoolSide = nil,     ---@type string|nil
+    EmerCoolColor = nil,    ---@type color|nil
+    SVR_Channel = nil,      ---@type integer
+    PLC_Channel = nil,      ---@type integer
+    ConnTimeout = nil,      ---@type number
+    TrustedRange = nil,     ---@type number
+    AuthKey = nil,          ---@type string|nil
+    LogMode = 0,
+    LogPath = "",
+    LogDebug = false,
+}
+
+---@class plc_config
+local ini_cfg = {}
+---@class plc_config
+local settings_cfg = {}
+
+-- all settings fields, their nice names, and their default values
+local fields = {
+    { "Networked", "Networked", false },
+    { "UnitID", "Unit ID", 1 },
+    { "EmerCoolEnable", "Emergency Coolant", false },
+    { "EmerCoolSide", "Emergency Coolant Side", nil },
+    { "EmerCoolColor", "Emergency Coolant Color", nil },
+    { "SVR_Channel", "SVR Channel", 16240 },
+    { "PLC_Channel", "PLC Channel", 16241 },
+    { "ConnTimeout", "Connection Timeout", 5 },
+    { "TrustedRange", "Trusted Range", 0 },
+    { "AuthKey", "Facility Auth Key" , ""},
+    { "LogMode", "Log Mode", log.MODE.APPEND },
+    { "LogPath", "Log Path", "/log.txt" },
+    { "LogDebug","Log Debug Messages", false }
+}
+
+local side_options = { "Top", "Bottom", "Left", "Right", "Front", "Back" }
+local side_options_map = { "top", "bottom", "left", "right", "front", "back" }
+local color_options = { "Red", "Orange", "Yellow", "Lime", "Green", "Cyan", "Light Blue", "Blue", "Purple", "Magenta", "Pink", "White", "Light Gray", "Gray", "Black", "Brown" }
+local color_options_map = { colors.red, colors.orange, colors.yellow, colors.lime, colors.green, colors.cyan, colors.lightBlue, colors.blue, colors.purple, colors.magenta, colors.pink, colors.white, colors.lightGray, colors.gray, colors.black, colors.brown }
+
+-- convert text representation to index
+---@param side string
+local function side_to_idx(side)
+    for k, v in ipairs(side_options_map) do
+        if v == side then return k end
+    end
+end
+
+-- convert color to index
+---@param color color
+local function color_to_idx(color)
+    for k, v in ipairs(color_options_map) do
+        if v == color then return k end
+    end
+end
+
+-- load data from the settings file
+---@param target plc_config
+---@param raw boolean? true to not use default values
+local function load_settings(target, raw)
+    for _, v in pairs(fields) do settings.unset(v[1]) end
+
+    local loaded = settings.load("/reactor-plc.settings")
+
+    for _, v in pairs(fields) do target[v[1]] = settings.get(v[1], tri(raw, nil, v[3])) end
+
+    return loaded
+end
+
+-- create the config view
+---@param display graphics_element
+local function config_view(display)
+
+---@diagnostic disable-next-line: undefined-field
+    local function exit() os.queueEvent("terminate") end
+
+    TextBox{parent=display,y=1,text="Reactor PLC Configurator",alignment=CENTER,height=1,fg_bg=style.header}
+
+    local root_pane_div = Div{parent=display,x=1,y=2}
+
+    local main_page = Div{parent=root_pane_div,x=1,y=1}
+    local plc_cfg = Div{parent=root_pane_div,x=1,y=1}
+    local net_cfg = Div{parent=root_pane_div,x=1,y=1}
+    local log_cfg = Div{parent=root_pane_div,x=1,y=1}
+    local summary = Div{parent=root_pane_div,x=1,y=1}
+    local changelog = Div{parent=root_pane_div,x=1,y=1}
+
+    local main_pane = MultiPane{parent=root_pane_div,x=1,y=1,panes={main_page,plc_cfg,net_cfg,log_cfg,summary,changelog}}
+
+    -- Main Page
+
+    local y_start = 5
+
+    TextBox{parent=main_page,x=2,y=2,height=2,text="Welcome to the Reactor PLC configurator! Please select one of the following options."}
+
+    if tool_ctl.ask_config then
+        TextBox{parent=main_page,x=2,y=y_start,height=4,width=49,text="Notice: This device has no valid config so the configurator has been automatically started. If you previously had a valid config, you may want to check the Change Log to see what changed.",fg_bg=cpair(colors.red,colors.lightGray)}
+        y_start = y_start + 5
+    end
+
+    local function view_config()
+        tool_ctl.viewing_config = true
+        tool_ctl.gen_summary(settings_cfg)
+        tool_ctl.settings_apply.hide(true)
+        main_pane.set_value(5)
+    end
+
+    if fs.exists("/reactor-plc/config.lua") then
+        PushButton{parent=main_page,x=2,y=y_start,min_width=28,text="Import Legacy 'config.lua'",callback=function()tool_ctl.load_legacy()end,fg_bg=cpair(colors.black,colors.cyan),active_fg_bg=btn_act_fg_bg}
+        y_start = y_start + 2
+    end
+
+    PushButton{parent=main_page,x=2,y=y_start,min_width=18,text="Configure System",callback=function()main_pane.set_value(2)end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg}
+    tool_ctl.view_cfg = PushButton{parent=main_page,x=2,y=y_start+2,min_width=20,text="View Configuration",callback=view_config,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg,dis_fg_bg=cpair(colors.lightGray,colors.white)}
+
+    if not tool_ctl.has_config then tool_ctl.view_cfg.disable() end
+
+    PushButton{parent=main_page,x=2,y=17,min_width=6,text="Exit",callback=exit,fg_bg=cpair(colors.black,colors.red),active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=main_page,x=39,y=17,min_width=12,text="Change Log",callback=function()main_pane.set_value(6)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#region PLC
+
+    local plc_c_1 = Div{parent=plc_cfg,x=2,y=4,width=49}
+    local plc_c_2 = Div{parent=plc_cfg,x=2,y=4,width=49}
+    local plc_c_3 = Div{parent=plc_cfg,x=2,y=4,width=49}
+    local plc_c_4 = Div{parent=plc_cfg,x=2,y=4,width=49}
+
+    local plc_pane = MultiPane{parent=plc_cfg,x=1,y=4,panes={plc_c_1,plc_c_2,plc_c_3,plc_c_4}}
+
+    TextBox{parent=plc_cfg,x=1,y=2,height=1,text=" PLC Configuration",fg_bg=cpair(colors.black,colors.orange)}
+
+    TextBox{parent=plc_c_1,x=1,y=1,height=1,text="Would you like to set this PLC as networked?"}
+    TextBox{parent=plc_c_1,x=1,y=3,height=4,text="If you have a supervisor, select the box. You will later be prompted to select the network configuration. If you instead want to use this as a standalone safety system, don't select the box.",fg_bg=g_lg_fg_bg}
+
+    local networked = CheckBox{parent=plc_c_1,x=1,y=8,label="Networked",default=ini_cfg.Networked,box_fg_bg=cpair(colors.orange,colors.black)}
+
+    local function submit_networked()
+        tool_ctl.set_networked(networked.get_value())
+        plc_pane.set_value(2)
+    end
+
+    PushButton{parent=plc_c_1,x=1,y=14,text="\x1b Back",callback=function()main_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=plc_c_1,x=44,y=14,text="Next \x1a",callback=submit_networked,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=plc_c_2,x=1,y=1,height=1,text="Please enter the reactor unit ID for this PLC."}
+    TextBox{parent=plc_c_2,x=1,y=3,height=3,text="If this is a networked PLC, currently only IDs 1 through 4 are acceptable.",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=plc_c_2,x=1,y=6,height=1,text="Unit #"}
+    local u_id = NumberField{parent=plc_c_2,x=7,y=6,width=5,max_chars=3,default=ini_cfg.UnitID,min=1,fg_bg=bw_fg_bg}
+
+    local u_id_err = TextBox{parent=plc_c_2,x=8,y=14,height=1,width=35,text="Please set a unit ID.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_id()
+        local unit_id = tonumber(u_id.get_value())
+        if unit_id ~= nil then
+            u_id_err.hide(true)
+            tmp_cfg.UnitID = unit_id
+            plc_pane.set_value(3)
+        else u_id_err.show() end
+    end
+
+    PushButton{parent=plc_c_2,x=1,y=14,text="\x1b Back",callback=function()plc_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=plc_c_2,x=44,y=14,text="Next \x1a",callback=submit_id,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=plc_c_3,x=1,y=1,height=4,text="When networked, the supervisor takes care of emergency coolant via RTUs. However, you can configure independent emergency coolant via the PLC."}
+    TextBox{parent=plc_c_3,x=1,y=6,height=5,text="This independent control can be used with or without a supervisor. To configure, you would next select the interface of the redstone output connected to one or more mekanism pipes.",fg_bg=g_lg_fg_bg}
+
+    local en_em_cool = CheckBox{parent=plc_c_3,x=1,y=11,label="Enable PLC Emergency Coolant Control",default=ini_cfg.EmerCoolEnable,box_fg_bg=cpair(colors.orange,colors.black)}
+
+    local function next_from_plc()
+        if tmp_cfg.Networked then main_pane.set_value(3) else main_pane.set_value(4) end
+    end
+
+    local function submit_en_emcool()
+        tmp_cfg.EmerCoolEnable = en_em_cool.get_value()
+        if tmp_cfg.EmerCoolEnable then plc_pane.set_value(4) else next_from_plc() end
+    end
+
+    PushButton{parent=plc_c_3,x=1,y=14,text="\x1b Back",callback=function()plc_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=plc_c_3,x=44,y=14,text="Next \x1a",callback=submit_en_emcool,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=plc_c_4,x=1,y=1,height=1,text="Emergency Coolant Redstone Output Side"}
+    local side = Radio2D{parent=plc_c_4,x=1,y=2,rows=2,columns=3,default=side_to_idx(ini_cfg.EmerCoolSide),options=side_options,radio_colors=cpair(colors.lightGray,colors.black),select_color=colors.orange}
+
+    TextBox{parent=plc_c_4,x=1,y=5,height=1,text="Bundled Redstone Configuration"}
+    local bundled = CheckBox{parent=plc_c_4,x=1,y=6,label="Is Bundled?",default=ini_cfg.EmerCoolColor~=nil,box_fg_bg=cpair(colors.orange,colors.black),callback=function(v)tool_ctl.bundled_emcool(v)end}
+    local color = Radio2D{parent=plc_c_4,x=1,y=8,rows=4,columns=4,default=color_to_idx(ini_cfg.EmerCoolColor),options=color_options,radio_colors=cpair(colors.lightGray,colors.black),color_map=color_options_map,disable_color=colors.gray,disable_fg_bg=g_lg_fg_bg}
+    if ini_cfg.EmerCoolColor == nil then color.disable() end
+
+    local function submit_emcool()
+        tmp_cfg.EmerCoolSide = side_options_map[side.get_value()]
+        tmp_cfg.EmerCoolColor = util.trinary(bundled.get_value(), color_options_map[color.get_value()], nil)
+        next_from_plc()
+    end
+
+    PushButton{parent=plc_c_4,x=1,y=14,text="\x1b Back",callback=function()plc_pane.set_value(3)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=plc_c_4,x=44,y=14,text="Next \x1a",callback=submit_emcool,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#endregion
+
+    --#region Network
+
+    local net_c_1 = Div{parent=net_cfg,x=2,y=4,width=49}
+    local net_c_2 = Div{parent=net_cfg,x=2,y=4,width=49}
+    local net_c_3 = Div{parent=net_cfg,x=2,y=4,width=49}
+
+    local net_pane = MultiPane{parent=net_cfg,x=1,y=4,panes={net_c_1,net_c_2,net_c_3}}
+
+    TextBox{parent=net_cfg,x=1,y=2,height=1,text=" Network Configuration",fg_bg=cpair(colors.black,colors.lightBlue)}
+
+    TextBox{parent=net_c_1,x=1,y=1,height=1,text="Please set the network channels below."}
+    TextBox{parent=net_c_1,x=1,y=3,height=4,text="Each of the 5 uniquely named channels, including the 2 below, must be the same for each device in this SCADA network. For multiplayer servers, it is recommended to not use the default channels.",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_1,x=1,y=8,height=1,text="Supervisor Channel"}
+    local svr_chan = NumberField{parent=net_c_1,x=1,y=9,width=7,default=ini_cfg.SVR_Channel,min=1,max=65535,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_1,x=9,y=9,height=4,text="[SVR_CHANNEL]",fg_bg=g_lg_fg_bg}
+    TextBox{parent=net_c_1,x=1,y=11,height=1,text="PLC Channel"}
+    local plc_chan = NumberField{parent=net_c_1,x=1,y=12,width=7,default=ini_cfg.PLC_Channel,min=1,max=65535,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_1,x=9,y=12,height=4,text="[PLC_CHANNEL]",fg_bg=g_lg_fg_bg}
+
+    local chan_err = TextBox{parent=net_c_1,x=8,y=14,height=1,width=35,text="",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_channels()
+        local svr_c = tonumber(svr_chan.get_value())
+        local plc_c = tonumber(plc_chan.get_value())
+        if svr_c ~= nil and plc_c ~= nil then
+            tmp_cfg.SVR_Channel = svr_c
+            tmp_cfg.PLC_Channel = plc_c
+            net_pane.set_value(2)
+            chan_err.hide(true)
+        elseif svr_c == nil then
+            chan_err.set_value("Please set the supervisor channel.")
+            chan_err.show()
+        else
+            chan_err.set_value("Please set the PLC channel.")
+            chan_err.show()
+        end
+    end
+
+    PushButton{parent=net_c_1,x=1,y=14,text="\x1b Back",callback=function()main_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=net_c_1,x=44,y=14,text="Next \x1a",callback=submit_channels,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=net_c_2,x=1,y=1,height=1,text="Connection Timeout"}
+    local timeout = NumberField{parent=net_c_2,x=1,y=2,width=7,default=ini_cfg.ConnTimeout,min=2,max=25,max_chars=6,max_frac_digits=2,allow_decimal=true,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_2,x=9,y=2,height=2,text="seconds (default 5)",fg_bg=g_lg_fg_bg}
+    TextBox{parent=net_c_2,x=1,y=3,height=4,text="You generally do not want or need to modify this. On slow servers, you can increase this to make the system wait longer before assuming a disconnection.",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_2,x=1,y=8,height=1,text="Trusted Range"}
+    local range = NumberField{parent=net_c_2,x=1,y=9,width=10,default=ini_cfg.TrustedRange,min=0,max_chars=20,allow_decimal=true,fg_bg=bw_fg_bg}
+    TextBox{parent=net_c_2,x=1,y=10,height=4,text="Setting this to a value larger than 0 prevents connections with devices that many meters (blocks) away in any direction.",fg_bg=g_lg_fg_bg}
+
+    local p2_err = TextBox{parent=net_c_2,x=8,y=14,height=1,width=35,text="",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_ct_tr()
+        local timeout_val = tonumber(timeout.get_value())
+        local range_val = tonumber(range.get_value())
+        if timeout_val ~= nil and range_val ~= nil then
+            tmp_cfg.ConnTimeout = timeout_val
+            tmp_cfg.TrustedRange = range_val
+            net_pane.set_value(3)
+            p2_err.hide(true)
+        elseif timeout_val == nil then
+            p2_err.set_value("Please set the connection timeout.")
+            p2_err.show()
+        else
+            p2_err.set_value("Please set the trusted range.")
+            p2_err.show()
+        end
+    end
+
+    PushButton{parent=net_c_2,x=1,y=14,text="\x1b Back",callback=function()net_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=net_c_2,x=44,y=14,text="Next \x1a",callback=submit_ct_tr,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=net_c_3,x=1,y=1,height=2,text="Optionally, set the facility authentication key below. Do NOT use one of your passwords."}
+    TextBox{parent=net_c_3,x=1,y=4,height=6,text="This enables verifying that messages are authentic, so it is intended for security on multiplayer servers. All devices on the same network MUST use the same key if any device has a key. This does result in some extra compution (can slow things down).",fg_bg=g_lg_fg_bg}
+
+    TextBox{parent=net_c_3,x=1,y=11,height=1,text="Facility Auth Key"}
+    local key, _, censor = TextField{parent=net_c_3,x=1,y=12,max_len=64,value=ini_cfg.AuthKey,width=32,height=1,fg_bg=bw_fg_bg}
+
+    local function censor_key(enable) censor(util.trinary(enable, "*", nil)) end
+
+    local hide_key = CheckBox{parent=net_c_3,x=34,y=12,label="Hide",box_fg_bg=cpair(colors.lightBlue,colors.black),callback=censor_key}
+
+    hide_key.set_value(true)
+    censor_key(true)
+
+    local key_err = TextBox{parent=net_c_3,x=8,y=14,height=1,width=35,text="Key must be at least 8 characters.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_auth()
+        local v = key.get_value()
+        if string.len(v) == 0 or string.len(v) >= 8 then
+            tmp_cfg.AuthKey = key.get_value()
+            main_pane.set_value(4)
+            key_err.hide(true)
+        else key_err.show() end
+    end
+
+    PushButton{parent=net_c_3,x=1,y=14,text="\x1b Back",callback=function()net_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=net_c_3,x=44,y=14,text="Next \x1a",callback=submit_auth,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#endregion
+
+    --#region Logging
+
+    local log_c_1 = Div{parent=log_cfg,x=2,y=4,width=49}
+
+    TextBox{parent=log_cfg,x=1,y=2,height=1,text=" Logging Configuration",fg_bg=cpair(colors.black,colors.pink)}
+
+    TextBox{parent=log_c_1,x=1,y=1,height=1,text="Please configure logging below."}
+
+    TextBox{parent=log_c_1,x=1,y=3,height=1,text="Log File Mode"}
+    local mode = RadioButton{parent=log_c_1,x=1,y=4,default=ini_cfg.LogMode+1,options={"Append on Startup","Replace on Startup"},callback=function()end,radio_colors=cpair(colors.lightGray,colors.black),select_color=colors.pink}
+
+    TextBox{parent=log_c_1,x=1,y=7,height=1,text="Log File Path"}
+    local path = TextField{parent=log_c_1,x=1,y=8,width=49,height=1,value=ini_cfg.LogPath,max_len=128,fg_bg=bw_fg_bg}
+
+    local en_dbg = CheckBox{parent=log_c_1,x=1,y=10,default=ini_cfg.LogDebug,label="Enable Logging Debug Messages",box_fg_bg=cpair(colors.pink,colors.black)}
+    TextBox{parent=log_c_1,x=3,y=11,height=2,text="This results in much larger log files. It is best to only use this when there is a problem.",fg_bg=g_lg_fg_bg}
+
+    local path_err = TextBox{parent=log_c_1,x=8,y=14,height=1,width=35,text="Please provide a log file path.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true}
+
+    local function submit_log()
+        if path.get_value() ~= "" then
+            path_err.hide(true)
+            tmp_cfg.LogMode = mode.get_value() - 1
+            tmp_cfg.LogPath = path.get_value()
+            tmp_cfg.LogDebug = en_dbg.get_value()
+            tool_ctl.gen_summary(tmp_cfg)
+            tool_ctl.viewing_config = false
+            tool_ctl.importing_legacy = false
+            tool_ctl.settings_apply.show()
+            main_pane.set_value(5)
+        else path_err.show() end
+    end
+
+    local function back_from_log()
+        if tmp_cfg.Networked then main_pane.set_value(3) else main_pane.set_value(2) end
+    end
+
+    PushButton{parent=log_c_1,x=1,y=14,text="\x1b Back",callback=back_from_log,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=log_c_1,x=44,y=14,text="Next \x1a",callback=submit_log,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    --#endregion
+
+    --#region Summary and Saving
+
+    local sum_c_1 = Div{parent=summary,x=2,y=4,width=49}
+    local sum_c_2 = Div{parent=summary,x=2,y=4,width=49}
+    local sum_c_3 = Div{parent=summary,x=2,y=4,width=49}
+    local sum_c_4 = Div{parent=summary,x=2,y=4,width=49}
+
+    local sum_pane = MultiPane{parent=summary,x=1,y=4,panes={sum_c_1,sum_c_2,sum_c_3,sum_c_4}}
+
+    TextBox{parent=summary,x=1,y=2,height=1,text=" Summary",fg_bg=cpair(colors.black,colors.green)}
+
+    local setting_list = ListBox{parent=sum_c_1,x=1,y=1,height=12,width=49,scroll_height=100,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)}
+
+    local function back_from_settings()
+        if tool_ctl.viewing_config or tool_ctl.importing_legacy then
+            main_pane.set_value(1)
+            tool_ctl.viewing_config = false
+            tool_ctl.importing_legacy = false
+            tool_ctl.settings_apply.show()
+        else
+            main_pane.set_value(4)
+        end
+    end
+
+    ---@param element graphics_element
+    ---@param data any
+    local function try_set(element, data)
+        if data ~= nil then element.set_value(data) end
+    end
+
+    local function save_and_continue()
+        for k, v in pairs(tmp_cfg) do settings.set(k, v) end
+
+        if settings.save("/reactor-plc.settings") then
+            load_settings(settings_cfg, true)
+            load_settings(ini_cfg)
+
+            try_set(networked, ini_cfg.Networked)
+            try_set(u_id, ini_cfg.UnitID)
+            try_set(en_em_cool, ini_cfg.EmerCoolEnable)
+            try_set(side, side_to_idx(ini_cfg.EmerCoolSide))
+            try_set(bundled, ini_cfg.EmerCoolColor ~= nil)
+            if ini_cfg.EmerCoolColor ~= nil then try_set(color, color_to_idx(ini_cfg.EmerCoolColor)) end
+            try_set(svr_chan, ini_cfg.SVR_Channel)
+            try_set(plc_chan, ini_cfg.PLC_Channel)
+            try_set(timeout, ini_cfg.ConnTimeout)
+            try_set(range, ini_cfg.TrustedRange)
+            try_set(key, ini_cfg.AuthKey)
+            try_set(mode, ini_cfg.LogMode)
+            try_set(path, ini_cfg.LogPath)
+            try_set(en_dbg, ini_cfg.LogDebug)
+
+            tool_ctl.view_cfg.enable()
+
+            if tool_ctl.importing_legacy then
+                tool_ctl.importing_legacy = false
+                sum_pane.set_value(3)
+            else
+                sum_pane.set_value(2)
+            end
+        else
+            sum_pane.set_value(4)
+        end
+    end
+
+    PushButton{parent=sum_c_1,x=1,y=14,text="\x1b Back",callback=back_from_settings,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    tool_ctl.show_key_btn = PushButton{parent=sum_c_1,x=8,y=14,min_width=17,text="Unhide Auth Key",callback=function()tool_ctl.show_auth_key()end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg,dis_fg_bg=cpair(colors.lightGray,colors.white)}
+    tool_ctl.settings_apply = PushButton{parent=sum_c_1,x=43,y=14,min_width=7,text="Apply",callback=save_and_continue,fg_bg=cpair(colors.black,colors.green),active_fg_bg=btn_act_fg_bg}
+
+    TextBox{parent=sum_c_2,x=1,y=1,height=1,text="Settings saved!"}
+
+    local function go_home()
+        main_pane.set_value(1)
+        plc_pane.set_value(1)
+        net_pane.set_value(1)
+        sum_pane.set_value(1)
+    end
+
+    PushButton{parent=sum_c_2,x=1,y=14,min_width=6,text="Home",callback=go_home,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=sum_c_2,x=44,y=14,min_width=6,text="Exit",callback=exit,fg_bg=cpair(colors.black,colors.red),active_fg_bg=cpair(colors.white,colors.gray)}
+
+    TextBox{parent=sum_c_3,x=1,y=1,height=2,text="The old config.lua file will now be deleted, then the configurator will exit."}
+
+    local function delete_legacy()
+        fs.delete("/reactor-plc/config.lua")
+        exit()
+    end
+
+    PushButton{parent=sum_c_3,x=1,y=14,min_width=8,text="Cancel",callback=go_home,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=sum_c_3,x=44,y=14,min_width=6,text="OK",callback=delete_legacy,fg_bg=cpair(colors.black,colors.green),active_fg_bg=cpair(colors.white,colors.gray)}
+
+    TextBox{parent=sum_c_4,x=1,y=1,height=5,text="Failed to save the settings file.\n\nThere may not be enough space for the modification or server file permissions may be denying writes."}
+    PushButton{parent=sum_c_4,x=1,y=14,min_width=6,text="Home",callback=go_home,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+    PushButton{parent=sum_c_4,x=44,y=14,min_width=6,text="Exit",callback=exit,fg_bg=cpair(colors.black,colors.red),active_fg_bg=cpair(colors.white,colors.gray)}
+
+    --#endregion
+
+    -- Config Change Log
+
+    local cl = Div{parent=changelog,x=2,y=4,width=49}
+
+    TextBox{parent=changelog,x=1,y=2,height=1,text=" Config Change Log",fg_bg=bw_fg_bg}
+
+    local c_log = ListBox{parent=cl,x=1,y=1,height=12,width=49,scroll_height=100,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)}
+
+    for _, change in ipairs(changes) do
+        TextBox{parent=c_log,text=change[1],height=1,fg_bg=bw_fg_bg}
+        for _, v in ipairs(change[2]) do
+            local e = Div{parent=c_log,height=#util.strwrap(v,46)}
+            TextBox{parent=e,y=1,x=1,text="- ",height=1,fg_bg=cpair(colors.gray,colors.white)}
+            TextBox{parent=e,y=1,x=3,text=v,height=e.get_height(),fg_bg=cpair(colors.gray,colors.white)}
+        end
+    end
+
+    PushButton{parent=cl,x=1,y=14,text="\x1b Back",callback=function()main_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
+
+    -- set tool functions now that we have the elements
+
+    function tool_ctl.set_networked(enable)
+        tmp_cfg.Networked = enable
+        if enable then u_id.set_max(4) else u_id.set_max(999) end
+    end
+
+    function tool_ctl.bundled_emcool(en) if en then color.enable() else color.disable() end end
+
+    -- load a legacy config file
+    function tool_ctl.load_legacy()
+        local config = require("reactor-plc.config")
+
+        tmp_cfg.Networked = config.NETWORKED
+        tmp_cfg.UnitID = config.REACTOR_ID
+        tmp_cfg.EmerCoolEnable = type(config.EMERGENCY_COOL) == "table"
+
+        if tmp_cfg.EmerCoolEnable then
+            tmp_cfg.EmerCoolSide = config.EMERGENCY_COOL.side
+            tmp_cfg.EmerCoolColor = config.EMERGENCY_COOL.color
+        else
+            tmp_cfg.EmerCoolSide = nil
+            tmp_cfg.EmerCoolColor = nil
+        end
+
+        tmp_cfg.SVR_Channel = config.SVR_CHANNEL
+        tmp_cfg.PLC_Channel = config.PLC_CHANNEL
+        tmp_cfg.ConnTimeout = config.COMMS_TIMEOUT
+        tmp_cfg.TrustedRange = config.TRUSTED_RANGE
+        tmp_cfg.AuthKey = config.AUTH_KEY or ""
+        tmp_cfg.LogMode = config.LOG_MODE
+        tmp_cfg.LogPath = config.LOG_PATH
+        tmp_cfg.LogDebug = config.LOG_DEBUG or false
+
+        tool_ctl.gen_summary(tmp_cfg)
+        sum_pane.set_value(1)
+        main_pane.set_value(5)
+        tool_ctl.importing_legacy = true
+    end
+
+    -- expose the auth key on the summary page
+    function tool_ctl.show_auth_key()
+        tool_ctl.show_key_btn.disable()
+        tool_ctl.auth_key_textbox.set_value(tool_ctl.auth_key_value)
+    end
+
+    -- generate the summary list
+    ---@param cfg plc_config
+    function tool_ctl.gen_summary(cfg)
+        setting_list.remove_all()
+
+        local alternate = false
+        local inner_width = setting_list.get_width() - 1
+
+        tool_ctl.show_key_btn.enable()
+        tool_ctl.auth_key_value = cfg.AuthKey or "" -- to show auth key
+
+        for i = 1, #fields do
+            local f = fields[i]
+            local height = 1
+            local label_w = string.len(f[2])
+            local val_max_w = (inner_width - label_w) + 1
+            local raw = cfg[f[1]]
+            local val = util.strval(raw)
+
+            if f[1] == "AuthKey" then val = string.rep("*", string.len(val)) end
+            if f[1] == "LogMode" then val = util.trinary(raw == log.MODE.APPEND, "append", "replace") end
+            if f[1] == "EmerCoolColor" and raw ~= nil then val = rsio.color_name(raw) end
+            if val == "nil" then val = "<not set>" end
+
+            local c = util.trinary(alternate, g_lg_fg_bg, cpair(colors.gray,colors.white))
+            alternate = not alternate
+
+            if string.len(val) > val_max_w then
+                local lines = util.strwrap(val, inner_width)
+                height = #lines + 1
+            end
+
+            local line = Div{parent=setting_list,height=height,fg_bg=c}
+            TextBox{parent=line,text=f[2],width=string.len(f[2]),fg_bg=cpair(colors.black,line.get_fg_bg().bkg)}
+
+            local textbox
+            if height > 1 then
+                textbox = TextBox{parent=line,x=1,y=2,text=val,height=height-1,alignment=LEFT}
+            else
+                textbox = TextBox{parent=line,x=label_w+1,y=1,text=val,alignment=RIGHT}
+            end
+
+            if f[1] == "AuthKey" then tool_ctl.auth_key_textbox = textbox end
+        end
+    end
+end
+
+-- reset terminal screen
+local function reset_term()
+    term.setTextColor(colors.white)
+    term.setBackgroundColor(colors.black)
+    term.clear()
+    term.setCursorPos(1, 1)
+end
+
+-- run the reactor PLC configurator
+---@param ask_config? boolean indicate if this is being called by the startup app due to an invalid configuration
+function configurator.configure(ask_config)
+    tool_ctl.ask_config = ask_config == true
+
+    load_settings(settings_cfg, true)
+    tool_ctl.has_config = load_settings(ini_cfg)
+
+    reset_term()
+
+    -- set overridden colors
+    for i = 1, #style.colors do
+        term.setPaletteColor(style.colors[i].c, style.colors[i].hex)
+    end
+
+    local status, error = pcall(function ()
+        local display = DisplayBox{window=term.current(),fg_bg=style.root}
+        config_view(display)
+
+        while true do
+            local event, param1, param2, param3 = util.pull_event()
+
+            -- handle event
+            if event == "timer" then
+                tcd.handle(param1)
+            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" or event == "double_click" then
+                local m_e = core.events.new_mouse_event(event, param1, param2, param3)
+                if m_e then display.handle_mouse(m_e) end
+            elseif event == "char" or event == "key" or event == "key_up" then
+                local k_e = core.events.new_key_event(event, param1, param2)
+                if k_e then display.handle_key(k_e) end
+            elseif event == "paste" then
+                display.handle_paste(param1)
+            end
+
+            if event == "terminate" then return end
+        end
+    end)
+
+    -- restore colors
+    for i = 1, #style.colors do
+        local r, g, b = term.nativePaletteColor(style.colors[i].c)
+        term.setPaletteColor(style.colors[i].c, r, g, b)
+    end
+
+    reset_term()
+    if not status then
+        println("configurator error: " .. error)
+    end
+
+    return status, error
+end
+
+return configurator

reactor-plc/panel/front_panel.lua

@@ -5,8 +5,8 @@
 local types      = require("scada-common.types")
 local util       = require("scada-common.util")
 
-local config     = require("reactor-plc.config")
 local databus    = require("reactor-plc.databus")
+local plc        = require("reactor-plc.plc")
 
 local style      = require("reactor-plc.panel.style")
 
@@ -23,15 +23,18 @@ local LED        = require("graphics.elements.indicators.led")
 local LEDPair    = require("graphics.elements.indicators.ledpair")
 local RGBLED     = require("graphics.elements.indicators.ledrgb")
 
-local TEXT_ALIGN = core.TEXT_ALIGN
+local ALIGN = core.ALIGN
 
 local cpair = core.cpair
 local border = core.border
 
+local ind_grn = style.ind_grn
+local ind_red = style.ind_red
+
 -- create new front panel view
 ---@param panel graphics_element main displaybox
 local function init(panel)
-    local header = TextBox{parent=panel,y=1,text="REACTOR PLC - UNIT ?",alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
+    local header = TextBox{parent=panel,y=1,text="REACTOR PLC - UNIT ?",alignment=ALIGN.CENTER,height=1,fg_bg=style.header}
     header.register(databus.ps, "unit_id", function (id) header.set_value(util.c("REACTOR PLC - UNIT ", id)) end)
 
     --
@@ -41,14 +44,14 @@ local function init(panel)
     local system = Div{parent=panel,width=14,height=18,x=2,y=3}
 
     local init_ok = LED{parent=system,label="STATUS",colors=cpair(colors.green,colors.red)}
-    local heartbeat = LED{parent=system,label="HEARTBEAT",colors=cpair(colors.green,colors.green_off)}
+    local heartbeat = LED{parent=system,label="HEARTBEAT",colors=ind_grn}
     system.line_break()
 
     init_ok.register(databus.ps, "init_ok", init_ok.update)
     heartbeat.register(databus.ps, "heartbeat", heartbeat.update)
 
     local reactor = LEDPair{parent=system,label="REACTOR",off=colors.red,c1=colors.yellow,c2=colors.green}
-    local modem = LED{parent=system,label="MODEM",colors=cpair(colors.green,colors.green_off)}
+    local modem = LED{parent=system,label="MODEM",colors=ind_grn}
     local network = RGBLED{parent=system,label="NETWORK",colors={colors.green,colors.red,colors.orange,colors.yellow,colors.gray}}
     network.update(types.PANEL_LINK_STATE.DISCONNECTED)
     system.line_break()
@@ -57,11 +60,11 @@ local function init(panel)
     modem.register(databus.ps, "has_modem", modem.update)
     network.register(databus.ps, "link_state", network.update)
 
-    local rt_main = LED{parent=system,label="RT MAIN",colors=cpair(colors.green,colors.green_off)}
-    local rt_rps  = LED{parent=system,label="RT RPS",colors=cpair(colors.green,colors.green_off)}
-    local rt_cmtx = LED{parent=system,label="RT COMMS TX",colors=cpair(colors.green,colors.green_off)}
-    local rt_cmrx = LED{parent=system,label="RT COMMS RX",colors=cpair(colors.green,colors.green_off)}
-    local rt_sctl = LED{parent=system,label="RT SPCTL",colors=cpair(colors.green,colors.green_off)}
+    local rt_main = LED{parent=system,label="RT MAIN",colors=ind_grn}
+    local rt_rps  = LED{parent=system,label="RT RPS",colors=ind_grn}
+    local rt_cmtx = LED{parent=system,label="RT COMMS TX",colors=ind_grn}
+    local rt_cmrx = LED{parent=system,label="RT COMMS RX",colors=ind_grn}
+    local rt_sctl = LED{parent=system,label="RT SPCTL",colors=ind_grn}
     system.line_break()
 
     rt_main.register(databus.ps, "routine__main", rt_main.update)
@@ -80,17 +83,17 @@ local function init(panel)
 
     local status = Div{parent=panel,width=19,height=18,x=17,y=3}
 
-    local active = LED{parent=status,x=2,width=12,label="RCT ACTIVE",colors=cpair(colors.green,colors.green_off)}
+    local active = LED{parent=status,x=2,width=12,label="RCT ACTIVE",colors=ind_grn}
 
     -- only show emergency coolant LED if emergency coolant is configured for this device
-    if type(config.EMERGENCY_COOL) == "table" then
+    if plc.config.EmerCoolEnable then
         local emer_cool = LED{parent=status,x=2,width=14,label="EMER COOLANT",colors=cpair(colors.yellow,colors.yellow_off)}
         emer_cool.register(databus.ps, "emer_cool", emer_cool.update)
     end
 
     local status_trip_rct = Rectangle{parent=status,width=20,height=3,x=1,border=border(1,colors.lightGray,true),even_inner=true,fg_bg=cpair(colors.black,colors.ivory)}
     local status_trip = Div{parent=status_trip_rct,width=18,height=1,fg_bg=cpair(colors.black,colors.lightGray)}
-    local scram = LED{parent=status_trip,width=10,label="RPS TRIP",colors=cpair(colors.red,colors.red_off),flash=true,period=flasher.PERIOD.BLINK_250_MS}
+    local scram = LED{parent=status_trip,width=10,label="RPS TRIP",colors=ind_red,flash=true,period=flasher.PERIOD.BLINK_250_MS}
 
     local controls_rct = Rectangle{parent=status,width=17,height=3,x=1,border=border(1,colors.white,true),even_inner=true,fg_bg=cpair(colors.black,colors.ivory)}
     local controls = Div{parent=controls_rct,width=15,height=1,fg_bg=cpair(colors.black,colors.white)}
@@ -105,8 +108,8 @@ local function init(panel)
     --
 
     local about   = Rectangle{parent=panel,width=32,height=3,x=2,y=16,border=border(1,colors.ivory),thin=true,fg_bg=cpair(colors.black,colors.white)}
-    local fw_v    = TextBox{parent=about,x=2,y=1,text="FW: v00.00.00",alignment=TEXT_ALIGN.LEFT,height=1}
-    local comms_v = TextBox{parent=about,x=17,y=1,text="NT: v00.00.00",alignment=TEXT_ALIGN.LEFT,height=1}
+    local fw_v    = TextBox{parent=about,x=2,y=1,text="FW: v00.00.00",alignment=ALIGN.LEFT,height=1}
+    local comms_v = TextBox{parent=about,x=17,y=1,text="NT: v00.00.00",alignment=ALIGN.LEFT,height=1}
 
     fw_v.register(databus.ps, "version", function (version) fw_v.set_value(util.c("FW: ", version)) end)
     comms_v.register(databus.ps, "comms_version", function (version) comms_v.set_value(util.c("NT: v", version)) end)
@@ -116,20 +119,20 @@ local function init(panel)
     --
 
     local rps = Rectangle{parent=panel,width=16,height=16,x=36,y=3,border=border(1,colors.lightGray),thin=true,fg_bg=cpair(colors.black,colors.lightGray)}
-    local rps_man  = LED{parent=rps,label="MANUAL",colors=cpair(colors.red,colors.red_off)}
-    local rps_auto = LED{parent=rps,label="AUTOMATIC",colors=cpair(colors.red,colors.red_off)}
-    local rps_tmo  = LED{parent=rps,label="TIMEOUT",colors=cpair(colors.red,colors.red_off)}
-    local rps_flt  = LED{parent=rps,label="PLC FAULT",colors=cpair(colors.red,colors.red_off)}
-    local rps_fail = LED{parent=rps,label="RCT FAULT",colors=cpair(colors.red,colors.red_off)}
+    local rps_man  = LED{parent=rps,label="MANUAL",colors=ind_red}
+    local rps_auto = LED{parent=rps,label="AUTOMATIC",colors=ind_red}
+    local rps_tmo  = LED{parent=rps,label="TIMEOUT",colors=ind_red}
+    local rps_flt  = LED{parent=rps,label="PLC FAULT",colors=ind_red}
+    local rps_fail = LED{parent=rps,label="RCT FAULT",colors=ind_red}
     rps.line_break()
-    local rps_dmg  = LED{parent=rps,label="HI DAMAGE",colors=cpair(colors.red,colors.red_off)}
-    local rps_tmp  = LED{parent=rps,label="HI TEMP",colors=cpair(colors.red,colors.red_off)}
+    local rps_dmg  = LED{parent=rps,label="HI DAMAGE",colors=ind_red}
+    local rps_tmp  = LED{parent=rps,label="HI TEMP",colors=ind_red}
     rps.line_break()
-    local rps_nof  = LED{parent=rps,label="LO FUEL",colors=cpair(colors.red,colors.red_off)}
-    local rps_wst  = LED{parent=rps,label="HI WASTE",colors=cpair(colors.red,colors.red_off)}
+    local rps_nof  = LED{parent=rps,label="LO FUEL",colors=ind_red}
+    local rps_wst  = LED{parent=rps,label="HI WASTE",colors=ind_red}
     rps.line_break()
-    local rps_ccl  = LED{parent=rps,label="LO CCOOLANT",colors=cpair(colors.red,colors.red_off)}
-    local rps_hcl  = LED{parent=rps,label="HI HCOOLANT",colors=cpair(colors.red,colors.red_off)}
+    local rps_ccl  = LED{parent=rps,label="LO CCOOLANT",colors=ind_red}
+    local rps_hcl  = LED{parent=rps,label="HI HCOOLANT",colors=ind_red}
 
     rps_man.register(databus.ps, "rps_manual", rps_man.update)
     rps_auto.register(databus.ps, "rps_automatic", rps_auto.update)

reactor-plc/panel/style.lua

@@ -39,4 +39,9 @@ style.colors = {
     { c = colors.brown,     hex = 0x672223 }    -- RED OFF
 }
 
+-- COMMON COLOR PAIRS --
+
+style.ind_grn = cpair(colors.green, colors.green_off)
+style.ind_red = cpair(colors.red, colors.red_off)
+
 return style

reactor-plc/plc.lua

@@ -16,7 +16,7 @@ local PROTOCOL = comms.PROTOCOL
 local DEVICE_TYPE = comms.DEVICE_TYPE
 local ESTABLISH_ACK = comms.ESTABLISH_ACK
 local RPLC_TYPE = comms.RPLC_TYPE
-local SCADA_MGMT_TYPE = comms.SCADA_MGMT_TYPE
+local MGMT_TYPE = comms.MGMT_TYPE
 local AUTO_ACK = comms.PLC_AUTO_ACK
 
 local RPS_LIMITS = const.RPS_LIMITS
@@ -26,14 +26,74 @@ local RPS_LIMITS = const.RPS_LIMITS
 local PCALL_SCRAM_MSG = "pcall: Scram requires the reactor to be active."
 local PCALL_START_MSG = "pcall: Reactor is already active."
 
+---@type plc_config
+local config = {}
+
+plc.config = config
+
+-- load the PLC configuration
+function plc.load_config()
+    if not settings.load("/reactor-plc.settings") then return false end
+
+    config.Networked = settings.get("Networked")
+    config.UnitID = settings.get("UnitID")
+
+    config.EmerCoolEnable = settings.get("EmerCoolEnable")
+    config.EmerCoolSide = settings.get("EmerCoolSide")
+    config.EmerCoolColor = settings.get("EmerCoolColor")
+
+    config.SVR_Channel = settings.get("SVR_Channel")
+    config.PLC_Channel = settings.get("PLC_Channel")
+    config.ConnTimeout = settings.get("ConnTimeout")
+    config.TrustedRange = settings.get("TrustedRange")
+    config.AuthKey = settings.get("AuthKey")
+
+    config.LogMode = settings.get("LogMode")
+    config.LogPath = settings.get("LogPath")
+    config.LogDebug = settings.get("LogDebug")
+
+    local cfv = util.new_validator()
+
+    cfv.assert_type_bool(config.Networked)
+    cfv.assert_type_int(config.UnitID)
+    cfv.assert_type_bool(config.EmerCoolEnable)
+
+    if config.Networked == true then
+        cfv.assert_channel(config.SVR_Channel)
+        cfv.assert_channel(config.PLC_Channel)
+        cfv.assert_type_num(config.ConnTimeout)
+        cfv.assert_min(config.ConnTimeout, 2)
+        cfv.assert_type_num(config.TrustedRange)
+        cfv.assert_min(config.TrustedRange, 0)
+        cfv.assert_type_str(config.AuthKey)
+
+        if type(config.AuthKey) == "string" then
+            local len = string.len(config.AuthKey)
+            cfv.assert_eq(len == 0 or len >= 8, true)
+        end
+    end
+
+    cfv.assert_type_int(config.LogMode)
+    cfv.assert_range(config.LogMode, 0, 1)
+    cfv.assert_type_str(config.LogPath)
+    cfv.assert_type_bool(config.LogDebug)
+
+    -- check emergency coolant configuration if enabled
+    if config.EmerCoolEnable then
+        cfv.assert_eq(rsio.is_valid_side(config.EmerCoolSide), true)
+        cfv.assert_eq(config.EmerCoolColor == nil or rsio.is_color(config.EmerCoolColor), true)
+    end
+
+    return cfv.valid()
+end
+
 -- RPS: Reactor Protection System<br>
 -- identifies dangerous states and SCRAMs reactor if warranted<br>
 -- autonomous from main SCADA supervisor/coordinator control
 ---@nodiscard
 ---@param reactor table
 ---@param is_formed boolean
----@param emer_cool nil|table emergency coolant configuration
-function plc.rps_init(reactor, is_formed, emer_cool)
+function plc.rps_init(reactor, is_formed)
     local state_keys = {
         high_dmg = 1,
         high_temp = 2,
@@ -73,22 +133,22 @@ function plc.rps_init(reactor, is_formed, emer_cool)
     ---@param state boolean true to enable emergency coolant, false to disable
     local function _set_emer_cool(state)
         -- check if this was configured: if it's a table, fields have already been validated.
-        if type(emer_cool) == "table" then
+        if config.EmerCoolEnable then
             local level = rsio.digital_write_active(rsio.IO.U_EMER_COOL, state)
 
             if level ~= false then
-                if rsio.is_color(emer_cool.color) then
-                    local output = rs.getBundledOutput(emer_cool.side)
+                if rsio.is_color(config.EmerCoolColor) then
+                    local output = rs.getBundledOutput(config.EmerCoolSide)
 
                     if rsio.digital_write(level) then
-                        output = colors.combine(output, emer_cool.color)
+                        output = colors.combine(output, config.EmerCoolColor)
                     else
-                        output = colors.subtract(output, emer_cool.color)
+                        output = colors.subtract(output, config.EmerCoolColor)
                     end
 
-                    rs.setBundledOutput(emer_cool.side, output)
+                    rs.setBundledOutput(config.EmerCoolSide, output)
                 else
-                    rs.setOutput(emer_cool.side, rsio.digital_write(level))
+                    rs.setOutput(config.EmerCoolSide, rsio.digital_write(level))
                 end
 
                 if state ~= self.emer_cool_active then
@@ -238,8 +298,9 @@ function plc.rps_init(reactor, is_formed, emer_cool)
         self.state[state_keys.sys_fail] = true
     end
 
-    -- SCRAM the reactor now (blocks waiting for server tick)
+    -- SCRAM the reactor now<br>
     ---@return boolean success
+    --- EVENT_CONSUMER: this function consumes events
     function public.scram()
         log.info("RPS: reactor SCRAM")
 
@@ -254,8 +315,9 @@ function plc.rps_init(reactor, is_formed, emer_cool)
         end
     end
 
-    -- start the reactor now (blocks waiting for server tick)
+    -- start the reactor now<br>
     ---@return boolean success
+    --- EVENT_CONSUMER: this function consumes events
     function public.activate()
         if not self.tripped then
             log.info("RPS: reactor start")
@@ -443,16 +505,12 @@ end
 
 -- Reactor PLC Communications
 ---@nodiscard
----@param id integer reactor ID
 ---@param version string PLC version
 ---@param nic nic network interface device
----@param plc_channel integer PLC comms channel
----@param svr_channel integer supervisor server channel
----@param range integer trusted device connection range
 ---@param reactor table reactor device
 ---@param rps rps RPS reference
 ---@param conn_watchdog watchdog watchdog reference
-function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, rps, conn_watchdog)
+function plc.comms(version, nic, reactor, rps, conn_watchdog)
     local self = {
         sv_addr = comms.BROADCAST,
         seq_num = 0,
@@ -466,13 +524,13 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
         max_burn_rate = nil
     }
 
-    comms.set_trusted_range(range)
+    comms.set_trusted_range(config.TrustedRange)
 
     -- PRIVATE FUNCTIONS --
 
     -- configure network channels
     nic.closeAll()
-    nic.open(plc_channel)
+    nic.open(config.PLC_Channel)
 
     -- send an RPLC packet
     ---@param msg_type RPLC_TYPE
@@ -481,15 +539,15 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
         local s_pkt = comms.scada_packet()
         local r_pkt = comms.rplc_packet()
 
-        r_pkt.make(id, msg_type, msg)
+        r_pkt.make(config.UnitID, msg_type, msg)
         s_pkt.make(self.sv_addr, self.seq_num, PROTOCOL.RPLC, r_pkt.raw_sendable())
 
-        nic.transmit(svr_channel, plc_channel, s_pkt)
+        nic.transmit(config.SVR_Channel, config.PLC_Channel, s_pkt)
         self.seq_num = self.seq_num + 1
     end
 
     -- send a SCADA management packet
-    ---@param msg_type SCADA_MGMT_TYPE
+    ---@param msg_type MGMT_TYPE
     ---@param msg table
     local function _send_mgmt(msg_type, msg)
         local s_pkt = comms.scada_packet()
@@ -498,7 +556,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
         m_pkt.make(msg_type, msg)
         s_pkt.make(self.sv_addr, self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
-        nic.transmit(svr_channel, plc_channel, s_pkt)
+        nic.transmit(config.SVR_Channel, config.PLC_Channel, s_pkt)
         self.seq_num = self.seq_num + 1
     end
 
@@ -600,7 +658,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
     -- keep alive ack
     ---@param srv_time integer
     local function _send_keep_alive_ack(srv_time)
-        _send_mgmt(SCADA_MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
+        _send_mgmt(MGMT_TYPE.KEEP_ALIVE, { srv_time, util.time() })
     end
 
     -- general ack
@@ -612,10 +670,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
 
     -- send structure properties (these should not change, server will cache these)
     local function _send_struct()
-        local min_pos = { x = 0, y = 0, z = 0 }
-        local max_pos = { x = 0, y = 0, z = 0 }
-
-        local mek_data = { false, 0, 0, 0, min_pos, max_pos, 0, 0, 0, 0, 0, 0, 0, 0 }
+        local mek_data = { false, 0, 0, 0, types.new_zero_coordinate(), types.new_zero_coordinate(), 0, 0, 0, 0, 0, 0, 0, 0 }
 
         local tasks = {
             function () mek_data[1]  = reactor.getLength() end,
@@ -668,12 +723,12 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
     function public.close()
         conn_watchdog.cancel()
         public.unlink()
-        _send_mgmt(SCADA_MGMT_TYPE.CLOSE, {})
+        _send_mgmt(MGMT_TYPE.CLOSE, {})
     end
 
     -- attempt to establish link with supervisor
     function public.send_link_req()
-        _send_mgmt(SCADA_MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.PLC, id })
+        _send_mgmt(MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.PLC, config.UnitID })
     end
 
     -- send live status information
@@ -685,21 +740,18 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
             local heating_rate = 0.0    ---@type number
 
             if (not no_reactor) and rps.is_formed() then
-                if _update_status_cache() then
-                    mek_data = self.status_cache
-                end
-
+                if _update_status_cache() then mek_data = self.status_cache end
                 heating_rate = reactor.getHeatingRate()
             end
 
             local sys_status = {
-                util.time(),                    -- timestamp
-                (not self.scrammed),            -- requested control state
-                no_reactor,                     -- no reactor peripheral connected
-                formed,                         -- reactor formed
-                self.auto_ack_token,            -- token to indicate auto command has been received before this status update
-                heating_rate,                   -- heating rate
-                mek_data                        -- mekanism status data
+                util.time(),         -- timestamp
+                (not self.scrammed), -- requested control state
+                no_reactor,          -- no reactor peripheral connected
+                formed,              -- reactor formed
+                self.auto_ack_token, -- indicate auto command received prior to this status update
+                heating_rate,        -- heating rate
+                mek_data             -- mekanism status data
             }
 
             _send(RPLC_TYPE.STATUS, sys_status)
@@ -769,7 +821,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
         local src_addr = packet.scada_frame.src_addr()
 
         -- handle packets now that we have prints setup
-        if l_chan == plc_channel then
+        if l_chan == config.PLC_Channel then
             -- check sequence number
             if self.r_seq_num == nil then
                 self.r_seq_num = packet.scada_frame.seq_num()
@@ -837,6 +889,10 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
                         -- enable the reactor
                         self.scrammed = false
                         _send_ack(packet.type, rps.activate())
+                    elseif packet.type == RPLC_TYPE.RPS_DISABLE then
+                        -- disable the reactor, but do not trip
+                        self.scrammed = true
+                        _send_ack(packet.type, rps.scram())
                     elseif packet.type == RPLC_TYPE.RPS_SCRAM then
                         -- disable the reactor per manual request
                         self.scrammed = true
@@ -929,7 +985,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
                 ---@cast packet mgmt_frame
                 -- if linked, only accept packets from configured supervisor
                 if self.linked then
-                    if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                    if packet.type == MGMT_TYPE.KEEP_ALIVE then
                         -- keep alive request received, echo back
                         if packet.length == 1 and type(packet.data[1]) == "number" then
                             local timestamp = packet.data[1]
@@ -945,7 +1001,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
                         else
                             log.debug("SCADA_MGMT keep alive packet length/type mismatch")
                         end
-                    elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                    elseif packet.type == MGMT_TYPE.CLOSE then
                         -- handle session close
                         conn_watchdog.cancel()
                         public.unlink()
@@ -954,7 +1010,7 @@ function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, r
                     else
                         log.debug("received unsupported SCADA_MGMT packet type " .. packet.type)
                     end
-                elseif packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                elseif packet.type == MGMT_TYPE.ESTABLISH then
                     -- link request confirmation
                     if packet.length == 1 then
                         local est_ack = packet.data[1]

reactor-plc/renderer.lua

@@ -5,18 +5,23 @@
 local panel_view = require("reactor-plc.panel.front_panel")
 local style      = require("reactor-plc.panel.style")
 
+local core       = require("graphics.core")
 local flasher    = require("graphics.flasher")
 
 local DisplayBox = require("graphics.elements.displaybox")
 
+---@class reactor_plc_renderer
 local renderer = {}
 
 local ui = {
     display = nil
 }
 
--- start the UI
-function renderer.start_ui()
+-- try to start the UI
+---@return boolean success, any error_msg
+function renderer.try_start_ui()
+    local status, msg = true, nil
+
     if ui.display == nil then
         -- reset terminal
         term.setTextColor(colors.white)
@@ -30,12 +35,22 @@ function renderer.start_ui()
         end
 
         -- init front panel view
-        ui.display = DisplayBox{window=term.current(),fg_bg=style.root}
-        panel_view(ui.display)
+        status, msg = pcall(function ()
+            ui.display = DisplayBox{window=term.current(),fg_bg=style.root}
+            panel_view(ui.display)
+        end)
 
-        -- start flasher callback task
-        flasher.run()
+        if status then
+            -- start flasher callback task
+            flasher.run()
+        else
+            -- report fail and close ui
+            msg = core.extract_assert_msg(msg)
+            renderer.close_ui()
+        end
     end
+
+    return status, msg
 end
 
 -- close out the UI

reactor-plc/startup.lua

@@ -4,65 +4,53 @@
 
 require("/initenv").init_env()
 
-local comms    = require("scada-common.comms")
-local crash    = require("scada-common.crash")
-local log      = require("scada-common.log")
-local mqueue   = require("scada-common.mqueue")
-local network  = require("scada-common.network")
-local ppm      = require("scada-common.ppm")
-local rsio     = require("scada-common.rsio")
-local util     = require("scada-common.util")
+local comms     = require("scada-common.comms")
+local crash     = require("scada-common.crash")
+local log       = require("scada-common.log")
+local mqueue    = require("scada-common.mqueue")
+local network   = require("scada-common.network")
+local ppm       = require("scada-common.ppm")
+local util      = require("scada-common.util")
 
-local config   = require("reactor-plc.config")
-local databus  = require("reactor-plc.databus")
-local plc      = require("reactor-plc.plc")
-local renderer = require("reactor-plc.renderer")
-local threads  = require("reactor-plc.threads")
+local configure = require("reactor-plc.configure")
+local databus   = require("reactor-plc.databus")
+local plc       = require("reactor-plc.plc")
+local renderer  = require("reactor-plc.renderer")
+local threads   = require("reactor-plc.threads")
 
-local R_PLC_VERSION = "v1.5.7"
+local R_PLC_VERSION = "v1.6.11"
 
 local println = util.println
 local println_ts = util.println_ts
 
 ----------------------------------------
--- config validation
+-- get configuration
 ----------------------------------------
 
-local cfv = util.new_validator()
-
-cfv.assert_type_bool(config.NETWORKED)
-cfv.assert_type_int(config.REACTOR_ID)
-cfv.assert_channel(config.SVR_CHANNEL)
-cfv.assert_channel(config.PLC_CHANNEL)
-cfv.assert_type_int(config.TRUSTED_RANGE)
-cfv.assert_type_num(config.COMMS_TIMEOUT)
-cfv.assert_min(config.COMMS_TIMEOUT, 2)
-cfv.assert_type_str(config.LOG_PATH)
-cfv.assert_type_int(config.LOG_MODE)
-
-assert(cfv.valid(), "bad config file: missing/invalid fields")
-
--- check emergency coolant configuration
-if type(config.EMERGENCY_COOL) == "table" then
-    if not rsio.is_valid_side(config.EMERGENCY_COOL.side) then
-        assert(false, "bad config file: emergency coolant side unrecognized")
-    elseif config.EMERGENCY_COOL.color ~= nil and not rsio.is_color(config.EMERGENCY_COOL.color) then
-        assert(false, "bad config file: emergency coolant invalid redstone channel color provided")
+if not plc.load_config() then
+    -- try to reconfigure (user action)
+    local success, error = configure.configure(true)
+    if success then
+        assert(plc.load_config(), "failed to load valid configuration")
+    else
+        assert(success, "reactor PLC configuration error: " .. error)
     end
 end
 
+local config = plc.config
+
 ----------------------------------------
 -- log init
 ----------------------------------------
 
-log.init(config.LOG_PATH, config.LOG_MODE, config.LOG_DEBUG == true)
+log.init(config.LogPath, config.LogMode, config.LogDebug)
 
 log.info("========================================")
 log.info("BOOTING reactor-plc.startup " .. R_PLC_VERSION)
 log.info("========================================")
 println(">> Reactor PLC " .. R_PLC_VERSION .. " <<")
 
-crash.set_env("plc", R_PLC_VERSION)
+crash.set_env("reactor-plc", R_PLC_VERSION)
 
 ----------------------------------------
 -- main application
@@ -75,32 +63,32 @@ local function main()
 
     -- record firmware versions and ID
     databus.tx_versions(R_PLC_VERSION, comms.version)
-    databus.tx_id(config.REACTOR_ID)
+    databus.tx_id(config.UnitID)
 
     -- mount connected devices
     ppm.mount_all()
 
     -- message authentication init
-    if type(config.AUTH_KEY) == "string" then
-        network.init_mac(config.AUTH_KEY)
+    if type(config.AuthKey) == "string" and string.len(config.AuthKey) > 0 then
+        network.init_mac(config.AuthKey)
     end
 
     -- shared memory across threads
     ---@class plc_shared_memory
     local __shared_memory = {
         -- networked setting
-        networked = config.NETWORKED,   ---@type boolean
+        networked = config.Networked,
 
         -- PLC system state flags
         ---@class plc_state
         plc_state = {
-            init_ok        = true,
-            fp_ok          = false,
-            shutdown       = false,
-            degraded       = true,
+            init_ok = true,
+            fp_ok = false,
+            shutdown = false,
+            degraded = true,
             reactor_formed = true,
-            no_reactor     = true,
-            no_modem       = true
+            no_reactor = true,
+            no_modem = true
         },
 
         -- control setpoints
@@ -118,10 +106,10 @@ local function main()
 
         -- system objects
         plc_sys = {
-            rps = nil,              ---@type rps
-            nic = nil,              ---@type nic
-            plc_comms = nil,        ---@type plc_comms
-            conn_watchdog = nil     ---@type watchdog
+            rps = nil,          ---@type rps
+            nic = nil,          ---@type nic
+            plc_comms = nil,    ---@type plc_comms
+            conn_watchdog = nil ---@type watchdog
         },
 
         -- message queues
@@ -184,10 +172,9 @@ local function main()
         -- front panel time!
         if not renderer.ui_ready() then
             local message
-            plc_state.fp_ok, message = pcall(renderer.start_ui)
+            plc_state.fp_ok, message = renderer.try_start_ui()
 
             if not plc_state.fp_ok then
-                renderer.close_ui()
                 println_ts(util.c("UI error: ", message))
                 println("init> running without front panel")
                 log.error(util.c("front panel GUI render failed with error ", message))
@@ -197,18 +184,17 @@ local function main()
 
         if plc_state.init_ok then
             -- init reactor protection system
-            smem_sys.rps = plc.rps_init(smem_dev.reactor, plc_state.reactor_formed, config.EMERGENCY_COOL)
+            smem_sys.rps = plc.rps_init(smem_dev.reactor, plc_state.reactor_formed)
             log.debug("init> rps init")
 
             if __shared_memory.networked then
                 -- comms watchdog
-                smem_sys.conn_watchdog = util.new_watchdog(config.COMMS_TIMEOUT)
+                smem_sys.conn_watchdog = util.new_watchdog(config.ConnTimeout)
                 log.debug("init> conn watchdog started")
 
                 -- create network interface then setup comms
                 smem_sys.nic = network.nic(smem_dev.modem)
-                smem_sys.plc_comms = plc.comms(config.REACTOR_ID, R_PLC_VERSION, smem_sys.nic, config.PLC_CHANNEL, config.SVR_CHANNEL,
-                                                config.TRUSTED_RANGE, smem_dev.reactor, smem_sys.rps, smem_sys.conn_watchdog)
+                smem_sys.plc_comms = plc.comms(R_PLC_VERSION, smem_sys.nic, smem_dev.reactor, smem_sys.rps, smem_sys.conn_watchdog)
                 log.debug("init> comms init")
             else
                 _println_no_fp("init> starting in offline mode")
@@ -216,7 +202,7 @@ local function main()
             end
 
             -- notify user of emergency coolant configuration status
-            if config.EMERGENCY_COOL ~= nil then
+            if config.EmerCoolEnable then
                 println("init> emergency coolant control ready")
                 log.info("init> running with emergency coolant control available")
             end

reactor-plc/threads.lua

@@ -173,7 +173,8 @@ function threads.thread__main(smem, init)
                         plc_state.degraded = true
                     elseif networked and type == "modem" then
                         -- we only care if this is our wireless modem
-                        if nic.is_modem(device) then
+                        -- note, check init_ok first since nic will be nil if it is false
+                        if plc_state.init_ok and nic.is_modem(device) then
                             nic.disconnect()
 
                             println_ts("comms modem disconnected!")
@@ -193,7 +194,7 @@ function threads.thread__main(smem, init)
                                 end
                             end
                         else
-                            log.warning("non-comms modem disconnected")
+                            log.warning("a modem was disconnected")
                         end
                     end
                 end
@@ -235,7 +236,8 @@ function threads.thread__main(smem, init)
                             rps.reset()
                         end
                     elseif networked and type == "modem" then
-                        if device.isWireless() and not nic.is_connected() then
+                        -- note, check init_ok first since nic will be nil if it is false
+                        if device.isWireless() and not (plc_state.init_ok and nic.is_connected()) then
                             -- reconnected modem
                             plc_dev.modem = device
                             plc_state.no_modem = false
@@ -265,7 +267,8 @@ function threads.thread__main(smem, init)
 
                 -- update indicators
                 databus.tx_hw_status(plc_state)
-            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" then
+            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" or
+                   event == "double_click" then
                 -- handle a mouse event
                 renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3))
             elseif event == "clock_start" then

rtu/config.lua

@@ -1,73 +0,0 @@
-local rsio = require("scada-common.rsio")
-
-local config = {}
-
--- supervisor comms channel
-config.SVR_CHANNEL = 16240
--- RTU/MODBUS comms channel
-config.RTU_CHANNEL = 16242
--- max trusted modem message distance (0 to disable check)
-config.TRUSTED_RANGE = 0
--- time in seconds (>= 2) before assuming a remote device is no longer active
-config.COMMS_TIMEOUT = 5
--- facility authentication key (do NOT use one of your passwords)
--- this enables verifying that messages are authentic
--- all devices on the same network must use the same key
--- config.AUTH_KEY = "SCADAfacility123"
-
--- alarm sounder volume (0.0 to 3.0, 1.0 being standard max volume, this is the option given to to speaker.play())
--- note: alarm sine waves are at half saturation, so that multiple will be required to reach full scale
-config.SOUNDER_VOLUME = 1.0
-
--- log path
-config.LOG_PATH = "/log.txt"
--- log mode
---  0 = APPEND (adds to existing file on start)
---  1 = NEW (replaces existing file on start)
-config.LOG_MODE = 0
--- true to log verbose debug messages
-config.LOG_DEBUG = false
-
--- RTU peripheral devices (named: side/network device name)
-config.RTU_DEVICES = {
-    {
-        name = "boilerValve_0",
-        index = 1,
-        for_reactor = 1
-    },
-    {
-        name = "turbineValve_0",
-        index = 1,
-        for_reactor = 1
-    }
-}
--- RTU redstone interface definitions
-config.RTU_REDSTONE = {
-    -- {
-    --     for_reactor = 1,
-    --     io = {
-    --         {
-    --             port = rsio.IO.WASTE_PO,
-    --             side = "top",
-    --             bundled_color = colors.red
-    --         },
-    --         {
-    --             port = rsio.IO.WASTE_PU,
-    --             side = "top",
-    --             bundled_color = colors.orange
-    --         },
-    --         {
-    --             port = rsio.IO.WASTE_POPL,
-    --             side = "top",
-    --             bundled_color = colors.yellow
-    --         },
-    --         {
-    --             port = rsio.IO.WASTE_AM,
-    --             side = "top",
-    --             bundled_color = colors.lime
-    --         }
-    --     }
-    -- }
-}
-
-return config

rtu/modbus.lua

@@ -215,7 +215,7 @@ function modbus.new(rtu_dev, use_parallel_read)
     ---@param value any
     ---@return boolean ok, MODBUS_EXCODE
     local function _5_write_single_coil(c_addr, value)
-        local response = nil
+        local response = MODBUS_EXCODE.OK
         local _, coils, _, _ = rtu_dev.io_count()
         local return_ok = c_addr <= coils
 
@@ -239,7 +239,7 @@ function modbus.new(rtu_dev, use_parallel_read)
     ---@param value any
     ---@return boolean ok, MODBUS_EXCODE
     local function _6_write_single_holding_register(hr_addr, value)
-        local response = nil
+        local response = MODBUS_EXCODE.OK
         local _, _, _, hold_regs = rtu_dev.io_count()
         local return_ok = hr_addr <= hold_regs
 
@@ -263,7 +263,7 @@ function modbus.new(rtu_dev, use_parallel_read)
     ---@param values any
     ---@return boolean ok, MODBUS_EXCODE
     local function _15_write_multiple_coils(c_addr_start, values)
-        local response = nil
+        local response = MODBUS_EXCODE.OK
         local _, coils, _, _ = rtu_dev.io_count()
         local count = #values
         local return_ok = ((c_addr_start + count) <= (coils + 1)) and (count > 0)
@@ -292,7 +292,7 @@ function modbus.new(rtu_dev, use_parallel_read)
     ---@param values any
     ---@return boolean ok, MODBUS_EXCODE
     local function _16_write_multiple_holding_registers(hr_addr_start, values)
-        local response = nil
+        local response = MODBUS_EXCODE.OK
         local _, _, _, hold_regs = rtu_dev.io_count()
         local count = #values
         local return_ok = ((hr_addr_start + count) <= (hold_regs + 1)) and (count > 0)
@@ -403,7 +403,7 @@ function modbus.new(rtu_dev, use_parallel_read)
         end
 
         if type(response) == "table" then
-        elseif type(response) == "nil" then
+        elseif response == MODBUS_EXCODE.OK then
             response = {}
         else
             response = { response }