Merge pull request #236 from MikaylaFischler/devel

2023.05.22 Release

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+	"image": "mcr.microsoft.com/devcontainers/universal:2",
+	"features": {
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"sumneko.lua",
+				"jackmacwindows.vscode-computercraft",
+				"ms-python.python",
+				"Catppuccin.catppuccin-vsc-icons",
+				"melishev.feather-vscode"
+			]
+		}
+	}
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots and Logs**
+If applicable, add screenshots to help explain your problem. Please include a text snippet from the log.txt files if possible, otherwise include a screenshot.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/check.yml

@@ -0,0 +1,31 @@
+name: Lua Checks
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - latest
+      - devel
+  pull_request:
+    branches:
+      - main
+      - latest
+      - devel
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3.5.1
+      - name: Luacheck
+        uses: lunarmodules/luacheck@v1.1.0
+        with:
+          # Argument Explanations
+          # -i 121 = Setting a read-only global variable
+          #    512 = Loop can be executed at most once
+          #    542 = An empty if branch
+          # --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

.github/workflows/shields.yml

@@ -0,0 +1,47 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy Component Versions
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Setup Python
+        uses: actions/setup-python@v3.1.3
+      - run: mkdir shields
+      - run: python imgen.py shields
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload shields JSON
+          path: 'shields/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,2 @@
+_notes/
+program.sh

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "sumneko.lua",
+        "jackmacwindows.vscode-computercraft",
+        "ms-python.python"
+    ]
+}

.vscode/settings.json

@@ -1,13 +1,29 @@
 {
     "Lua.diagnostics.globals": [
-        "term",
-        "fs",
-        "peripheral",
-        "rs",
+        "_HOST",
         "bit",
-        "parallel",
         "colors",
+        "fs",
+        "http",
+        "parallel",
+        "periphemu",
+        "peripheral",
+        "read",
+        "rs",
+        "settings",
+        "shell",
+        "term",
         "textutils",
-        "shell"
+        "window"
+    ],
+    "Lua.diagnostics.severity": {
+        "unused-local": "Information",
+        "unused-vararg": "Information",
+        "unused-function": "Warning",
+        "unused-label": "Information"
+    },
+    "Lua.hint.setType": true,
+    "Lua.diagnostics.disable": [
+        "duplicate-set-field"
     ]
 }

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Mikayla Fischler
+Copyright © 2022 - 2023 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

@@ -1,13 +1,52 @@
 # cc-mek-scada
 Configurable ComputerCraft SCADA system for multi-reactor control of Mekanism fission reactors with a GUI, automatic safety features, waste processing control, and more! 
 
-This requires CC: Tweaked and Mekanism v10.0+ (10.1 recommended for full feature set).
+![GitHub](https://img.shields.io/github/license/MikaylaFischler/cc-mek-scada)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/MikaylaFischler/cc-mek-scada?include_prereleases)
+![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/MikaylaFischler/cc-mek-scada/check.yml?branch=main&label=main)
+![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/MikaylaFischler/cc-mek-scada/check.yml?branch=latest&label=latest)
+![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/MikaylaFischler/cc-mek-scada/check.yml?branch=devel&label=devel)
 
+Mod Requirements:
+- CC: Tweaked
+- Mekanism v10.1+
+
+Mod Recommendations:
+- Advanced Peripherals (adds the capability to detect environmental radiation levels)
+
+v10.1+ is required due the complete support of CC:Tweaked added in Mekanism v10.1
+
+There was also an apparent bug with boilers disconnecting and reconnecting when active in my test world on 10.0.24, so it may not even have been an option to fully implement this with support for 10.0.
+
+## Released Component Versions
+
+### Core
+
+![Bootloader](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Fbootloader.json)
+![Comms](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Fcomms.json)
+
+### Utilities
+
+![Installer](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Finstaller.json)
+
+### Applications
+
+![Reactor PLC](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Freactor-plc.json)
+![RTU](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Frtu.json)
+![Supervisor](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Fsupervisor.json)
+![Coordinator](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Fcoordinator.json)
+![Pocket](https://img.shields.io/endpoint?url=https%3A%2F%2Fmikaylafischler.github.io%2Fcc-mek-scada%2Fpocket.json)
+
+## Installation
+
+You can install this on a ComputerCraft computer using either:
+* `wget https://raw.githubusercontent.com/MikaylaFischler/cc-mek-scada/main/ccmsi.lua`
+* `pastebin get iUMjgW0C ccmsi.lua`
 
 ## [SCADA](https://en.wikipedia.org/wiki/SCADA)
 > Supervisory control and data acquisition (SCADA) is a control system architecture comprising computers, networked data communications and graphical user interfaces for high-level supervision of machines and processes. It also covers sensors and other devices, such as programmable logic controllers, which interface with process plant or machinery.
 
-This project implements concepts of a SCADA system in ComputerCraft (because why not? ..okay don't answer that). I recommend reviewing that linked wikipedia page on SCADA if you want to understand the concepts used here.
+This project implements concepts of a SCADA system in ComputerCraft (because why not? ..okay don't answer that). I recommend reviewing that linked wikipedia page on SCADA if you *want* to understand the concepts used here.
 
 ![Architecture](https://upload.wikimedia.org/wikipedia/commons/thumb/1/10/Functional_levels_of_a_Distributed_Control_System.svg/1000px-Functional_levels_of_a_Distributed_Control_System.svg.png)
 
@@ -35,7 +74,7 @@ The RTU control code is relatively unique, as instead of having instructions be
 
 ### PLCs
 
-PLCs are advanced devices that allow for both reporting and control to/from the SCADA system in addition to programed behaviors independent of the SCADA system. Currently there is only one type of PLC, and that is the reactor PLC. This is responsible for reporting on and controlling the reactor as a part of the SCADA system, and independently regulating the safety of the reactor. It checks the status for multiple hazard scenarios and shuts down the reactor if any condition is satisfied.
+PLCs are advanced devices that allow for both reporting and control to/from the SCADA system in addition to programed behaviors independent of the SCADA system. Currently there is only one type of PLC, and that is the reactor PLC. This is responsible for reporting on and controlling the reactor as a part of the SCADA system, and independently regulating the safety of the reactor. It checks the status for multiple hazard scenarios and shuts down the reactor if any condition is met.
 
 There can and should only be one of these per reactor. A single Advanced Computer will act as the PLC, with either a direct connection (physical contact) or a wired modem connection to the reactor logic port.
 
@@ -53,9 +92,8 @@ TBD, I am planning on AES symmetric encryption for security + HMAC to prevent re
 
 This is somewhat important here as otherwise anyone can just control your setup, which is undeseriable. Unlike normal Minecraft PVP chaos, it would be very difficult to identify who is messing with your system, as with an Ender Modem they can do it from effectively anywhere and the server operators would have to check every computer's filesystem to find suspicious code. 
 
-The only other possible security mitigation for commanding (no effect on monitoring) is to enforce a maximum authorized transmission range (which I will probably also do, or maybe fall back to), as modem message events contain the transmission distance.
+The other security mitigation for commanding (no effect on monitoring) is to enforce a maximum authorized transmission range, which has been added as a configurable feature.
 
 ## Known Issues
 
-GitHub issue \#29:
-It appears that with Mekanism 10.0, a boiler peripheral may rapidly disconnect/reconnect constantly while running. This will prevent that RTU from operating correctly while also filling up the log file. This may be due to a very specific version interaction of CC: Tweaked and Mekansim, so you are welcome to try this on Mekanism 10.0 servers, but do be aware it may not work.
+None yet since the switch to requiring 10.1+!

ccmsi.lua

@@ -0,0 +1,670 @@
+--
+-- ComputerCraft Mekanism SCADA System Installer Utility
+--
+
+--[[
+Copyright (c) 2023 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,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+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.0"
+
+local install_dir = "/.install-cache"
+local repo_path = "http://raw.githubusercontent.com/MikaylaFischler/cc-mek-scada/"
+
+local opts = { ... }
+local mode = nil
+local app = nil
+
+-- record the local installation manifest
+---@param manifest table
+---@param dependencies table
+local function write_install_manifest(manifest, dependencies)
+    local versions = {}
+    for key, value in pairs(manifest.versions) do
+        local is_dependency = false
+        for _, dependency in pairs(dependencies) do
+            if key == "bootloader" and dependency == "system" then
+                is_dependency = true
+                break
+            end
+        end
+
+        if key == app or key == "comms" or is_dependency then versions[key] = value end
+    end
+
+    manifest.versions = versions
+
+    local imfile = fs.open("install_manifest.json", "w")
+    imfile.write(textutils.serializeJSON(manifest))
+    imfile.close()
+end
+
+--
+-- get and validate command line options
+--
+
+println("-- CC Mekanism SCADA Installer " .. CCMSI_VERSION .. " --")
+
+if #opts == 0 or opts[1] == "help" then
+    println("usage: ccmsi <mode> <app> <tag/branch>")
+    println("<mode>")
+    term.setTextColor(colors.lightGray)
+    println(" check       - check latest versions avilable")
+    term.setTextColor(colors.yellow)
+    println("               ccmsi check <tag/branch> for target")
+    term.setTextColor(colors.lightGray)
+    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")
+    term.setTextColor(colors.white)
+    println("<app>")
+    term.setTextColor(colors.lightGray)
+    println(" reactor-plc - reactor PLC firmware")
+    println(" rtu         - RTU firmware")
+    println(" supervisor  - supervisor server application")
+    println(" coordinator - coordinator application")
+    println(" pocket      - pocket application")
+    term.setTextColor(colors.white)
+    println("<tag/branch>")
+    term.setTextColor(colors.yellow)
+    println(" second parameter when used with check")
+    term.setTextColor(colors.lightGray)
+    println(" note: defaults to main")
+    println(" target GitHub tag or branch name")
+    return
+else
+    for _, v in pairs({ "check", "install", "update", "remove", "purge" }) do
+        if opts[1] == v then
+            mode = v
+            break
+        end
+    end
+
+    if mode == nil then
+        println("unrecognized mode")
+        return
+    end
+
+    for _, v in pairs({ "reactor-plc", "rtu", "supervisor", "coordinator", "pocket" }) do
+        if opts[2] == v then
+            app = v
+            break
+        end
+    end
+
+    if app == nil and mode ~= "check" then
+        println("unrecognized application")
+        return
+    end
+end
+
+--
+-- run selected mode
+--
+
+if mode == "check" then
+    -------------------------
+    -- GET REMOTE MANIFEST --
+    -------------------------
+
+    if opts[2] then repo_path = repo_path .. opts[2] .. "/" else repo_path = repo_path .. "main/" end
+    local install_manifest = repo_path .. "install_manifest.json"
+
+    local response, error = http.get(install_manifest)
+
+    if response == nil then
+        term.setTextColor(colors.orange)
+        println("failed to get installation manifest from GitHub, cannot update or install")
+        term.setTextColor(colors.red)
+        println("HTTP error: " .. error)
+        term.setTextColor(colors.white)
+        return
+    end
+
+    local ok, manifest = pcall(function () return textutils.unserializeJSON(response.readAll()) end)
+
+    if not ok then
+        term.setTextColor(colors.red)
+        println("error parsing remote installation manifest")
+        term.setTextColor(colors.white)
+        return
+    end
+
+    ------------------------
+    -- GET LOCAL MANIFEST --
+    ------------------------
+
+    local imfile = fs.open("install_manifest.json", "r")
+    local local_ok = false
+    local local_manifest = {}
+
+    if imfile ~= nil then
+        local_ok, local_manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
+        imfile.close()
+    end
+
+    if not local_ok then
+        term.setTextColor(colors.yellow)
+        println("failed to load local installation information")
+        term.setTextColor(colors.white)
+
+        local_manifest = { versions = { installer = CCMSI_VERSION } }
+    else
+        local_manifest.versions.installer = CCMSI_VERSION
+    end
+
+    -- list all versions
+    for key, value in pairs(manifest.versions) do
+        term.setTextColor(colors.purple)
+        print(string.format("%-14s", "[" .. key .. "]"))
+        if key == "installer" or (local_ok and (local_manifest.versions[key] ~= nil)) then
+            term.setTextColor(colors.blue)
+            print(local_manifest.versions[key])
+            if value ~= local_manifest.versions[key] then
+                term.setTextColor(colors.white)
+                print(" (")
+                term.setTextColor(colors.cyan)
+                print(value)
+                term.setTextColor(colors.white)
+                println(" available)")
+            else
+                term.setTextColor(colors.green)
+                println(" (up to date)")
+            end
+        else
+            term.setTextColor(colors.lightGray)
+            print("not installed")
+            term.setTextColor(colors.white)
+            print(" (latest ")
+            term.setTextColor(colors.cyan)
+            print(value)
+            term.setTextColor(colors.white)
+            println(")")
+        end
+    end
+elseif mode == "install" or mode == "update" then
+    -------------------------
+    -- GET REMOTE MANIFEST --
+    -------------------------
+
+    if opts[3] then repo_path = repo_path .. opts[3] .. "/" else repo_path = repo_path .. "main/" end
+    local install_manifest = repo_path .. "install_manifest.json"
+
+    local response, error = http.get(install_manifest)
+
+    if response == nil then
+        term.setTextColor(colors.orange)
+        println("failed to get installation manifest from GitHub, cannot update or install")
+        term.setTextColor(colors.red)
+        println("HTTP error: " .. error)
+        term.setTextColor(colors.white)
+        return
+    end
+
+    local ok, manifest = pcall(function () return textutils.unserializeJSON(response.readAll()) end)
+
+    if not ok then
+        term.setTextColor(colors.red)
+        println("error parsing remote installation manifest")
+        term.setTextColor(colors.white)
+    end
+
+    ------------------------
+    -- GET LOCAL MANIFEST --
+    ------------------------
+
+    local imfile = fs.open("install_manifest.json", "r")
+    local local_ok = false
+    local local_manifest = {}
+
+    if imfile ~= nil then
+        local_ok, local_manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
+        imfile.close()
+    end
+
+    local local_app_version = nil
+    local local_comms_version = nil
+    local local_boot_version = nil
+
+    -- try to find local versions
+    if not local_ok then
+        if mode == "update" then
+            term.setTextColor(colors.red)
+            println("failed to load local installation information, cannot update")
+            term.setTextColor(colors.white)
+            return
+        end
+    else
+        local_app_version = local_manifest.versions[app]
+        local_comms_version = local_manifest.versions.comms
+        local_boot_version = local_manifest.versions.bootloader
+
+        if local_manifest.versions[app] == nil then
+            term.setTextColor(colors.red)
+            println("another application is already installed, please purge it before installing a new application")
+            term.setTextColor(colors.white)
+            return
+        end
+
+        local_manifest.versions.installer = CCMSI_VERSION
+        if manifest.versions.installer ~= CCMSI_VERSION then
+            term.setTextColor(colors.yellow)
+            println("a newer version of the installer is available, consider downloading it")
+            term.setTextColor(colors.white)
+        end
+    end
+
+    local remote_app_version = manifest.versions[app]
+    local remote_comms_version = manifest.versions.comms
+    local remote_boot_version = manifest.versions.bootloader
+
+    term.setTextColor(colors.green)
+    if mode == "install" then
+        println("installing " .. app .. " files...")
+    elseif mode == "update" then
+        println("updating " .. app .. " files... (keeping old config.lua)")
+    end
+    term.setTextColor(colors.white)
+
+    -- display bootloader version change information
+    if local_boot_version ~= nil then
+        if local_boot_version ~= remote_boot_version then
+            print("[bootldr] updating ")
+            term.setTextColor(colors.blue)
+            print(local_boot_version)
+            term.setTextColor(colors.white)
+            print(" \xbb ")
+            term.setTextColor(colors.blue)
+            println(remote_boot_version)
+            term.setTextColor(colors.white)
+        elseif mode == "install" then
+            print("[bootldr] reinstalling ")
+            term.setTextColor(colors.blue)
+            println(local_boot_version)
+            term.setTextColor(colors.white)
+        end
+    else
+        print("[bootldr] new install of ")
+        term.setTextColor(colors.blue)
+        println(remote_boot_version)
+        term.setTextColor(colors.white)
+    end
+
+    -- display app version change information
+    if local_app_version ~= nil then
+        if local_app_version ~= remote_app_version then
+            print("[" .. app .. "] updating ")
+            term.setTextColor(colors.blue)
+            print(local_app_version)
+            term.setTextColor(colors.white)
+            print(" \xbb ")
+            term.setTextColor(colors.blue)
+            println(remote_app_version)
+            term.setTextColor(colors.white)
+        elseif mode == "install" then
+            print("[" .. app .. "] reinstalling ")
+            term.setTextColor(colors.blue)
+            println(local_app_version)
+            term.setTextColor(colors.white)
+        end
+    else
+        print("[" .. app .. "] new install of ")
+        term.setTextColor(colors.blue)
+        println(remote_app_version)
+        term.setTextColor(colors.white)
+    end
+
+    -- display comms version change information
+    if local_comms_version ~= nil then
+        if local_comms_version ~= remote_comms_version then
+            print("[comms] updating ")
+            term.setTextColor(colors.blue)
+            print(local_comms_version)
+            term.setTextColor(colors.white)
+            print(" \xbb ")
+            term.setTextColor(colors.blue)
+            println(remote_comms_version)
+            term.setTextColor(colors.white)
+            print("[comms] ")
+            term.setTextColor(colors.yellow)
+            println("other devices on the network will require an update")
+            term.setTextColor(colors.white)
+        elseif mode == "install" then
+            print("[comms] reinstalling ")
+            term.setTextColor(colors.blue)
+            println(local_comms_version)
+            term.setTextColor(colors.white)
+        end
+    else
+        print("[comms] new install of ")
+        term.setTextColor(colors.blue)
+        println(remote_comms_version)
+        term.setTextColor(colors.white)
+    end
+
+    --------------------------
+    -- START INSTALL/UPDATE --
+    --------------------------
+
+    local space_required = manifest.sizes.manifest
+    local space_available = fs.getFreeSpace("/")
+
+    local single_file_mode = false
+    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)
+
+    for _, dependency in pairs(dependencies) do
+        local size = size_list[dependency]
+        space_required = space_required + size
+    end
+
+    -- check space constraints
+    if space_available < space_required then
+        single_file_mode = true
+        term.setTextColor(colors.yellow)
+        println("WARNING: Insufficient space available for a full download!")
+        term.setTextColor(colors.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.")
+        println("Do you wish to continue? (y/N)")
+
+        local confirm = read()
+        if confirm ~= "y" and confirm ~= "Y" then
+            println("installation cancelled")
+            return
+        end
+    end
+
+---@diagnostic disable-next-line: undefined-field
+    os.sleep(2)
+
+    local success = true
+
+    if not single_file_mode then
+        if fs.exists(install_dir) then
+            fs.delete(install_dir)
+            fs.makeDir(install_dir)
+        end
+
+        -- download all dependencies
+        for _, dependency in pairs(dependencies) do
+            if mode == "update" and ((dependency == "system" and local_boot_version == remote_boot_version) or (local_app_version == remote_app_version)) then
+                -- skip system package if unchanged, skip app package if not changed
+                -- skip packages that have no version if app version didn't change
+                term.setTextColor(colors.white)
+                print("skipping download of unchanged package ")
+                term.setTextColor(colors.blue)
+                println(dependency)
+            else
+                term.setTextColor(colors.white)
+                print("downloading package ")
+                term.setTextColor(colors.blue)
+                println(dependency)
+
+                term.setTextColor(colors.lightGray)
+                local files = file_list[dependency]
+                for _, file in pairs(files) do
+                    println("GET " .. file)
+                    local dl, err = http.get(repo_path .. file)
+
+                    if dl == nil then
+                        term.setTextColor(colors.red)
+                        println("GET HTTP Error " .. err)
+                        success = false
+                        break
+                    else
+                        local handle = fs.open(install_dir .. "/" .. file, "w")
+                        handle.write(dl.readAll())
+                        handle.close()
+                    end
+                end
+            end
+        end
+
+        -- copy in downloaded files (installation)
+        if success then
+            for _, dependency in pairs(dependencies) do
+                if mode == "update" and ((dependency == "system" and local_boot_version == remote_boot_version) or (local_app_version == remote_app_version)) then
+                    -- skip system package if unchanged, skip app package if not changed
+                    -- skip packages that have no version if app version didn't change
+                    term.setTextColor(colors.white)
+                    print("skipping install of unchanged package ")
+                    term.setTextColor(colors.blue)
+                    println(dependency)
+                else
+                    term.setTextColor(colors.white)
+                    print("installing package ")
+                    term.setTextColor(colors.blue)
+                    println(dependency)
+
+                    term.setTextColor(colors.lightGray)
+                    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
+                    end
+                end
+            end
+        end
+
+        fs.delete(install_dir)
+
+        if success then
+            -- if we made it here, then none of the file system functions threw exceptions
+            -- that means everything is OK
+            write_install_manifest(manifest, dependencies)
+            term.setTextColor(colors.green)
+            if mode == "install" then
+                println("installation completed successfully")
+            else
+                println("update completed successfully")
+            end
+        else
+            if mode == "install" then
+                term.setTextColor(colors.red)
+                println("installation failed")
+            else
+                term.setTextColor(colors.orange)
+                println("update failed, existing files unmodified")
+            end
+        end
+    else
+        -- go through all files and replace one by one
+        for _, dependency in pairs(dependencies) do
+            if mode == "update" and ((dependency == "system" and local_boot_version == remote_boot_version) or (local_app_version == remote_app_version)) then
+                -- skip system package if unchanged, skip app package if not changed
+                -- skip packages that have no version if app version didn't change
+                term.setTextColor(colors.white)
+                print("skipping install of unchanged package ")
+                term.setTextColor(colors.blue)
+                println(dependency)
+            else
+                term.setTextColor(colors.white)
+                print("installing package ")
+                term.setTextColor(colors.blue)
+                println(dependency)
+
+                term.setTextColor(colors.lightGray)
+                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)
+
+                        if dl == nil then
+                            println("GET HTTP Error " .. err)
+                            success = false
+                            break
+                        else
+                            local handle = fs.open("/" .. file, "w")
+                            handle.write(dl.readAll())
+                            handle.close()
+                        end
+                    end
+                end
+            end
+        end
+
+        if success then
+            -- if we made it here, then none of the file system functions threw exceptions
+            -- that means everything is OK
+            write_install_manifest(manifest, dependencies)
+            term.setTextColor(colors.green)
+            if mode == "install" then
+                println("installation completed successfully")
+            else
+                println("update completed successfully")
+            end
+        else
+            term.setTextColor(colors.red)
+            if mode == "install" then
+                println("installation failed, files may have been skipped")
+            else
+                println("update failed, files may have been skipped")
+            end
+        end
+    end
+elseif mode == "remove" or mode == "purge" then
+    local imfile = fs.open("install_manifest.json", "r")
+    local ok = false
+    local manifest = {}
+
+    if imfile ~= nil then
+        ok, manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
+        imfile.close()
+    end
+
+    if not ok then
+        term.setTextColor(colors.red)
+        println("error parsing local installation manifest")
+        term.setTextColor(colors.white)
+        return
+    elseif mode == "remove" and manifest.versions[app] == nil then
+        term.setTextColor(colors.red)
+        println(app .. " is not installed")
+        term.setTextColor(colors.white)
+        return
+    end
+
+    term.setTextColor(colors.orange)
+    if mode == "remove" then
+        println("removing all " .. app .. " files except for config.lua and log.txt...")
+    elseif mode == "purge" then
+        println("purging all " .. app .. " files...")
+    end
+
+---@diagnostic disable-next-line: undefined-field
+    os.sleep(2)
+
+    local file_list = manifest.files
+    local dependencies = manifest.depends[app]
+    local config_file = app .. "/config.lua"
+
+    table.insert(dependencies, app)
+
+    term.setTextColor(colors.lightGray)
+
+    -- delete log file if purging
+    if mode == "purge" and fs.exists(config_file) then
+        local 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)
+            end
+        end)
+
+        if not log_deleted then
+            term.setTextColor(colors.red)
+            println("failed to delete log file")
+            term.setTextColor(colors.lightGray)
+---@diagnostic disable-next-line: undefined-field
+            os.sleep(1)
+        end
+    end
+
+    -- delete all files except config unless purging
+    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
+        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
+
+            if fs.isDir(folder) then
+                fs.delete(folder)
+                println("deleted directory " .. folder)
+            end
+        elseif dependency == app then
+            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
+        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 = {}
+        imfile = fs.open("install_manifest.json", "w")
+        imfile.write(textutils.serializeJSON(manifest))
+        imfile.close()
+    end
+
+    term.setTextColor(colors.green)
+    println("done!")
+end
+
+term.setTextColor(colors.white)

coordinator/config.lua

@@ -0,0 +1,34 @@
+local config = {}
+
+-- port of the SCADA supervisor
+config.SCADA_SV_PORT = 16100
+-- port to listen to incoming packets from supervisor
+config.SCADA_SV_CTL_LISTEN = 16101
+-- listen port for SCADA coordinator API access
+config.SCADA_API_LISTEN = 16200
+-- 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
+
+-- 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
+
+-- 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

@@ -1,12 +1,746 @@
-local comms = require("scada-common.comms")
+local comms       = require("scada-common.comms")
+local log         = require("scada-common.log")
+local ppm         = require("scada-common.ppm")
+local util        = require("scada-common.util")
+
+local iocontrol   = require("coordinator.iocontrol")
+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 println_ts = util.println_ts
+
+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 UNIT_COMMAND = comms.UNIT_COMMAND
+local FAC_COMMAND = comms.FAC_COMMAND
 
 local coordinator = {}
 
--- coordinator communications
-coordinator.coord_comms = function ()
-    local self = {
-        reactor_struct_cache = nil
+-- 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")
+
+    local iface = dialog.ask_options(names, "c")
+
+    if iface ~= false and iface ~= nil then
+        util.filter_table(names, function (x) return x ~= iface end)
+    end
+
+    return iface
+end
+
+-- configure monitor layout
+---@param num_units integer number of units expected
+---@return boolean success, monitors_struct? monitors
+function coordinator.configure_monitors(num_units)
+    ---@class monitors_struct
+    local monitors = {
+        primary = nil,
+        primary_name = "",
+        unit_displays = {},
+        unit_name_map = {}
     }
+
+    local monitors_avail = ppm.get_monitor_list()
+    local names = {}
+    local available = {}
+
+    -- get all interface names
+    for iface, _ in pairs(monitors_avail) do
+        table.insert(names, iface)
+        table.insert(available, iface)
+    end
+
+    -- we need a certain number of monitors (1 per unit + 1 primary display)
+    local num_displays_needed = num_units + 1
+    if #names < num_displays_needed then
+        local message = "not enough monitors connected (need " .. num_displays_needed .. ")"
+        println(message)
+        log.warning(message)
+        return false
+    end
+
+    -- 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 _unitd = settings.get("UNIT_DISPLAYS")
+
+        -- filter out already assigned monitors
+        util.filter_table(available, function (x) return x ~= _primary 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
+        -- lets get a monitor
+        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
+
+    -------------------
+    -- 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
+                -- lets get a monitor
+                println("please select monitor for unit #" .. i)
+                display = ask_monitor(available)
+            end
+
+            if display == false then return false end
+
+            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
+            end
+
+            while display == nil and #available > 0 do
+                -- lets get a monitor
+                display = ask_monitor(available)
+            end
+
+            if display == false then return false end
+
+            unit_displays[i] = display
+        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
+
+    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
+end
+
+-- dmesg print wrapper
+---@param message string message
+---@param dmesg_tag string tag
+---@param working? boolean to use dmesg_working
+---@return function? update, function? done
+local function log_dmesg(message, dmesg_tag, working)
+    local colors = {
+        GRAPHICS = colors.green,
+        SYSTEM = colors.cyan,
+        BOOT = colors.blue,
+        COMMS = colors.purple
+    }
+
+    if working then
+        return log.dmesg_working(message, dmesg_tag, colors[dmesg_tag])
+    else
+        log.dmesg(message, dmesg_tag, colors[dmesg_tag])
+    end
+end
+
+function coordinator.log_graphics(message) log_dmesg(message, "GRAPHICS") end
+function coordinator.log_sys(message) log_dmesg(message, "SYSTEM") end
+function coordinator.log_boot(message) log_dmesg(message, "BOOT") end
+function coordinator.log_comms(message) log_dmesg(message, "COMMS") end
+
+-- log a message for communications connecting, providing access to progress indication control functions
+---@nodiscard
+---@param message string
+---@return function update, function done
+function coordinator.log_comms_connecting(message)
+    local update, done = log_dmesg(message, "COMMS", true)
+    ---@cast update function
+    ---@cast done function
+    return update, done
+end
+
+-- coordinator communications
+---@nodiscard
+---@param version string coordinator version
+---@param modem table modem device
+---@param sv_port integer port of configured supervisor
+---@param sv_listen integer listening port for supervisor replys
+---@param api_listen integer listening port for pocket API
+---@param range integer trusted device connection range
+---@param sv_watchdog watchdog
+function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range, sv_watchdog)
+    local self = {
+        sv_linked = false,
+        sv_seq_num = 0,
+        sv_r_seq_num = nil,
+        sv_config_err = false,
+        connected = false,
+        last_est_ack = ESTABLISH_ACK.ALLOW,
+        last_api_est_acks = {}
+    }
+
+    comms.set_trusted_range(range)
+
+    -- PRIVATE FUNCTIONS --
+
+    -- configure modem channels
+    local function _conf_channels()
+        modem.closeAll()
+        modem.open(sv_listen)
+        modem.open(api_listen)
+    end
+
+    _conf_channels()
+
+    -- link modem to apisessions
+    apisessions.init(modem)
+
+    -- send a packet to the supervisor
+    ---@param msg_type SCADA_MGMT_TYPE|SCADA_CRDN_TYPE
+    ---@param msg table
+    local function _send_sv(protocol, msg_type, msg)
+        local s_pkt = comms.scada_packet()
+        local pkt   ---@type mgmt_packet|crdn_packet
+
+        if protocol == PROTOCOL.SCADA_MGMT then
+            pkt = comms.mgmt_packet()
+        elseif protocol == PROTOCOL.SCADA_CRDN then
+            pkt = comms.crdn_packet()
+        else
+            return
+        end
+
+        pkt.make(msg_type, msg)
+        s_pkt.make(self.sv_seq_num, protocol, pkt.raw_sendable())
+
+        modem.transmit(sv_port, sv_listen, s_pkt.raw_sendable())
+        self.sv_seq_num = self.sv_seq_num + 1
+    end
+
+    -- send an API establish request response
+    ---@param dest integer
+    ---@param msg table
+    local function _send_api_establish_ack(seq_id, dest, msg)
+        local s_pkt = comms.scada_packet()
+        local m_pkt = comms.mgmt_packet()
+
+        m_pkt.make(SCADA_MGMT_TYPE.ESTABLISH, msg)
+        s_pkt.make(seq_id, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
+
+        modem.transmit(dest, api_listen, s_pkt.raw_sendable())
+    end
+
+    -- attempt connection establishment
+    local function _send_establish()
+        _send_sv(PROTOCOL.SCADA_MGMT, SCADA_MGMT_TYPE.ESTABLISH, { comms.version, version, DEVICE_TYPE.CRDN })
+    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() })
+    end
+
+    -- PUBLIC FUNCTIONS --
+
+    ---@class coord_comms
+    local public = {}
+
+    -- reconnect a newly connected modem
+    ---@param new_modem table
+    function public.reconnect_modem(new_modem)
+        modem = new_modem
+        apisessions.relink_modem(new_modem)
+        _conf_channels()
+    end
+
+    -- close the connection to the server
+    function public.close()
+        sv_watchdog.cancel()
+        self.sv_linked = false
+        _send_sv(PROTOCOL.SCADA_MGMT, SCADA_MGMT_TYPE.CLOSE, {})
+    end
+
+    -- attempt to connect to the subervisor
+    ---@nodiscard
+    ---@param timeout_s number timeout in seconds
+    ---@param tick_dmesg_waiting function callback to tick dmesg waiting
+    ---@param task_done function callback to show done on dmesg
+    ---@return boolean sv_linked true if connected, false otherwise
+    --- EVENT_CONSUMER: this function consumes events
+    function public.sv_connect(timeout_s, tick_dmesg_waiting, task_done)
+        local clock = util.new_clock(1)
+        local start = util.time_s()
+        local terminated = false
+
+        _send_establish()
+
+        clock.start()
+
+        while (util.time_s() - start) < timeout_s and (not self.sv_linked) and (not self.sv_config_err) do
+            local event, p1, p2, p3, p4, p5 = util.pull_event()
+
+            if event == "timer" and clock.is_clock(p1) then
+                -- timed out attempt, try again
+                tick_dmesg_waiting(math.max(0, timeout_s - (util.time_s() - start)))
+                _send_establish()
+                clock.start()
+            elseif event == "modem_message" then
+                -- handle message
+                local packet = public.parse_packet(p1, p2, p3, p4, p5)
+                if packet ~= nil and packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                    public.handle_packet(packet)
+                end
+            elseif event == "terminate" then
+                terminated = true
+                break
+            end
+        end
+
+        task_done(self.sv_linked)
+
+        if terminated 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")
+        elseif not self.sv_linked then
+            if self.last_est_ack == ESTABLISH_ACK.DENY then
+                coordinator.log_comms("supervisor connection attempt denied")
+            elseif self.last_est_ack == ESTABLISH_ACK.COLLISION then
+                coordinator.log_comms("supervisor connection failed due to collision")
+            elseif self.last_est_ack == ESTABLISH_ACK.BAD_VERSION then
+                coordinator.log_comms("supervisor connection failed due to version mismatch")
+            else
+                coordinator.log_comms("supervisor connection failed with no valid response")
+            end
+        end
+
+        return self.sv_linked
+    end
+
+    -- send a facility command
+    ---@param cmd FAC_COMMAND command
+    function public.send_fac_command(cmd)
+        _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.FAC_CMD, { cmd })
+    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
+        })
+    end
+
+    -- send a unit command
+    ---@param cmd UNIT_COMMAND command
+    ---@param unit integer unit ID
+    ---@param option any? optional option options for the optional options (like burn rate) (does option still look like a word?)
+    function public.send_unit_command(cmd, unit, option)
+        _send_sv(PROTOCOL.SCADA_CRDN, SCADA_CRDN_TYPE.UNIT_CMD, { cmd, unit, option })
+    end
+
+    -- parse a packet
+    ---@param side string
+    ---@param sender integer
+    ---@param reply_to integer
+    ---@param message any
+    ---@param distance integer
+    ---@return mgmt_frame|crdn_frame|capi_frame|nil packet
+    function public.parse_packet(side, sender, reply_to, message, distance)
+        local pkt = nil
+        local s_pkt = comms.scada_packet()
+
+        -- parse packet as generic SCADA packet
+        s_pkt.receive(side, sender, reply_to, message, distance)
+
+        if s_pkt.is_valid() then
+            -- get as SCADA management packet
+            if s_pkt.protocol() == PROTOCOL.SCADA_MGMT then
+                local mgmt_pkt = comms.mgmt_packet()
+                if mgmt_pkt.decode(s_pkt) then
+                    pkt = mgmt_pkt.get()
+                end
+            -- 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
+            -- 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
+        end
+
+        return pkt
+    end
+
+    -- handle a packet
+    ---@param packet mgmt_frame|crdn_frame|capi_frame|nil
+    function public.handle_packet(packet)
+        if packet ~= nil then
+            local l_port = packet.scada_frame.local_port()
+            local r_port = packet.scada_frame.remote_port()
+            local protocol = packet.scada_frame.protocol()
+
+            if l_port == api_listen then
+                if protocol == PROTOCOL.COORD_API then
+                    ---@cast packet capi_frame
+                    -- look for an associated session
+                    local session = apisessions.find_session(r_port)
+
+                    -- API 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")
+                    end
+                elseif protocol == PROTOCOL.SCADA_MGMT then
+                    ---@cast packet mgmt_frame
+                    -- look for an associated session
+                    local session = apisessions.find_session(r_port)
+
+                    -- SCADA management packet
+                    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
+                        -- establish a new session
+                        local next_seq_id = packet.scada_frame.seq_num() + 1
+
+                        -- validate packet and continue
+                        if packet.length == 3 and type(packet.data[1]) == "string" and type(packet.data[2]) == "string" then
+                            local comms_v = packet.data[1]
+                            local firmware_v = packet.data[2]
+                            local dev_type = packet.data[3]
+
+                            if comms_v ~= comms.version then
+                                if self.last_api_est_acks[r_port] ~= ESTABLISH_ACK.BAD_VERSION then
+                                    log.info(util.c("dropping API establish packet with incorrect comms version v", comms_v, " (expected v", comms.version, ")"))
+                                    self.last_api_est_acks[r_port] = ESTABLISH_ACK.BAD_VERSION
+                                end
+
+                                _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.BAD_VERSION })
+                            elseif dev_type == DEVICE_TYPE.PKT then
+                                -- pocket linking request
+                                local id = apisessions.establish_session(l_port, r_port, firmware_v)
+                                println(util.c("API: pocket (", firmware_v, ") [:", r_port, "] connected with session ID ", id))
+                                coordinator.log_comms(util.c("API: pocket (", firmware_v, ") [:", r_port, "] connected with session ID ", id))
+
+                                _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.ALLOW })
+                                self.last_api_est_acks[r_port] = ESTABLISH_ACK.ALLOW
+                            else
+                                log.debug(util.c("illegal establish packet for device ", dev_type, " on API listening channel"))
+                                _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.DENY })
+                            end
+                        else
+                            log.debug("invalid establish packet (on API listening channel)")
+                            _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.DENY })
+                        end
+                    else
+                        -- any other packet should be session related, discard it
+                        log.debug(util.c(r_port, "->", l_port, ": discarding SCADA_MGMT packet without a known session"))
+                    end
+                else
+                    log.debug("illegal packet type " .. protocol .. " on api listening channel", true)
+                end
+            elseif l_port == sv_listen then
+                -- check sequence number
+                if self.sv_r_seq_num == nil then
+                    self.sv_r_seq_num = packet.scada_frame.seq_num()
+                elseif self.connected and ((self.sv_r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
+                    log.warning("sequence out-of-order: last = " .. self.sv_r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    return
+                else
+                    self.sv_r_seq_num = packet.scada_frame.seq_num()
+                end
+
+                -- feed watchdog on valid sequence number
+                sv_watchdog.feed()
+
+                -- handle packet
+                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.length == 2 then
+                                -- record builds
+                                local fac_builds = iocontrol.record_facility_builds(packet.data[1])
+                                local unit_builds = iocontrol.record_unit_builds(packet.data[2])
+
+                                if fac_builds and unit_builds then
+                                    -- acknowledge receipt of builds
+                                    _send_sv(PROTOCOL.SCADA_CRDN, SCADA_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
+                            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, {})
+                                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
+                            -- 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
+                            -- facility command acknowledgement
+                            if packet.length >= 2 then
+                                local cmd = packet.data[1]
+                                local ack = packet.data[2] == true
+
+                                if cmd == FAC_COMMAND.SCRAM_ALL then
+                                    iocontrol.get_db().facility.scram_ack(ack)
+                                elseif cmd == FAC_COMMAND.STOP then
+                                    iocontrol.get_db().facility.stop_ack(ack)
+                                elseif cmd == FAC_COMMAND.START then
+                                    if packet.length == 7 then
+                                        process.start_ack_handle({ table.unpack(packet.data, 2) })
+                                    else
+                                        log.debug("SCADA_CRDN process start (with configuration) ack echo packet length mismatch")
+                                    end
+                                elseif cmd == FAC_COMMAND.ACK_ALL_ALARMS then
+                                    iocontrol.get_db().facility.ack_alarms_ack(ack)
+                                else
+                                    log.debug(util.c("received facility command ack with unknown command ", cmd))
+                                end
+                            else
+                                log.debug("SCADA_CRDN facility command ack packet length mismatch")
+                            end
+                        elseif packet.type == SCADA_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, {})
+                                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
+                            -- 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
+                            -- unit command acknowledgement
+                            if packet.length == 3 then
+                                local cmd = packet.data[1]
+                                local unit_id = packet.data[2]
+                                local ack = packet.data[3] == true
+
+                                local unit = iocontrol.get_db().units[unit_id]  ---@type ioctl_unit
+
+                                if unit ~= nil then
+                                    if cmd == UNIT_COMMAND.SCRAM then
+                                        unit.scram_ack(ack)
+                                    elseif cmd == UNIT_COMMAND.START then
+                                        unit.start_ack(ack)
+                                    elseif cmd == UNIT_COMMAND.RESET_RPS then
+                                        unit.reset_rps_ack(ack)
+                                    elseif cmd == UNIT_COMMAND.SET_BURN then
+                                        unit.set_burn_ack(ack)
+                                    elseif cmd == UNIT_COMMAND.SET_WASTE then
+                                        unit.set_waste_ack(ack)
+                                    elseif cmd == UNIT_COMMAND.ACK_ALL_ALARMS then
+                                        unit.ack_alarms_ack(ack)
+                                    elseif cmd == UNIT_COMMAND.SET_GROUP then
+                                        -- UI will be updated to display current group if changed successfully
+                                    else
+                                        log.debug(util.c("received unit command ack with unknown command ", cmd))
+                                    end
+                                else
+                                    log.debug(util.c("received unit command ack with unknown unit ", unit_id))
+                                end
+                            else
+                                log.debug("SCADA_CRDN unit command ack packet length mismatch")
+                            end
+                        else
+                            log.debug("received unknown SCADA_CRDN packet type " .. packet.type)
+                        end
+                    else
+                        log.debug("discarding SCADA_CRDN packet before linked")
+                    end
+                elseif protocol == PROTOCOL.SCADA_MGMT then
+                    ---@cast packet mgmt_frame
+                    if packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                        -- connection with supervisor established
+                        if packet.length == 2 then
+                            local est_ack = packet.data[1]
+                            local config = packet.data[2]
+
+                            if est_ack == ESTABLISH_ACK.ALLOW then
+                                if type(config) == "table" and #config > 1 then
+                                    -- get configuration
+
+                                    ---@class facility_conf
+                                    local conf = {
+                                        num_units = config[1],  ---@type integer
+                                        defs = {}               -- boilers and turbines
+                                    }
+
+                                    if (#config - 1) == (conf.num_units * 2) then
+                                        -- record sequence of pairs of [#boilers, #turbines] per unit
+                                        for i = 2, #config do
+                                            table.insert(conf.defs, config[i])
+                                        end
+
+                                        -- init io controller
+                                        iocontrol.init(conf, public)
+
+                                        self.sv_linked = true
+                                        self.sv_config_err = false
+                                    else
+                                        self.sv_config_err = true
+                                        log.warning("invalid supervisor configuration definitions received, establish failed")
+                                    end
+                                else
+                                    log.debug("invalid supervisor configuration table received, establish failed")
+                                end
+                            else
+                                log.debug("SCADA_MGMT establish packet reply (len = 2) unsupported")
+                            end
+
+                            self.last_est_ack = est_ack
+                        elseif packet.length == 1 then
+                            local est_ack = packet.data[1]
+
+                            if est_ack == ESTABLISH_ACK.DENY then
+                                if self.last_est_ack ~= est_ack then
+                                    log.info("supervisor connection denied")
+                                end
+                            elseif est_ack == ESTABLISH_ACK.COLLISION then
+                                if self.last_est_ack ~= est_ack then
+                                    log.warning("supervisor connection denied due to collision")
+                                end
+                            elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
+                                if self.last_est_ack ~= est_ack then
+                                    log.warning("supervisor comms version mismatch")
+                                end
+                            else
+                                log.debug("SCADA_MGMT establish packet reply (len = 1) unsupported")
+                            end
+
+                            self.last_est_ack = est_ack
+                        else
+                            log.debug("SCADA_MGMT establish packet length mismatch")
+                        end
+                    elseif self.sv_linked then
+                        if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                            -- keep alive request received, echo back
+                            if packet.length == 1 then
+                                local timestamp = packet.data[1]
+                                local trip_time = util.time() - timestamp
+
+                                if trip_time > 750 then
+                                    log.warning("coord KEEP_ALIVE trip time > 750ms (" .. trip_time .. "ms)")
+                                end
+
+                                -- log.debug("coord RTT = " .. trip_time .. "ms")
+
+                                iocontrol.get_db().facility.ps.publish("sv_ping", trip_time)
+
+                                _send_keep_alive_ack(timestamp)
+                            else
+                                log.debug("SCADA keep alive packet length mismatch")
+                            end
+                        elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                            -- handle session close
+                            sv_watchdog.cancel()
+                            self.sv_linked = false
+                            println_ts("server connection closed by remote host")
+                            log.info("server connection closed by remote host")
+                        else
+                            log.debug("received unknown SCADA_MGMT packet type " .. packet.type)
+                        end
+                    else
+                        log.debug("discarding non-link SCADA_MGMT packet before linked")
+                    end
+                else
+                    log.debug("illegal packet type " .. protocol .. " on supervisor listening channel", true)
+                end
+            else
+                log.debug("received packet on unconfigured channel " .. l_port, true)
+            end
+        end
+    end
+
+    -- check if the coordinator is still linked to the supervisor
+    ---@nodiscard
+    function public.is_linked() return self.sv_linked end
+
+    return public
 end
 
 return coordinator

coordinator/iocontrol.lua

@@ -0,0 +1,771 @@
+--
+-- I/O Control for Supervisor/Coordinator Integration
+--
+
+local log     = require("scada-common.log")
+local psil    = require("scada-common.psil")
+local types   = require("scada-common.types")
+local util    = require("scada-common.util")
+
+local process = require("coordinator.process")
+local sounder = require("coordinator.sounder")
+
+local ALARM_STATE = types.ALARM_STATE
+local PROCESS = types.PROCESS
+
+local iocontrol = {}
+
+---@class ioctl
+local io = {}
+
+-- luacheck: no unused args
+
+-- placeholder acknowledge function for type hinting
+---@param success boolean
+---@diagnostic disable-next-line: unused-local
+local function __generic_ack(success) end
+
+-- luacheck: unused args
+
+-- initialize the coordinator IO controller
+---@param conf facility_conf configuration
+---@param comms coord_comms comms reference
+function iocontrol.init(conf, comms)
+    ---@class ioctl_facility
+    io.facility = {
+        num_units = conf.num_units, ---@type integer
+        all_sys_ok = false,
+        rtu_count = 0,
+
+        auto_ready = false,
+        auto_active = false,
+        auto_ramping = false,
+        auto_saturated = false,
+
+        auto_scram = false,
+        ---@type ascram_status
+        ascram_status = {
+            matrix_dc = false,
+            matrix_fill = false,
+            crit_alarm = false,
+            radiation = false,
+            gen_fault = false
+        },
+
+        radiation = types.new_zero_radiation_reading(),
+
+        save_cfg_ack = __generic_ack,
+        start_ack = __generic_ack,
+        stop_ack = __generic_ack,
+        scram_ack = __generic_ack,
+        ack_alarms_ack = __generic_ack,
+
+        ps = psil.create(),
+
+        induction_ps_tbl = {},
+        induction_data_tbl = {},
+
+        env_d_ps = psil.create(),
+        env_d_data = {}
+    }
+
+    -- create induction tables (currently only 1 is supported)
+    for _ = 1, conf.num_units do
+        local data = {} ---@type imatrix_session_db
+        table.insert(io.facility.induction_ps_tbl, psil.create())
+        table.insert(io.facility.induction_data_tbl, data)
+    end
+
+    io.units = {}
+    for i = 1, conf.num_units do
+        local function ack(alarm) process.ack_alarm(i, alarm) end
+        local function reset(alarm) process.reset_alarm(i, alarm) end
+
+        ---@class ioctl_unit
+        local entry = {
+            unit_id = i,
+
+            num_boilers = 0,
+            num_turbines = 0,
+
+            control_state = false,
+            burn_rate_cmd = 0.0,
+            waste_control = 0,
+            radiation = types.new_zero_radiation_reading(),
+
+            -- auto control group
+            a_group = 0,
+
+            start = function () process.start(i) end,
+            scram = function () process.scram(i) end,
+            reset_rps = function () process.reset_rps(i) end,
+            ack_alarms = function () process.ack_all_alarms(i) end,
+            set_burn = function (rate) process.set_rate(i, rate) end,   ---@param rate number burn rate
+            set_waste = function (mode) process.set_waste(i, mode) end, ---@param mode integer waste processing mode
+
+            set_group = function (grp) process.set_group(i, grp) end,   ---@param grp integer|0 group ID or 0
+
+            start_ack = __generic_ack,
+            scram_ack = __generic_ack,
+            reset_rps_ack = __generic_ack,
+            ack_alarms_ack = __generic_ack,
+            set_burn_ack = __generic_ack,
+            set_waste_ack = __generic_ack,
+
+            alarm_callbacks = {
+                c_breach   = { ack = function () ack(1)  end, reset = function () reset(1)  end },
+                radiation  = { ack = function () ack(2)  end, reset = function () reset(2)  end },
+                r_lost     = { ack = function () ack(3)  end, reset = function () reset(3)  end },
+                dmg_crit   = { ack = function () ack(4)  end, reset = function () reset(4)  end },
+                damage     = { ack = function () ack(5)  end, reset = function () reset(5)  end },
+                over_temp  = { ack = function () ack(6)  end, reset = function () reset(6)  end },
+                high_temp  = { ack = function () ack(7)  end, reset = function () reset(7)  end },
+                waste_leak = { ack = function () ack(8)  end, reset = function () reset(8)  end },
+                waste_high = { ack = function () ack(9)  end, reset = function () reset(9)  end },
+                rps_trans  = { ack = function () ack(10) end, reset = function () reset(10) end },
+                rcs_trans  = { ack = function () ack(11) end, reset = function () reset(11) end },
+                t_trip     = { ack = function () ack(12) end, reset = function () reset(12) end }
+            },
+
+            ---@type alarms
+            alarms = {
+                ALARM_STATE.INACTIVE,   -- containment breach
+                ALARM_STATE.INACTIVE,   -- containment radiation
+                ALARM_STATE.INACTIVE,   -- reactor lost
+                ALARM_STATE.INACTIVE,   -- damage critical
+                ALARM_STATE.INACTIVE,   -- reactor taking damage
+                ALARM_STATE.INACTIVE,   -- reactor over temperature
+                ALARM_STATE.INACTIVE,   -- reactor high temperature
+                ALARM_STATE.INACTIVE,   -- waste leak
+                ALARM_STATE.INACTIVE,   -- waste level high
+                ALARM_STATE.INACTIVE,   -- RPS transient
+                ALARM_STATE.INACTIVE,   -- RCS transient
+                ALARM_STATE.INACTIVE    -- turbine trip
+            },
+
+            annunciator = {},   ---@type annunciator
+
+            unit_ps = psil.create(),
+            reactor_data = {},  ---@type reactor_db
+
+            boiler_ps_tbl = {},
+            boiler_data_tbl = {},
+
+            turbine_ps_tbl = {},
+            turbine_data_tbl = {}
+        }
+
+        -- create boiler tables
+        for _ = 1, conf.defs[(i * 2) - 1] do
+            local data = {} ---@type boilerv_session_db
+            table.insert(entry.boiler_ps_tbl, psil.create())
+            table.insert(entry.boiler_data_tbl, data)
+        end
+
+        -- create turbine tables
+        for _ = 1, conf.defs[i * 2] do
+            local data = {} ---@type turbinev_session_db
+            table.insert(entry.turbine_ps_tbl, psil.create())
+            table.insert(entry.turbine_data_tbl, data)
+        end
+
+        entry.num_boilers = #entry.boiler_data_tbl
+        entry.num_turbines = #entry.turbine_data_tbl
+
+        table.insert(io.units, entry)
+    end
+
+    -- pass IO control here since it can't be require'd due to a require loop
+    process.init(io, comms)
+end
+
+-- populate facility structure builds
+---@param build table
+---@return boolean valid
+function iocontrol.record_facility_builds(build)
+    local valid = true
+
+    if type(build) == "table" then
+        local fac = io.facility
+
+        -- induction matricies
+        if type(build.induction) == "table" then
+            for id, matrix in pairs(build.induction) do
+                if type(fac.induction_data_tbl[id]) == "table" then
+                    fac.induction_data_tbl[id].formed = matrix[1]  ---@type boolean
+                    fac.induction_data_tbl[id].build  = matrix[2]  ---@type table
+
+                    fac.induction_ps_tbl[id].publish("formed", matrix[1])
+
+                    for key, val in pairs(fac.induction_data_tbl[id].build) do
+                        fac.induction_ps_tbl[id].publish(key, val)
+                    end
+                else
+                    log.debug(util.c("iocontrol.record_facility_builds: invalid induction matrix id ", id))
+                    valid = false
+                end
+            end
+        end
+    else
+        log.debug("facility builds not a table")
+        valid = false
+    end
+
+    return valid
+end
+
+-- populate unit structure builds
+---@param builds table
+---@return boolean valid
+function iocontrol.record_unit_builds(builds)
+    local valid = true
+
+    -- 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 log_header = util.c("iocontrol.record_unit_builds[UNIT ", id, "]: ")
+
+        if type(build) ~= "table" then
+            log.debug(log_header .. "build not a table")
+            valid = false
+        elseif type(unit) ~= "table" then
+            log.debug(log_header .. "invalid unit id")
+            valid = false
+        else
+            -- reactor build
+            if type(build.reactor) == "table" then
+                unit.reactor_data.mek_struct = build.reactor    ---@type mek_struct
+                for key, val in pairs(unit.reactor_data.mek_struct) do
+                    unit.unit_ps.publish(key, val)
+                end
+
+                if (type(unit.reactor_data.mek_struct.length) == "number") and (unit.reactor_data.mek_struct.length ~= 0) and
+                    (type(unit.reactor_data.mek_struct.width) == "number") and (unit.reactor_data.mek_struct.width ~= 0) then
+                    unit.unit_ps.publish("size", { unit.reactor_data.mek_struct.length, unit.reactor_data.mek_struct.width })
+                end
+            end
+
+            -- boiler builds
+            if type(build.boilers) == "table" then
+                for b_id, boiler in pairs(build.boilers) do
+                    if type(unit.boiler_data_tbl[b_id]) == "table" then
+                        unit.boiler_data_tbl[b_id].formed = boiler[1] ---@type boolean
+                        unit.boiler_data_tbl[b_id].build  = boiler[2] ---@type table
+
+                        unit.boiler_ps_tbl[b_id].publish("formed", boiler[1])
+
+                        for key, val in pairs(unit.boiler_data_tbl[b_id].build) do
+                            unit.boiler_ps_tbl[b_id].publish(key, val)
+                        end
+                    else
+                        log.debug(util.c(log_header, "invalid boiler id ", b_id))
+                        valid = false
+                    end
+                end
+            end
+
+            -- turbine builds
+            if type(build.turbines) == "table" then
+                for t_id, turbine in pairs(build.turbines) do
+                    if type(unit.turbine_data_tbl[t_id]) == "table" then
+                        unit.turbine_data_tbl[t_id].formed = turbine[1]   ---@type boolean
+                        unit.turbine_data_tbl[t_id].build  = turbine[2]   ---@type table
+
+                        unit.turbine_ps_tbl[t_id].publish("formed", turbine[1])
+
+                        for key, val in pairs(unit.turbine_data_tbl[t_id].build) do
+                            unit.turbine_ps_tbl[t_id].publish(key, val)
+                        end
+                    else
+                        log.debug(util.c(log_header, "invalid turbine id ", t_id))
+                        valid = false
+                    end
+                end
+            end
+        end
+    end
+
+    return valid
+end
+
+-- update facility status
+---@param status table
+---@return boolean valid
+function iocontrol.update_facility_status(status)
+    local valid = true
+    local log_header = util.c("iocontrol.update_facility_status: ")
+
+    if type(status) ~= "table" then
+        log.debug(util.c(log_header, "status not a table"))
+        valid = false
+    else
+        local fac = io.facility
+
+        -- auto control status information
+
+        local ctl_status = status[1]
+
+        if type(ctl_status) == "table" and #ctl_status == 14 then
+            fac.all_sys_ok = ctl_status[1]
+            fac.auto_ready = ctl_status[2]
+
+            if type(ctl_status[3]) == "number" then
+                fac.auto_active = ctl_status[3] > PROCESS.INACTIVE
+            else
+                fac.auto_active = false
+                valid = false
+            end
+
+            fac.auto_ramping = ctl_status[4]
+            fac.auto_saturated = ctl_status[5]
+
+            fac.auto_scram = ctl_status[6]
+            fac.ascram_status.matrix_dc = ctl_status[7]
+            fac.ascram_status.matrix_fill = ctl_status[8]
+            fac.ascram_status.crit_alarm = ctl_status[9]
+            fac.ascram_status.radiation = ctl_status[10]
+            fac.ascram_status.gen_fault = ctl_status[11]
+
+            fac.status_line_1 = ctl_status[12]
+            fac.status_line_2 = ctl_status[13]
+
+            fac.ps.publish("all_sys_ok", fac.all_sys_ok)
+            fac.ps.publish("auto_ready", fac.auto_ready)
+            fac.ps.publish("auto_active", fac.auto_active)
+            fac.ps.publish("auto_ramping", fac.auto_ramping)
+            fac.ps.publish("auto_saturated", fac.auto_saturated)
+            fac.ps.publish("auto_scram", fac.auto_scram)
+            fac.ps.publish("as_matrix_dc", fac.ascram_status.matrix_dc)
+            fac.ps.publish("as_matrix_fill", fac.ascram_status.matrix_fill)
+            fac.ps.publish("as_crit_alarm", fac.ascram_status.crit_alarm)
+            fac.ps.publish("as_radiation", fac.ascram_status.radiation)
+            fac.ps.publish("as_gen_fault", fac.ascram_status.gen_fault)
+            fac.ps.publish("status_line_1", fac.status_line_1)
+            fac.ps.publish("status_line_2", fac.status_line_2)
+
+            local group_map = ctl_status[14]
+
+            if (type(group_map) == "table") and (#group_map == fac.num_units) then
+                local names = { "Manual", "Primary", "Secondary", "Tertiary", "Backup" }
+                for i = 1, #group_map do
+                    io.units[i].a_group = group_map[i]
+                    io.units[i].unit_ps.publish("auto_group_id", group_map[i])
+                    io.units[i].unit_ps.publish("auto_group", names[group_map[i] + 1])
+                end
+            end
+        else
+            log.debug(log_header .. "control status not a table or length mismatch")
+            valid = false
+        end
+
+        -- RTU statuses
+
+        local rtu_statuses = status[2]
+
+        fac.rtu_count = 0
+
+        if type(rtu_statuses) == "table" then
+            -- connected RTU count
+            fac.rtu_count = rtu_statuses.count
+
+            -- power statistics
+            if type(rtu_statuses.power) == "table" then
+                fac.induction_ps_tbl[1].publish("avg_charge", rtu_statuses.power[1])
+                fac.induction_ps_tbl[1].publish("avg_inflow", rtu_statuses.power[2])
+                fac.induction_ps_tbl[1].publish("avg_outflow", rtu_statuses.power[3])
+            else
+                log.debug(log_header .. "power statistics list not a table")
+                valid = false
+            end
+
+            -- induction matricies statuses
+            if type(rtu_statuses.induction) == "table" then
+                for id = 1, #fac.induction_ps_tbl do
+                    if rtu_statuses.induction[id] == nil then
+                        -- disconnected
+                        fac.induction_ps_tbl[id].publish("computed_status", 1)
+                    end
+                end
+
+                for id, matrix in pairs(rtu_statuses.induction) do
+                    if type(fac.induction_data_tbl[id]) == "table" then
+                        local rtu_faulted                 = matrix[1]   ---@type boolean
+                        fac.induction_data_tbl[id].formed = matrix[2]   ---@type boolean
+                        fac.induction_data_tbl[id].state  = matrix[3]   ---@type table
+                        fac.induction_data_tbl[id].tanks  = matrix[4]   ---@type table
+
+                        local data = fac.induction_data_tbl[id]         ---@type imatrix_session_db
+
+                        fac.induction_ps_tbl[id].publish("formed", data.formed)
+                        fac.induction_ps_tbl[id].publish("faulted", rtu_faulted)
+
+                        if data.formed then
+                            if rtu_faulted then
+                                fac.induction_ps_tbl[id].publish("computed_status", 3)  -- faulted
+                            elseif data.tanks.energy_fill >= 0.99 then
+                                fac.induction_ps_tbl[id].publish("computed_status", 6)  -- full
+                            elseif data.tanks.energy_fill <= 0.01 then
+                                fac.induction_ps_tbl[id].publish("computed_status", 5)  -- empty
+                            else
+                                fac.induction_ps_tbl[id].publish("computed_status", 4)  -- on-line
+                            end
+                        else
+                            fac.induction_ps_tbl[id].publish("computed_status", 2)      -- not formed
+                        end
+
+                        for key, val in pairs(fac.induction_data_tbl[id].state) do
+                            fac.induction_ps_tbl[id].publish(key, val)
+                        end
+
+                        for key, val in pairs(fac.induction_data_tbl[id].tanks) do
+                            fac.induction_ps_tbl[id].publish(key, val)
+                        end
+                    else
+                        log.debug(util.c(log_header, "invalid induction matrix id ", id))
+                    end
+                end
+            else
+                log.debug(log_header .. "induction matrix list not a table")
+                valid = false
+            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
+
+                    fac.ps.publish("rad_computed_status", util.trinary(rtu_faulted, 2, 3))
+                    fac.ps.publish("radiation", fac.radiation)
+                else
+                    fac.radiation = types.new_zero_radiation_reading()
+                    fac.ps.publish("rad_computed_status", 1)
+                end
+            else
+                log.debug(log_header .. "radiation monitor list not a table")
+                valid = false
+            end
+        else
+            log.debug(log_header .. "rtu statuses not a table")
+            valid = false
+        end
+
+        fac.ps.publish("rtu_count", fac.rtu_count)
+    end
+
+    return valid
+end
+
+-- update unit statuses
+---@param statuses table
+---@return boolean valid
+function iocontrol.update_unit_statuses(statuses)
+    local valid = true
+
+    if type(statuses) ~= "table" then
+        log.debug("iocontrol.update_unit_statuses: unit statuses not a table")
+        valid = false
+    elseif #statuses ~= #io.units then
+        log.debug("iocontrol.update_unit_statuses: number of provided unit statuses does not match expected number of units")
+        valid = false
+    else
+        local burn_rate_sum = 0.0
+
+        -- get all unit statuses
+        for i = 1, #statuses do
+            local log_header = util.c("iocontrol.update_unit_statuses[unit ", i, "]: ")
+
+            local unit = io.units[i]    ---@type ioctl_unit
+            local status = statuses[i]
+
+            if type(status) ~= "table" or #status ~= 5 then
+                log.debug(log_header .. "invalid status entry in unit statuses (not a table or invalid length)")
+                valid = false
+            else
+                -- reactor PLC status
+                local reactor_status = status[1]
+
+                if type(reactor_status) ~= "table" then
+                    reactor_status = {}
+                    log.debug(log_header .. "reactor status not a table")
+                end
+
+                if #reactor_status == 0 then
+                    unit.unit_ps.publish("computed_status", 1)   -- disconnected
+                elseif #reactor_status == 3 then
+                    local mek_status = reactor_status[1]
+                    local rps_status = reactor_status[2]
+                    local gen_status = reactor_status[3]
+
+                    if #gen_status == 6 then
+                        unit.reactor_data.last_status_update = gen_status[1]
+                        unit.reactor_data.control_state      = gen_status[2]
+                        unit.reactor_data.rps_tripped        = gen_status[3]
+                        unit.reactor_data.rps_trip_cause     = gen_status[4]
+                        unit.reactor_data.no_reactor         = gen_status[5]
+                        unit.reactor_data.formed             = gen_status[6]
+                    else
+                        log.debug(log_header .. "reactor general status length mismatch")
+                    end
+
+                    unit.reactor_data.rps_status = rps_status   ---@type rps_status
+                    unit.reactor_data.mek_status = mek_status   ---@type mek_status
+
+                    -- if status hasn't been received, mek_status = {}
+                    if type(unit.reactor_data.mek_status.act_burn_rate) == "number" then
+                        burn_rate_sum = burn_rate_sum + unit.reactor_data.mek_status.act_burn_rate
+                    end
+
+                    if unit.reactor_data.mek_status.status then
+                        unit.unit_ps.publish("computed_status", 5)       -- running
+                    else
+                        if unit.reactor_data.no_reactor then
+                            unit.unit_ps.publish("computed_status", 3)   -- faulted
+                        elseif not unit.reactor_data.formed then
+                            unit.unit_ps.publish("computed_status", 2)   -- multiblock not formed
+                        elseif unit.reactor_data.rps_status.force_dis then
+                            unit.unit_ps.publish("computed_status", 7)   -- reactor force disabled
+                        elseif unit.reactor_data.rps_tripped and unit.reactor_data.rps_trip_cause ~= "manual" then
+                            unit.unit_ps.publish("computed_status", 6)   -- SCRAM
+                        else
+                            unit.unit_ps.publish("computed_status", 4)   -- disabled
+                        end
+                    end
+
+                    for key, val in pairs(unit.reactor_data) do
+                        if key ~= "rps_status" and key ~= "mek_struct" and key ~= "mek_status" then
+                            unit.unit_ps.publish(key, val)
+                        end
+                    end
+
+                    if type(unit.reactor_data.rps_status) == "table" then
+                        for key, val in pairs(unit.reactor_data.rps_status) do
+                            unit.unit_ps.publish(key, val)
+                        end
+                    end
+
+                    if type(unit.reactor_data.mek_status) == "table" then
+                        for key, val in pairs(unit.reactor_data.mek_status) do
+                            unit.unit_ps.publish(key, val)
+                        end
+                    end
+                else
+                    log.debug(log_header .. "reactor status length mismatch")
+                    valid = false
+                end
+
+                -- RTU statuses
+                local rtu_statuses = status[2]
+
+                if type(rtu_statuses) == "table" then
+                    -- boiler statuses
+                    if type(rtu_statuses.boilers) == "table" then
+                        for id = 1, #unit.boiler_ps_tbl do
+                            if rtu_statuses.boilers[i] == nil then
+                                -- disconnected
+                                unit.boiler_ps_tbl[id].publish("computed_status", 1)
+                            end
+                        end
+
+                        for id, boiler in pairs(rtu_statuses.boilers) do
+                            if type(unit.boiler_data_tbl[id]) == "table" then
+                                local rtu_faulted               = boiler[1] ---@type boolean
+                                unit.boiler_data_tbl[id].formed = boiler[2] ---@type boolean
+                                unit.boiler_data_tbl[id].state  = boiler[3] ---@type table
+                                unit.boiler_data_tbl[id].tanks  = boiler[4] ---@type table
+
+                                local data = unit.boiler_data_tbl[id]  ---@type boilerv_session_db
+
+                                unit.boiler_ps_tbl[id].publish("formed", data.formed)
+                                unit.boiler_ps_tbl[id].publish("faulted", rtu_faulted)
+
+                                if rtu_faulted then
+                                    unit.boiler_ps_tbl[id].publish("computed_status", 3)        -- faulted
+                                elseif data.formed then
+                                    if data.state.boil_rate > 0 then
+                                        unit.boiler_ps_tbl[id].publish("computed_status", 5)    -- active
+                                    else
+                                        unit.boiler_ps_tbl[id].publish("computed_status", 4)    -- idle
+                                    end
+                                else
+                                    unit.boiler_ps_tbl[id].publish("computed_status", 2)        -- not formed
+                                end
+
+                                for key, val in pairs(unit.boiler_data_tbl[id].state) do
+                                    unit.boiler_ps_tbl[id].publish(key, val)
+                                end
+
+                                for key, val in pairs(unit.boiler_data_tbl[id].tanks) do
+                                    unit.boiler_ps_tbl[id].publish(key, val)
+                                end
+                            else
+                                log.debug(util.c(log_header, "invalid boiler id ", id))
+                                valid = false
+                            end
+                        end
+                    else
+                        log.debug(log_header .. "boiler list not a table")
+                        valid = false
+                    end
+
+                    -- turbine statuses
+                    if type(rtu_statuses.turbines) == "table" then
+                        for id = 1, #unit.turbine_ps_tbl do
+                            if rtu_statuses.turbines[i] == nil then
+                                -- disconnected
+                                unit.turbine_ps_tbl[id].publish("computed_status", 1)
+                            end
+                        end
+
+                        for id, turbine in pairs(rtu_statuses.turbines) do
+                            if type(unit.turbine_data_tbl[id]) == "table" then
+                                local rtu_faulted                = turbine[1]   ---@type boolean
+                                unit.turbine_data_tbl[id].formed = turbine[2]   ---@type boolean
+                                unit.turbine_data_tbl[id].state  = turbine[3]   ---@type table
+                                unit.turbine_data_tbl[id].tanks  = turbine[4]   ---@type table
+
+                                local data = unit.turbine_data_tbl[id]  ---@type turbinev_session_db
+
+                                unit.turbine_ps_tbl[id].publish("formed", data.formed)
+                                unit.turbine_ps_tbl[id].publish("faulted", rtu_faulted)
+
+                                if rtu_faulted then
+                                    unit.turbine_ps_tbl[id].publish("computed_status", 3)       -- faulted
+                                elseif data.formed then
+                                    if data.tanks.energy_fill >= 0.99 then
+                                        unit.turbine_ps_tbl[id].publish("computed_status", 6)   -- trip
+                                    elseif data.state.flow_rate < 100 then
+                                        unit.turbine_ps_tbl[id].publish("computed_status", 4)   -- idle
+                                    else
+                                        unit.turbine_ps_tbl[id].publish("computed_status", 5)   -- active
+                                    end
+                                else
+                                    unit.turbine_ps_tbl[id].publish("computed_status", 2)       -- not formed
+                                end
+
+                                for key, val in pairs(unit.turbine_data_tbl[id].state) do
+                                    unit.turbine_ps_tbl[id].publish(key, val)
+                                end
+
+                                for key, val in pairs(unit.turbine_data_tbl[id].tanks) do
+                                    unit.turbine_ps_tbl[id].publish(key, val)
+                                end
+                            else
+                                log.debug(util.c(log_header, "invalid turbine id ", id))
+                                valid = false
+                            end
+                        end
+                    else
+                        log.debug(log_header .. "turbine list not a table")
+                        valid = false
+                    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
+
+                            unit.unit_ps.publish("radiation", unit.radiation)
+                        else
+                            unit.radiation = types.new_zero_radiation_reading()
+                        end
+                    else
+                        log.debug(log_header .. "radiation monitor list not a table")
+                        valid = false
+                    end
+                else
+                    log.debug(log_header .. "rtu list not a table")
+                    valid = false
+                end
+
+                -- annunciator
+                unit.annunciator = status[3]
+
+                if type(unit.annunciator) ~= "table" then
+                    unit.annunciator = {}
+                    log.debug(log_header .. "annunciator state not a table")
+                    valid = false
+                end
+
+                for key, val in pairs(unit.annunciator) do
+                    if key == "BoilerOnline" or key == "HeatingRateLow" or key == "WaterLevelLow" then
+                        -- split up array for all boilers
+                        for id = 1, #val do
+                            unit.boiler_ps_tbl[id].publish(key, val[id])
+                        end
+                    elseif key == "TurbineOnline" or key == "SteamDumpOpen" or key == "TurbineOverSpeed" or
+                           key == "GeneratorTrip" or key == "TurbineTrip" then
+                        -- split up array for all turbines
+                        for id = 1, #val do
+                            unit.turbine_ps_tbl[id].publish(key, val[id])
+                        end
+                    elseif type(val) == "table" then
+                        -- we missed one of the tables?
+                        log.debug(log_header .. "unrecognized table found in annunciator list, this is a bug")
+                        valid = false
+                    else
+                        -- non-table fields
+                        unit.unit_ps.publish(key, val)
+                    end
+                end
+
+                -- alarms
+                local alarm_states = status[4]
+
+                if type(alarm_states) == "table" then
+                    for id = 1, #alarm_states do
+                        local state = alarm_states[id]
+
+                        unit.alarms[id] = state
+
+                        if state == types.ALARM_STATE.TRIPPED or state == types.ALARM_STATE.ACKED then
+                            unit.unit_ps.publish("Alarm_" .. id, 2)
+                        elseif state == types.ALARM_STATE.RING_BACK then
+                            unit.unit_ps.publish("Alarm_" .. id, 3)
+                        else
+                            unit.unit_ps.publish("Alarm_" .. id, 1)
+                        end
+                    end
+                else
+                    log.debug(log_header .. "alarm states not a table")
+                    valid = false
+                end
+
+                -- unit state fields
+                local unit_state = status[5]
+
+                if type(unit_state) == "table" then
+                    if #unit_state == 5 then
+                        unit.unit_ps.publish("U_StatusLine1", unit_state[1])
+                        unit.unit_ps.publish("U_StatusLine2", unit_state[2])
+                        unit.unit_ps.publish("U_WasteMode", unit_state[3])
+                        unit.unit_ps.publish("U_AutoReady", unit_state[4])
+                        unit.unit_ps.publish("U_AutoDegraded", unit_state[5])
+                    else
+                        log.debug(log_header .. "unit state length mismatch")
+                        valid = false
+                    end
+                else
+                    log.debug(log_header .. "unit state not a table")
+                    valid = false
+                end
+            end
+        end
+
+        io.facility.ps.publish("burn_sum", burn_rate_sum)
+
+        -- update alarm sounder
+        sounder.eval(io.units)
+    end
+
+    return valid
+end
+
+-- get the IO controller database
+function iocontrol.get_db() return io end
+
+return iocontrol

coordinator/process.lua

@@ -0,0 +1,273 @@
+--
+-- Process Control Management
+--
+
+local comms = require("scada-common.comms")
+local log   = require("scada-common.log")
+local types = require("scada-common.types")
+local util  = require("scada-common.util")
+
+local FAC_COMMAND = comms.FAC_COMMAND
+local UNIT_COMMAND = comms.UNIT_COMMAND
+
+local PROCESS = types.PROCESS
+
+---@class process_controller
+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 = {}
+    }
+}
+
+--------------------------
+-- UNIT COMMAND CONTROL --
+--------------------------
+
+-- initialize the process controller
+---@param iocontrol ioctl iocontrl system
+---@param coord_comms coord_comms coordinator communications
+function process.init(iocontrol, coord_comms)
+    self.io = iocontrol
+    self.comms = coord_comms
+
+    for i = 1, self.io.facility.num_units do
+        self.config.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 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.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)
+
+        for id = 1, math.min(#self.config.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])
+        end
+
+        log.info("PROCESS: loaded auto control settings from coord.settings")
+    end
+
+    local waste_mode = settings.get("WASTE_MODES")  ---@type table|nil
+
+    if type(waste_mode) == "table" then
+        for id, mode in pairs(waste_mode) do
+            self.comms.send_unit_command(UNIT_COMMAND.SET_WASTE, id, mode)
+        end
+
+        log.info("PROCESS: loaded waste mode settings from coord.settings")
+    end
+
+    local prio_groups = settings.get("PRIORITY_GROUPS") ---@type table|nil
+
+    if type(prio_groups) == "table" then
+        for id, group in pairs(prio_groups) do
+            self.comms.send_unit_command(UNIT_COMMAND.SET_GROUP, id, group)
+        end
+
+        log.info("PROCESS: loaded priority groups settings from coord.settings")
+    end
+end
+
+-- facility SCRAM command
+function process.fac_scram()
+    self.comms.send_fac_command(FAC_COMMAND.SCRAM_ALL)
+    log.debug("PROCESS: FAC SCRAM ALL")
+end
+
+-- facility alarm acknowledge command
+function process.fac_ack_alarms()
+    self.comms.send_fac_command(FAC_COMMAND.ACK_ALL_ALARMS)
+    log.debug("PROCESS: FAC ACK ALL ALARMS")
+end
+
+-- start reactor
+---@param id integer unit ID
+function process.start(id)
+    self.io.units[id].control_state = true
+    self.comms.send_unit_command(UNIT_COMMAND.START, id)
+    log.debug(util.c("PROCESS: UNIT[", id, "] START"))
+end
+
+-- SCRAM reactor
+---@param id integer unit ID
+function process.scram(id)
+    self.io.units[id].control_state = false
+    self.comms.send_unit_command(UNIT_COMMAND.SCRAM, id)
+    log.debug(util.c("PROCESS: UNIT[", id, "] SCRAM"))
+end
+
+-- reset reactor protection system
+---@param id integer unit ID
+function process.reset_rps(id)
+    self.comms.send_unit_command(UNIT_COMMAND.RESET_RPS, id)
+    log.debug(util.c("PROCESS: UNIT[", id, "] RESET RPS"))
+end
+
+-- set burn rate
+---@param id integer unit ID
+---@param rate number burn rate
+function process.set_rate(id, rate)
+    self.comms.send_unit_command(UNIT_COMMAND.SET_BURN, id, rate)
+    log.debug(util.c("PROCESS: UNIT[", id, "] SET BURN ", rate))
+end
+
+-- set waste mode
+---@param id integer unit ID
+---@param mode integer waste mode
+function process.set_waste(id, mode)
+    -- publish so that if it fails then it gets reset
+    self.io.units[id].unit_ps.publish("U_WasteMode", 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
+
+    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
+        log.error("process.set_waste(): failed to save coordinator settings file")
+    end
+end
+
+-- acknowledge all alarms
+---@param id integer unit ID
+function process.ack_all_alarms(id)
+    self.comms.send_unit_command(UNIT_COMMAND.ACK_ALL_ALARMS, id)
+    log.debug(util.c("PROCESS: UNIT[", id, "] ACK ALL ALARMS"))
+end
+
+-- acknowledge an alarm
+---@param id integer unit ID
+---@param alarm integer alarm ID
+function process.ack_alarm(id, alarm)
+    self.comms.send_unit_command(UNIT_COMMAND.ACK_ALARM, id, alarm)
+    log.debug(util.c("PROCESS: UNIT[", id, "] ACK ALARM ", alarm))
+end
+
+-- reset an alarm
+---@param id integer unit ID
+---@param alarm integer alarm ID
+function process.reset_alarm(id, alarm)
+    self.comms.send_unit_command(UNIT_COMMAND.RESET_ALARM, id, alarm)
+    log.debug(util.c("PROCESS: UNIT[", id, "] RESET ALARM ", alarm))
+end
+
+-- assign a unit to a group
+---@param unit_id integer unit ID
+---@param group_id integer|0 group ID or 0 for independent
+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
+
+    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
+        log.error("process.set_group(): failed to save coordinator settings file")
+    end
+end
+
+--------------------------
+-- AUTO PROCESS CONTROL --
+--------------------------
+
+-- stop automatic process control
+function process.stop_auto()
+    self.comms.send_fac_command(FAC_COMMAND.STOP)
+    log.debug("PROCESS: STOP AUTO CTL")
+end
+
+-- start automatic process control
+function process.start_auto()
+    self.comms.send_auto_start(self.config)
+    log.debug("PROCESS: START AUTO CTL")
+end
+
+-- save process control settings
+---@param mode PROCESS control mode
+---@param burn_target number burn rate target
+---@param charge_target number charge target
+---@param gen_target number generation rate target
+---@param limits table unit burn rate limits
+function process.save(mode, burn_target, charge_target, gen_target, limits)
+    -- attempt to load settings
+    if not settings.load("/coord.settings") then
+        log.warning("process.save(): failed to load coordinator settings file")
+    end
+
+    -- config table
+    self.config = {
+        mode = mode,
+        burn_target = burn_target,
+        charge_target = charge_target,
+        gen_target = gen_target,
+        limits = limits
+    }
+
+    -- save config
+    settings.set("PROCESS", self.config)
+    local saved = settings.save("/coord.settings")
+
+    if not saved then
+        log.warning("process.save(): failed to save coordinator settings file")
+    end
+
+    self.io.facility.save_cfg_ack(saved)
+end
+
+-- handle a start command acknowledgement
+---@param response table ack and configuration reply
+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]
+
+    for i = 1, #response[6] do
+        self.config.limits[i] = response[6][i]
+    end
+
+    self.io.facility.ps.publish("auto_mode", self.config.mode)
+    self.io.facility.ps.publish("burn_target", self.config.burn_target)
+    self.io.facility.ps.publish("charge_target", self.config.charge_target)
+    self.io.facility.ps.publish("gen_target", self.config.gen_target)
+
+    self.io.facility.start_ack(ack)
+end
+
+return process

coordinator/renderer.lua

@@ -0,0 +1,182 @@
+--
+-- Graphics Rendering Control
+--
+
+local log        = require("scada-common.log")
+local util       = require("scada-common.util")
+
+local style      = require("coordinator.ui.style")
+
+local main_view  = require("coordinator.ui.layout.main_view")
+local unit_view  = require("coordinator.ui.layout.unit_view")
+
+local flasher    = require("graphics.flasher")
+
+local DisplayBox = require("graphics.elements.displaybox")
+
+local renderer = {}
+
+-- render engine
+local engine = {
+    monitors = nil,         ---@type monitors_struct|nil
+    dmesg_window = nil,     ---@type table|nil
+    ui_ready = false,
+    ui = {
+        main_display = nil, ---@type graphics_element|nil
+        unit_displays = {}
+    }
+}
+
+-- init a display to the "default", but set text scale to 0.5
+---@param monitor table monitor
+local function _init_display(monitor)
+    monitor.setTextScale(0.5)
+    monitor.setTextColor(colors.white)
+    monitor.setBackgroundColor(colors.black)
+    monitor.clear()
+    monitor.setCursorPos(1, 1)
+
+    -- set overridden colors
+    for i = 1, #style.colors do
+        monitor.setPaletteColor(style.colors[i].c, style.colors[i].hex)
+    end
+end
+
+-- link to the monitor peripherals
+---@param monitors monitors_struct
+function renderer.set_displays(monitors)
+    engine.monitors = monitors
+end
+
+-- check if the renderer is configured to use a given monitor peripheral
+---@nodiscard
+---@param periph table peripheral
+---@return boolean is_used
+function renderer.is_monitor_used(periph)
+    if engine.monitors ~= nil then
+        if engine.monitors.primary == periph then
+            return true
+        else
+            for _, monitor in ipairs(engine.monitors.unit_displays) do
+                if monitor == periph then return true end
+            end
+        end
+    end
+
+    return false
+end
+
+-- init all displays in use by the renderer
+function renderer.init_displays()
+    -- init primary monitor
+    _init_display(engine.monitors.primary)
+
+    -- init unit displays
+    for _, monitor in ipairs(engine.monitors.unit_displays) do
+        _init_display(monitor)
+    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 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()
+    engine.dmesg_window = window.create(engine.monitors.primary, 1, 1, disp_x, disp_y)
+    log.direct_dmesg(engine.dmesg_window)
+end
+
+-- start the coordinator GUI
+function renderer.start_ui()
+    if not engine.ui_ready then
+        -- hide dmesg
+        engine.dmesg_window.setVisible(false)
+
+        -- show main view on main monitor
+        engine.ui.main_display = DisplayBox{window=engine.monitors.primary,fg_bg=style.root}
+        main_view(engine.ui.main_display)
+
+        -- show unit views on unit displays
+        for i = 1, #engine.monitors.unit_displays do
+            engine.ui.unit_displays[i] = DisplayBox{window=engine.monitors.unit_displays[i],fg_bg=style.root}
+            unit_view(engine.ui.unit_displays[i], i)
+        end
+
+        -- start flasher callback task
+        flasher.run()
+
+        -- report ui as ready
+        engine.ui_ready = true
+    end
+end
+
+-- close out the UI
+function renderer.close_ui()
+    -- stop blinking indicators
+    flasher.clear()
+
+    -- delete element trees
+    if engine.ui.main_display ~= nil then engine.ui.main_display.delete() end
+    for _, display in ipairs(engine.ui.unit_displays) do display.delete() end
+
+    -- report ui as not ready
+    engine.ui_ready = false
+
+    -- clear root UI elements
+    engine.ui.main_display = nil
+    engine.ui.unit_displays = {}
+
+    -- clear unit monitors
+    for _, monitor in ipairs(engine.monitors.unit_displays) do monitor.clear() end
+
+    -- re-draw dmesg
+    engine.dmesg_window.setVisible(true)
+    engine.dmesg_window.redraw()
+end
+
+-- is the UI ready?
+---@nodiscard
+---@return boolean ready
+function renderer.ui_ready() return engine.ui_ready end
+
+-- handle a touch event
+---@param event mouse_interaction|nil
+function renderer.handle_mouse(event)
+    if engine.ui_ready and event ~= nil then
+        if event.monitor == engine.monitors.primary_name then
+            engine.ui.main_display.handle_mouse(event)
+        else
+            for id, monitor in ipairs(engine.monitors.unit_name_map) do
+                if event.monitor == monitor then
+                    local layout = engine.ui.unit_displays[id]  ---@type graphics_element
+                    layout.handle_mouse(event)
+                end
+            end
+        end
+    end
+end
+
+return renderer

coordinator/session/api.lua

@@ -0,0 +1,251 @@
+local comms  = require("scada-common.comms")
+local log    = require("scada-common.log")
+local mqueue = require("scada-common.mqueue")
+local util   = require("scada-common.util")
+
+local api = {}
+
+local PROTOCOL = comms.PROTOCOL
+-- local CAPI_TYPE = comms.CAPI_TYPE
+local SCADA_MGMT_TYPE = comms.SCADA_MGMT_TYPE
+
+local println = util.println
+
+-- retry time constants in ms
+-- local INITIAL_WAIT = 1500
+-- local RETRY_PERIOD = 1000
+
+local API_S_CMDS = {
+}
+
+local API_S_DATA = {
+}
+
+api.API_S_CMDS = API_S_CMDS
+api.API_S_DATA = API_S_DATA
+
+local PERIODICS = {
+    KEEP_ALIVE = 2000
+}
+
+-- pocket API session
+---@nodiscard
+---@param id integer session ID
+---@param in_queue mqueue in message queue
+---@param out_queue mqueue out message queue
+---@param timeout number communications timeout
+function api.new_session(id, in_queue, out_queue, timeout)
+    local log_header = "api_session(" .. id .. "): "
+
+    local self = {
+        -- connection properties
+        seq_num = 0,
+        r_seq_num = nil,
+        connected = true,
+        conn_watchdog = util.new_watchdog(timeout),
+        last_rtt = 0,
+        -- periodic messages
+        periodics = {
+            last_update = 0,
+            keep_alive = 0
+        },
+        -- when to next retry one of these requests
+        retry_times = {
+        },
+        -- command acknowledgements
+        acks = {
+        },
+        -- session database
+        ---@class api_db
+        sDB = {
+        }
+    }
+
+    ---@class api_session
+    local public = {}
+
+    -- mark this API session as closed, stop watchdog
+    local function _close()
+        self.conn_watchdog.cancel()
+        self.connected = false
+    end
+
+    -- send a CAPI packet
+    -----@param msg_type CAPI_TYPE
+    -----@param msg table
+    -- local function _send(msg_type, msg)
+    --     local s_pkt = comms.scada_packet()
+    --     local c_pkt = comms.capi_packet()
+
+    --     c_pkt.make(msg_type, msg)
+    --     s_pkt.make(self.seq_num, PROTOCOL.COORD_API, 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 table
+    local function _send_mgmt(msg_type, msg)
+        local s_pkt = comms.scada_packet()
+        local m_pkt = comms.mgmt_packet()
+
+        m_pkt.make(msg_type, msg)
+        s_pkt.make(self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
+
+        out_queue.push_packet(s_pkt)
+        self.seq_num = self.seq_num + 1
+    end
+
+    -- handle a packet
+    ---@param pkt mgmt_frame|capi_frame
+    local function _handle_packet(pkt)
+        -- check sequence number
+        if self.r_seq_num == nil then
+            self.r_seq_num = pkt.scada_frame.seq_num()
+        elseif (self.r_seq_num + 1) ~= pkt.scada_frame.seq_num() then
+            log.warning(log_header .. "sequence out-of-order: last = " .. self.r_seq_num .. ", new = " .. pkt.scada_frame.seq_num())
+            return
+        else
+            self.r_seq_num = pkt.scada_frame.seq_num()
+        end
+
+        -- feed watchdog
+        self.conn_watchdog.feed()
+
+        -- process packet
+        if pkt.scada_frame.protocol() == PROTOCOL.COORD_API then
+            ---@cast pkt capi_frame
+            -- feed watchdog
+            self.conn_watchdog.feed()
+
+            -- handle packet by type
+            if pkt.type == nil then
+            else
+                log.debug(log_header .. "handler received unsupported CAPI 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
+                -- keep alive reply
+                if pkt.length == 2 then
+                    local srv_start = pkt.data[1]
+                    -- local api_send = pkt.data[2]
+                    local srv_now = util.time()
+                    self.last_rtt = srv_now - srv_start
+
+                    if self.last_rtt > 750 then
+                        log.warning(log_header .. "API KEEP_ALIVE round trip time > 750ms (" .. self.last_rtt .. "ms)")
+                    end
+
+                    -- log.debug(log_header .. "API RTT = " .. self.last_rtt .. "ms")
+                    -- log.debug(log_header .. "API TT  = " .. (srv_now - api_send) .. "ms")
+                else
+                    log.debug(log_header .. "SCADA keep alive packet length mismatch")
+                end
+            elseif pkt.type == SCADA_MGMT_TYPE.CLOSE then
+                -- close the session
+                _close()
+            else
+                log.debug(log_header .. "handler received unsupported SCADA_MGMT packet type " .. pkt.type)
+            end
+        end
+    end
+
+    -- PUBLIC FUNCTIONS --
+
+    -- get the session ID
+    ---@nodiscard
+    function public.get_id() return id end
+
+    -- get the session database
+    ---@nodiscard
+    function public.get_db() return self.sDB end
+
+    -- check if a timer matches this session's watchdog
+    ---@nodiscard
+    function public.check_wd(timer)
+        return self.conn_watchdog.is_timer(timer) and self.connected
+    end
+
+    -- close the connection
+    function public.close()
+        _close()
+        _send_mgmt(SCADA_MGMT_TYPE.CLOSE, {})
+        println("connection to API session " .. id .. " closed by server")
+        log.info(log_header .. "session closed by server")
+    end
+
+    -- iterate the session
+    ---@nodiscard
+    ---@return boolean connected
+    function public.iterate()
+        if self.connected then
+            ------------------
+            -- handle queue --
+            ------------------
+
+            local handle_start = util.time()
+
+            while in_queue.ready() and self.connected do
+                -- get a new message to process
+                local message = in_queue.pop()
+
+                if message ~= nil then
+                    if message.qtype == mqueue.TYPE.PACKET then
+                        -- handle a packet
+                        _handle_packet(message.message)
+                    elseif message.qtype == mqueue.TYPE.COMMAND then
+                        -- handle instruction
+                    elseif message.qtype == mqueue.TYPE.DATA then
+                        -- instruction with body
+                    end
+                end
+
+                -- max 100ms spent processing queue
+                if util.time() - handle_start > 100 then
+                    log.warning(log_header .. "exceeded 100ms queue process limit")
+                    break
+                end
+            end
+
+            -- exit if connection was closed
+            if not self.connected then
+                println("connection to API session " .. id .. " closed by remote host")
+                log.info(log_header .. "session closed by remote host")
+                return self.connected
+            end
+
+            ----------------------
+            -- update periodics --
+            ----------------------
+
+            local elapsed = util.time() - self.periodics.last_update
+
+            local periodics = self.periodics
+
+            -- keep alive
+
+            periodics.keep_alive = periodics.keep_alive + elapsed
+            if periodics.keep_alive >= PERIODICS.KEEP_ALIVE then
+                _send_mgmt(SCADA_MGMT_TYPE.KEEP_ALIVE, { util.time() })
+                periodics.keep_alive = 0
+            end
+
+            self.periodics.last_update = util.time()
+
+            ---------------------
+            -- attempt retries --
+            ---------------------
+
+            -- local rtimes = self.retry_times
+        end
+
+        return self.connected
+    end
+
+    return public
+end
+
+return api

coordinator/session/apisessions.lua

@@ -0,0 +1,174 @@
+
+local log    = require("scada-common.log")
+local mqueue = require("scada-common.mqueue")
+local util   = require("scada-common.util")
+
+local config = require("coordinator.config")
+
+local api    = require("coordinator.session.api")
+
+local apisessions = {}
+
+local self = {
+    modem = nil,
+    next_id = 0,
+    sessions = {}
+}
+
+-- PRIVATE FUNCTIONS --
+
+-- handle a session output queue
+---@param session api_session_struct
+local function _api_handle_outq(session)
+    -- record handler start time
+    local handle_start = util.time()
+
+    -- process output queue
+    while session.out_queue.ready() do
+        -- get a new message to process
+        local msg = session.out_queue.pop()
+
+        if msg ~= nil then
+            if msg.qtype == mqueue.TYPE.PACKET then
+                -- handle a packet to be sent
+                self.modem.transmit(session.r_port, session.l_port, msg.message.raw_sendable())
+            elseif msg.qtype == mqueue.TYPE.COMMAND then
+                -- handle instruction/notification
+            elseif msg.qtype == mqueue.TYPE.DATA then
+                -- instruction/notification with body
+            end
+        end
+
+        -- max 100ms spent processing queue
+        if util.time() - handle_start > 100 then
+            log.warning("API out queue handler exceeded 100ms queue process limit")
+            log.warning(util.c("offending session: port ", session.r_port))
+            break
+        end
+    end
+end
+
+-- cleanly close a session
+---@param session api_session_struct
+local function _shutdown(session)
+    session.open = false
+    session.instance.close()
+
+    -- send packets in out queue (namely the close packet)
+    while session.out_queue.ready() do
+        local msg = session.out_queue.pop()
+        if msg ~= nil and msg.qtype == mqueue.TYPE.PACKET then
+            self.modem.transmit(session.r_port, session.l_port, msg.message.raw_sendable())
+        end
+    end
+
+    log.debug(util.c("closed API session ", session.instance.get_id(), " on remote port ", session.r_port))
+end
+
+-- PUBLIC FUNCTIONS --
+
+-- initialize apisessions
+---@param modem table
+function apisessions.init(modem)
+    self.modem = modem
+end
+
+-- re-link the modem
+---@param modem table
+function apisessions.relink_modem(modem)
+    self.modem = modem
+end
+
+-- find a session by remote port
+---@nodiscard
+---@param port integer
+---@return api_session_struct|nil
+function apisessions.find_session(port)
+    for i = 1, #self.sessions do
+        if self.sessions[i].r_port == port then return self.sessions[i] end
+    end
+    return nil
+end
+
+-- establish a new API session
+---@nodiscard
+---@param local_port integer
+---@param remote_port integer
+---@param version string
+---@return integer session_id
+function apisessions.establish_session(local_port, remote_port, version)
+    ---@class api_session_struct
+    local api_s = {
+        open = true,
+        version = version,
+        l_port = local_port,
+        r_port = remote_port,
+        in_queue = mqueue.new(),
+        out_queue = mqueue.new(),
+        instance = nil  ---@type api_session
+    }
+
+    api_s.instance = api.new_session(self.next_id, api_s.in_queue, api_s.out_queue, config.API_TIMEOUT)
+    table.insert(self.sessions, api_s)
+
+    log.debug(util.c("established new API session to ", remote_port, " with ID ", self.next_id))
+
+    self.next_id = self.next_id + 1
+
+    -- success
+    return api_s.instance.get_id()
+end
+
+-- attempt to identify which session's watchdog timer fired
+---@param timer_event number
+function apisessions.check_all_watchdogs(timer_event)
+    for i = 1, #self.sessions do
+        local session = self.sessions[i]  ---@type api_session_struct
+        if session.open then
+            local triggered = session.instance.check_wd(timer_event)
+            if triggered then
+                log.debug(util.c("watchdog closing API session ", session.instance.get_id(),
+                    " on remote port ", session.r_port, "..."))
+                _shutdown(session)
+            end
+        end
+    end
+end
+
+-- iterate all the API sessions
+function apisessions.iterate_all()
+    for i = 1, #self.sessions do
+        local session = self.sessions[i]    ---@type api_session_struct
+
+        if session.open and session.instance.iterate() then
+            _api_handle_outq(session)
+        else
+            session.open = false
+        end
+    end
+end
+
+-- delete all closed sessions
+function apisessions.free_all_closed()
+    local f = function (session) return session.open end
+
+    ---@param session api_session_struct
+    local on_delete = function (session)
+        log.debug(util.c("free'ing closed API session ", session.instance.get_id(),
+            " on remote port ", session.r_port))
+    end
+
+    util.filter_table(self.sessions, f, on_delete)
+end
+
+-- close all open connections
+function apisessions.close_all()
+    for i = 1, #self.sessions do
+        local session = self.sessions[i]  ---@type api_session_struct
+        if session.open then _shutdown(session) end
+    end
+
+    apisessions.free_all_closed()
+end
+
+return apisessions

coordinator/sounder.lua

@@ -0,0 +1,469 @@
+--
+-- Alarm Sounder
+--
+
+local log   = require("scada-common.log")
+local types = require("scada-common.types")
+local util  = require("scada-common.util")
+
+local ALARM = types.ALARM
+local ALARM_STATE = types.ALARM_STATE
+
+---@class sounder
+local sounder = {}
+
+-- note: max samples = 0x20000 (128 * 1024 samples)
+
+local _2_PI        = 2 * math.pi    -- 2 whole pies, hope you're hungry
+local _DRATE       = 48000          -- 48kHz audio
+local _MAX_VAL     = 127 / 2        -- max signed integer in this 8-bit audio
+local _05s_SAMPLES = 24000          -- half a second worth of samples
+
+local test_alarms = { false, false, false, false, false, false, false, false, false, false, false, false }
+
+local alarm_ctl = {
+    speaker = nil,
+    volume = 0.5,
+    playing = false,
+    num_active = 0,
+    next_block = 1,
+    -- split audio up into 0.5s samples so specific components can be ended quicker
+    quad_buffer = { {}, {}, {}, {} }
+}
+
+-- sounds modeled after https://www.e2s.com/references-and-guidelines/listen-and-download-alarm-tones
+
+local T_340Hz_Int_2Hz = 1
+local T_544Hz_440Hz_Alt = 2
+local T_660Hz_Int_125ms = 3
+local T_745Hz_Int_1Hz = 4
+local T_800Hz_Int = 5
+local T_800Hz_1000Hz_Alt = 6
+local T_1000Hz_Int = 7
+local T_1800Hz_Int_4Hz = 8
+
+local TONES = {
+    { active = false, component = { {}, {}, {}, {} } }, -- 340Hz @ 2Hz Intermittent
+    { active = false, component = { {}, {}, {}, {} } }, -- 544Hz 100mS / 440Hz 400mS Alternating
+    { active = false, component = { {}, {}, {}, {} } }, -- 660Hz @ 125ms On 125ms Off
+    { active = false, component = { {}, {}, {}, {} } }, -- 745Hz @ 1Hz Intermittent
+    { active = false, component = { {}, {}, {}, {} } }, -- 800Hz @ 0.25s On 1.75s Off
+    { active = false, component = { {}, {}, {}, {} } }, -- 800/1000Hz @ 0.25s Alternating
+    { active = false, component = { {}, {}, {}, {} } }, -- 1KHz 1s on, 1s off Intermittent
+    { active = false, component = { {}, {}, {}, {} } }  -- 1.8KHz @ 4Hz Intermittent
+}
+
+-- calculate how many samples are in the given number of milliseconds
+---@nodiscard
+---@param ms integer milliseconds
+---@return integer samples
+local function ms_to_samples(ms) return math.floor(ms * 48) end
+
+--#region Tone Generation (the Maths)
+
+-- 340Hz @ 2Hz Intermittent
+local function gen_tone_1()
+    local t, dt = 0, _2_PI * 340 / _DRATE
+
+    for i = 1, _05s_SAMPLES do
+        local val = math.floor(math.sin(t) * _MAX_VAL)
+        TONES[1].component[1][i] = val
+        TONES[1].component[3][i] = val
+        TONES[1].component[2][i] = 0
+        TONES[1].component[4][i] = 0
+        t = (t + dt) % _2_PI
+    end
+end
+
+-- 544Hz 100mS / 440Hz 400mS Alternating
+local function gen_tone_2()
+    local t1, dt1 = 0, _2_PI * 544 / _DRATE
+    local t2, dt2 = 0, _2_PI * 440 / _DRATE
+    local alternate_at = ms_to_samples(100)
+
+    for i = 1, _05s_SAMPLES do
+        local value
+
+        if i <= alternate_at then
+            value = math.floor(math.sin(t1) * _MAX_VAL)
+            t1 = (t1 + dt1) % _2_PI
+        else
+            value = math.floor(math.sin(t2) * _MAX_VAL)
+            t2 = (t2 + dt2) % _2_PI
+        end
+
+        TONES[2].component[1][i] = value
+        TONES[2].component[2][i] = value
+        TONES[2].component[3][i] = value
+        TONES[2].component[4][i] = value
+    end
+end
+
+-- 660Hz @ 125ms On 125ms Off
+local function gen_tone_3()
+    local elapsed_samples = 0
+    local alternate_after = ms_to_samples(125)
+    local alternate_at = alternate_after
+    local mode = true
+
+    local t, dt = 0, _2_PI * 660 / _DRATE
+
+    for set = 1, 4 do
+        for i = 1, _05s_SAMPLES do
+            if mode then
+                local val = math.floor(math.sin(t) * _MAX_VAL)
+                TONES[3].component[set][i] = val
+                t = (t + dt) % _2_PI
+            else
+                t = 0
+                TONES[3].component[set][i] = 0
+            end
+
+            if elapsed_samples == alternate_at then
+                mode = not mode
+                alternate_at = elapsed_samples + alternate_after
+            end
+
+            elapsed_samples = elapsed_samples + 1
+        end
+    end
+end
+
+-- 745Hz @ 1Hz Intermittent
+local function gen_tone_4()
+    local t, dt = 0, _2_PI * 745 / _DRATE
+
+    for i = 1, _05s_SAMPLES do
+        local val = math.floor(math.sin(t) * _MAX_VAL)
+        TONES[4].component[1][i] = val
+        TONES[4].component[3][i] = val
+        TONES[4].component[2][i] = 0
+        TONES[4].component[4][i] = 0
+        t = (t + dt) % _2_PI
+    end
+end
+
+-- 800Hz @ 0.25s On 1.75s Off
+local function gen_tone_5()
+    local t, dt = 0, _2_PI * 800 / _DRATE
+    local stop_at = ms_to_samples(250)
+
+    for i = 1, _05s_SAMPLES do
+        local val = math.floor(math.sin(t) * _MAX_VAL)
+
+        if i > stop_at then
+            TONES[5].component[1][i] = val
+        else
+            TONES[5].component[1][i] = 0
+        end
+
+        TONES[5].component[2][i] = 0
+        TONES[5].component[3][i] = 0
+        TONES[5].component[4][i] = 0
+
+        t = (t + dt) % _2_PI
+    end
+end
+
+-- 1000/800Hz @ 0.25s Alternating
+local function gen_tone_6()
+    local t1, dt1 = 0, _2_PI * 1000 / _DRATE
+    local t2, dt2 = 0, _2_PI * 800 / _DRATE
+
+    local alternate_at = ms_to_samples(250)
+
+    for i = 1, _05s_SAMPLES do
+        local val
+        if i <= alternate_at then
+            val = math.floor(math.sin(t1) * _MAX_VAL)
+            t1 = (t1 + dt1) % _2_PI
+        else
+            val = math.floor(math.sin(t2) * _MAX_VAL)
+            t2 = (t2 + dt2) % _2_PI
+        end
+
+        TONES[6].component[1][i] = val
+        TONES[6].component[2][i] = val
+        TONES[6].component[3][i] = val
+        TONES[6].component[4][i] = val
+    end
+end
+
+-- 1KHz 1s on, 1s off Intermittent
+local function gen_tone_7()
+    local t, dt = 0, _2_PI * 1000 / _DRATE
+
+    for i = 1, _05s_SAMPLES do
+        local val = math.floor(math.sin(t) * _MAX_VAL)
+        TONES[7].component[1][i] = val
+        TONES[7].component[2][i] = val
+        TONES[7].component[3][i] = 0
+        TONES[7].component[4][i] = 0
+        t = (t + dt) % _2_PI
+    end
+end
+
+-- 1800Hz @ 4Hz Intermittent
+local function gen_tone_8()
+    local t, dt = 0, _2_PI * 1800 / _DRATE
+
+    local off_at = ms_to_samples(250)
+
+    for i = 1, _05s_SAMPLES do
+        local val = 0
+
+        if i <= off_at then
+            val = math.floor(math.sin(t) * _MAX_VAL)
+            t = (t + dt) % _2_PI
+        end
+
+        TONES[8].component[1][i] = val
+        TONES[8].component[2][i] = val
+        TONES[8].component[3][i] = val
+        TONES[8].component[4][i] = val
+    end
+end
+
+--#endregion
+
+-- hard audio limiter
+---@nodiscard
+---@param output number output level
+---@return number limited -128.0 to 127.0
+local function limit(output)
+    return math.max(-128, math.min(127, output))
+end
+
+-- zero the alarm audio buffer
+local function zero()
+    for i = 1, 4 do
+        for s = 1, _05s_SAMPLES do alarm_ctl.quad_buffer[i][s] = 0 end
+    end
+end
+
+-- add an alarm to the output buffer
+---@param alarm_idx integer tone ID
+local function add(alarm_idx)
+    alarm_ctl.num_active = alarm_ctl.num_active + 1
+    TONES[alarm_idx].active = true
+
+    for i = 1, 4 do
+        for s = 1, _05s_SAMPLES do
+            alarm_ctl.quad_buffer[i][s] = limit(alarm_ctl.quad_buffer[i][s] + TONES[alarm_idx].component[i][s])
+        end
+    end
+end
+
+-- start audio or continue audio on buffer empty
+---@return boolean success successfully added buffer to audio output
+local function play()
+    if not alarm_ctl.playing then
+        alarm_ctl.playing = true
+        alarm_ctl.next_block = 1
+
+        return sounder.continue()
+    else
+        return true
+    end
+end
+
+-- initialize the annunciator alarm system
+---@param speaker table speaker peripheral
+---@param volume number speaker volume
+function sounder.init(speaker, volume)
+    alarm_ctl.speaker = speaker
+    alarm_ctl.speaker.stop()
+
+    alarm_ctl.volume = volume
+    alarm_ctl.playing = false
+    alarm_ctl.num_active = 0
+    alarm_ctl.next_block = 1
+
+    zero()
+
+    -- generate tones
+    gen_tone_1()
+    gen_tone_2()
+    gen_tone_3()
+    gen_tone_4()
+    gen_tone_5()
+    gen_tone_6()
+    gen_tone_7()
+    gen_tone_8()
+end
+
+-- reconnect the speaker peripheral
+---@param speaker table speaker peripheral
+function sounder.reconnect(speaker)
+    alarm_ctl.speaker = speaker
+    alarm_ctl.playing = false
+    alarm_ctl.next_block = 1
+    alarm_ctl.num_active = 0
+    for id = 1, #TONES do TONES[id].active = false end
+end
+
+-- check alarm state to enable/disable alarms
+---@param units table|nil unit list or nil to use test mode
+function sounder.eval(units)
+    local changed = false
+    local any_active = false
+    local new_states = { false, false, false, false, false, false, false, false }
+    local alarms = { false, false, false, false, false, false, false, false, false, false, false, false }
+
+    if units ~= nil then
+        -- check all alarms for all units
+        for i = 1, #units do
+            local unit = units[i]   ---@type ioctl_unit
+            for id = 1, #unit.alarms do
+                alarms[id] = alarms[id] or (unit.alarms[id] == ALARM_STATE.TRIPPED)
+            end
+        end
+    else
+        alarms = test_alarms
+    end
+
+    -- containment breach is worst case CRITICAL alarm, this takes priority
+    if alarms[ALARM.ContainmentBreach] then
+        new_states[T_1800Hz_Int_4Hz] = true
+    else
+        -- critical damage is highest priority CRITICAL level alarm
+        if alarms[ALARM.CriticalDamage] then
+            new_states[T_660Hz_Int_125ms] = true
+        else
+            -- EMERGENCY level alarms + URGENT over temp
+            if alarms[ALARM.ReactorDamage] or alarms[ALARM.ReactorOverTemp] or alarms[ALARM.ReactorWasteLeak] then
+                new_states[T_544Hz_440Hz_Alt] = true
+            -- URGENT level turbine trip
+            elseif alarms[ALARM.TurbineTrip] then
+                new_states[T_745Hz_Int_1Hz] = true
+            -- URGENT level reactor lost
+            elseif alarms[ALARM.ReactorLost] then
+                new_states[T_340Hz_Int_2Hz] = true
+            -- TIMELY level alarms
+            elseif alarms[ALARM.ReactorHighTemp] or alarms[ALARM.ReactorHighWaste] or alarms[ALARM.RCSTransient] then
+                new_states[T_800Hz_Int] = true
+            end
+        end
+
+        -- check RPS transient URGENT level alarm
+        if alarms[ALARM.RPSTransient] then
+            new_states[T_1000Hz_Int] = true
+            -- disable really painful audio combination
+            new_states[T_340Hz_Int_2Hz] = false
+        end
+    end
+
+    -- radiation is a big concern, always play this CRITICAL level alarm if active
+    if alarms[ALARM.ContainmentRadiation] then
+        new_states[T_800Hz_1000Hz_Alt] = true
+        -- we are going to disable the RPS trip alarm audio due to conflict, and if it was enabled
+        -- then we can re-enable the reactor lost alarm audio since it doesn't painfully combine with this one
+        if new_states[T_1000Hz_Int] and alarms[ALARM.ReactorLost] then new_states[T_340Hz_Int_2Hz] = true end
+        -- it sounds *really* bad if this is in conjunction with these other tones, so disable them
+        new_states[T_745Hz_Int_1Hz] = false
+        new_states[T_800Hz_Int] = false
+        new_states[T_1000Hz_Int] = false
+    end
+
+    -- check if any changed, check if any active, update active flags
+    for id = 1, #TONES do
+        if new_states[id] ~= TONES[id].active then
+            TONES[id].active = new_states[id]
+            changed = true
+        end
+
+        if TONES[id].active then any_active = true end
+    end
+
+    -- zero and re-add tones if changed
+    if changed then
+        zero()
+
+        for id = 1, #TONES do
+            if TONES[id].active then add(id) end
+        end
+    end
+
+    if any_active then play() else sounder.stop() end
+end
+
+-- stop all audio and clear output buffer
+function sounder.stop()
+    alarm_ctl.playing = false
+    alarm_ctl.speaker.stop()
+    alarm_ctl.next_block = 1
+    alarm_ctl.num_active = 0
+    for id = 1, #TONES do TONES[id].active = false end
+    zero()
+end
+
+-- continue audio on buffer empty
+---@return boolean success successfully added buffer to audio output
+function sounder.continue()
+    if alarm_ctl.playing then
+        if alarm_ctl.speaker ~= nil and #alarm_ctl.quad_buffer[alarm_ctl.next_block] > 0 then
+            local success = alarm_ctl.speaker.playAudio(alarm_ctl.quad_buffer[alarm_ctl.next_block], alarm_ctl.volume)
+
+            alarm_ctl.next_block = alarm_ctl.next_block + 1
+            if alarm_ctl.next_block > 4 then alarm_ctl.next_block = 1 end
+
+            if not success then
+                log.debug("SOUNDER: error playing audio")
+            end
+
+            return success
+        else
+            return false
+        end
+    else
+        return false
+    end
+end
+
+--#region Test Functions
+
+function sounder.test_1() add(1) play() end -- play tone T_340Hz_Int_2Hz
+function sounder.test_2() add(2) play() end -- play tone T_544Hz_440Hz_Alt
+function sounder.test_3() add(3) play() end -- play tone T_660Hz_Int_125ms
+function sounder.test_4() add(4) play() end -- play tone T_745Hz_Int_1Hz
+function sounder.test_5() add(5) play() end -- play tone T_800Hz_Int
+function sounder.test_6() add(6) play() end -- play tone T_800Hz_1000Hz_Alt
+function sounder.test_7() add(7) play() end -- play tone T_1000Hz_Int
+function sounder.test_8() add(8) play() end -- play tone T_1800Hz_Int_4Hz
+
+function sounder.test_breach(active)    test_alarms[ALARM.ContainmentBreach]    = active end    ---@param active boolean
+function sounder.test_rad(active)       test_alarms[ALARM.ContainmentRadiation] = active end    ---@param active boolean
+function sounder.test_lost(active)      test_alarms[ALARM.ReactorLost]          = active end    ---@param active boolean
+function sounder.test_crit(active)      test_alarms[ALARM.CriticalDamage]       = active end    ---@param active boolean
+function sounder.test_dmg(active)       test_alarms[ALARM.ReactorDamage]        = active end    ---@param active boolean
+function sounder.test_overtemp(active)  test_alarms[ALARM.ReactorOverTemp]      = active end    ---@param active boolean
+function sounder.test_hightemp(active)  test_alarms[ALARM.ReactorHighTemp]      = active end    ---@param active boolean
+function sounder.test_wasteleak(active) test_alarms[ALARM.ReactorWasteLeak]     = active end    ---@param active boolean
+function sounder.test_highwaste(active) test_alarms[ALARM.ReactorHighWaste]     = active end    ---@param active boolean
+function sounder.test_rps(active)       test_alarms[ALARM.RPSTransient]         = active end    ---@param active boolean
+function sounder.test_rcs(active)       test_alarms[ALARM.RCSTransient]         = active end    ---@param active boolean
+function sounder.test_turbinet(active)  test_alarms[ALARM.TurbineTrip]          = active end    ---@param active boolean
+
+-- power rescaling limiter test
+function sounder.test_power_scale()
+    local start = util.time_ms()
+
+    zero()
+
+    for id = 1, #TONES do
+        if TONES[id].active then
+            for i = 1, 4 do
+                for s = 1, _05s_SAMPLES do
+                    alarm_ctl.quad_buffer[i][s] = limit(alarm_ctl.quad_buffer[i][s] +
+                        (TONES[id].component[i][s] / math.sqrt(alarm_ctl.num_active)))
+                end
+            end
+        end
+    end
+
+    log.debug("SOUNDER: power rescale test took " .. (util.time_ms() - start) .. "ms")
+end
+
+--#endregion
+
+return sounder

coordinator/startup.lua

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

coordinator/ui/components/boiler.lua

@@ -0,0 +1,50 @@
+local style          = require("coordinator.ui.style")
+
+local core           = require("graphics.core")
+
+local Rectangle      = require("graphics.elements.rectangle")
+local TextBox        = require("graphics.elements.textbox")
+
+local DataIndicator  = require("graphics.elements.indicators.data")
+local StateIndicator = require("graphics.elements.indicators.state")
+local VerticalBar    = require("graphics.elements.indicators.vbar")
+
+local cpair = core.cpair
+local border = core.border
+
+-- 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 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}
+
+    status.register(ps, "computed_status", status.update)
+    temp.register(ps, "temperature", temp.update)
+    boil_r.register(ps, "boil_rate", boil_r.update)
+
+    TextBox{parent=boiler,text="H",x=2,y=5,height=1,width=1,fg_bg=text_fg_bg}
+    TextBox{parent=boiler,text="W",x=3,y=5,height=1,width=1,fg_bg=text_fg_bg}
+    TextBox{parent=boiler,text="S",x=27,y=5,height=1,width=1,fg_bg=text_fg_bg}
+    TextBox{parent=boiler,text="C",x=28,y=5,height=1,width=1,fg_bg=text_fg_bg}
+
+    local hcool = VerticalBar{parent=boiler,x=2,y=1,fg_bg=cpair(colors.orange,colors.gray),height=4,width=1}
+    local water = VerticalBar{parent=boiler,x=3,y=1,fg_bg=cpair(colors.blue,colors.gray),height=4,width=1}
+    local steam = VerticalBar{parent=boiler,x=27,y=1,fg_bg=cpair(colors.white,colors.gray),height=4,width=1}
+    local ccool = VerticalBar{parent=boiler,x=28,y=1,fg_bg=cpair(colors.lightBlue,colors.gray),height=4,width=1}
+
+    hcool.register(ps, "hcool_fill", hcool.update)
+    water.register(ps, "water_fill", water.update)
+    steam.register(ps, "steam_fill", steam.update)
+    ccool.register(ps, "ccool_fill", ccool.update)
+end
+
+return new_view

coordinator/ui/components/imatrix.lua

@@ -0,0 +1,96 @@
+local util           = require("scada-common.util")
+
+local style          = require("coordinator.ui.style")
+
+local core           = require("graphics.core")
+
+local Div            = require("graphics.elements.div")
+local Rectangle      = require("graphics.elements.rectangle")
+local TextBox        = require("graphics.elements.textbox")
+
+local DataIndicator  = require("graphics.elements.indicators.data")
+local PowerIndicator = require("graphics.elements.indicators.power")
+local StateIndicator = require("graphics.elements.indicators.state")
+local VerticalBar    = require("graphics.elements.indicators.vbar")
+
+local cpair = core.cpair
+local border = core.border
+
+local TEXT_ALIGN = core.TEXT_ALIGN
+
+-- new induction matrix view
+---@param root graphics_element parent
+---@param x integer top left x
+---@param y integer top left y
+---@param data imatrix_session_db matrix data
+---@param ps psil ps interface
+---@param id number? matrix ID
+local function new_view(root, x, y, data, ps, id)
+    local title = "INDUCTION MATRIX"
+    if type(id) == "number" then title = title .. id end
+
+    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)}
+
+    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}
+    local capacity = PowerIndicator{parent=rect,x=7,y=4,lu_colors=lu_col,label="Capacity:",format="%8.2f",value=0,width=26,fg_bg=text_fg_bg}
+    local input    = PowerIndicator{parent=rect,x=7,y=5,lu_colors=lu_col,label="Input:   ",format="%8.2f",rate=true,value=0,width=26,fg_bg=text_fg_bg}
+    local output   = PowerIndicator{parent=rect,x=7,y=6,lu_colors=lu_col,label="Output:  ",format="%8.2f",rate=true,value=0,width=26,fg_bg=text_fg_bg}
+
+    local avg_chg  = PowerIndicator{parent=rect,x=7,y=8,lu_colors=lu_col,label="Avg. Chg:",format="%8.2f",value=0,width=26,fg_bg=text_fg_bg}
+    local avg_in   = PowerIndicator{parent=rect,x=7,y=9,lu_colors=lu_col,label="Avg. In: ",format="%8.2f",rate=true,value=0,width=26,fg_bg=text_fg_bg}
+    local avg_out  = PowerIndicator{parent=rect,x=7,y=10,lu_colors=lu_col,label="Avg. Out:",format="%8.2f",rate=true,value=0,width=26,fg_bg=text_fg_bg}
+
+    status.register(ps, "computed_status", status.update)
+    energy.register(ps, "energy", function (val) energy.update(util.joules_to_fe(val)) end)
+    capacity.register(ps, "max_energy", function (val) capacity.update(util.joules_to_fe(val)) end)
+    input.register(ps, "last_input", function (val) input.update(util.joules_to_fe(val)) end)
+    output.register(ps, "last_output", function (val) output.update(util.joules_to_fe(val)) end)
+
+    avg_chg.register(ps, "avg_charge", avg_chg.update)
+    avg_in.register(ps, "avg_inflow", avg_in.update)
+    avg_out.register(ps, "avg_outflow", avg_out.update)
+
+    local fill      = DataIndicator{parent=rect,x=11,y=12,lu_colors=lu_col,label="Fill:",unit="%",format="%8.2f",value=0,width=18,fg_bg=text_fg_bg}
+
+    local cells     = DataIndicator{parent=rect,x=11,y=14,lu_colors=lu_col,label="Cells:    ",format="%7d",value=0,width=18,fg_bg=text_fg_bg}
+    local providers = DataIndicator{parent=rect,x=11,y=15,lu_colors=lu_col,label="Providers:",format="%7d",value=0,width=18,fg_bg=text_fg_bg}
+
+    TextBox{parent=rect,text="Transfer Capacity",x=11,y=17,height=1,width=17,fg_bg=label_fg_bg}
+    local trans_cap = PowerIndicator{parent=rect,x=19,y=18,lu_colors=lu_col,label="",format="%5.2f",rate=true,value=0,width=12,fg_bg=text_fg_bg}
+
+    cells.register(ps, "cells", cells.update)
+    providers.register(ps, "providers", providers.update)
+    fill.register(ps, "energy_fill", function (val) fill.update(val * 100) end)
+    trans_cap.register(ps, "transfer_cap", function (val) trans_cap.update(util.joules_to_fe(val)) end)
+
+    local charge  = VerticalBar{parent=rect,x=2,y=2,fg_bg=cpair(colors.green,colors.gray),height=17,width=4}
+    local in_cap  = VerticalBar{parent=rect,x=7,y=12,fg_bg=cpair(colors.red,colors.gray),height=7,width=1}
+    local out_cap = VerticalBar{parent=rect,x=9,y=12,fg_bg=cpair(colors.blue,colors.gray),height=7,width=1}
+
+    TextBox{parent=rect,text="FILL",x=2,y=20,height=1,width=4,fg_bg=text_fg_bg}
+    TextBox{parent=rect,text="I/O",x=7,y=20,height=1,width=3,fg_bg=text_fg_bg}
+
+    local function calc_saturation(val)
+        if (type(data.build) == "table") and (type(data.build.transfer_cap) == "number") and (data.build.transfer_cap > 0) then
+            return val / data.build.transfer_cap
+        else
+            return 0
+        end
+    end
+
+    charge.register(ps, "energy_fill", charge.update)
+    in_cap.register(ps, "last_input", function (val) in_cap.update(calc_saturation(val)) end)
+    out_cap.register(ps, "last_output", function (val) out_cap.update(calc_saturation(val)) end)
+end
+
+return new_view

coordinator/ui/components/processctl.lua

@@ -0,0 +1,266 @@
+local tcd               = require("scada-common.tcallbackdsp")
+local util              = require("scada-common.util")
+
+local iocontrol         = require("coordinator.iocontrol")
+local process           = require("coordinator.process")
+
+local style             = require("coordinator.ui.style")
+
+local core              = require("graphics.core")
+
+local Div               = require("graphics.elements.div")
+local Rectangle         = require("graphics.elements.rectangle")
+local TextBox           = require("graphics.elements.textbox")
+
+local DataIndicator     = require("graphics.elements.indicators.data")
+local IndicatorLight    = require("graphics.elements.indicators.light")
+local RadIndicator      = require("graphics.elements.indicators.rad")
+local TriIndicatorLight = require("graphics.elements.indicators.trilight")
+
+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 cpair = core.cpair
+local border = core.border
+
+local period = core.flasher.PERIOD
+
+-- new process control view
+---@param root graphics_element parent
+---@param x integer top left x
+---@param y integer top left y
+local function new_view(root, x, y)
+    assert(root.height() >= (y + 24), "main display not of sufficient vertical resolution (add an additional row of monitors)")
+
+    local facility = iocontrol.get_db().facility
+    local units = iocontrol.get_db().units
+
+    local bw_fg_bg   = cpair(colors.black, colors.white)
+    local hzd_fg_bg  = cpair(colors.white, colors.gray)
+    local lu_cpair   = cpair(colors.gray, colors.gray)
+    local dis_colors = cpair(colors.white, colors.lightGray)
+
+    local main = Div{parent=root,width=104,height=24,x=x,y=y}
+
+    local scram = HazardButton{parent=main,x=1,y=1,text="FAC SCRAM",accent=colors.yellow,dis_colors=dis_colors,callback=process.fac_scram,fg_bg=hzd_fg_bg}
+    local ack_a = HazardButton{parent=main,x=16,y=1,text="ACK \x13",accent=colors.orange,dis_colors=dis_colors,callback=process.fac_ack_alarms,fg_bg=hzd_fg_bg}
+
+    facility.scram_ack = scram.on_response
+    facility.ack_alarms_ack = ack_a.on_response
+
+    local all_ok  = IndicatorLight{parent=main,y=5,label="Unit Systems Online",colors=cpair(colors.green,colors.red)}
+    local ind_mat = IndicatorLight{parent=main,label="Induction Matrix",colors=cpair(colors.green,colors.gray)}
+    local rad_mon = TriIndicatorLight{parent=main,label="Radiation Monitor",c1=colors.gray,c2=colors.yellow,c3=colors.green}
+
+    all_ok.register(facility.ps, "all_sys_ok", all_ok.update)
+    ind_mat.register(facility.induction_ps_tbl[1], "computed_status", function (status) ind_mat.update(status > 1) end)
+    rad_mon.register(facility.ps, "rad_computed_status", rad_mon.update)
+
+    main.line_break()
+
+    local auto_ready = IndicatorLight{parent=main,label="Configured Units Ready",colors=cpair(colors.green,colors.red)}
+    local auto_act   = IndicatorLight{parent=main,label="Process Active",colors=cpair(colors.green,colors.gray)}
+    local auto_ramp  = IndicatorLight{parent=main,label="Process Ramping",colors=cpair(colors.white,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local auto_sat   = IndicatorLight{parent=main,label="Min/Max Burn Rate",colors=cpair(colors.yellow,colors.gray)}
+
+    auto_ready.register(facility.ps, "auto_ready", auto_ready.update)
+    auto_act.register(facility.ps, "auto_active", auto_act.update)
+    auto_ramp.register(facility.ps, "auto_ramping", auto_ramp.update)
+    auto_sat.register(facility.ps, "auto_saturated", auto_sat.update)
+
+    main.line_break()
+
+    local auto_scram  = IndicatorLight{parent=main,label="Automatic SCRAM",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local matrix_dc   = IndicatorLight{parent=main,label="Matrix Disconnected",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_500_MS}
+    local matrix_fill = IndicatorLight{parent=main,label="Matrix Charge High",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_500_MS}
+    local unit_crit   = IndicatorLight{parent=main,label="Unit Critical Alarm",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local fac_rad_h   = IndicatorLight{parent=main,label="Facility Radiation High",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local gen_fault   = IndicatorLight{parent=main,label="Gen. Control Fault",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_500_MS}
+
+    auto_scram.register(facility.ps, "auto_scram", auto_scram.update)
+    matrix_dc.register(facility.ps, "as_matrix_dc", matrix_dc.update)
+    matrix_fill.register(facility.ps, "as_matrix_fill", matrix_fill.update)
+    unit_crit.register(facility.ps, "as_crit_alarm", unit_crit.update)
+    fac_rad_h.register(facility.ps, "as_radiation", fac_rad_h.update)
+    gen_fault.register(facility.ps, "as_gen_fault", gen_fault.update)
+
+    TextBox{parent=main,y=23,text="Radiation",height=1,width=13,fg_bg=style.label}
+    local radiation = RadIndicator{parent=main,label="",format="%9.3f",lu_colors=lu_cpair,width=13,fg_bg=bw_fg_bg}
+    radiation.register(facility.ps, "radiation", radiation.update)
+
+    TextBox{parent=main,x=15,y=23,text="Linked RTUs",height=1,width=11,fg_bg=style.label}
+    local rtu_count = DataIndicator{parent=main,x=15,y=24,label="",format="%11d",value=0,lu_colors=lu_cpair,width=11,fg_bg=bw_fg_bg}
+    rtu_count.register(facility.ps, "rtu_count", rtu_count.update)
+
+    ---------------------
+    -- process control --
+    ---------------------
+
+    local proc = Div{parent=main,width=78,height=24,x=27,y=1}
+
+    -----------------------------
+    -- process control targets --
+    -----------------------------
+
+    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)}
+    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}
+    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)}
+
+    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)}
+    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}
+    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)}
+
+    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)}
+    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}
+    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)}
+
+    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)
+
+    -----------------
+    -- unit limits --
+    -----------------
+
+    local limit_div = Div{parent=proc,width=21,height=19,x=34,y=6}
+
+    local rate_limits = {}
+
+    for i = 1, facility.num_units do
+        local unit = units[i]   ---@type ioctl_unit
+
+        local _y = ((i - 1) * 5) + 1
+
+        local unit_tag = Div{parent=limit_div,x=1,y=_y,width=8,height=4,fg_bg=cpair(colors.black,colors.lightBlue)}
+        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(colors.gray,colors.white)}
+        rate_limits[i] = 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=bw_fg_bg}
+        TextBox{parent=lim_ctl,x=9,y=2,text="mB/t",width=4,height=1}
+
+        rate_limits[i].register(unit.unit_ps, "max_burn", rate_limits[i].set_max)
+        rate_limits[i].register(unit.unit_ps, "burn_limit", rate_limits[i].set_value)
+
+        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(colors.black,colors.black),width=14,fg_bg=cpair(colors.black,colors.brown)}
+
+        cur_burn.register(unit.unit_ps, "act_burn_rate", cur_burn.update)
+    end
+
+    -------------------
+    -- unit statuses --
+    -------------------
+
+    local stat_div = Div{parent=proc,width=38,height=19,x=57,y=6}
+
+    for i = 1, facility.num_units do
+        local unit = units[i]   ---@type ioctl_unit
+
+        local _y = ((i - 1) * 5) + 1
+
+        local unit_tag = Div{parent=stat_div,x=1,y=_y,width=8,height=4,fg_bg=cpair(colors.black,colors.lightBlue)}
+        TextBox{parent=unit_tag,x=2,y=2,text="Unit "..i.." Status",width=7,height=2}
+
+        local lights   = Div{parent=stat_div,x=9,y=_y,width=12,height=4,fg_bg=bw_fg_bg}
+        local ready    = IndicatorLight{parent=lights,x=2,y=2,label="Ready",colors=cpair(colors.green,colors.gray)}
+        local degraded = IndicatorLight{parent=lights,x=2,y=3,label="Degraded",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+
+        ready.register(unit.unit_ps, "U_AutoReady", ready.update)
+        degraded.register(unit.unit_ps, "U_AutoDegraded", degraded.update)
+    end
+
+    -------------------------
+    -- controls and status --
+    -------------------------
+
+    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.purple,colors.black),radio_bg=colors.gray}
+
+    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)}
+
+    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)}
+
+    -- save the automatic process control configuration without starting
+    local function _save_cfg()
+        local limits = {}
+        for i = 1, #rate_limits do limits[i] = rate_limits[i].get_value() end
+
+        process.save(mode.get_value(), b_target.get_value(), c_target.get_value(), g_target.get_value(), limits)
+    end
+
+    -- start automatic control after saving process control settings
+    local function _start_auto()
+        _save_cfg()
+        process.start_auto()
+    end
+
+    local save  = HazardButton{parent=auto_controls,x=2,y=2,text="SAVE",accent=colors.purple,dis_colors=dis_colors,callback=_save_cfg,fg_bg=hzd_fg_bg}
+    local start = HazardButton{parent=auto_controls,x=13,y=2,text="START",accent=colors.lightBlue,dis_colors=dis_colors,callback=_start_auto,fg_bg=hzd_fg_bg}
+    local stop  = HazardButton{parent=auto_controls,x=23,y=2,text="STOP",accent=colors.red,dis_colors=dis_colors,callback=process.stop_auto,fg_bg=hzd_fg_bg}
+
+    facility.start_ack = start.on_response
+    facility.stop_ack = stop.on_response
+
+    function facility.save_cfg_ack(ack)
+        tcd.dispatch(0.2, function () save.on_response(ack) end)
+    end
+
+    start.register(facility.ps, "auto_ready", function (ready)
+        if ready and (not facility.auto_active) then start.enable() else start.disable() end
+    end)
+
+    -- REGISTER_NOTE: for optimization/brevity, due to not deleting anything but the whole element tree when it comes
+    -- to the process control display and coordinator GUI as a whole, child elements will not directly be registered here
+    -- (preventing garbage collection until the parent 'proc' is deleted)
+    proc.register(facility.ps, "auto_active", function (active)
+        if active then
+            b_target.disable()
+            c_target.disable()
+            g_target.disable()
+
+            mode.disable()
+            start.disable()
+
+            for i = 1, #rate_limits do rate_limits[i].disable() end
+        else
+            b_target.enable()
+            c_target.enable()
+            g_target.enable()
+
+            mode.enable()
+            if facility.auto_ready then start.enable() end
+
+            for i = 1, #rate_limits do rate_limits[i].enable() end
+        end
+    end)
+end
+
+return new_view

coordinator/ui/components/reactor.lua

@@ -0,0 +1,72 @@
+local types          = require("scada-common.types")
+
+local style          = require("coordinator.ui.style")
+
+local core           = require("graphics.core")
+
+local Rectangle      = require("graphics.elements.rectangle")
+local TextBox        = require("graphics.elements.textbox")
+
+local DataIndicator  = require("graphics.elements.indicators.data")
+local HorizontalBar  = require("graphics.elements.indicators.hbar")
+local StateIndicator = require("graphics.elements.indicators.state")
+
+local cpair = core.cpair
+local border = core.border
+
+-- create new reactor 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 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}
+    local heating_r = DataIndicator{parent=reactor,x=2,y=5,lu_colors=lu_col,label="Heating:",unit="mB/t",format="%12.0f",value=0,commas=true,width=26,fg_bg=text_fg_bg}
+
+    status.register(ps, "computed_status", status.update)
+    core_temp.register(ps, "temp", core_temp.update)
+    burn_r.register(ps, "act_burn_rate", burn_r.update)
+    heating_r.register(ps, "heating_rate", heating_r.update)
+
+    local reactor_fills = Rectangle{parent=root,border=border(1, colors.gray, true),width=24,height=7,x=(x + 29),y=y}
+
+    TextBox{parent=reactor_fills,text="FUEL",x=2,y=1,height=1,fg_bg=text_fg_bg}
+    TextBox{parent=reactor_fills,text="COOL",x=2,y=2,height=1,fg_bg=text_fg_bg}
+    TextBox{parent=reactor_fills,text="HCOOL",x=2,y=4,height=1,fg_bg=text_fg_bg}
+    TextBox{parent=reactor_fills,text="WASTE",x=2,y=5,height=1,fg_bg=text_fg_bg}
+
+    local fuel  = HorizontalBar{parent=reactor_fills,x=8,y=1,show_percent=true,bar_fg_bg=cpair(colors.black,colors.gray),height=1,width=14}
+    local ccool = HorizontalBar{parent=reactor_fills,x=8,y=2,show_percent=true,bar_fg_bg=cpair(colors.blue,colors.gray),height=1,width=14}
+    local hcool = HorizontalBar{parent=reactor_fills,x=8,y=4,show_percent=true,bar_fg_bg=cpair(colors.white,colors.gray),height=1,width=14}
+    local waste = HorizontalBar{parent=reactor_fills,x=8,y=5,show_percent=true,bar_fg_bg=cpair(colors.brown,colors.gray),height=1,width=14}
+
+    ccool.register(ps, "ccool_type", function (type)
+        if type == types.FLUID.SODIUM then
+            ccool.recolor(cpair(colors.lightBlue, colors.gray))
+        else
+            ccool.recolor(cpair(colors.blue, colors.gray))
+        end
+    end)
+
+    hcool.register(ps, "hcool_type", function (type)
+        if type == types.FLUID.SUPERHEATED_SODIUM then
+            hcool.recolor(cpair(colors.orange, colors.gray))
+        else
+            hcool.recolor(cpair(colors.white, colors.gray))
+        end
+    end)
+
+    fuel.register(ps, "fuel_fill", fuel.update)
+    ccool.register(ps, "ccool_fill", ccool.update)
+    hcool.register(ps, "hcool_fill", hcool.update)
+    waste.register(ps, "waste_fill", waste.update)
+end
+
+return new_view

coordinator/ui/components/turbine.lua

@@ -0,0 +1,47 @@
+local util           = require("scada-common.util")
+
+local style          = require("coordinator.ui.style")
+
+local core           = require("graphics.core")
+
+local Rectangle      = require("graphics.elements.rectangle")
+local TextBox        = require("graphics.elements.textbox")
+
+local DataIndicator  = require("graphics.elements.indicators.data")
+local PowerIndicator = require("graphics.elements.indicators.power")
+local StateIndicator = require("graphics.elements.indicators.state")
+local VerticalBar    = require("graphics.elements.indicators.vbar")
+
+local cpair = core.cpair
+local border = core.border
+
+-- 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 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}
+    local flow_rate = DataIndicator{parent=turbine,x=5,y=4,lu_colors=lu_col,label="",unit="mB/t",format="%10.0f",value=0,commas=true,width=16,fg_bg=text_fg_bg}
+
+    status.register(ps, "computed_status", status.update)
+    prod_rate.register(ps, "prod_rate", function (val) prod_rate.update(util.joules_to_fe(val)) end)
+    flow_rate.register(ps, "flow_rate", flow_rate.update)
+
+    local steam  = VerticalBar{parent=turbine,x=2,y=1,fg_bg=cpair(colors.white,colors.gray),height=4,width=1}
+    local energy = VerticalBar{parent=turbine,x=3,y=1,fg_bg=cpair(colors.green,colors.gray),height=4,width=1}
+
+    TextBox{parent=turbine,text="S",x=2,y=5,height=1,width=1,fg_bg=text_fg_bg}
+    TextBox{parent=turbine,text="E",x=3,y=5,height=1,width=1,fg_bg=text_fg_bg}
+
+    steam.register(ps, "steam_fill", steam.update)
+    energy.register(ps, "energy_fill", energy.update)
+end
+
+return new_view

coordinator/ui/components/unit_detail.lua

@@ -0,0 +1,540 @@
+--
+-- Reactor Unit SCADA Coordinator GUI
+--
+
+local iocontrol         = require("coordinator.iocontrol")
+
+local style             = require("coordinator.ui.style")
+
+local core              = require("graphics.core")
+
+local Div               = require("graphics.elements.div")
+local Rectangle         = require("graphics.elements.rectangle")
+local TextBox           = require("graphics.elements.textbox")
+
+local AlarmLight        = require("graphics.elements.indicators.alight")
+local CoreMap           = require("graphics.elements.indicators.coremap")
+local DataIndicator     = require("graphics.elements.indicators.data")
+local IndicatorLight    = require("graphics.elements.indicators.light")
+local RadIndicator      = require("graphics.elements.indicators.rad")
+local TriIndicatorLight = require("graphics.elements.indicators.trilight")
+local VerticalBar       = require("graphics.elements.indicators.vbar")
+
+local HazardButton      = require("graphics.elements.controls.hazard_button")
+local MultiButton       = require("graphics.elements.controls.multi_button")
+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 cpair = core.cpair
+local border = core.border
+
+local period = core.flasher.PERIOD
+
+local waste_opts = {
+    {
+        text = "Auto",
+        fg_bg = cpair(colors.black, colors.lightGray),
+        active_fg_bg = cpair(colors.white, colors.gray)
+    },
+    {
+        text = "Pu",
+        fg_bg = cpair(colors.black, colors.lightGray),
+        active_fg_bg = cpair(colors.black, colors.green)
+    },
+    {
+        text = "Po",
+        fg_bg = cpair(colors.black, colors.lightGray),
+        active_fg_bg = cpair(colors.black, colors.cyan)
+    },
+    {
+        text = "AM",
+        fg_bg = cpair(colors.black, colors.lightGray),
+        active_fg_bg = cpair(colors.black, colors.purple)
+    }
+}
+
+-- create a unit view
+---@param parent graphics_element parent
+---@param id integer
+local function init(parent, id)
+    local unit = iocontrol.get_db().units[id]   ---@type ioctl_unit
+    local f_ps = iocontrol.get_db().facility.ps
+    local u_ps = unit.unit_ps
+    local b_ps = unit.boiler_ps_tbl
+    local t_ps = unit.turbine_ps_tbl
+
+    local main = Div{parent=parent,x=1,y=1}
+
+    TextBox{parent=main,text="Reactor Unit #" .. id,alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
+
+    local bw_fg_bg  = cpair(colors.black, colors.white)
+    local hzd_fg_bg = cpair(colors.white, colors.gray)
+    local lu_cpair  = cpair(colors.gray, colors.gray)
+
+    -----------------------------
+    -- main stats and core map --
+    -----------------------------
+
+    local core_map = CoreMap{parent=main,x=2,y=3,reactor_l=18,reactor_w=18}
+    core_map.register(u_ps, "temp", core_map.update)
+    core_map.register(u_ps, "size", function (s) core_map.resize(s[1], s[2]) end)
+
+    TextBox{parent=main,x=12,y=22,text="Heating Rate",height=1,width=12,fg_bg=style.label}
+    local heating_r = DataIndicator{parent=main,x=12,label="",format="%14.0f",value=0,unit="mB/t",commas=true,lu_colors=lu_cpair,width=19,fg_bg=bw_fg_bg}
+    heating_r.register(u_ps, "heating_rate", heating_r.update)
+
+    TextBox{parent=main,x=12,y=25,text="Commanded Burn Rate",height=1,width=19,fg_bg=style.label}
+    local burn_r = DataIndicator{parent=main,x=12,label="",format="%14.2f",value=0,unit="mB/t",lu_colors=lu_cpair,width=19,fg_bg=bw_fg_bg}
+    burn_r.register(u_ps, "burn_rate", burn_r.update)
+
+    TextBox{parent=main,text="F",x=2,y=22,width=1,height=1,fg_bg=style.label}
+    TextBox{parent=main,text="C",x=4,y=22,width=1,height=1,fg_bg=style.label}
+    TextBox{parent=main,text="\x1a",x=6,y=24,width=1,height=1,fg_bg=style.label}
+    TextBox{parent=main,text="\x1a",x=6,y=25,width=1,height=1,fg_bg=style.label}
+    TextBox{parent=main,text="H",x=8,y=22,width=1,height=1,fg_bg=style.label}
+    TextBox{parent=main,text="W",x=10,y=22,width=1,height=1,fg_bg=style.label}
+
+    local fuel  = VerticalBar{parent=main,x=2,y=23,fg_bg=cpair(colors.black,colors.gray),height=4,width=1}
+    local ccool = VerticalBar{parent=main,x=4,y=23,fg_bg=cpair(colors.blue,colors.gray),height=4,width=1}
+    local hcool = VerticalBar{parent=main,x=8,y=23,fg_bg=cpair(colors.white,colors.gray),height=4,width=1}
+    local waste = VerticalBar{parent=main,x=10,y=23,fg_bg=cpair(colors.brown,colors.gray),height=4,width=1}
+
+    fuel.register(u_ps, "fuel_fill", fuel.update)
+    ccool.register(u_ps, "ccool_fill", ccool.update)
+    hcool.register(u_ps, "hcool_fill", hcool.update)
+    waste.register(u_ps, "waste_fill", waste.update)
+
+    ccool.register(u_ps, "ccool_type", function (type)
+        if type == "mekanism:sodium" then
+            ccool.recolor(cpair(colors.lightBlue, colors.gray))
+        else
+            ccool.recolor(cpair(colors.blue, colors.gray))
+        end
+    end)
+
+    hcool.register(u_ps, "hcool_type", function (type)
+        if type == "mekanism:superheated_sodium" then
+            hcool.recolor(cpair(colors.orange, colors.gray))
+        else
+            hcool.recolor(cpair(colors.white, colors.gray))
+        end
+    end)
+
+    TextBox{parent=main,x=32,y=22,text="Core Temp",height=1,width=9,fg_bg=style.label}
+    local core_temp = DataIndicator{parent=main,x=32,label="",format="%11.2f",value=0,unit="K",lu_colors=lu_cpair,width=13,fg_bg=bw_fg_bg}
+    core_temp.register(u_ps, "temp", core_temp.update)
+
+    TextBox{parent=main,x=32,y=25,text="Burn Rate",height=1,width=9,fg_bg=style.label}
+    local act_burn_r = DataIndicator{parent=main,x=32,label="",format="%8.2f",value=0,unit="mB/t",lu_colors=lu_cpair,width=13,fg_bg=bw_fg_bg}
+    act_burn_r.register(u_ps, "act_burn_rate", act_burn_r.update)
+
+    TextBox{parent=main,x=32,y=28,text="Damage",height=1,width=6,fg_bg=style.label}
+    local damage_p = DataIndicator{parent=main,x=32,label="",format="%11.0f",value=0,unit="%",lu_colors=lu_cpair,width=13,fg_bg=bw_fg_bg}
+    damage_p.register(u_ps, "damage", damage_p.update)
+
+    TextBox{parent=main,x=32,y=31,text="Radiation",height=1,width=21,fg_bg=style.label}
+    local radiation = RadIndicator{parent=main,x=32,label="",format="%9.3f",lu_colors=lu_cpair,width=13,fg_bg=bw_fg_bg}
+    radiation.register(u_ps, "radiation", radiation.update)
+
+    -------------------
+    -- system status --
+    -------------------
+
+    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)}
+
+    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)
+
+    -----------------
+    -- annunciator --
+    -----------------
+
+    -- annunciator colors (generally) per IAEA-TECDOC-812 recommendations
+
+    local annunciator = Div{parent=main,width=23,height=18,x=22,y=3}
+
+    -- connectivity
+    local plc_online = IndicatorLight{parent=annunciator,label="PLC Online",colors=cpair(colors.green,colors.red)}
+    local plc_hbeat  = IndicatorLight{parent=annunciator,label="PLC Heartbeat",colors=cpair(colors.white,colors.gray)}
+    local rad_mon    = TriIndicatorLight{parent=annunciator,label="Radiation Monitor",c1=colors.gray,c2=colors.yellow,c3=colors.green}
+
+    plc_online.register(u_ps, "PLCOnline", plc_online.update)
+    plc_hbeat.register(u_ps, "PLCHeartbeat", plc_hbeat.update)
+    rad_mon.register(u_ps, "RadiationMonitor", rad_mon.update)
+
+    annunciator.line_break()
+
+    -- operating state
+    local r_active = IndicatorLight{parent=annunciator,label="Active",colors=cpair(colors.green,colors.gray)}
+    local r_auto   = IndicatorLight{parent=annunciator,label="Automatic Control",colors=cpair(colors.white,colors.gray)}
+
+    r_active.register(u_ps, "status", r_active.update)
+    r_auto.register(u_ps, "AutoControl", r_auto.update)
+
+    -- main unit transient/warning annunciator panel
+    local r_scram = IndicatorLight{parent=annunciator,label="Reactor SCRAM",colors=cpair(colors.red,colors.gray)}
+    local r_mscrm = IndicatorLight{parent=annunciator,label="Manual Reactor SCRAM",colors=cpair(colors.red,colors.gray)}
+    local r_ascrm = IndicatorLight{parent=annunciator,label="Auto Reactor SCRAM",colors=cpair(colors.red,colors.gray)}
+    local rad_wrn = IndicatorLight{parent=annunciator,label="Radiation Warning",colors=cpair(colors.yellow,colors.gray)}
+    local r_rtrip = IndicatorLight{parent=annunciator,label="RCP Trip",colors=cpair(colors.red,colors.gray)}
+    local r_cflow = IndicatorLight{parent=annunciator,label="RCS Flow Low",colors=cpair(colors.yellow,colors.gray)}
+    local r_clow  = IndicatorLight{parent=annunciator,label="Coolant  Level Low",colors=cpair(colors.yellow,colors.gray)}
+    local r_temp  = IndicatorLight{parent=annunciator,label="Reactor Temp. High",colors=cpair(colors.red,colors.gray)}
+    local r_rhdt  = IndicatorLight{parent=annunciator,label="Reactor High Delta T",colors=cpair(colors.yellow,colors.gray)}
+    local r_firl  = IndicatorLight{parent=annunciator,label="Fuel Input Rate Low",colors=cpair(colors.yellow,colors.gray)}
+    local r_wloc  = IndicatorLight{parent=annunciator,label="Waste Line Occlusion",colors=cpair(colors.yellow,colors.gray)}
+    local r_hsrt  = IndicatorLight{parent=annunciator,label="Startup Rate High",colors=cpair(colors.yellow,colors.gray)}
+
+    r_scram.register(u_ps, "ReactorSCRAM", r_scram.update)
+    r_mscrm.register(u_ps, "ManualReactorSCRAM", r_mscrm.update)
+    r_ascrm.register(u_ps, "AutoReactorSCRAM", r_ascrm.update)
+    rad_wrn.register(u_ps, "RadiationWarning", rad_wrn.update)
+    r_rtrip.register(u_ps, "RCPTrip", r_rtrip.update)
+    r_cflow.register(u_ps, "RCSFlowLow", r_cflow.update)
+    r_clow.register(u_ps, "CoolantLevelLow", r_clow.update)
+    r_temp.register(u_ps, "ReactorTempHigh", r_temp.update)
+    r_rhdt.register(u_ps, "ReactorHighDeltaT", r_rhdt.update)
+    r_firl.register(u_ps, "FuelInputRateLow", r_firl.update)
+    r_wloc.register(u_ps, "WasteLineOcclusion", r_wloc.update)
+    r_hsrt.register(u_ps, "HighStartupRate", r_hsrt.update)
+
+    -- 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}
+    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}
+
+    local rps_trp = IndicatorLight{parent=rps_annunc,label="RPS Trip",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local rps_dmg = IndicatorLight{parent=rps_annunc,label="Damage Level High",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local rps_exh = IndicatorLight{parent=rps_annunc,label="Excess Heated Coolant",colors=cpair(colors.yellow,colors.gray)}
+    local rps_exw = IndicatorLight{parent=rps_annunc,label="Excess Waste",colors=cpair(colors.yellow,colors.gray)}
+    local rps_tmp = IndicatorLight{parent=rps_annunc,label="Core Temperature High",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    local rps_nof = IndicatorLight{parent=rps_annunc,label="No Fuel",colors=cpair(colors.yellow,colors.gray)}
+    local rps_loc = IndicatorLight{parent=rps_annunc,label="Coolant Level Low Low",colors=cpair(colors.yellow,colors.gray)}
+    local rps_flt = IndicatorLight{parent=rps_annunc,label="PPM Fault",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_500_MS}
+    local rps_tmo = IndicatorLight{parent=rps_annunc,label="Connection Timeout",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_500_MS}
+    local rps_sfl = IndicatorLight{parent=rps_annunc,label="System Failure",colors=cpair(colors.orange,colors.gray),flash=true,period=period.BLINK_500_MS}
+
+    rps_trp.register(u_ps, "rps_tripped", rps_trp.update)
+    rps_dmg.register(u_ps, "high_dmg", rps_dmg.update)
+    rps_exh.register(u_ps, "ex_hcool", rps_exh.update)
+    rps_exw.register(u_ps, "ex_waste", rps_exw.update)
+    rps_tmp.register(u_ps, "high_temp", rps_tmp.update)
+    rps_nof.register(u_ps, "no_fuel", rps_nof.update)
+    rps_loc.register(u_ps, "low_cool", rps_loc.update)
+    rps_flt.register(u_ps, "fault", rps_flt.update)
+    rps_tmo.register(u_ps, "timeout", rps_tmo.update)
+    rps_sfl.register(u_ps, "sys_fail", rps_sfl.update)
+
+    -- 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}
+    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}
+
+    local c_flt  = IndicatorLight{parent=rcs_annunc,label="RCS Hardware Fault",colors=cpair(colors.yellow,colors.gray)}
+    local c_emg  = TriIndicatorLight{parent=rcs_annunc,label="Emergency Coolant",c1=colors.gray,c2=colors.white,c3=colors.green}
+    local c_cfm  = IndicatorLight{parent=rcs_annunc,label="Coolant Feed Mismatch",colors=cpair(colors.yellow,colors.gray)}
+    local c_brm  = IndicatorLight{parent=rcs_annunc,label="Boil Rate Mismatch",colors=cpair(colors.yellow,colors.gray)}
+    local c_sfm  = IndicatorLight{parent=rcs_annunc,label="Steam Feed Mismatch",colors=cpair(colors.yellow,colors.gray)}
+    local c_mwrf = IndicatorLight{parent=rcs_annunc,label="Max Water Return Feed",colors=cpair(colors.yellow,colors.gray)}
+
+    c_flt.register(u_ps, "RCSFault", c_flt.update)
+    c_emg.register(u_ps, "EmergencyCoolant", c_emg.update)
+    c_cfm.register(u_ps, "CoolantFeedMismatch", c_cfm.update)
+    c_brm.register(u_ps, "BoilRateMismatch", c_brm.update)
+    c_sfm.register(u_ps, "SteamFeedMismatch", c_sfm.update)
+    c_mwrf.register(u_ps, "MaxWaterReturnFeed", c_mwrf.update)
+
+    local available_space = 16 - (unit.num_boilers * 2 + unit.num_turbines * 4)
+
+    local function _add_space()
+        -- if we have some extra space, add padding
+        rcs_tags.line_break()
+        rcs_annunc.line_break()
+    end
+
+    -- boiler annunciator panel(s)
+
+    if available_space > 0 then _add_space() end
+
+    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=cpair(colors.red,colors.gray)}
+        b1_wll.register(b_ps[1], "WasterLevelLow", 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=cpair(colors.yellow,colors.gray)}
+        b1_hr.register(b_ps[1], "HeatingRateLow", b1_hr.update)
+    end
+    if unit.num_boilers > 1 then
+        -- note, can't (shouldn't for sure...) have 0 turbines
+        if (available_space > 2 and unit.num_turbines == 1) or
+           (available_space > 3 and unit.num_turbines == 2) or
+           (available_space > 4) then
+            _add_space()
+        end
+
+        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=cpair(colors.red,colors.gray)}
+        b2_wll.register(b_ps[2], "WasterLevelLow", 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=cpair(colors.yellow,colors.gray)}
+        b2_hr.register(b_ps[2], "HeatingRateLow", b2_hr.update)
+    end
+
+    -- turbine annunciator panels
+
+    if available_space > 1 then _add_space() end
+
+    TextBox{parent=rcs_tags,text="T1",width=2,height=1,fg_bg=bw_fg_bg}
+    local t1_sdo = TriIndicatorLight{parent=rcs_annunc,label="Steam Relief Valve Open",c1=colors.gray,c2=colors.yellow,c3=colors.red}
+    t1_sdo.register(t_ps[1], "SteamDumpOpen", t1_sdo.update)
+
+    TextBox{parent=rcs_tags,text="T1",width=2,height=1,fg_bg=bw_fg_bg}
+    local t1_tos = IndicatorLight{parent=rcs_annunc,label="Turbine Over Speed",colors=cpair(colors.red,colors.gray)}
+    t1_tos.register(t_ps[1], "TurbineOverSpeed", t1_tos.update)
+
+    TextBox{parent=rcs_tags,text="T1",width=2,height=1,fg_bg=bw_fg_bg}
+    local t1_gtrp = IndicatorLight{parent=rcs_annunc,label="Generator Trip",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_250_MS}
+    t1_gtrp.register(t_ps[1], "GeneratorTrip", t1_gtrp.update)
+
+    TextBox{parent=rcs_tags,text="T1",width=2,height=1,fg_bg=bw_fg_bg}
+    local t1_trp = IndicatorLight{parent=rcs_annunc,label="Turbine Trip",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+    t1_trp.register(t_ps[1], "TurbineTrip", t1_trp.update)
+
+    if unit.num_turbines > 1 then
+        if (available_space > 2 and unit.num_turbines == 2) or available_space > 3 then
+            _add_space()
+        end
+
+        TextBox{parent=rcs_tags,text="T2",width=2,height=1,fg_bg=bw_fg_bg}
+        local t2_sdo = TriIndicatorLight{parent=rcs_annunc,label="Steam Relief Valve Open",c1=colors.gray,c2=colors.yellow,c3=colors.red}
+        t2_sdo.register(t_ps[2], "SteamDumpOpen", t2_sdo.update)
+
+        TextBox{parent=rcs_tags,text="T2",width=2,height=1,fg_bg=bw_fg_bg}
+        local t2_tos = IndicatorLight{parent=rcs_annunc,label="Turbine Over Speed",colors=cpair(colors.red,colors.gray)}
+        t2_tos.register(t_ps[2], "TurbineOverSpeed", t2_tos.update)
+
+        TextBox{parent=rcs_tags,text="T2",width=2,height=1,fg_bg=bw_fg_bg}
+        local t2_gtrp = IndicatorLight{parent=rcs_annunc,label="Generator Trip",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_250_MS}
+        t2_gtrp.register(t_ps[2], "GeneratorTrip", t2_gtrp.update)
+
+        TextBox{parent=rcs_tags,text="T2",width=2,height=1,fg_bg=bw_fg_bg}
+        local t2_trp = IndicatorLight{parent=rcs_annunc,label="Turbine Trip",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+        t2_trp.register(t_ps[2], "TurbineTrip", t2_trp.update)
+    end
+
+    if unit.num_turbines > 2 then
+        if available_space > 3 then _add_space() end
+
+        TextBox{parent=rcs_tags,text="T3",width=2,height=1,fg_bg=bw_fg_bg}
+        local t3_sdo = TriIndicatorLight{parent=rcs_annunc,label="Steam Relief Valve Open",c1=colors.gray,c2=colors.yellow,c3=colors.red}
+        t3_sdo.register(t_ps[3], "SteamDumpOpen", t3_sdo.update)
+
+        TextBox{parent=rcs_tags,text="T3",width=2,height=1,fg_bg=bw_fg_bg}
+        local t3_tos = IndicatorLight{parent=rcs_annunc,label="Turbine Over Speed",colors=cpair(colors.red,colors.gray)}
+        t3_tos.register(t_ps[3], "TurbineOverSpeed", t3_tos.update)
+
+        TextBox{parent=rcs_tags,text="T3",width=2,height=1,fg_bg=bw_fg_bg}
+        local t3_gtrp = IndicatorLight{parent=rcs_annunc,label="Generator Trip",colors=cpair(colors.yellow,colors.gray),flash=true,period=period.BLINK_250_MS}
+        t3_gtrp.register(t_ps[3], "GeneratorTrip", t3_gtrp.update)
+
+        TextBox{parent=rcs_tags,text="T3",width=2,height=1,fg_bg=bw_fg_bg}
+        local t3_trp = IndicatorLight{parent=rcs_annunc,label="Turbine Trip",colors=cpair(colors.red,colors.gray),flash=true,period=period.BLINK_250_MS}
+        t3_trp.register(t_ps[3], "TurbineTrip", t3_trp.update)
+    end
+
+    ----------------------
+    -- 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}
+    TextBox{parent=burn_control,x=9,y=2,text="mB/t"}
+
+    local set_burn = function () unit.set_burn(burn_rate.get_value()) end
+    local set_burn_btn = PushButton{parent=burn_control,x=14,y=2,text="SET",min_width=5,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=cpair(colors.white,colors.gray),dis_fg_bg=dis_colors,callback=set_burn}
+
+    burn_rate.register(u_ps, "burn_rate", burn_rate.set_value)
+    burn_rate.register(u_ps, "max_burn", burn_rate.set_max)
+
+    local start = HazardButton{parent=main,x=2,y=28,text="START",accent=colors.lightBlue,dis_colors=dis_colors,callback=unit.start,fg_bg=hzd_fg_bg}
+    local ack_a = HazardButton{parent=main,x=12,y=32,text="ACK \x13",accent=colors.orange,dis_colors=dis_colors,callback=unit.ack_alarms,fg_bg=hzd_fg_bg}
+    local scram = HazardButton{parent=main,x=2,y=32,text="SCRAM",accent=colors.yellow,dis_colors=dis_colors,callback=unit.scram,fg_bg=hzd_fg_bg}
+    local reset = HazardButton{parent=main,x=22,y=32,text="RESET",accent=colors.red,dis_colors=dis_colors,callback=unit.reset_rps,fg_bg=hzd_fg_bg}
+
+    unit.start_ack = start.on_response
+    unit.scram_ack = scram.on_response
+    unit.reset_rps_ack = reset.on_response
+    unit.ack_alarms_ack = ack_a.on_response
+
+    local function start_button_en_check()
+        if (unit.reactor_data ~= nil) and (unit.reactor_data.mek_status ~= nil) then
+            local can_start = (not unit.reactor_data.mek_status.status) and
+                                (not unit.reactor_data.rps_tripped) and
+                                (unit.a_group == 0)
+            if can_start then start.enable() else start.disable() end
+        end
+    end
+
+    start.register(u_ps, "status", start_button_en_check)
+    start.register(u_ps, "rps_tripped", start_button_en_check)
+    start.register(u_ps, "auto_group_id", start_button_en_check)
+    start.register(u_ps, "AutoControl", start_button_en_check)
+
+    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}
+    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}
+
+    local waste_mode = MultiButton{parent=waste_div,x=1,y=1,options=waste_opts,callback=unit.set_waste,min_width=6}
+
+    waste_mode.register(u_ps, "U_WasteMode", waste_mode.set_value)
+
+    ----------------------
+    -- alarm management --
+    ----------------------
+
+    local alarm_panel = Div{parent=main,x=2,y=36,width=29,height=16,fg_bg=bw_fg_bg}
+
+    local a_brc = AlarmLight{parent=alarm_panel,x=6,y=2,label="Containment Breach",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    local a_rad = AlarmLight{parent=alarm_panel,x=6,label="Containment Radiation",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    local a_dmg = AlarmLight{parent=alarm_panel,x=6,label="Critical Damage",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    alarm_panel.line_break()
+    local a_rcl = AlarmLight{parent=alarm_panel,x=6,label="Reactor Lost",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    local a_rcd = AlarmLight{parent=alarm_panel,x=6,label="Reactor Damage",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    local a_rot = AlarmLight{parent=alarm_panel,x=6,label="Reactor Over Temp",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    local a_rht = AlarmLight{parent=alarm_panel,x=6,label="Reactor High Temp",c1=colors.gray,c2=colors.yellow,c3=colors.green,flash=true,period=period.BLINK_500_MS}
+    local a_rwl = AlarmLight{parent=alarm_panel,x=6,label="Reactor Waste Leak",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+    local a_rwh = AlarmLight{parent=alarm_panel,x=6,label="Reactor Waste High",c1=colors.gray,c2=colors.yellow,c3=colors.green,flash=true,period=period.BLINK_500_MS}
+    alarm_panel.line_break()
+    local a_rps = AlarmLight{parent=alarm_panel,x=6,label="RPS Transient",c1=colors.gray,c2=colors.yellow,c3=colors.green,flash=true,period=period.BLINK_500_MS}
+    local a_clt = AlarmLight{parent=alarm_panel,x=6,label="RCS Transient",c1=colors.gray,c2=colors.yellow,c3=colors.green,flash=true,period=period.BLINK_500_MS}
+    local a_tbt = AlarmLight{parent=alarm_panel,x=6,label="Turbine Trip",c1=colors.gray,c2=colors.red,c3=colors.green,flash=true,period=period.BLINK_250_MS}
+
+    a_brc.register(u_ps, "Alarm_1", a_brc.update)
+    a_rad.register(u_ps, "Alarm_2", a_rad.update)
+    a_dmg.register(u_ps, "Alarm_4", a_dmg.update)
+
+    a_rcl.register(u_ps, "Alarm_3", a_rcl.update)
+    a_rcd.register(u_ps, "Alarm_5", a_rcd.update)
+    a_rot.register(u_ps, "Alarm_6", a_rot.update)
+    a_rht.register(u_ps, "Alarm_7", a_rht.update)
+    a_rwl.register(u_ps, "Alarm_8", a_rwl.update)
+    a_rwh.register(u_ps, "Alarm_9", a_rwh.update)
+
+    a_rps.register(u_ps, "Alarm_10", a_rps.update)
+    a_clt.register(u_ps, "Alarm_11", a_clt.update)
+    a_tbt.register(u_ps, "Alarm_12", a_tbt.update)
+
+    -- ack's and resets
+
+    local c = unit.alarm_callbacks
+    local ack_fg_bg = cpair(colors.black, colors.orange)
+    local rst_fg_bg = cpair(colors.black, colors.lime)
+    local active_fg_bg = cpair(colors.white, colors.gray)
+
+    PushButton{parent=alarm_panel,x=2,y=2,text="\x13",callback=c.c_breach.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=2,text="R",callback=c.c_breach.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=3,text="\x13",callback=c.radiation.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=3,text="R",callback=c.radiation.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=4,text="\x13",callback=c.dmg_crit.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=4,text="R",callback=c.dmg_crit.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+
+    PushButton{parent=alarm_panel,x=2,y=6,text="\x13",callback=c.r_lost.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=6,text="R",callback=c.r_lost.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=7,text="\x13",callback=c.damage.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=7,text="R",callback=c.damage.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=8,text="\x13",callback=c.over_temp.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=8,text="R",callback=c.over_temp.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=9,text="\x13",callback=c.high_temp.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=9,text="R",callback=c.high_temp.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=10,text="\x13",callback=c.waste_leak.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=10,text="R",callback=c.waste_leak.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=11,text="\x13",callback=c.waste_high.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=11,text="R",callback=c.waste_high.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+
+    PushButton{parent=alarm_panel,x=2,y=13,text="\x13",callback=c.rps_trans.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=13,text="R",callback=c.rps_trans.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=14,text="\x13",callback=c.rcs_trans.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=14,text="R",callback=c.rcs_trans.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=2,y=15,text="\x13",callback=c.t_trip.ack,fg_bg=ack_fg_bg,active_fg_bg=active_fg_bg}
+    PushButton{parent=alarm_panel,x=4,y=15,text="R",callback=c.t_trip.reset,fg_bg=rst_fg_bg,active_fg_bg=active_fg_bg}
+
+    -- color tags
+
+    TextBox{parent=alarm_panel,x=5,y=13,text="\x95",width=1,height=1,fg_bg=cpair(colors.white,colors.cyan)}
+    TextBox{parent=alarm_panel,x=5,text="\x95",width=1,height=1,fg_bg=cpair(colors.white,colors.blue)}
+    TextBox{parent=alarm_panel,x=5,text="\x95",width=1,height=1,fg_bg=cpair(colors.white,colors.blue)}
+
+    --------------------------------
+    -- 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}
+    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}
+
+    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=cpair(colors.white,colors.gray),dis_fg_bg=cpair(colors.gray,colors.white),callback=set_group}
+
+    auto_div.line_break()
+
+    TextBox{parent=auto_div,text="Prio. Group",height=1,width=11,fg_bg=style.label}
+    local auto_grp = TextBox{parent=auto_div,text="Manual",height=1,width=11,fg_bg=bw_fg_bg}
+
+    auto_grp.register(u_ps, "auto_group", auto_grp.set_value)
+
+    auto_div.line_break()
+
+    local a_rdy = IndicatorLight{parent=auto_div,label="Ready",x=2,colors=cpair(colors.green,colors.gray)}
+    local a_stb = IndicatorLight{parent=auto_div,label="Standby",x=2,colors=cpair(colors.white,colors.gray),flash=true,period=period.BLINK_1000_MS}
+
+    a_rdy.register(u_ps, "U_AutoReady", a_rdy.update)
+
+    -- update standby indicator
+    a_stb.register(u_ps, "status", function (active)
+        a_stb.update(unit.annunciator.AutoControl and (not active))
+    end)
+    a_stb.register(u_ps, "AutoControl", function (auto_active)
+        if auto_active then
+            a_stb.update(unit.reactor_data.mek_status.status == false)
+        else a_stb.update(false) end
+    end)
+
+    -- enable/disable controls based on group assignment (start button is separate)
+    burn_rate.register(u_ps, "auto_group_id", function (gid)
+        if gid == 0 then burn_rate.enable() else burn_rate.disable() end
+    end)
+    set_burn_btn.register(u_ps, "auto_group_id", function (gid)
+        if gid == 0 then set_burn_btn.enable() else set_burn_btn.disable() end
+    end)
+
+    -- can't change group if auto is engaged regardless of if this unit is part of auto control
+    set_grp_btn.register(f_ps, "auto_active", function (auto_active)
+        if auto_active then set_grp_btn.disable() else set_grp_btn.enable() end
+    end)
+
+    return main
+end
+
+return init

coordinator/ui/components/unit_overview.lua

@@ -0,0 +1,175 @@
+--
+-- Basic Unit Overview
+--
+
+local core         = require("graphics.core")
+
+local style        = require("coordinator.ui.style")
+
+local reactor_view = require("coordinator.ui.components.reactor")
+local boiler_view  = require("coordinator.ui.components.boiler")
+local turbine_view = require("coordinator.ui.components.turbine")
+
+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 pipe = core.pipe
+
+-- make a new unit overview window
+---@param parent graphics_element parent
+---@param x integer top left x
+---@param y integer top left y
+---@param unit ioctl_unit unit database entry
+local function make(parent, x, y, unit)
+    local num_boilers = #unit.boiler_data_tbl
+    local num_turbines = #unit.turbine_data_tbl
+
+    assert(num_boilers  >= 0 and num_boilers  <= 2, "minimum 0 boilers, maximum 2 boilers")
+    assert(num_turbines >= 1 and num_turbines <= 3, "minimum 1 turbine, maximum 3 turbines")
+
+    local height = 25
+
+    if num_boilers == 0 and num_turbines == 1 then
+        height = 9
+    elseif num_boilers == 1 and num_turbines <= 2 then
+        height = 17
+    end
+
+    assert(parent.height() >= (y + height), "main display not of sufficient vertical resolution (add an additional row of monitors)")
+
+    -- bounding box div
+    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}
+
+    -------------
+    -- REACTOR --
+    -------------
+
+    reactor_view(root, 1, 3, unit.unit_ps)
+
+    if num_boilers > 0 then
+        local coolant_pipes = {}
+
+        if num_boilers >= 2 then
+            table.insert(coolant_pipes, pipe(0, 0, 11, 12, colors.lightBlue))
+        end
+
+        table.insert(coolant_pipes, pipe(0, 0, 11, 3, colors.lightBlue))
+        table.insert(coolant_pipes, pipe(2, 0, 11, 2, colors.orange))
+
+        if num_boilers >= 2 then
+            table.insert(coolant_pipes, pipe(2, 0, 11, 11, colors.orange))
+        end
+
+        PipeNetwork{parent=root,x=4,y=10,pipes=coolant_pipes,bg=colors.lightGray}
+    end
+
+    -------------
+    -- BOILERS --
+    -------------
+
+    if num_boilers >= 1 then boiler_view(root, 16, 11, unit.boiler_ps_tbl[1]) end
+    if num_boilers >= 2 then boiler_view(root, 16, 19, unit.boiler_ps_tbl[2]) end
+
+    --------------
+    -- TURBINES --
+    --------------
+
+    local t_idx = 1
+    local no_boilers = num_boilers == 0
+
+    if (num_turbines >= 3) or no_boilers or (num_boilers == 1 and num_turbines >= 2) then
+        turbine_view(root, 58, 3, unit.turbine_ps_tbl[t_idx])
+        t_idx = t_idx + 1
+    end
+
+    if (num_turbines >= 1 and not no_boilers) or num_turbines >= 2 then
+        turbine_view(root, 58, 11, unit.turbine_ps_tbl[t_idx])
+        t_idx = t_idx + 1
+    end
+
+    if (num_turbines >= 2 and num_boilers >= 2) or num_turbines >= 3 then
+        turbine_view(root, 58, 19, unit.turbine_ps_tbl[t_idx])
+    end
+
+    local steam_pipes_b = {}
+
+    if no_boilers then
+        table.insert(steam_pipes_b, pipe(0, 1, 3, 1, colors.white))         -- steam to turbine 1
+        table.insert(steam_pipes_b, pipe(0, 2, 3, 2, colors.blue))          -- water to turbine 1
+
+        if num_turbines >= 2 then
+            table.insert(steam_pipes_b, pipe(1, 2, 3, 9, colors.white))     -- steam to turbine 2
+            table.insert(steam_pipes_b, pipe(2, 3, 3, 10, colors.blue))     -- water to turbine 2
+        end
+
+        if num_turbines >= 3 then
+            table.insert(steam_pipes_b, pipe(1, 9, 3, 17, colors.white))    -- steam boiler 1 to turbine 1 junction end
+            table.insert(steam_pipes_b, pipe(2, 10, 3, 18, colors.blue))    -- water boiler 1 to turbine 1 junction start
+        end
+    else
+        -- boiler side pipes
+        local steam_pipes_a = {
+            -- boiler 1 steam/water pipes
+            pipe(0, 1, 6, 1, colors.white, false, true),    -- steam boiler 1 to turbine junction
+            pipe(0, 2, 6, 2, colors.blue, false, true)      -- water boiler 1 to turbine junction
+        }
+
+        if num_boilers >= 2 then
+            -- boiler 2 steam/water pipes
+            table.insert(steam_pipes_a, pipe(0, 9, 6, 9, colors.white, false, true))    -- steam boiler 2 to turbine junction
+            table.insert(steam_pipes_a, pipe(0, 10, 6, 10, colors.blue, false, true))   -- water boiler 2 to turbine junction
+        end
+
+        -- turbine side pipes
+
+        if num_turbines >= 3 or (num_boilers == 1 and num_turbines == 2) then
+            table.insert(steam_pipes_b, pipe(0, 9, 1, 2, colors.white, false, true))    -- steam boiler 1 to turbine 1 junction start
+            table.insert(steam_pipes_b, pipe(1, 1, 3, 1, colors.white, false, false))   -- steam boiler 1 to turbine 1 junction end
+        end
+
+        table.insert(steam_pipes_b, pipe(0, 9, 3, 9, colors.white, false, true))        -- steam boiler 1 to turbine 2
+
+        if num_turbines >= 3 or (num_boilers == 1 and num_turbines == 2) then
+            table.insert(steam_pipes_b, pipe(0, 10, 2, 3, colors.blue, false, true))    -- water boiler 1 to turbine 1 junction start
+            table.insert(steam_pipes_b, pipe(2, 2, 3, 2, colors.blue, false, false))    -- water boiler 1 to turbine 1 junction end
+        end
+
+        table.insert(steam_pipes_b, pipe(0, 10, 3, 10, colors.blue, false, true))       -- water boiler 1 to turbine 2
+
+        if num_turbines >= 3 or (num_turbines >= 2 and num_boilers >= 2) then
+            if num_boilers >= 2 then
+                table.insert(steam_pipes_b, pipe(0, 17, 1, 9, colors.white, false, true))   -- steam boiler 2 to turbine 2 junction
+                table.insert(steam_pipes_b, pipe(0, 17, 3, 17, colors.white, false, true))  -- steam boiler 2 to turbine 3
+
+                table.insert(steam_pipes_b, pipe(0, 18, 2, 10, colors.blue, false, true))   -- water boiler 2 to turbine 3
+                table.insert(steam_pipes_b, pipe(0, 18, 3, 18, colors.blue, false, true))   -- water boiler 2 to turbine 2 junction
+            else
+                table.insert(steam_pipes_b, pipe(1, 17, 1, 9, colors.white, false, true))   -- steam boiler 2 to turbine 2 junction
+                table.insert(steam_pipes_b, pipe(1, 17, 3, 17, colors.white, false, true))  -- steam boiler 2 to turbine 3
+
+                table.insert(steam_pipes_b, pipe(2, 18, 2, 10, colors.blue, false, true))   -- water boiler 2 to turbine 3
+                table.insert(steam_pipes_b, pipe(2, 18, 3, 18, colors.blue, false, true))   -- water boiler 2 to turbine 2 junction
+            end
+        elseif num_turbines == 1 and num_boilers >= 2 then
+            table.insert(steam_pipes_b, pipe(0, 17, 1, 9, colors.white, false, true))       -- steam boiler 2 to turbine 2 junction
+            table.insert(steam_pipes_b, pipe(0, 17, 1, 17, colors.white, false, true))      -- steam boiler 2 to turbine 3
+
+            table.insert(steam_pipes_b, pipe(0, 18, 2, 10, colors.blue, false, true))       -- water boiler 2 to turbine 3
+            table.insert(steam_pipes_b, pipe(0, 18, 2, 18, colors.blue, false, true))       -- water boiler 2 to turbine 2 junction
+        end
+
+        PipeNetwork{parent=root,x=47,y=11,pipes=steam_pipes_a,bg=colors.lightGray}
+    end
+
+    PipeNetwork{parent=root,x=54,y=3,pipes=steam_pipes_b,bg=colors.lightGray}
+
+    return root
+end
+
+return make

coordinator/ui/dialog.lua

@@ -0,0 +1,52 @@
+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/main_view.lua

@@ -0,0 +1,89 @@
+--
+-- Main SCADA Coordinator GUI
+--
+
+local util          = require("scada-common.util")
+
+local iocontrol     = require("coordinator.iocontrol")
+
+local style         = require("coordinator.ui.style")
+
+local imatrix       = require("coordinator.ui.components.imatrix")
+local process_ctl   = require("coordinator.ui.components.processctl")
+local unit_overview = require("coordinator.ui.components.unit_overview")
+
+local core          = require("graphics.core")
+
+local TextBox       = require("graphics.elements.textbox")
+
+local DataIndicator = require("graphics.elements.indicators.data")
+
+local TEXT_ALIGN = core.TEXT_ALIGN
+
+local cpair = core.cpair
+
+-- create new main view
+---@param main graphics_element main displaybox
+local function init(main)
+    local facility = iocontrol.get_db().facility
+    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}
+    -- max length example: "01:23:45 AM - Wednesday, September 28 2022"
+    local datetime = TextBox{parent=main,x=(header.width()-42),y=1,text="",alignment=TEXT_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)
+
+    local uo_1, uo_2, uo_3, uo_4    ---@type graphics_element
+
+    local cnc_y_start = 3
+    local row_1_height = 0
+
+    -- unit overviews
+    if facility.num_units >= 1 then
+        uo_1 = unit_overview(main, 2, 3, units[1])
+        row_1_height = uo_1.height()
+    end
+
+    if facility.num_units >= 2 then
+        uo_2 = unit_overview(main, 84, 3, units[2])
+        row_1_height = math.max(row_1_height, uo_2.height())
+    end
+
+    cnc_y_start = cnc_y_start + row_1_height + 1
+
+    if facility.num_units >= 3 then
+        -- base offset 3, spacing 1, max height of units 1 and 2
+        local row_2_offset = cnc_y_start
+
+        uo_3 = unit_overview(main, 2, row_2_offset, units[3])
+        cnc_y_start = row_2_offset + uo_3.height() + 1
+
+        if facility.num_units == 4 then
+            uo_4 = unit_overview(main, 84, row_2_offset, units[4])
+            cnc_y_start = math.max(cnc_y_start, row_2_offset + uo_4.height() + 1)
+        end
+    end
+
+    -- command & control
+
+    cnc_y_start = cnc_y_start
+
+    -- induction matrix and process control interfaces are 24 tall + space needed for divider
+    local cnc_bottom_align_start = main.height() - 26
+
+    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.width()),alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=cpair(colors.lightGray,colors.gray)}
+
+    cnc_bottom_align_start = cnc_bottom_align_start + 2
+
+    process_ctl(main, 2, cnc_bottom_align_start)
+
+    imatrix(main, 131, cnc_bottom_align_start, facility.induction_data_tbl[1], facility.induction_ps_tbl[1])
+end
+
+return init

coordinator/ui/layout/unit_view.lua

@@ -0,0 +1,14 @@
+--
+-- Reactor Unit SCADA Coordinator GUI
+--
+
+local unit_detail = require("coordinator.ui.components.unit_detail")
+
+-- create a unit view
+---@param main graphics_element main displaybox
+---@param id integer
+local function init(main, id)
+    unit_detail(main, id)
+end
+
+return init

coordinator/ui/style.lua

@@ -0,0 +1,158 @@
+--
+-- Graphics Style Options
+--
+
+local core = require("graphics.core")
+
+local style = {}
+
+local cpair = core.cpair
+
+-- GLOBAL --
+
+style.root = cpair(colors.black, colors.lightGray)
+style.header = cpair(colors.white, colors.gray)
+style.label = cpair(colors.gray, colors.lightGray)
+
+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.white,     hex = 0xf0f0f0 },
+    { c = colors.lightGray, hex = 0xcacaca },
+    { c = colors.gray,      hex = 0x575757 },
+    -- { c = colors.black,     hex = 0x191919 },
+    -- { c = colors.brown,     hex = 0x7f664c }
+}
+
+-- MAIN LAYOUT --
+
+style.reactor = {
+    -- reactor states
+    states = {
+        {
+            color = cpair(colors.black, colors.yellow),
+            text = "PLC OFF-LINE"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "NOT FORMED"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "PLC  FAULT"
+        },
+        {
+            color = cpair(colors.white, colors.gray),
+            text = "DISABLED"
+        },
+        {
+            color = cpair(colors.black, colors.green),
+            text = "ACTIVE"
+        },
+        {
+            color = cpair(colors.black, colors.red),
+            text = "SCRAMMED"
+        },
+        {
+            color = cpair(colors.black, colors.red),
+            text = "FORCE DISABLED"
+        }
+    }
+}
+
+style.boiler = {
+    -- boiler states
+    states = {
+        {
+            color = cpair(colors.black, colors.yellow),
+            text = "OFF-LINE"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "NOT FORMED"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "RTU  FAULT"
+        },
+        {
+            color = cpair(colors.white, colors.gray),
+            text = "IDLE"
+        },
+        {
+            color = cpair(colors.black, colors.green),
+            text = "ACTIVE"
+        }
+    }
+}
+
+style.turbine = {
+    -- turbine states
+    states = {
+        {
+            color = cpair(colors.black, colors.yellow),
+            text = "OFF-LINE"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "NOT FORMED"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "RTU  FAULT"
+        },
+        {
+            color = cpair(colors.white, colors.gray),
+            text = "IDLE"
+        },
+        {
+            color = cpair(colors.black, colors.green),
+            text = "ACTIVE"
+        },
+        {
+            color = cpair(colors.black, colors.red),
+            text = "TRIP"
+        }
+    }
+}
+
+style.imatrix = {
+    -- induction matrix states
+    states = {
+        {
+            color = cpair(colors.black, colors.yellow),
+            text = "OFF-LINE"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "NOT FORMED"
+        },
+        {
+            color = cpair(colors.black, colors.orange),
+            text = "RTU  FAULT"
+        },
+        {
+            color = cpair(colors.black, colors.green),
+            text = "ONLINE"
+        },
+        {
+            color = cpair(colors.black, colors.yellow),
+            text = "LOW CHARGE"
+        },
+        {
+            color = cpair(colors.black, colors.yellow),
+            text = "HIGH  CHARGE"
+        },
+    }
+}
+
+return style

graphics/core.lua

@@ -0,0 +1,131 @@
+--
+-- Graphics Core Types, Checks, and Constructors
+--
+
+local events  = require("graphics.events")
+local flasher = require("graphics.flasher")
+
+local core = {}
+
+core.flasher = flasher
+core.events = events
+
+-- Core Types
+
+---@enum TEXT_ALIGN
+core.TEXT_ALIGN = {
+    LEFT = 1,
+    CENTER = 2,
+    RIGHT = 3
+}
+
+---@class graphics_border
+---@field width integer
+---@field color color
+---@field even boolean
+
+---@alias element_id string|integer
+
+-- create a new border definition
+---@nodiscard
+---@param width integer border width
+---@param color color border color
+---@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
+    }
+end
+
+---@class graphics_frame
+---@field x integer
+---@field y integer
+---@field w integer
+---@field h integer
+
+-- create a new graphics frame definition
+---@nodiscard
+---@param x integer
+---@param y integer
+---@param w integer
+---@param h integer
+---@return graphics_frame
+function core.gframe(x, y, w, h)
+    return {
+        x = x,
+        y = y,
+        w = w,
+        h = h
+    }
+end
+
+---@class cpair
+---@field color_a color
+---@field color_b color
+---@field blit_a string
+---@field blit_b string
+---@field fgd color
+---@field bkg color
+---@field blit_fgd string
+---@field blit_bkg string
+
+-- create a new color pair definition
+---@nodiscard
+---@param a color
+---@param b color
+---@return cpair
+function core.cpair(a, b)
+    return {
+        -- color pairs
+        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)
+    }
+end
+
+---@class pipe
+---@field x1 integer starting x, origin is 0
+---@field y1 integer starting y, origin is 0
+---@field x2 integer ending x, origin is 0
+---@field y2 integer ending y, origin is 0
+---@field w integer width
+---@field h integer height
+---@field color color pipe color
+---@field thin boolean true for 1 subpixel, false (default) for 2
+---@field align_tr boolean false to align bottom left (default), true to align top right
+
+-- create a new pipe<br>
+-- note: pipe coordinate origin is (0, 0)
+---@nodiscard
+---@param x1 integer starting x, origin is 0
+---@param y1 integer starting y, origin is 0
+---@param x2 integer ending x, origin is 0
+---@param y2 integer ending y, origin is 0
+---@param color color pipe color
+---@param thin? boolean true for 1 subpixel, false (default) for 2
+---@param align_tr? boolean false to align bottom left (default), true to align top right
+---@return pipe
+function core.pipe(x1, y1, x2, y2, color, thin, align_tr)
+    return {
+        x1 = x1,
+        y1 = y1,
+        x2 = x2,
+        y2 = y2,
+        w = math.abs(x2 - x1) + 1,
+        h = math.abs(y2 - y1) + 1,
+        color = color,
+        thin = thin or false,
+        align_tr = align_tr or false
+    }
+end
+
+return core

graphics/element.lua

@@ -0,0 +1,563 @@
+--
+-- Generic Graphics Element
+--
+
+local core = require("graphics.core")
+
+local element = {}
+
+---@class graphics_args_generic
+---@field window? table
+---@field parent? graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer next line if omitted
+---@field offset_x? integer 0 if omitted
+---@field offset_y? integer 0 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+---@alias graphics_args graphics_args_generic
+---|waiting_args
+---|hazard_button_args
+---|multi_button_args
+---|push_button_args
+---|radio_button_args
+---|sidebar_args
+---|spinbox_args
+---|switch_button_args
+---|tabbar_args
+---|alarm_indicator_light
+---|core_map_args
+---|data_indicator_args
+---|hbar_args
+---|icon_indicator_args
+---|indicator_led_args
+---|indicator_led_pair_args
+---|indicator_led_rgb_args
+---|indicator_light_args
+---|power_indicator_args
+---|rad_indicator_args
+---|state_indicator_args
+---|tristate_indicator_light_args
+---|vbar_args
+---|colormap_args
+---|displaybox_args
+---|div_args
+---|multipane_args
+---|pipenet_args
+---|rectangle_args
+---|textbox_args
+---|tiling_args
+
+---@class element_subscription
+---@field ps psil ps used
+---@field key string data key
+---@field func function callback
+
+-- a base graphics element, should not be created on its own
+---@nodiscard
+---@param args graphics_args arguments
+function element.new(args)
+    local self = {
+        id = -1,
+        elem_type = debug.getinfo(2).name,
+        define_completed = false,
+        p_window = nil,                                 ---@type table
+        position = { x = 1, y = 1 },                    ---@type coordinate_2d
+        child_offset = { x = 0, y = 0 },
+        bounds = { x1 = 1, y1 = 1, x2 = 1, y2 = 1 },    ---@class element_bounds
+        next_y = 1,
+        children = {},
+        subscriptions = {},
+        mt = {}
+    }
+
+    ---@class graphics_template
+    local protected = {
+        enabled = true,
+        value = nil,    ---@type any
+        window = nil,   ---@type table
+        fg_bg = core.cpair(colors.white, colors.black),
+        frame = core.gframe(1, 1, 1, 1)
+    }
+
+    local name_brief = "graphics.element{" .. self.elem_type .. "}: "
+
+    -- element as string
+    function self.mt.__tostring()
+        return "graphics.element{" .. self.elem_type .. "} @ " .. tostring(self)
+    end
+
+    ---@class graphics_element
+    local public = {}
+
+    setmetatable(public, self.mt)
+
+    -------------------------
+    -- PROTECTED FUNCTIONS --
+    -------------------------
+
+    -- prepare the template
+    ---@param offset_x integer x offset
+    ---@param offset_y integer y offset
+    ---@param next_y integer next line if no y was provided
+    function protected.prepare_template(offset_x, offset_y, next_y)
+        -- get frame coordinates/size
+        if args.gframe ~= nil then
+            protected.frame.x = args.gframe.x
+            protected.frame.y = args.gframe.y
+            protected.frame.w = args.gframe.w
+            protected.frame.h = args.gframe.h
+        else
+            local w, h = self.p_window.getSize()
+            protected.frame.x = args.x or 1
+
+            if args.parent ~= nil then
+                protected.frame.y = args.y or (next_y - offset_y)
+            else
+                protected.frame.y = args.y or next_y
+            end
+
+            protected.frame.w = args.width or w
+            protected.frame.h = args.height or h
+        end
+
+        -- inner offsets
+        if args.offset_x ~= nil then self.child_offset.x = args.offset_x end
+        if args.offset_y ~= nil then self.child_offset.y = args.offset_y end
+
+        -- adjust window frame if applicable
+        local f = protected.frame
+        local x = f.x
+        local y = f.y
+
+        -- apply offsets
+        if args.parent ~= nil then
+            -- constrain to parent inner width/height
+            local w, h = self.p_window.getSize()
+            f.w = math.min(f.w, w - ((2 * offset_x) + (f.x - 1)))
+            f.h = math.min(f.h, h - ((2 * offset_y) + (f.y - 1)))
+
+            -- offset x/y
+            f.x = x + offset_x
+            f.y = y + 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")
+
+        -- create window
+        protected.window = window.create(self.p_window, f.x, f.y, f.w, f.h, true)
+
+        -- init colors
+        if args.fg_bg ~= nil then
+            protected.fg_bg = args.fg_bg
+        elseif args.parent ~= nil then
+            protected.fg_bg = args.parent.get_fg_bg()
+        end
+
+        -- set colors
+        protected.window.setBackgroundColor(protected.fg_bg.bkg)
+        protected.window.setTextColor(protected.fg_bg.fgd)
+        protected.window.clear()
+
+        -- record position
+        self.position.x, self.position.y = protected.window.getPosition()
+
+        -- calculate bounds
+        self.bounds.x1 = self.position.x
+        self.bounds.x2 = self.position.x + f.w - 1
+        self.bounds.y1 = self.position.y
+        self.bounds.y2 = self.position.y + f.h - 1
+    end
+
+    -- check if a coordinate is within the bounds of this element
+    ---@param x integer
+    ---@param y integer
+    function protected.in_bounds(x, y)
+        local in_x = x >= self.bounds.x1 and x <= self.bounds.x2
+        local in_y = y >= self.bounds.y1 and y <= self.bounds.y2
+        return in_x and in_y
+    end
+
+-- luacheck: push ignore
+---@diagnostic disable: unused-local, unused-vararg
+
+    -- dynamically insert a child element
+    ---@param id string|integer element identifier
+    ---@param elem graphics_element element
+    function protected.insert(id, elem)
+    end
+
+    -- dynamically remove a child element
+    ---@param id string|integer element identifier
+    function protected.remove(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
+    function protected.get() return public, self.id end
+
+    -----------
+    -- SETUP --
+    -----------
+
+    -- get the parent window
+    self.p_window = args.window
+    if self.p_window == nil and args.parent ~= nil then
+        self.p_window = args.parent.window()
+    end
+
+    -- check window
+    assert(self.p_window, name_brief .. "no parent window provided")
+
+    -- prepare the template
+    if args.parent == nil then
+        protected.prepare_template(0, 0, 1)
+    else
+        self.id = args.parent.__add_child(args.id, protected)
+    end
+
+    ----------------------
+    -- PUBLIC FUNCTIONS --
+    ----------------------
+
+    -- get the window object
+    ---@nodiscard
+    function public.window() return protected.window end
+
+    -- delete this element (hide and unsubscribe from PSIL)
+    function public.delete()
+        -- hide + stop animations
+        public.hide()
+
+        -- unsubscribe from PSIL
+        for i = 1, #self.subscriptions do
+            local s = self.subscriptions[i] ---@type element_subscription
+            s.ps.unsubscribe(s.key, s.func)
+        end
+
+        -- delete all children
+        for k, v in pairs(self.children) do
+            v.delete()
+            self.children[k] = nil
+        end
+    end
+
+    -- ELEMENT TREE --
+
+    -- add a child element
+    ---@nodiscard
+    ---@param key string|nil id
+    ---@param child graphics_template
+    ---@return integer|string key
+    function public.__add_child(key, child)
+        -- offset first automatic placement
+        if self.next_y <= self.child_offset.y then
+            self.next_y = self.child_offset.y + 1
+        end
+
+        child.prepare_template(self.child_offset.x, self.child_offset.y, self.next_y)
+
+        self.next_y = child.frame.y + child.frame.h
+
+        local child_element = child.get()
+
+        if key == nil then
+            table.insert(self.children, child_element)
+            return #self.children
+        else
+            self.children[key] = child_element
+            return key
+        end
+    end
+
+    -- get a child element
+    ---@nodiscard
+    ---@param id element_id
+    ---@return graphics_element
+    function public.get_child(id) return self.children[id] end
+
+    -- remove a child element
+    ---@param id element_id
+    function public.remove(id)
+        if self.children[id] ~= nil then
+            self.children[id].delete()
+            self.children[id] = nil
+        end
+    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 self.children[id] == nil then
+            for _, child in pairs(self.children) do
+                local elem = child.get_element_by_id(id)
+                if elem ~= nil then return elem end
+            end
+        else
+            return self.children[id]
+        end
+
+        return nil
+    end
+
+    -- DYNAMIC CHILD ELEMENTS --
+
+    -- insert an element as a contained child<br>
+    -- this is intended to be used dynamically, and depends on the target element type.<br>
+    -- not all elements support dynamic children.
+    ---@param id string|integer element identifier
+    ---@param elem graphics_element element
+    function public.insert_element(id, elem)
+        protected.insert(id, elem)
+    end
+
+    -- remove an element from contained children<br>
+    -- this is intended to be used dynamically, and depends on the target element type.<br>
+    -- not all elements support dynamic children.
+    ---@param id string|integer element identifier
+    function public.remove_element(id)
+        protected.remove(id)
+    end
+
+    -- AUTO-PLACEMENT --
+
+    -- skip a line for automatically placed elements
+    function public.line_break()
+        self.next_y = self.next_y + 1
+    end
+
+    -- PROPERTIES --
+
+    -- get the foreground/background colors
+    ---@nodiscard
+    ---@return cpair fg_bg
+    function public.get_fg_bg()
+        return protected.fg_bg
+    end
+
+    -- get element x
+    ---@nodiscard
+    ---@return integer x
+    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
+
+    -- get element width
+    ---@nodiscard
+    ---@return integer width
+    function public.width()
+        return protected.frame.w
+    end
+
+    -- get element height
+    ---@nodiscard
+    ---@return integer height
+    function public.height()
+        return protected.frame.h
+    end
+
+    -- get the element value
+    ---@nodiscard
+    ---@return any value
+    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
+
+    -- set minimum input value
+    ---@param min integer minimum allowed value
+    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
+
+    -- enable the element
+    function public.enable()
+        protected.enabled = true
+        protected.enable()
+    end
+
+    -- disable the element
+    function public.disable()
+        protected.enabled = false
+        protected.disable()
+    end
+
+    -- custom recolor command, varies by element if implemented
+    ---@vararg cpair|color color(s)
+    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
+
+    -- 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
+    ---@param x integer x position relative to parent frame
+    ---@param y integer y position relative to parent frame
+    function public.reposition(x, y)
+        protected.window.reposition(x, y)
+    end
+
+    -- FUNCTION CALLBACKS --
+
+    -- handle a monitor touch or mouse click
+    ---@param event mouse_interaction mouse interaction event
+    function public.handle_mouse(event)
+        local x_ini, y_ini = event.initial.x, event.initial.y
+
+        local ini_in = protected.in_bounds(x_ini, y_ini)
+
+        if ini_in then
+            local event_T = core.events.mouse_transposed(event, self.position.x, self.position.y)
+
+            -- handle the mouse event then pass to children
+            protected.handle_mouse(event_T)
+            for _, child in pairs(self.children) do child.handle_mouse(event_T) end
+        end
+    end
+
+    -- draw the element given new data
+    ---@vararg any new data
+    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
+
+    -- register a callback with a PSIL, allowing for automatic unregister on delete<br>
+    -- do not use graphics elements directly with PSIL subscribe()
+    ---@param ps psil PSIL to subscribe to
+    ---@param key string key to subscribe to
+    ---@param func function function to link
+    function public.register(ps, key, func)
+        table.insert(self.subscriptions, { ps = ps, key = key, func = func })
+        ps.subscribe(key, func)
+    end
+
+    -- VISIBILITY --
+
+    -- show the element
+    function public.show()
+        protected.window.setVisible(true)
+        protected.start_anim()
+        for _, child in pairs(self.children) do child.show() end
+    end
+
+    -- hide the element
+    function public.hide()
+        protected.stop_anim()
+        for _, child in pairs(self.children) do child.hide() end
+        protected.window.setVisible(false)
+    end
+
+    -- re-draw the element
+    function public.redraw()
+        protected.window.redraw()
+    end
+
+    return protected
+end
+
+return element

graphics/elements/animations/waiting.lua

@@ -0,0 +1,108 @@
+-- Loading/Waiting Animation Graphics Element
+
+local tcd     = require("scada-common.tcallbackdsp")
+
+local element = require("graphics.element")
+
+---@class waiting_args
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new waiting animation element
+---@param args waiting_args
+---@return graphics_element element, element_id id
+local function waiting(args)
+    local state = 0
+    local run_animation = false
+
+    args.width = 4
+    args.height = 3
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    local blit_fg = e.fg_bg.blit_fgd
+    local blit_bg = e.fg_bg.blit_bkg
+    local blit_fg_2x = e.fg_bg.blit_fgd .. e.fg_bg.blit_fgd
+    local blit_bg_2x = e.fg_bg.blit_bkg .. e.fg_bg.blit_bkg
+
+    -- tick the animation
+    local function animate()
+        e.window.clear()
+
+        if state >= 0 and state < 7 then
+            -- top
+            e.window.setCursorPos(1 + math.floor(state / 2), 1)
+            if state % 2 == 0 then
+                e.window.blit("\x8f", blit_fg, blit_bg)
+            else
+                e.window.blit("\x8a\x85", blit_fg_2x, blit_bg_2x)
+            end
+
+            -- bottom
+            e.window.setCursorPos(4 - math.ceil(state / 2), 3)
+            if state % 2 == 0 then
+                e.window.blit("\x8f", blit_fg, blit_bg)
+            else
+                e.window.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)
+            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)
+            else
+                e.window.setCursorPos(4, 2 + math.floor(st / 3))
+                e.window.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)
+            elseif st % 3 == 1 then
+                e.window.setCursorPos(1, 2 - math.floor(st / 3))
+                e.window.blit("\x83", blit_bg, blit_fg)
+            else
+                e.window.setCursorPos(1, 2 - math.floor(st / 3))
+                e.window.blit("\x8f", blit_fg, blit_bg)
+            end
+        end
+
+        state = state + 1
+        if state >= 12 then state = 0 end
+
+        if run_animation then
+            tcd.dispatch_unique(0.15, animate)
+        end
+    end
+
+    -- start the animation
+    function e.start_anim()
+        run_animation = true
+        animate()
+    end
+
+    -- stop the animation
+    function e.stop_anim()
+        run_animation = false
+    end
+
+    e.start_anim()
+
+    return e.get()
+end
+
+return waiting

graphics/elements/colormap.lua

@@ -0,0 +1,33 @@
+-- Color Map Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class colormap_args
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+
+-- new color map
+---@param args colormap_args
+---@return graphics_element element, element_id id
+local function colormap(args)
+    local bkg = "008877FFCCEE114455DD9933BBAA2266"
+    local spaces = util.spaces(32)
+
+    args.width = 32
+    args.height = 1
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- draw color map
+    e.window.setCursorPos(1, 1)
+    e.window.blit(spaces, bkg, bkg)
+
+    return e.get()
+end
+
+return colormap

graphics/elements/controls/hazard_button.lua

@@ -0,0 +1,204 @@
+-- Hazard-bordered Button Graphics Element
+
+local tcd     = require("scada-common.tcallbackdsp")
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class hazard_button_args
+---@field text string text to show on button
+---@field accent color accent color for hazard border
+---@field dis_colors? cpair text color and border color when disabled
+---@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 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new hazard button
+---@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")
+
+    -- 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")
+
+        -- center left
+        e.window.setCursorPos(1, 2)
+        e.window.setTextColor(args.fg_bg.bkg)
+        e.window.setBackgroundColor(accent)
+        e.window.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")
+
+        -- 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")
+    end
+
+    -- on request timeout: recursively calls itself to double flash button text
+    ---@param n integer call count
+    local function on_timeout(n)
+        -- start at 0
+        if n == nil then n = 0 end
+
+        if n == 0 then
+            -- go back off
+            e.window.setTextColor(args.fg_bg.fgd)
+            e.window.setCursorPos(3, 2)
+            e.window.write(args.text)
+        end
+
+        if n >= 4 then
+            -- done
+        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)
+                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)
+                on_timeout(n + 1)
+            end)
+        end
+    end
+
+    -- 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)
+    end
+
+    -- blink routine for failure indication
+    ---@param n integer call count
+    local function on_failure(n)
+        -- start at 0
+        if n == nil then n = 0 end
+
+        if n == 0 then
+            -- go back off
+            e.window.setTextColor(args.fg_bg.fgd)
+            e.window.setCursorPos(3, 2)
+            e.window.write(args.text)
+        end
+
+        if n >= 2 then
+            -- done
+        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)
+                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)
+                on_failure(n + 1)
+            end)
+        end
+    end
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        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)
+
+                -- abort any other callbacks
+                tcd.abort(on_timeout)
+                tcd.abort(on_success)
+                tcd.abort(on_failure)
+
+                -- 1.5 second timeout
+                tcd.dispatch(1.5, on_timeout)
+
+                -- call the touch callback
+                args.callback()
+            end
+        end
+    end
+
+    -- callback on request response
+    ---@param result boolean true for success, false for failure
+    function e.response_callback(result)
+        tcd.abort(on_timeout)
+        if result then on_success() else on_failure(0) 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
+    end
+
+    -- show the button as disabled
+    function e.disable()
+        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)
+        end
+    end
+
+    -- show the button as enabled
+    function e.enable()
+        draw_border(args.accent)
+        e.window.setTextColor(args.fg_bg.fgd)
+        e.window.setCursorPos(3, 2)
+        e.window.write(args.text)
+    end
+
+    -- initial draw of border
+    draw_border(args.accent)
+
+    return e.get()
+end
+
+return hazard_button

graphics/elements/controls/multi_button.lua

@@ -0,0 +1,136 @@
+-- Multi Button Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class button_option
+---@field text string
+---@field fg_bg cpair
+---@field active_fg_bg cpair
+---@field _start_x integer starting touch x range (inclusive)
+---@field _end_x integer ending touch x range (inclusive)
+
+---@class multi_button_args
+---@field options table button options
+---@field callback function function to call on touch
+---@field default? integer default state, defaults to options[1]
+---@field min_width? integer text length + 2 if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field height? integer parent height if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new multi button (latch selection, exclusively one button at a time)
+---@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")
+
+    -- single line
+    args.height = 1
+
+    -- determine widths
+    local max_width = 1
+    for i = 1, #args.options do
+        local opt = args.options[i] ---@type button_option
+        if string.len(opt.text) > max_width then
+            max_width = string.len(opt.text)
+        end
+    end
+
+    local button_width = math.max(max_width, args.min_width or 0)
+
+    args.width = (button_width * #args.options) + #args.options + 1
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- button state (convert nil to 1 if missing)
+    e.value = args.default or 1
+
+    -- calculate required button information
+    local next_x = 2
+    for i = 1, #args.options do
+        local opt = args.options[i] ---@type button_option
+
+        opt._start_x = next_x
+        opt._end_x = next_x + button_width - 1
+
+        next_x = next_x + (button_width + 1)
+    end
+
+    -- show the button state
+    local function draw()
+        for i = 1, #args.options do
+            local opt = args.options[i] ---@type button_option
+
+            e.window.setCursorPos(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)
+            else
+                -- show as unpressed
+                e.window.setTextColor(opt.fg_bg.fgd)
+                e.window.setBackgroundColor(opt.fg_bg.bkg)
+            end
+
+            e.window.write(util.pad(opt.text, button_width))
+        end
+    end
+
+    -- check which button a given x is within
+    ---@return integer|nil button index or nil if not within a button
+    local function which_button(x)
+        for i = 1, #args.options do
+            local opt = args.options[i] ---@type button_option
+            if x >= opt._start_x and x <= opt._end_x then return i end
+        end
+
+        return nil
+    end
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        -- if enabled and the button row was pressed...
+        if e.enabled and core.events.was_clicked(event.type) then
+            -- a button may have been pressed, which one was it?
+            local button_ini = which_button(event.initial.x)
+            local button_cur = which_button(event.current.x)
+
+            -- mouse up must always have started with a mouse down on the same button to count as a click
+            -- 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()
+                args.callback(e.value)
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val integer new value
+    function e.set_value(val)
+        e.value = val
+        draw()
+    end
+
+    -- initial draw
+    draw()
+
+    return e.get()
+end
+
+return multi_button

graphics/elements/controls/push_button.lua

@@ -0,0 +1,126 @@
+-- Button Graphics Element
+
+local tcd     = require("scada-common.tcallbackdsp")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+local CLICK_TYPE = core.events.CLICK_TYPE
+
+---@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 active_fg_bg? cpair foreground/background colors when pressed
+---@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 1 if omitted
+---@field height? integer parent height if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new push button
+---@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")
+
+    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)
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    local h_pad = math.floor((e.frame.w - text_width) / 2) + 1
+    local v_pad = math.floor(e.frame.h / 2) + 1
+
+    -- draw the button
+    local function draw()
+        e.window.clear()
+
+        -- write the button text
+        e.window.setCursorPos(h_pad, v_pad)
+        e.window.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()
+        end
+    end
+
+    -- draw the button as unpressed (if active_fg_bg set)
+    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()
+        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
+                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
+                show_pressed()
+            elseif event.type == CLICK_TYPE.UP then
+                show_unpressed()
+                if e.in_bounds(event.current.x, event.current.y) then
+                    args.callback()
+                end
+            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
+    end
+
+    -- show butten as enabled
+    function e.enable()
+        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()
+        end
+    end
+
+    -- show button as disabled
+    function e.disable()
+        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()
+        end
+    end
+
+    -- initial draw
+    draw()
+
+    return e.get()
+end
+
+return push_button

graphics/elements/controls/radio_button.lua

@@ -0,0 +1,109 @@
+-- Radio Button Graphics Element
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@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 default? integer default state, defaults to options[1]
+---@field min_width? integer text length + 2 if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new radio button list (latch selection, exclusively one button at a time)
+---@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
+
+    -- determine widths
+    local max_width = 1
+    for i = 1, #args.options do
+        local opt = args.options[i] ---@type string
+        if string.len(opt) > max_width then
+            max_width = string.len(opt)
+        end
+    end
+
+    local button_text_width = math.max(max_width, args.min_width or 0)
+
+    args.width = button_text_width + 2
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- button state (convert nil to 1 if missing)
+    e.value = args.default or 1
+
+    -- show the button state
+    local function draw()
+        for i = 1, #args.options do
+            local opt = args.options[i] ---@type string
+
+            e.window.setCursorPos(1, i)
+
+            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.window.write("\x88")
+
+            e.window.setTextColor(args.radio_bg)
+            e.window.setBackgroundColor(e.fg_bg.bkg)
+            e.window.write("\x95")
+
+            -- write button text
+            e.window.setTextColor(e.fg_bg.fgd)
+            e.window.setBackgroundColor(e.fg_bg.bkg)
+            e.window.write(opt)
+        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
+            if args.options[event.current.y] ~= nil then
+                e.value = event.current.y
+                draw()
+                args.callback(e.value)
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val integer new value
+    function e.set_value(val)
+        e.value = val
+        draw()
+    end
+
+    -- initial draw
+    draw()
+
+    return e.get()
+end
+
+return radio_button

graphics/elements/controls/sidebar.lua

@@ -0,0 +1,121 @@
+-- Sidebar Graphics Element
+
+local tcd     = require("scada-common.tcallbackdsp")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+local CLICK_TYPE = core.events.CLICK_TYPE
+
+---@class sidebar_tab
+---@field char string character identifier
+---@field color cpair tab colors (fg/bg)
+
+---@class sidebar_args
+---@field tabs table sidebar tab options
+---@field callback function function to call on tab change
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field height? integer parent height if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new sidebar tab selector
+---@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")
+
+    -- 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")
+
+    -- default to 1st tab
+    e.value = 1
+
+    -- show the button state
+    ---@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_idx = pressed_idx or e.value
+
+        for i = 1, #args.tabs do
+            local tab = args.tabs[i] ---@type sidebar_tab
+
+            local y = ((i - 1) * 3) + 1
+
+            e.window.setCursorPos(1, y)
+
+            if pressed and i == pressed_idx then
+                e.window.setTextColor(e.fg_bg.fgd)
+                e.window.setBackgroundColor(e.fg_bg.bkg)
+            else
+                e.window.setTextColor(tab.color.fgd)
+                e.window.setBackgroundColor(tab.color.bkg)
+            end
+
+            e.window.write("   ")
+            e.window.setCursorPos(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("   ")
+        end
+    end
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        -- determine what was pressed
+        if e.enabled then
+            local cur_idx = math.ceil(event.current.y / 3)
+            local ini_idx = math.ceil(event.initial.y / 3)
+
+            if args.tabs[cur_idx] ~= nil then
+                if event.type == CLICK_TYPE.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
+                    draw(true, cur_idx)
+                elseif event.type == CLICK_TYPE.UP then
+                    if cur_idx == ini_idx and e.in_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
+                draw(false)
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val integer new value
+    function e.set_value(val)
+        e.value = val
+        draw(false)
+    end
+
+    -- initial draw
+    draw(false)
+
+    return e.get()
+end
+
+return sidebar

graphics/elements/controls/spinbox_numeric.lua

@@ -0,0 +1,194 @@
+-- Spinbox Numeric Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class spinbox_args
+---@field default? number default value, defaults to 0.0
+---@field min? number default 0, currently must be 0 or greater
+---@field max? number default max number that can be displayed with the digits configuration
+---@field whole_num_precision integer number of whole number digits
+---@field fractional_precision integer number of fractional digits
+---@field arrow_fg_bg cpair arrow foreground/background colors
+---@field arrow_disable? color color when disabled (default light gray)
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new spinbox control (minimum value is 0)
+---@param args spinbox_args
+---@return graphics_element element, element_id id
+local function spinbox(args)
+    -- properties
+    local digits = {}
+    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")
+
+    local fmt, fmt_init ---@type string, string
+
+    if fr_prec > 0 then
+        fmt = "%" .. (wn_prec + fr_prec + 1) .. "." .. fr_prec .. "f"
+        fmt_init = "%0" .. (wn_prec + fr_prec + 1) .. "." .. fr_prec .. "f"
+    else
+        fmt = "%" .. wn_prec .. "d"
+        fmt_init = "%0" .. wn_prec .. "d"
+    end
+
+    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")
+
+    -- determine widths
+    args.width = wn_prec + fr_prec + util.trinary(fr_prec > 0, 1, 0)
+    args.height = 3
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- set initial value
+    e.value = args.default or 0
+
+    -- 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))
+        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))
+        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)
+
+        digits = {}
+---@diagnostic disable-next-line: discard-returns
+        initial_str:gsub("%d", function (char) table.insert(digits, char) end)
+    end
+
+    -- update the value per digits table
+    local function update_value()
+        e.value = 0
+        for i = 1, #digits do
+            local pow = math.abs(wn_prec - i)
+            if i <= wn_prec then
+                e.value = e.value + (digits[i] * (10 ^ pow))
+            else
+                e.value = e.value + (digits[i] * (10 ^ -pow))
+            end
+        end
+    end
+
+    -- print out the current value
+    local function show_num()
+        -- enforce limits
+        if (type(args.min) == "number") and (e.value < args.min) then
+            e.value = args.min
+            set_digits()
+        elseif e.value < 0 then
+            e.value = 0
+            set_digits()
+        else
+            if string.len(util.sprintf(fmt, e.value)) > args.width then
+                -- max printable exceeded, so max out to all 9s
+                for i = 1, #digits do digits[i] = 9 end
+                update_value()
+            elseif (type(args.max) == "number") and (e.value > args.max) then
+                e.value = args.max
+                set_digits()
+            else
+                set_digits()
+            end
+        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))
+    end
+
+    -- init with the default value
+    show_num()
+
+    -- 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 and core.events.was_clicked(event.type) and
+                (event.current.x ~= dec_point_x) and (event.current.y ~= 2) then
+            if event.current.x == event.initial.x and event.current.y == event.initial.y then
+                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
+
+                    update_value()
+                    show_num()
+                end
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val number number to show
+    function e.set_value(val)
+        e.value = val
+        show_num()
+    end
+
+    -- set minimum input value
+    ---@param min integer minimum allowed value
+    function e.set_min(min)
+        if min >= 0 then
+            args.min = min
+            show_num()
+        end
+    end
+
+    -- set maximum input value
+    ---@param max integer maximum allowed value
+    function e.set_max(max)
+        args.max = max
+        show_num()
+    end
+
+    -- enable this input
+    function e.enable()
+        draw_arrows(args.arrow_fg_bg.fgd)
+    end
+
+    -- disable this input
+    function e.disable()
+        draw_arrows(args.arrow_disable or colors.lightGray)
+    end
+
+    -- default to zero, init digits table
+    e.value = 0
+    set_digits()
+
+    return e.get()
+end
+
+return spinbox

graphics/elements/controls/switch_button.lua

@@ -0,0 +1,92 @@
+-- Button Graphics Element
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class switch_button_args
+---@field text string button text
+---@field callback function function to call on touch
+---@field default? boolean default state, defaults to off (false)
+---@field min_width? integer text length + 2 if omitted
+---@field active_fg_bg cpair foreground/background colors when pressed
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field height? integer parent height if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new switch button (latch high/low)
+---@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")
+
+    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)
+
+    -- 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()
+        if e.value then
+            -- show as pressed
+            e.window.setTextColor(args.active_fg_bg.fgd)
+            e.window.setBackgroundColor(args.active_fg_bg.bkg)
+        else
+            -- show as unpressed
+            e.window.setTextColor(e.fg_bg.fgd)
+            e.window.setBackgroundColor(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)
+    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
+            args.callback(e.value)
+        end
+    end
+
+    -- set the value
+    ---@param val boolean new value
+    function e.set_value(val)
+        -- set state
+        e.value = val
+        draw_state()
+    end
+
+    return e.get()
+end
+
+return switch_button

graphics/elements/controls/tabbar.lua

@@ -0,0 +1,130 @@
+-- Tab Bar Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class tabbar_tab
+---@field name string tab name
+---@field color cpair tab colors (fg/bg)
+---@field _start_x integer starting touch x range (inclusive)
+---@field _end_x integer ending touch x range (inclusive)
+
+---@class tabbar_args
+---@field tabs table tab options
+---@field callback function function to call on tab change
+---@field min_width? integer text length + 2 if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new tab selector
+---@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")
+
+    -- always 1 tall
+    args.height = 1
+
+    -- determine widths
+    local max_width = 1
+    for i = 1, #args.tabs do
+        local opt = args.tabs[i]    ---@type tabbar_tab
+        if string.len(opt.name) > max_width then
+            max_width = string.len(opt.name)
+        end
+    end
+
+    local button_width = math.max(max_width, args.min_width or 0)
+
+    -- 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")
+
+    -- default to 1st tab
+    e.value = 1
+
+    -- calculate required tab dimension information
+    local next_x = 1
+    for i = 1, #args.tabs do
+        local tab = args.tabs[i] ---@type tabbar_tab
+
+        tab._start_x = next_x
+        tab._end_x = next_x + button_width - 1
+
+        next_x = next_x + button_width
+    end
+
+    -- show the tab state
+    local function draw()
+        for i = 1, #args.tabs do
+            local tab = args.tabs[i]    ---@type tabbar_tab
+
+            e.window.setCursorPos(tab._start_x, 1)
+
+            if e.value == i then
+                e.window.setTextColor(tab.color.fgd)
+                e.window.setBackgroundColor(tab.color.bkg)
+            else
+                e.window.setTextColor(e.fg_bg.fgd)
+                e.window.setBackgroundColor(e.fg_bg.bkg)
+            end
+
+            e.window.write(util.pad(tab.name, button_width))
+        end
+    end
+
+    -- check which tab a given x is within
+    ---@return integer|nil button index or nil if not within a tab
+    local function which_tab(x)
+        for i = 1, #args.tabs do
+            local tab = args.tabs[i]    ---@type tabbar_tab
+            if x >= tab._start_x and x <= tab._end_x then return i end
+        end
+
+        return nil
+    end
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        -- determine what was pressed
+        if e.enabled and core.events.was_clicked(event.type) then
+            -- a button may have been pressed, which one was it?
+            local tab_ini = which_tab(event.initial.x)
+            local tab_cur = which_tab(event.current.x)
+
+            -- mouse up must always have started with a mouse down on the same tab to count as a click
+            -- 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()
+                args.callback(e.value)
+            end
+        end
+    end
+
+    -- set the value
+    ---@param val integer new value
+    function e.set_value(val)
+        e.value = val
+        draw()
+    end
+
+    -- initial draw
+    draw()
+
+    return e.get()
+end
+
+return tabbar

graphics/elements/displaybox.lua

@@ -0,0 +1,22 @@
+-- Root Display Box Graphics Element
+
+local element = require("graphics.element")
+
+---@class displaybox_args
+---@field window table
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new root display box
+---@nodiscard
+---@param args displaybox_args
+local function displaybox(args)
+    -- create new graphics element base object
+    return element.new(args).get()
+end
+
+return displaybox

graphics/elements/div.lua

@@ -0,0 +1,24 @@
+-- Div (Division, like in HTML) Graphics Element
+
+local element = require("graphics.element")
+
+---@class div_args
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new div element
+---@nodiscard
+---@param args div_args
+---@return graphics_element element, element_id id
+local function div(args)
+    -- create new graphics element base object
+    return element.new(args).get()
+end
+
+return div

graphics/elements/indicators/alight.lua

@@ -0,0 +1,114 @@
+-- Tri-State Alarm Indicator Light Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+local flasher = require("graphics.flasher")
+
+---@class alarm_indicator_light
+---@field label string indicator label
+---@field c1 color color for off state
+---@field c2 color color for alarm state
+---@field c3 color color for ring-back state
+---@field min_label_width? integer label length if omitted
+---@field flash? boolean whether to flash on alarm state rather than stay on
+---@field period? PERIOD flash period
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new alarm indicator light
+---@nodiscard
+---@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")
+
+    if args.flash then
+        assert(util.is_int(args.period), "graphics.elements.indicators.alight: 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)
+
+    -- called by flasher when enabled
+    local function flash_callback()
+        e.window.setCursorPos(1, 1)
+
+        if flash_on then
+            if e.value == 2 then
+                e.window.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)
+            else
+                e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+            end
+        end
+
+        flash_on = not flash_on
+    end
+
+    -- on state change
+    ---@param new_state integer indicator state
+    function e.on_update(new_state)
+        local was_off = e.value ~= 2
+
+        e.value = new_state
+        e.window.setCursorPos(1, 1)
+
+        if args.flash then
+            if was_off and (new_state == 2) then
+                flash_on = true
+                flasher.start(flash_callback, args.period)
+            elseif new_state ~= 2 then
+                flash_on = false
+                flasher.stop(flash_callback)
+
+                if new_state == 3 then
+                    e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+                else
+                    e.window.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)
+        elseif new_state == 3 then
+            e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+        else
+            e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+        end
+    end
+
+    -- set indicator state
+    ---@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)
+
+    return e.get()
+end
+
+return alarm_indicator_light

graphics/elements/indicators/coremap.lua

@@ -0,0 +1,169 @@
+-- Reactor Core View Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class core_map_args
+---@field reactor_l integer reactor length
+---@field reactor_w integer reactor width
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+
+-- new core map box
+---@nodiscard
+---@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")
+
+    -- require max dimensions
+    args.width = 18
+    args.height = 18
+
+    -- inherit only foreground color
+    args.fg_bg = core.cpair(args.parent.get_fg_bg().fgd, colors.gray)
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    local alternator = true
+
+    local core_l = args.reactor_l - 2
+    local core_w = args.reactor_w - 2
+
+    local shift_x = 8 - math.floor(core_l / 2)
+    local shift_y = 8 - math.floor(core_w / 2)
+
+    local start_x = 2 + shift_x
+    local start_y = 2 + shift_y
+
+    local inner_width = core_l
+    local inner_height = core_w
+
+    -- create coordinate grid and frame
+    local function draw_frame()
+        e.window.setTextColor(colors.white)
+
+        for x = 0, (inner_width - 1) do
+            e.window.setCursorPos(x + start_x, 1)
+            e.window.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))
+        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)
+    end
+
+    -- draw the core
+    ---@param t number temperature in K
+    local function draw_core(t)
+        local i = 1
+        local back_c = "F"
+        local text_c    ---@type string
+
+        -- determine fuel assembly coloring
+        if t <= 300 then
+            -- gray
+            text_c = "8"
+        elseif t <= 350 then
+            -- blue
+            text_c = "3"
+        elseif t < 600 then
+            -- green
+            text_c = "D"
+        elseif t < 1000 then
+            -- yellow
+            text_c = "4"
+            -- back_c = "8"
+        elseif t < 1200 then
+            -- orange
+            text_c = "1"
+        elseif t < 1300 then
+            -- red
+            text_c = "E"
+        else
+            -- pink
+            text_c = "2"
+        end
+
+        -- draw 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
+                    i = i + 1
+                    e.window.blit("\x07", text_c, back_c)
+                else
+                    e.window.blit("\x07", "7", "8")
+                end
+
+                alternator = not alternator
+            end
+
+            if inner_width % 2 == 0 then alternator = not alternator end
+        end
+
+        -- reset alternator
+        alternator = true
+    end
+
+    -- on state change
+    ---@param temperature number temperature in Kelvin
+    function e.on_update(temperature)
+        e.value = temperature
+        draw_core(e.value)
+    end
+
+    -- set temperature to display
+    ---@param val number degrees K
+    function e.set_value(val) e.on_update(val) end
+
+    -- resize reactor dimensions
+    ---@param reactor_l integer reactor length (rendered in 2D top-down as width)
+    ---@param reactor_w integer reactor width (rendered in 2D top-down as height)
+    function e.resize(reactor_l, reactor_w)
+        -- enforce possible dimensions
+        if reactor_l > 18 then reactor_l = 18 elseif reactor_l < 3 then reactor_l = 3 end
+        if reactor_w > 18 then reactor_w = 18 elseif reactor_w < 3 then reactor_w = 3 end
+
+        -- update dimensions
+        core_l = reactor_l - 2
+        core_w = reactor_w - 2
+        shift_x = 8 - math.floor(core_l / 2)
+        shift_y = 8 - math.floor(core_w / 2)
+        start_x = 2 + shift_x
+        start_y = 2 + shift_y
+        inner_width = core_l
+        inner_height = core_w
+
+        e.window.clear()
+
+        -- re-draw
+        draw_frame()
+        e.on_update(e.value)
+    end
+
+    -- initial (one-time except for resize()) frame draw
+    draw_frame()
+
+    -- initial draw
+    e.on_update(0)
+
+    return e.get()
+end
+
+return core_map

graphics/elements/indicators/data.lua

@@ -0,0 +1,93 @@
+-- Data Indicator Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class data_indicator_args
+---@field label string indicator label
+---@field unit? string indicator unit
+---@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 parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width integer length
+---@field fg_bg? cpair foreground/background colors
+
+-- new data indicator
+---@nodiscard
+---@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")
+
+    -- 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)
+
+    local label_len = string.len(args.label)
+    local data_start = 1
+    local clear_width = args.width
+
+    if label_len > 0 then
+        data_start = data_start + (label_len + 1)
+        clear_width = args.width - (label_len + 1)
+    end
+
+    -- on state change
+    ---@param value any new value
+    function e.on_update(value)
+        e.value = value
+
+        -- clear old data and label
+        e.window.setCursorPos(data_start, 1)
+        e.window.write(util.spaces(clear_width))
+
+        -- write data
+        local data_str = util.sprintf(args.format, value)
+        e.window.setCursorPos(data_start, 1)
+        e.window.setTextColor(e.fg_bg.fgd)
+        if args.commas then
+            e.window.write(util.comma_format(data_str))
+        else
+            e.window.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)
+            end
+            e.window.write(" " .. args.unit)
+        end
+    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)
+
+    return e.get()
+end
+
+return data

graphics/elements/indicators/hbar.lua

@@ -0,0 +1,125 @@
+-- Horizontal Bar Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class hbar_args
+---@field show_percent? boolean whether or not to show the percent
+---@field bar_fg_bg? cpair bar foreground/background colors if showing percent
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new horizontal bar
+---@nodiscard
+---@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)
+
+    -- 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")
+
+    -- determine bar colors
+    local bar_bkg = e.fg_bg.blit_bkg
+    local bar_fgd = e.fg_bg.blit_fgd
+    if args.bar_fg_bg ~= nil then
+        bar_bkg = args.bar_fg_bg.blit_bkg
+        bar_fgd = args.bar_fg_bg.blit_fgd
+    end
+
+    -- handle data changes
+    ---@param fraction number 0.0 to 1.0
+    function e.on_update(fraction)
+        e.value = fraction
+
+        -- enforce minimum and maximum
+        if fraction < 0 then
+            fraction = 0.0
+        elseif fraction > 1 then
+            fraction = 1.0
+        end
+
+        -- compute number of bars
+        local num_bars = util.round(fraction * (bar_width * 2))
+
+        -- redraw bar if changed
+        if num_bars ~= last_num_bars then
+            last_num_bars = num_bars
+
+            local fgd = ""
+            local bkg = ""
+            local spaces = ""
+
+            -- fill percentage
+            for _ = 1, num_bars / 2 do
+                spaces = spaces .. " "
+                fgd = fgd .. bar_fgd
+                bkg = bkg .. bar_bkg
+            end
+
+            -- add fractional bar if needed
+            if num_bars % 2 == 1 then
+                spaces = spaces .. "\x95"
+                fgd = fgd .. bar_bkg
+                bkg = bkg .. bar_fgd
+            end
+
+            -- pad background
+            for _ = 1, ((bar_width * 2) - num_bars) / 2 do
+                spaces = spaces .. " "
+                fgd = fgd .. bar_bkg
+                bkg = bkg .. bar_bkg
+            end
+
+            -- draw bar
+            for y = 1, e.frame.h do
+                e.window.setCursorPos(1, y)
+                -- intentionally swapped fgd/bkg since we use spaces as fill, but they are the opposite
+                e.window.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))
+        end
+    end
+
+    -- change bar color
+    ---@param bar_fg_bg cpair new bar colors
+    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
+    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)
+
+    return e.get()
+end
+
+return hbar

graphics/elements/indicators/icon.lua

@@ -0,0 +1,74 @@
+-- Icon Indicator Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class icon_sym_color
+---@field color cpair
+---@field symbol string
+
+---@class icon_indicator_args
+---@field label string indicator label
+---@field states table state color and symbol table
+---@field value? integer default state, defaults to 1
+---@field min_label_width? integer label length if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new icon indicator
+---@nodiscard
+---@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")
+
+    -- 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)
+
+    -- state blit strings
+    local state_blit_cmds = {}
+    for i = 1, #args.states do
+        local sym_color = args.states[i]    ---@type icon_sym_color
+
+        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)
+        })
+    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)
+    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)
+
+    return e.get()
+end
+
+return icon

graphics/elements/indicators/led.lua

@@ -0,0 +1,100 @@
+-- Indicator "LED" Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+local flasher = require("graphics.flasher")
+
+---@class indicator_led_args
+---@field label string indicator label
+---@field colors cpair on/off colors (a/b respectively)
+---@field min_label_width? integer label length if omitted
+---@field flash? boolean whether to flash on true rather than stay on
+---@field period? PERIOD flash period
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new indicator LED
+---@nodiscard
+---@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")
+
+    if args.flash then
+        assert(util.is_int(args.period), "graphics.elements.indicators.led: 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)
+
+    -- called by flasher when enabled
+    local function flash_callback()
+        e.window.setCursorPos(1, 1)
+
+        if flash_on then
+            e.window.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)
+        end
+
+        flash_on = not flash_on
+    end
+
+    -- enable light or start flashing
+    local function enable()
+        if args.flash then
+            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)
+        end
+    end
+
+    -- disable light or stop flashing
+    local function disable()
+        if args.flash then
+            flash_on = false
+            flasher.stop(flash_callback)
+        end
+
+        e.window.setCursorPos(1, 1)
+        e.window.blit("\x8c", args.colors.blit_b, e.fg_bg.blit_bkg)
+    end
+
+    -- on state change
+    ---@param new_state boolean indicator state
+    function e.on_update(new_state)
+        e.value = new_state
+        if new_state then enable() else disable() end
+    end
+
+    -- set indicator state
+    ---@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)
+    end
+
+    return e.get()
+end
+
+return indicator_led

graphics/elements/indicators/ledpair.lua

@@ -0,0 +1,114 @@
+-- Indicator LED Pair Graphics Element (two LEDs provide: off, color_a, color_b)
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+local flasher = require("graphics.flasher")
+
+---@class indicator_led_pair_args
+---@field label string indicator label
+---@field off color color for off
+---@field c1 color color for #1 on
+---@field c2 color color for #2 on
+---@field min_label_width? integer label length if omitted
+---@field flash? boolean whether to flash when on rather than stay on
+---@field period? PERIOD flash period
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new dual LED indicator light
+---@nodiscard
+---@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")
+
+    if args.flash then
+        assert(util.is_int(args.period), "graphics.elements.indicators.ledpair: 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)
+
+    -- 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)
+
+        if flash_on then
+            if e.value == 2 then
+                e.window.blit("\x8c", c1, e.fg_bg.blit_bkg)
+            elseif e.value == 3 then
+                e.window.blit("\x8c", c2, e.fg_bg.blit_bkg)
+            end
+        else
+            e.window.blit("\x8c", co, e.fg_bg.blit_bkg)
+        end
+
+        flash_on = not flash_on
+    end
+
+    -- on state change
+    ---@param new_state integer indicator state
+    function e.on_update(new_state)
+        local was_off = e.value <= 1
+
+        e.value = new_state
+        e.window.setCursorPos(1, 1)
+
+        if args.flash then
+            if was_off and (new_state > 1) then
+                flash_on = true
+                flasher.start(flash_callback, args.period)
+            elseif new_state <= 1 then
+                flash_on = false
+                flasher.stop(flash_callback)
+
+                e.window.blit("\x8c", co, e.fg_bg.blit_bkg)
+            end
+        elseif new_state == 2 then
+            e.window.blit("\x8c", c1, e.fg_bg.blit_bkg)
+        elseif new_state == 3 then
+            e.window.blit("\x8c", c2, e.fg_bg.blit_bkg)
+        else
+            e.window.blit("\x8c", co, e.fg_bg.blit_bkg)
+        end
+    end
+
+    -- set indicator state
+    ---@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)
+    end
+
+    return e.get()
+end
+
+return indicator_led_pair

graphics/elements/indicators/ledrgb.lua

@@ -0,0 +1,59 @@
+-- Indicator RGB LED Graphics Element
+
+local element = require("graphics.element")
+
+---@class indicator_led_rgb_args
+---@field label string indicator label
+---@field colors table colors to use
+---@field min_label_width? integer label length if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new RGB LED indicator light
+---@nodiscard
+---@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")
+
+    -- 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)
+        if type(args.colors[new_state]) == "number" then
+            e.window.blit("\x8c", colors.toBlit(args.colors[new_state]), e.fg_bg.blit_bkg)
+        end
+    end
+
+    -- set indicator state
+    ---@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)
+    end
+
+    return e.get()
+end
+
+return indicator_led_rgb

graphics/elements/indicators/light.lua

@@ -0,0 +1,98 @@
+-- Indicator Light Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+local flasher = require("graphics.flasher")
+
+---@class indicator_light_args
+---@field label string indicator label
+---@field colors cpair on/off colors (a/b respectively)
+---@field min_label_width? integer label length if omitted
+---@field flash? boolean whether to flash on true rather than stay on
+---@field period? PERIOD flash period
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new indicator light
+---@nodiscard
+---@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")
+
+    if args.flash then
+        assert(util.is_int(args.period), "graphics.elements.indicators.light: 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)
+
+    -- called by flasher when enabled
+    local function flash_callback()
+        e.window.setCursorPos(1, 1)
+
+        if flash_on then
+            e.window.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)
+        end
+
+        flash_on = not flash_on
+    end
+
+    -- enable light or start flashing
+    local function enable()
+        if args.flash then
+            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)
+        end
+    end
+
+    -- disable light or stop flashing
+    local function disable()
+        if args.flash then
+            flash_on = false
+            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)
+    end
+
+    -- on state change
+    ---@param new_state boolean indicator state
+    function e.on_update(new_state)
+        e.value = new_state
+        if new_state then enable() else disable() end
+    end
+
+    -- set indicator state
+    ---@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)
+
+    return e.get()
+end
+
+return indicator_light

graphics/elements/indicators/power.lua

@@ -0,0 +1,85 @@
+-- Power Indicator Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class power_indicator_args
+---@field label string indicator label
+---@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 parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width integer length
+---@field fg_bg? cpair foreground/background colors
+
+-- new power indicator
+---@nodiscard
+---@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")
+
+    -- 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)
+
+    local data_start = string.len(args.label) + 2
+    if string.len(args.label) == 0 then data_start = 1 end
+
+    -- on state change
+    ---@param value any new value
+    function e.on_update(value)
+        e.value = value
+
+        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))
+
+        -- write unit
+        if args.lu_colors ~= nil then
+            e.window.setTextColor(args.lu_colors.color_b)
+        end
+
+        -- append per tick if rate is set
+        -- add space to FE so we don't end up with FEE (after having kFE for example)
+        if args.rate == true then
+            unit = unit .. "/t"
+            if unit == "FE/t" then unit = "FE/t " end
+        else
+            if unit == "FE" then unit = "FE " end
+        end
+
+        e.window.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)
+
+    return e.get()
+end
+
+return power

graphics/elements/indicators/rad.lua

@@ -0,0 +1,90 @@
+-- Radiation Indicator Graphics Element
+
+local types   = require("scada-common.types")
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class rad_indicator_args
+---@field label string indicator label
+---@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 parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width integer length
+---@field fg_bg? cpair foreground/background colors
+
+-- new radiation indicator
+---@nodiscard
+---@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")
+
+    -- 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)
+
+    local label_len = string.len(args.label)
+    local data_start = 1
+    local clear_width = args.width
+
+    if label_len > 0 then
+        data_start = data_start + (label_len + 1)
+        clear_width = args.width - (label_len + 1)
+    end
+
+    -- on state change
+    ---@param value any new value
+    function e.on_update(value)
+        e.value = value.radiation
+
+        -- clear old data and label
+        e.window.setCursorPos(data_start, 1)
+        e.window.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)
+        if args.commas then
+            e.window.write(util.comma_format(data_str))
+        else
+            e.window.write(data_str)
+        end
+
+        -- write unit
+        if args.lu_colors ~= nil then
+            e.window.setTextColor(args.lu_colors.color_b)
+        end
+        e.window.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())
+
+    return e.get()
+end
+
+return rad

graphics/elements/indicators/state.lua

@@ -0,0 +1,80 @@
+-- State (Text) Indicator Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class state_text_color
+---@field color cpair
+---@field text string
+
+---@class state_indicator_args
+---@field states table state color and text table
+---@field value? integer default state, defaults to 1
+---@field min_width? integer max state text length if omitted
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field height? integer 1 if omitted, must be an odd number
+---@field fg_bg? cpair foreground/background colors
+
+-- new state indicator
+---@nodiscard
+---@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")
+
+    -- 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
+
+    -- initial guess at width
+    args.width = args.min_width or 1
+
+    -- state blit strings
+    local state_blit_cmds = {}
+    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
+
+        local text = util.pad(state_def.text, args.width)
+
+        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))
+        })
+    end
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- 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)
+    end
+
+    -- set indicator state
+    ---@param val integer indicator state
+    function e.set_value(val) e.on_update(val) end
+
+    -- initial draw
+    e.on_update(args.value or 1)
+
+    return e.get()
+end
+
+return state_indicator

graphics/elements/indicators/trilight.lua

@@ -0,0 +1,111 @@
+-- Tri-State Indicator Light Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+local flasher = require("graphics.flasher")
+
+---@class tristate_indicator_light_args
+---@field label string indicator label
+---@field c1 color color for state 1
+---@field c2 color color for state 2
+---@field c3 color color for state 3
+---@field min_label_width? integer label length if omitted
+---@field flash? boolean whether to flash on state 2 or 3 rather than stay on
+---@field period? PERIOD flash period
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field fg_bg? cpair foreground/background colors
+
+-- new tri-state indicator light
+---@nodiscard
+---@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")
+
+    if args.flash then
+        assert(util.is_int(args.period), "graphics.elements.indicators.trilight: 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
+
+    -- called by flasher when enabled
+    local function flash_callback()
+        e.window.setCursorPos(1, 1)
+
+        if flash_on then
+            if e.value == 2 then
+                e.window.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)
+            end
+        else
+            e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+        end
+
+        flash_on = not flash_on
+    end
+
+    -- on state change
+    ---@param new_state integer indicator state
+    function e.on_update(new_state)
+        local was_off = e.value <= 1
+
+        e.value = new_state
+        e.window.setCursorPos(1, 1)
+
+        if args.flash then
+            if was_off and (new_state > 1) then
+                flash_on = true
+                flasher.start(flash_callback, args.period)
+            elseif new_state <= 1 then
+                flash_on = false
+                flasher.stop(flash_callback)
+
+                e.window.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)
+        elseif new_state == 3 then
+            e.window.blit(" \x95", "0" .. c3, c3 .. e.fg_bg.blit_bkg)
+        else
+            e.window.blit(" \x95", "0" .. c1, c1 .. e.fg_bg.blit_bkg)
+        end
+    end
+
+    -- set indicator state
+    ---@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)
+
+    return e.get()
+end
+
+return tristate_indicator_light

graphics/elements/indicators/vbar.lua

@@ -0,0 +1,105 @@
+-- Vertical Bar Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class vbar_args
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new vertical bar
+---@nodiscard
+---@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)
+    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)
+
+    -- handle data changes
+    ---@param fraction number 0.0 to 1.0
+    function e.on_update(fraction)
+        e.value = fraction
+
+        -- enforce minimum and maximum
+        if fraction < 0 then
+            fraction = 0.0
+        elseif fraction > 1 then
+            fraction = 1.0
+        end
+
+        -- compute number of bars
+        local num_bars = util.round(fraction * (e.frame.h * 3))
+
+        -- redraw only if number of bars has changed
+        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)
+
+            -- fill percentage
+            for _ = 1, num_bars / 3 do
+                e.window.blit(spaces, bkg, fgd)
+                y = y - 1
+                e.window.setCursorPos(1, y)
+            end
+
+            -- add fractional bar if needed
+            if num_bars % 3 == 1 then
+                e.window.blit(one_third, bkg, fgd)
+                y = y - 1
+            elseif num_bars % 3 == 2 then
+                e.window.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)
+                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
+
+    return e.get()
+end
+
+return vbar

graphics/elements/multipane.lua

@@ -0,0 +1,42 @@
+-- Multi-Pane Display Graphics Element
+
+local element = require("graphics.element")
+
+---@class multipane_args
+---@field panes table panes to swap between
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new multipane element
+---@nodiscard
+---@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")
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- 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()
+        end
+    end
+
+    e.set_value(1)
+
+    return e.get()
+end
+
+return multipane

graphics/elements/pipenet.lua

@@ -0,0 +1,147 @@
+-- Pipe Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+---@class pipenet_args
+---@field pipes table pipe list
+---@field bg? color background color
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+
+-- new pipe network
+---@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")
+
+    args.width = 0
+    args.height = 0
+
+    -- determine width/height
+    for i = 1, #args.pipes do
+        local pipe = args.pipes[i]  ---@type pipe
+
+        local true_w = pipe.w + math.min(pipe.x1, pipe.x2)
+        local true_h = pipe.h + math.min(pipe.y1, pipe.y2)
+
+        if true_w > args.width  then args.width  = true_w end
+        if true_h > args.height then args.height = true_h end
+    end
+
+    args.x = args.x or 1
+    args.y = args.y or 1
+
+    if args.bg ~= nil then
+        args.fg_bg = core.cpair(args.bg, args.bg)
+    end
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- draw all pipes
+    for p = 1, #args.pipes do
+        local pipe = args.pipes[p]  ---@type pipe
+
+        local x = 1 + pipe.x1
+        local y = 1 + pipe.y1
+
+        local x_step = util.trinary(pipe.x1 >= pipe.x2, -1, 1)
+        local y_step = util.trinary(pipe.y1 >= pipe.y2, -1, 1)
+
+        e.window.setCursorPos(x, y)
+
+        local c = core.cpair(pipe.color, e.fg_bg.bkg)
+
+        if pipe.align_tr then
+            -- cross width then height
+            for i = 1, pipe.w do
+                if pipe.thin then
+                    if i == pipe.w then
+                        -- corner
+                        if y_step > 0 then
+                            e.window.blit("\x93", c.blit_bkg, c.blit_fgd)
+                        else
+                            e.window.blit("\x8e", c.blit_fgd, c.blit_bkg)
+                        end
+                    else
+                        e.window.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)
+                    else
+                        e.window.blit("\x8f", c.blit_fgd, c.blit_bkg)
+                    end
+                end
+
+                x = x + x_step
+                e.window.setCursorPos(x, y)
+            end
+
+            -- back up one
+            x = x - x_step
+
+            for _ = 1, pipe.h - 1 do
+                y = y + y_step
+                e.window.setCursorPos(x, y)
+
+                if pipe.thin then
+                    e.window.blit("\x95", c.blit_bkg, c.blit_fgd)
+                else
+                    e.window.blit(" ", c.blit_bkg, c.blit_fgd)
+                end
+            end
+        else
+            -- cross height then width
+            for i = 1, pipe.h do
+                if pipe.thin then
+                    if i == pipe.h then
+                        -- corner
+                        if y_step < 0 then
+                            e.window.blit("\x97", c.blit_bkg, c.blit_fgd)
+                        else
+                            e.window.blit("\x8d", c.blit_fgd, c.blit_bkg)
+                        end
+                    else
+                        e.window.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)
+                    else
+                        e.window.blit(" ", c.blit_bkg, c.blit_fgd)
+                    end
+                end
+
+                y = y + y_step
+                e.window.setCursorPos(x, y)
+            end
+
+            -- back up one
+            y = y - y_step
+
+            for _ = 1, pipe.w - 1 do
+                x = x + x_step
+                e.window.setCursorPos(x, y)
+
+                if pipe.thin then
+                    e.window.blit("\x8c", c.blit_fgd, c.blit_bkg)
+                else
+                    e.window.blit("\x83", c.blit_bkg, c.blit_fgd)
+                end
+            end
+        end
+
+    end
+
+    return e.get()
+end
+
+return pipenet

graphics/elements/rectangle.lua

@@ -0,0 +1,183 @@
+-- Rectangle Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class rectangle_args
+---@field border? graphics_border
+---@field thin? boolean true to use extra thin even borders
+---@field even_inner? boolean true to make the inner area of a border even
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new rectangle
+---@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")
+
+    -- if thin, then width will always need to be 1
+    if args.thin == true then
+        args.border.width = 1
+        args.border.even = true
+    end
+
+    -- offset children
+    if args.border ~= nil then
+        args.offset_x = args.border.width
+        args.offset_y = args.border.width
+
+        -- slightly different y offset if the border is set to even
+        if args.border.even then
+            local width_x2 = (2 * args.border.width)
+            args.offset_y = math.floor(width_x2 / 3) + util.trinary(width_x2 % 3 > 0, 1, 0)
+        end
+    end
+
+    -- create new graphics element base object
+    local e = element.new(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)
+
+        local border_width = args.offset_x
+        local border_height = args.offset_y
+        local border_blit = colors.toBlit(args.border.color)
+        local width_x2 = border_width * 2
+        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")
+
+        -- 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_sides = blit_fg
+        local blit_bg_sides = ""
+        local blit_bg_top_bot = util.strrep(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"
+            else
+                p_a = "\x97" .. util.strrep("\x83", inner_width) .. "\x94"
+                p_b = "\x8a" .. util.strrep("\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)
+            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)
+            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)
+
+        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)
+
+            blit_fg_sides = border_blit .. util.strrep(e.fg_bg.blit_bkg, inner_width) .. e.fg_bg.blit_bkg
+        end
+
+        -- form the body blit strings (sides are border, inside is normal)
+        for x = 1, e.frame.w do
+            -- edges get border color, center gets normal
+            if x <= border_width or x > (e.frame.w - border_width) then
+                if args.thin and x == 1 then
+                    blit_bg_sides = blit_bg_sides .. e.fg_bg.blit_bkg
+                else
+                    blit_bg_sides = blit_bg_sides .. border_blit
+                end
+            else
+                blit_bg_sides = blit_bg_sides .. e.fg_bg.blit_bkg
+            end
+        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)
+
+                        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)
+                        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)
+                        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
+            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)
+                end
+            end
+        end
+    end
+
+    return e.get()
+end
+
+return rectangle

graphics/elements/textbox.lua

@@ -0,0 +1,70 @@
+-- Text Box Graphics Element
+
+local util    = require("scada-common.util")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+local TEXT_ALIGN = core.TEXT_ALIGN
+
+---@class textbox_args
+---@field text string text to show
+---@field alignment? TEXT_ALIGN text alignment, left by default
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new text box
+---@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")
+
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    local alignment = args.alignment or TEXT_ALIGN.LEFT
+
+    -- draw textbox
+
+    local function display_text(text)
+        e.value = text
+
+        local lines = util.strwrap(text, e.frame.w)
+
+        for i = 1, #lines do
+            if i > e.frame.h then break end
+
+            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)
+            else
+                e.window.setCursorPos(1, i)
+            end
+
+            e.window.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)
+    end
+
+    return e.get()
+end
+
+return textbox

graphics/elements/tiling.lua

@@ -0,0 +1,87 @@
+-- "Basketweave" Tiling Graphics Element
+
+local util    = require("scada-common.util")
+
+local element = require("graphics.element")
+
+---@class tiling_args
+---@field fill_c cpair colors to fill with
+---@field even? boolean whether to account for rectangular pixels
+---@field border_c? color optional frame color
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+
+-- new tiling box
+---@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")
+
+    -- 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
+
+    local even = args.even == true
+
+    local start_x = 1
+    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
+
+        inner_width = math.floor((e.frame.w - 2 * util.trinary(even, 2, 1)) / util.trinary(even, 2, 1))
+        inner_height = e.frame.h - 2
+    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")
+
+    -- 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
+
+            alternator = not alternator
+        end
+
+        if inner_width % 2 == 0 then alternator = not alternator end
+    end
+
+    return e.get()
+end
+
+return tiling

graphics/events.lua

@@ -0,0 +1,161 @@
+--
+-- Graphics Events and Event Handlers
+--
+
+local util = require("scada-common.util")
+
+local events = {}
+
+---@enum CLICK_BUTTON
+events.CLICK_BUTTON = {
+    GENERIC = 0,
+    LEFT_BUTTON = 1,
+    RIGHT_BUTTON = 2,
+    MID_BUTTON = 3
+}
+
+---@enum CLICK_TYPE
+events.CLICK_TYPE = {
+    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
+}
+
+-- 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
+
+---@class mouse_interaction
+---@field monitor string
+---@field button CLICK_BUTTON
+---@field type CLICK_TYPE
+---@field initial coordinate_2d
+---@field current coordinate_2d
+
+local handler = {
+    -- left, right, middle button down tracking
+    button_down = {
+        _coord2d(0, 0),
+        _coord2d(0, 0),
+        _coord2d(0, 0)
+    }
+}
+
+-- create a new monitor touch mouse interaction event
+---@nodiscard
+---@param monitor string
+---@param x integer
+---@param y integer
+---@return mouse_interaction
+local function _monitor_touch(monitor, x, y)
+    return {
+        monitor = monitor,
+        button = events.CLICK_BUTTON.GENERIC,
+        type = events.CLICK_TYPE.TAP,
+        initial = _coord2d(x, y),
+        current = _coord2d(x, y)
+    }
+end
+
+-- create a new mouse button mouse interaction event
+---@nodiscard
+---@param button CLICK_BUTTON mouse button
+---@param type CLICK_TYPE click type
+---@param x1 integer initial x
+---@param y1 integer initial y
+---@param x2 integer current x
+---@param y2 integer current y
+---@return mouse_interaction
+local function _mouse_event(button, type, x1, y1, x2, y2)
+    return {
+        monitor = "terminal",
+        button = button,
+        type = type,
+        initial = _coord2d(x1, y1),
+        current = _coord2d(x2, y2)
+    }
+end
+
+-- create a new generic mouse interaction event
+---@nodiscard
+---@param type CLICK_TYPE
+---@param x integer
+---@param y integer
+---@return mouse_interaction
+function events.mouse_generic(type, x, y)
+    return {
+        monitor = "",
+        button = events.CLICK_BUTTON.GENERIC,
+        type = type,
+        initial = _coord2d(x, y),
+        current = _coord2d(x, y)
+    }
+end
+
+-- create a new transposed mouse interaction event using the event's monitor/button fields
+---@nodiscard
+---@param event mouse_interaction
+---@param elem_pos_x integer element's x position: new x = (event x - element x) + 1
+---@param elem_pos_y integer element's y position: new y = (event y - element y) + 1
+---@return mouse_interaction
+function events.mouse_transposed(event, elem_pos_x, elem_pos_y)
+    return {
+        monitor = event.monitor,
+        button = event.button,
+        type = event.type,
+        initial = _coord2d((event.initial.x - elem_pos_x) + 1, (event.initial.y - elem_pos_y) + 1),
+        current = _coord2d((event.current.x - elem_pos_x) + 1, (event.current.y - elem_pos_y) + 1)
+    }
+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
+
+-- create a new mouse event to pass onto graphics renderer<br>
+-- supports: mouse_click, mouse_up, mouse_drag, mouse_scroll, and monitor_touch
+---@param event_type os_event OS event to handle
+---@param opt integer|string button, scroll direction, or monitor for monitor touch
+---@param x integer x coordinate
+---@param y integer y coordinate
+---@return mouse_interaction|nil
+function events.new_mouse_event(event_type, opt, x, y)
+    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)
+    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)
+    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)
+    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)
+    end
+end
+
+-- create a new key 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)
+    if event_type == "char" then
+    elseif event_type == "key" then
+    elseif event_type == "key_up" then
+    end
+end
+
+return events

graphics/flasher.lua

@@ -0,0 +1,80 @@
+--
+-- Indicator Light Flasher
+--
+
+local tcd = require("scada-common.tcallbackdsp")
+
+local flasher = {}
+
+-- note: no additional call needs to be made in a main loop as this class automatically uses the TCD to operate
+
+---@alias PERIOD integer
+local PERIOD = {
+    BLINK_250_MS = 1,
+    BLINK_500_MS = 2,
+    BLINK_1000_MS = 3
+}
+
+flasher.PERIOD = PERIOD
+
+local active = false
+local registry = { {}, {}, {} } -- one registry table per period
+local callback_counter = 0
+
+-- blink registered indicators<br>
+-- this assumes it is called every 250ms, it does no checking of time on its own
+local function callback_250ms()
+    if active then
+        for _, f in ipairs(registry[PERIOD.BLINK_250_MS]) do f() end
+
+        if callback_counter % 2 == 0 then
+            for _, f in ipairs(registry[PERIOD.BLINK_500_MS]) do f() end
+        end
+
+        if callback_counter % 4 == 0 then
+            for _, f in ipairs(registry[PERIOD.BLINK_1000_MS]) do f() end
+        end
+
+        callback_counter = callback_counter + 1
+
+        tcd.dispatch_unique(0.25, callback_250ms)
+    end
+end
+
+-- start/resume the flasher periodic
+function flasher.run()
+    active = true
+    callback_250ms()
+end
+
+-- clear all blinking indicators and stop the flasher periodic
+function flasher.clear()
+    active = false
+    callback_counter = 0
+    registry = { {}, {}, {} }
+end
+
+-- register a function to be called on the selected blink period<br>
+-- times are not strictly enforced, but all with a given period will be set at the same time
+---@param f function function to call each period
+---@param period PERIOD time period option (1, 2, or 3)
+function flasher.start(f, period)
+    if type(registry[period]) == "table" then
+        table.insert(registry[period], f)
+    end
+end
+
+-- stop a function from being called at the blink period
+---@param f function function callback registered
+function flasher.stop(f)
+    for i = 1, #registry do
+        for key, val in ipairs(registry[i]) do
+            if val == f then
+                table.remove(registry[i], key)
+                return
+            end
+        end
+    end
+end
+
+return flasher

imgen.py

@@ -0,0 +1,130 @@
+import json
+import os
+import sys
+
+# list files in a directory
+def list_files(path):
+    list = []
+
+    for (root, dirs, files) in os.walk(path):
+        for f in files:
+            list.append((root[2:] + "/" + f).replace('\\','/'))
+
+    return list
+
+# get size of all files in a directory
+def dir_size(path):
+    total = 0
+
+    for (root, dirs, files) in os.walk(path):
+        for f in files:
+            total += os.path.getsize(root + "/" + f)
+
+    return total
+
+# get the version of an application at the provided path
+def get_version(path, is_comms = False):
+    ver = ""
+    string = "comms.version = \""
+
+    if not is_comms:
+        string = "_VERSION = \""
+
+    f = open(path, "r")
+
+    for line in f:
+        pos = line.find(string)
+        if pos >= 0:
+            ver = line[(pos + len(string)):(len(line) - 2)]
+            break
+
+    f.close()
+
+    return ver
+
+# generate installation manifest object
+def make_manifest(size):
+    manifest = {
+        "versions" : {
+            "installer" : get_version("./ccmsi.lua"),
+            "bootloader" : get_version("./startup.lua"),
+            "comms" : get_version("./scada-common/comms.lua", True),
+            "reactor-plc" : get_version("./reactor-plc/startup.lua"),
+            "rtu" : get_version("./rtu/startup.lua"),
+            "supervisor" : get_version("./supervisor/startup.lua"),
+            "coordinator" : get_version("./coordinator/startup.lua"),
+            "pocket" : get_version("./pocket/startup.lua")
+        },
+        "files" : {
+            # common files
+            "system" : [ "initenv.lua", "startup.lua" ],
+            "common" : list_files("./scada-common"),
+            "graphics" : list_files("./graphics"),
+            "lockbox" : list_files("./lockbox"),
+            # platform files
+            "reactor-plc" : list_files("./reactor-plc"),
+            "rtu" : list_files("./rtu"),
+            "supervisor" : list_files("./supervisor"),
+            "coordinator" : list_files("./coordinator"),
+            "pocket" : list_files("./pocket"),
+        },
+        "depends" : {
+            "reactor-plc" : [ "system", "common", "graphics" ],
+            "rtu" : [ "system", "common", "graphics" ],
+            "supervisor" : [ "system", "common" ],
+            "coordinator" : [ "system", "common", "graphics" ],
+            "pocket" : [ "system", "common", "graphics" ]
+        },
+        "sizes" : {
+            # manifest file estimate
+            "manifest" : size,
+            # common files
+            "system" : os.path.getsize("initenv.lua") + os.path.getsize("startup.lua"),
+            "common" : dir_size("./scada-common"),
+            "graphics" : dir_size("./graphics"),
+            "lockbox" : dir_size("./lockbox"),
+            # platform files
+            "reactor-plc" : dir_size("./reactor-plc"),
+            "rtu" : dir_size("./rtu"),
+            "supervisor" : dir_size("./supervisor"),
+            "coordinator" : dir_size("./coordinator"),
+            "pocket" : dir_size("./pocket"),
+        }
+    }
+
+    return manifest
+
+# write initial manifest with placeholder size
+f = open("install_manifest.json", "w")
+json.dump(make_manifest("-----"), f)
+f.close()
+
+manifest_size = os.path.getsize("install_manifest.json")
+
+final_manifest = make_manifest(manifest_size)
+
+# calculate file size then regenerate with embedded size
+f = open("install_manifest.json", "w")
+json.dump(final_manifest, f)
+f.close()
+
+if len(sys.argv) > 1 and sys.argv[1] == "shields":
+    # write all the JSON files for shields.io
+    for key, version in final_manifest["versions"].items():
+        f = open("./shields/" + key + ".json", "w")
+
+        if version.find("alpha") >= 0:
+            color = "yellow"
+        elif version.find("beta") >= 0:
+            color = "orange"
+        else:
+            color = "blue"
+
+        json.dump({
+            "schemaVersion": 1,
+            "label": key,
+            "message": "" + version,
+            "color": color
+        }, f)
+
+        f.close()

initenv.lua

@@ -2,17 +2,17 @@
 -- Initialize the Post-Boot Module Environment
 --
 
--- initialize booted environment
-local init_env = function ()
-    local _require = require("cc.require")
-    local _env = setmetatable({}, { __index = _ENV })
+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, "/")
+        -- overwrite require/package globals
+        require, package = _require.make(_env, "/")
 
-    -- reset terminal
-    term.clear()
-    term.setCursorPos(1, 1)
-end
-
-return { init_env = init_env }
+        -- reset terminal
+        term.clear()
+        term.setCursorPos(1, 1)
+    end
+}

lockbox/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 James L.
+
+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, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

lockbox/cipher/aes128.lua

@@ -0,0 +1,415 @@
+local Array = require("lockbox.util.array");
+local Bit = require("lockbox.util.bit");
+
+local XOR = Bit.bxor;
+
+local SBOX = {
+ [0] = 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
+ 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
+ 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
+ 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
+ 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
+ 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
+ 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
+ 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
+ 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
+ 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
+ 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
+ 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
+ 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
+ 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
+ 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
+ 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16};
+
+local ISBOX = {
+ [0] = 0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38, 0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
+ 0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87, 0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
+ 0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D, 0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
+ 0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2, 0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
+ 0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
+ 0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA, 0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
+ 0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A, 0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
+ 0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02, 0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
+ 0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA, 0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
+ 0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85, 0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
+ 0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89, 0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
+ 0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20, 0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
+ 0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31, 0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
+ 0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D, 0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
+ 0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0, 0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
+ 0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26, 0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D};
+
+local ROW_SHIFT =  {  1,  6, 11, 16,  5, 10, 15,  4,  9, 14,  3,  8, 13,  2,  7, 12, };
+local IROW_SHIFT = {  1, 14, 11,  8,  5,  2, 15, 12,  9,  6,  3, 16, 13, 10,  7,  4, };
+
+local ETABLE = {
+ [0] = 0x01, 0x03, 0x05, 0x0F, 0x11, 0x33, 0x55, 0xFF, 0x1A, 0x2E, 0x72, 0x96, 0xA1, 0xF8, 0x13, 0x35,
+ 0x5F, 0xE1, 0x38, 0x48, 0xD8, 0x73, 0x95, 0xA4, 0xF7, 0x02, 0x06, 0x0A, 0x1E, 0x22, 0x66, 0xAA,
+ 0xE5, 0x34, 0x5C, 0xE4, 0x37, 0x59, 0xEB, 0x26, 0x6A, 0xBE, 0xD9, 0x70, 0x90, 0xAB, 0xE6, 0x31,
+ 0x53, 0xF5, 0x04, 0x0C, 0x14, 0x3C, 0x44, 0xCC, 0x4F, 0xD1, 0x68, 0xB8, 0xD3, 0x6E, 0xB2, 0xCD,
+ 0x4C, 0xD4, 0x67, 0xA9, 0xE0, 0x3B, 0x4D, 0xD7, 0x62, 0xA6, 0xF1, 0x08, 0x18, 0x28, 0x78, 0x88,
+ 0x83, 0x9E, 0xB9, 0xD0, 0x6B, 0xBD, 0xDC, 0x7F, 0x81, 0x98, 0xB3, 0xCE, 0x49, 0xDB, 0x76, 0x9A,
+ 0xB5, 0xC4, 0x57, 0xF9, 0x10, 0x30, 0x50, 0xF0, 0x0B, 0x1D, 0x27, 0x69, 0xBB, 0xD6, 0x61, 0xA3,
+ 0xFE, 0x19, 0x2B, 0x7D, 0x87, 0x92, 0xAD, 0xEC, 0x2F, 0x71, 0x93, 0xAE, 0xE9, 0x20, 0x60, 0xA0,
+ 0xFB, 0x16, 0x3A, 0x4E, 0xD2, 0x6D, 0xB7, 0xC2, 0x5D, 0xE7, 0x32, 0x56, 0xFA, 0x15, 0x3F, 0x41,
+ 0xC3, 0x5E, 0xE2, 0x3D, 0x47, 0xC9, 0x40, 0xC0, 0x5B, 0xED, 0x2C, 0x74, 0x9C, 0xBF, 0xDA, 0x75,
+ 0x9F, 0xBA, 0xD5, 0x64, 0xAC, 0xEF, 0x2A, 0x7E, 0x82, 0x9D, 0xBC, 0xDF, 0x7A, 0x8E, 0x89, 0x80,
+ 0x9B, 0xB6, 0xC1, 0x58, 0xE8, 0x23, 0x65, 0xAF, 0xEA, 0x25, 0x6F, 0xB1, 0xC8, 0x43, 0xC5, 0x54,
+ 0xFC, 0x1F, 0x21, 0x63, 0xA5, 0xF4, 0x07, 0x09, 0x1B, 0x2D, 0x77, 0x99, 0xB0, 0xCB, 0x46, 0xCA,
+ 0x45, 0xCF, 0x4A, 0xDE, 0x79, 0x8B, 0x86, 0x91, 0xA8, 0xE3, 0x3E, 0x42, 0xC6, 0x51, 0xF3, 0x0E,
+ 0x12, 0x36, 0x5A, 0xEE, 0x29, 0x7B, 0x8D, 0x8C, 0x8F, 0x8A, 0x85, 0x94, 0xA7, 0xF2, 0x0D, 0x17,
+ 0x39, 0x4B, 0xDD, 0x7C, 0x84, 0x97, 0xA2, 0xFD, 0x1C, 0x24, 0x6C, 0xB4, 0xC7, 0x52, 0xF6, 0x01};
+
+local LTABLE = {
+ [0] = 0x00, 0x00, 0x19, 0x01, 0x32, 0x02, 0x1A, 0xC6, 0x4B, 0xC7, 0x1B, 0x68, 0x33, 0xEE, 0xDF, 0x03,
+ 0x64, 0x04, 0xE0, 0x0E, 0x34, 0x8D, 0x81, 0xEF, 0x4C, 0x71, 0x08, 0xC8, 0xF8, 0x69, 0x1C, 0xC1,
+ 0x7D, 0xC2, 0x1D, 0xB5, 0xF9, 0xB9, 0x27, 0x6A, 0x4D, 0xE4, 0xA6, 0x72, 0x9A, 0xC9, 0x09, 0x78,
+ 0x65, 0x2F, 0x8A, 0x05, 0x21, 0x0F, 0xE1, 0x24, 0x12, 0xF0, 0x82, 0x45, 0x35, 0x93, 0xDA, 0x8E,
+ 0x96, 0x8F, 0xDB, 0xBD, 0x36, 0xD0, 0xCE, 0x94, 0x13, 0x5C, 0xD2, 0xF1, 0x40, 0x46, 0x83, 0x38,
+ 0x66, 0xDD, 0xFD, 0x30, 0xBF, 0x06, 0x8B, 0x62, 0xB3, 0x25, 0xE2, 0x98, 0x22, 0x88, 0x91, 0x10,
+ 0x7E, 0x6E, 0x48, 0xC3, 0xA3, 0xB6, 0x1E, 0x42, 0x3A, 0x6B, 0x28, 0x54, 0xFA, 0x85, 0x3D, 0xBA,
+ 0x2B, 0x79, 0x0A, 0x15, 0x9B, 0x9F, 0x5E, 0xCA, 0x4E, 0xD4, 0xAC, 0xE5, 0xF3, 0x73, 0xA7, 0x57,
+ 0xAF, 0x58, 0xA8, 0x50, 0xF4, 0xEA, 0xD6, 0x74, 0x4F, 0xAE, 0xE9, 0xD5, 0xE7, 0xE6, 0xAD, 0xE8,
+ 0x2C, 0xD7, 0x75, 0x7A, 0xEB, 0x16, 0x0B, 0xF5, 0x59, 0xCB, 0x5F, 0xB0, 0x9C, 0xA9, 0x51, 0xA0,
+ 0x7F, 0x0C, 0xF6, 0x6F, 0x17, 0xC4, 0x49, 0xEC, 0xD8, 0x43, 0x1F, 0x2D, 0xA4, 0x76, 0x7B, 0xB7,
+ 0xCC, 0xBB, 0x3E, 0x5A, 0xFB, 0x60, 0xB1, 0x86, 0x3B, 0x52, 0xA1, 0x6C, 0xAA, 0x55, 0x29, 0x9D,
+ 0x97, 0xB2, 0x87, 0x90, 0x61, 0xBE, 0xDC, 0xFC, 0xBC, 0x95, 0xCF, 0xCD, 0x37, 0x3F, 0x5B, 0xD1,
+ 0x53, 0x39, 0x84, 0x3C, 0x41, 0xA2, 0x6D, 0x47, 0x14, 0x2A, 0x9E, 0x5D, 0x56, 0xF2, 0xD3, 0xAB,
+ 0x44, 0x11, 0x92, 0xD9, 0x23, 0x20, 0x2E, 0x89, 0xB4, 0x7C, 0xB8, 0x26, 0x77, 0x99, 0xE3, 0xA5,
+ 0x67, 0x4A, 0xED, 0xDE, 0xC5, 0x31, 0xFE, 0x18, 0x0D, 0x63, 0x8C, 0x80, 0xC0, 0xF7, 0x70, 0x07};
+
+local MIXTABLE = {
+ 0x02, 0x03, 0x01, 0x01,
+ 0x01, 0x02, 0x03, 0x01,
+ 0x01, 0x01, 0x02, 0x03,
+ 0x03, 0x01, 0x01, 0x02};
+
+local IMIXTABLE = {
+ 0x0E, 0x0B, 0x0D, 0x09,
+ 0x09, 0x0E, 0x0B, 0x0D,
+ 0x0D, 0x09, 0x0E, 0x0B,
+ 0x0B, 0x0D, 0x09, 0x0E};
+
+local RCON = {
+[0] = 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a,
+0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39,
+0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a,
+0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8,
+0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef,
+0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc,
+0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b,
+0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3,
+0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94,
+0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20,
+0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35,
+0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f,
+0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04,
+0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63,
+0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd,
+0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d};
+
+
+local GMUL = function(A, B)
+    if(A == 0x01) then return B; end
+    if(B == 0x01) then return A; end
+    if(A == 0x00) then return 0; end
+    if(B == 0x00) then return 0; end
+
+    local LA = LTABLE[A];
+    local LB = LTABLE[B];
+
+    local sum = LA + LB;
+    if (sum > 0xFF) then sum = sum - 0xFF; end
+
+    return ETABLE[sum];
+end
+
+local byteSub = Array.substitute;
+
+local shiftRow = Array.permute;
+
+local mixCol = function(i, mix)
+    local out = {};
+
+    local a, b, c, d;
+
+    a = GMUL(i[ 1], mix[ 1]);
+    b = GMUL(i[ 2], mix[ 2]);
+    c = GMUL(i[ 3], mix[ 3]);
+    d = GMUL(i[ 4], mix[ 4]);
+    out[ 1] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[ 5]);
+    b = GMUL(i[ 2], mix[ 6]);
+    c = GMUL(i[ 3], mix[ 7]);
+    d = GMUL(i[ 4], mix[ 8]);
+    out[ 2] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[ 9]);
+    b = GMUL(i[ 2], mix[10]);
+    c = GMUL(i[ 3], mix[11]);
+    d = GMUL(i[ 4], mix[12]);
+    out[ 3] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[13]);
+    b = GMUL(i[ 2], mix[14]);
+    c = GMUL(i[ 3], mix[15]);
+    d = GMUL(i[ 4], mix[16]);
+    out[ 4] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[ 5], mix[ 1]);
+    b = GMUL(i[ 6], mix[ 2]);
+    c = GMUL(i[ 7], mix[ 3]);
+    d = GMUL(i[ 8], mix[ 4]);
+    out[ 5] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[ 5]);
+    b = GMUL(i[ 6], mix[ 6]);
+    c = GMUL(i[ 7], mix[ 7]);
+    d = GMUL(i[ 8], mix[ 8]);
+    out[ 6] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[ 9]);
+    b = GMUL(i[ 6], mix[10]);
+    c = GMUL(i[ 7], mix[11]);
+    d = GMUL(i[ 8], mix[12]);
+    out[ 7] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[13]);
+    b = GMUL(i[ 6], mix[14]);
+    c = GMUL(i[ 7], mix[15]);
+    d = GMUL(i[ 8], mix[16]);
+    out[ 8] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[ 9], mix[ 1]);
+    b = GMUL(i[10], mix[ 2]);
+    c = GMUL(i[11], mix[ 3]);
+    d = GMUL(i[12], mix[ 4]);
+    out[ 9] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[ 5]);
+    b = GMUL(i[10], mix[ 6]);
+    c = GMUL(i[11], mix[ 7]);
+    d = GMUL(i[12], mix[ 8]);
+    out[10] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[ 9]);
+    b = GMUL(i[10], mix[10]);
+    c = GMUL(i[11], mix[11]);
+    d = GMUL(i[12], mix[12]);
+    out[11] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[13]);
+    b = GMUL(i[10], mix[14]);
+    c = GMUL(i[11], mix[15]);
+    d = GMUL(i[12], mix[16]);
+    out[12] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[13], mix[ 1]);
+    b = GMUL(i[14], mix[ 2]);
+    c = GMUL(i[15], mix[ 3]);
+    d = GMUL(i[16], mix[ 4]);
+    out[13] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[ 5]);
+    b = GMUL(i[14], mix[ 6]);
+    c = GMUL(i[15], mix[ 7]);
+    d = GMUL(i[16], mix[ 8]);
+    out[14] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[ 9]);
+    b = GMUL(i[14], mix[10]);
+    c = GMUL(i[15], mix[11]);
+    d = GMUL(i[16], mix[12]);
+    out[15] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[13]);
+    b = GMUL(i[14], mix[14]);
+    c = GMUL(i[15], mix[15]);
+    d = GMUL(i[16], mix[16]);
+    out[16] = XOR(XOR(a, b), XOR(c, d));
+
+    return out;
+end
+
+local keyRound = function(key, round)
+    local out = {};
+
+    out[ 1] = XOR(key[ 1], XOR(SBOX[key[14]], RCON[round]));
+    out[ 2] = XOR(key[ 2], SBOX[key[15]]);
+    out[ 3] = XOR(key[ 3], SBOX[key[16]]);
+    out[ 4] = XOR(key[ 4], SBOX[key[13]]);
+
+    out[ 5] = XOR(out[ 1], key[ 5]);
+    out[ 6] = XOR(out[ 2], key[ 6]);
+    out[ 7] = XOR(out[ 3], key[ 7]);
+    out[ 8] = XOR(out[ 4], key[ 8]);
+
+    out[ 9] = XOR(out[ 5], key[ 9]);
+    out[10] = XOR(out[ 6], key[10]);
+    out[11] = XOR(out[ 7], key[11]);
+    out[12] = XOR(out[ 8], key[12]);
+
+    out[13] = XOR(out[ 9], key[13]);
+    out[14] = XOR(out[10], key[14]);
+    out[15] = XOR(out[11], key[15]);
+    out[16] = XOR(out[12], key[16]);
+
+    return out;
+end
+
+local keyExpand = function(key)
+    local keys = {};
+
+    local temp = key;
+
+    keys[1] = temp;
+
+    for i = 1, 10 do
+        temp = keyRound(temp, i);
+        keys[i + 1] = temp;
+    end
+
+    return keys;
+
+end
+
+local addKey = Array.XOR;
+
+
+
+local AES = {};
+
+AES.blockSize = 16;
+
+AES.encrypt = function(_key, block)
+
+    local key = keyExpand(_key);
+
+    --round 0
+    block = addKey(block, key[1]);
+
+    --round 1
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[2]);
+
+    --round 2
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[3]);
+
+    --round 3
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[4]);
+
+    --round 4
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[5]);
+
+    --round 5
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[6]);
+
+    --round 6
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[7]);
+
+    --round 7
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[8]);
+
+    --round 8
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[9]);
+
+    --round 9
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[10]);
+
+    --round 10
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = addKey(block, key[11]);
+
+    return block;
+
+end
+
+AES.decrypt = function(_key, block)
+
+    local key = keyExpand(_key);
+
+    --round 0
+    block = addKey(block, key[11]);
+
+    --round 1
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[10]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 2
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[9]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 3
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[8]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 4
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[7]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 5
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[6]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 6
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[5]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 7
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[4]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 8
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[3]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 9
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[2]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 10
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[1]);
+
+    return block;
+end
+
+return AES;

lockbox/cipher/aes192.lua

@@ -0,0 +1,462 @@
+
+local Array = require("lockbox.util.array");
+local Bit = require("lockbox.util.bit");
+
+local XOR = Bit.bxor;
+
+local SBOX = {
+ [0] = 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
+ 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
+ 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
+ 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
+ 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
+ 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
+ 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
+ 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
+ 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
+ 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
+ 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
+ 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
+ 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
+ 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
+ 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
+ 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16};
+
+local ISBOX = {
+ [0] = 0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38, 0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
+ 0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87, 0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
+ 0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D, 0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
+ 0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2, 0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
+ 0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
+ 0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA, 0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
+ 0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A, 0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
+ 0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02, 0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
+ 0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA, 0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
+ 0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85, 0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
+ 0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89, 0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
+ 0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20, 0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
+ 0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31, 0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
+ 0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D, 0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
+ 0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0, 0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
+ 0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26, 0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D};
+
+local ROW_SHIFT =  {  1,  6, 11, 16,  5, 10, 15,  4,  9, 14,  3,  8, 13,  2,  7, 12, };
+local IROW_SHIFT = {  1, 14, 11,  8,  5,  2, 15, 12,  9,  6,  3, 16, 13, 10,  7,  4, };
+
+local ETABLE = {
+ [0] = 0x01, 0x03, 0x05, 0x0F, 0x11, 0x33, 0x55, 0xFF, 0x1A, 0x2E, 0x72, 0x96, 0xA1, 0xF8, 0x13, 0x35,
+ 0x5F, 0xE1, 0x38, 0x48, 0xD8, 0x73, 0x95, 0xA4, 0xF7, 0x02, 0x06, 0x0A, 0x1E, 0x22, 0x66, 0xAA,
+ 0xE5, 0x34, 0x5C, 0xE4, 0x37, 0x59, 0xEB, 0x26, 0x6A, 0xBE, 0xD9, 0x70, 0x90, 0xAB, 0xE6, 0x31,
+ 0x53, 0xF5, 0x04, 0x0C, 0x14, 0x3C, 0x44, 0xCC, 0x4F, 0xD1, 0x68, 0xB8, 0xD3, 0x6E, 0xB2, 0xCD,
+ 0x4C, 0xD4, 0x67, 0xA9, 0xE0, 0x3B, 0x4D, 0xD7, 0x62, 0xA6, 0xF1, 0x08, 0x18, 0x28, 0x78, 0x88,
+ 0x83, 0x9E, 0xB9, 0xD0, 0x6B, 0xBD, 0xDC, 0x7F, 0x81, 0x98, 0xB3, 0xCE, 0x49, 0xDB, 0x76, 0x9A,
+ 0xB5, 0xC4, 0x57, 0xF9, 0x10, 0x30, 0x50, 0xF0, 0x0B, 0x1D, 0x27, 0x69, 0xBB, 0xD6, 0x61, 0xA3,
+ 0xFE, 0x19, 0x2B, 0x7D, 0x87, 0x92, 0xAD, 0xEC, 0x2F, 0x71, 0x93, 0xAE, 0xE9, 0x20, 0x60, 0xA0,
+ 0xFB, 0x16, 0x3A, 0x4E, 0xD2, 0x6D, 0xB7, 0xC2, 0x5D, 0xE7, 0x32, 0x56, 0xFA, 0x15, 0x3F, 0x41,
+ 0xC3, 0x5E, 0xE2, 0x3D, 0x47, 0xC9, 0x40, 0xC0, 0x5B, 0xED, 0x2C, 0x74, 0x9C, 0xBF, 0xDA, 0x75,
+ 0x9F, 0xBA, 0xD5, 0x64, 0xAC, 0xEF, 0x2A, 0x7E, 0x82, 0x9D, 0xBC, 0xDF, 0x7A, 0x8E, 0x89, 0x80,
+ 0x9B, 0xB6, 0xC1, 0x58, 0xE8, 0x23, 0x65, 0xAF, 0xEA, 0x25, 0x6F, 0xB1, 0xC8, 0x43, 0xC5, 0x54,
+ 0xFC, 0x1F, 0x21, 0x63, 0xA5, 0xF4, 0x07, 0x09, 0x1B, 0x2D, 0x77, 0x99, 0xB0, 0xCB, 0x46, 0xCA,
+ 0x45, 0xCF, 0x4A, 0xDE, 0x79, 0x8B, 0x86, 0x91, 0xA8, 0xE3, 0x3E, 0x42, 0xC6, 0x51, 0xF3, 0x0E,
+ 0x12, 0x36, 0x5A, 0xEE, 0x29, 0x7B, 0x8D, 0x8C, 0x8F, 0x8A, 0x85, 0x94, 0xA7, 0xF2, 0x0D, 0x17,
+ 0x39, 0x4B, 0xDD, 0x7C, 0x84, 0x97, 0xA2, 0xFD, 0x1C, 0x24, 0x6C, 0xB4, 0xC7, 0x52, 0xF6, 0x01};
+
+local LTABLE = {
+ [0] = 0x00, 0x00, 0x19, 0x01, 0x32, 0x02, 0x1A, 0xC6, 0x4B, 0xC7, 0x1B, 0x68, 0x33, 0xEE, 0xDF, 0x03,
+ 0x64, 0x04, 0xE0, 0x0E, 0x34, 0x8D, 0x81, 0xEF, 0x4C, 0x71, 0x08, 0xC8, 0xF8, 0x69, 0x1C, 0xC1,
+ 0x7D, 0xC2, 0x1D, 0xB5, 0xF9, 0xB9, 0x27, 0x6A, 0x4D, 0xE4, 0xA6, 0x72, 0x9A, 0xC9, 0x09, 0x78,
+ 0x65, 0x2F, 0x8A, 0x05, 0x21, 0x0F, 0xE1, 0x24, 0x12, 0xF0, 0x82, 0x45, 0x35, 0x93, 0xDA, 0x8E,
+ 0x96, 0x8F, 0xDB, 0xBD, 0x36, 0xD0, 0xCE, 0x94, 0x13, 0x5C, 0xD2, 0xF1, 0x40, 0x46, 0x83, 0x38,
+ 0x66, 0xDD, 0xFD, 0x30, 0xBF, 0x06, 0x8B, 0x62, 0xB3, 0x25, 0xE2, 0x98, 0x22, 0x88, 0x91, 0x10,
+ 0x7E, 0x6E, 0x48, 0xC3, 0xA3, 0xB6, 0x1E, 0x42, 0x3A, 0x6B, 0x28, 0x54, 0xFA, 0x85, 0x3D, 0xBA,
+ 0x2B, 0x79, 0x0A, 0x15, 0x9B, 0x9F, 0x5E, 0xCA, 0x4E, 0xD4, 0xAC, 0xE5, 0xF3, 0x73, 0xA7, 0x57,
+ 0xAF, 0x58, 0xA8, 0x50, 0xF4, 0xEA, 0xD6, 0x74, 0x4F, 0xAE, 0xE9, 0xD5, 0xE7, 0xE6, 0xAD, 0xE8,
+ 0x2C, 0xD7, 0x75, 0x7A, 0xEB, 0x16, 0x0B, 0xF5, 0x59, 0xCB, 0x5F, 0xB0, 0x9C, 0xA9, 0x51, 0xA0,
+ 0x7F, 0x0C, 0xF6, 0x6F, 0x17, 0xC4, 0x49, 0xEC, 0xD8, 0x43, 0x1F, 0x2D, 0xA4, 0x76, 0x7B, 0xB7,
+ 0xCC, 0xBB, 0x3E, 0x5A, 0xFB, 0x60, 0xB1, 0x86, 0x3B, 0x52, 0xA1, 0x6C, 0xAA, 0x55, 0x29, 0x9D,
+ 0x97, 0xB2, 0x87, 0x90, 0x61, 0xBE, 0xDC, 0xFC, 0xBC, 0x95, 0xCF, 0xCD, 0x37, 0x3F, 0x5B, 0xD1,
+ 0x53, 0x39, 0x84, 0x3C, 0x41, 0xA2, 0x6D, 0x47, 0x14, 0x2A, 0x9E, 0x5D, 0x56, 0xF2, 0xD3, 0xAB,
+ 0x44, 0x11, 0x92, 0xD9, 0x23, 0x20, 0x2E, 0x89, 0xB4, 0x7C, 0xB8, 0x26, 0x77, 0x99, 0xE3, 0xA5,
+ 0x67, 0x4A, 0xED, 0xDE, 0xC5, 0x31, 0xFE, 0x18, 0x0D, 0x63, 0x8C, 0x80, 0xC0, 0xF7, 0x70, 0x07};
+
+local MIXTABLE = {
+ 0x02, 0x03, 0x01, 0x01,
+ 0x01, 0x02, 0x03, 0x01,
+ 0x01, 0x01, 0x02, 0x03,
+ 0x03, 0x01, 0x01, 0x02};
+
+local IMIXTABLE = {
+ 0x0E, 0x0B, 0x0D, 0x09,
+ 0x09, 0x0E, 0x0B, 0x0D,
+ 0x0D, 0x09, 0x0E, 0x0B,
+ 0x0B, 0x0D, 0x09, 0x0E};
+
+local RCON = {
+[0] = 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a,
+0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39,
+0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a,
+0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8,
+0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef,
+0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc,
+0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b,
+0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3,
+0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94,
+0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20,
+0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35,
+0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f,
+0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04,
+0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63,
+0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd,
+0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d};
+
+
+local GMUL = function(A, B)
+    if(A == 0x01) then return B; end
+    if(B == 0x01) then return A; end
+    if(A == 0x00) then return 0; end
+    if(B == 0x00) then return 0; end
+
+    local LA = LTABLE[A];
+    local LB = LTABLE[B];
+
+    local sum = LA + LB;
+    if (sum > 0xFF) then sum = sum - 0xFF; end
+
+    return ETABLE[sum];
+end
+
+local byteSub = Array.substitute;
+
+local shiftRow = Array.permute;
+
+local mixCol = function(i, mix)
+    local out = {};
+
+    local a, b, c, d;
+
+    a = GMUL(i[ 1], mix[ 1]);
+    b = GMUL(i[ 2], mix[ 2]);
+    c = GMUL(i[ 3], mix[ 3]);
+    d = GMUL(i[ 4], mix[ 4]);
+    out[ 1] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[ 5]);
+    b = GMUL(i[ 2], mix[ 6]);
+    c = GMUL(i[ 3], mix[ 7]);
+    d = GMUL(i[ 4], mix[ 8]);
+    out[ 2] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[ 9]);
+    b = GMUL(i[ 2], mix[10]);
+    c = GMUL(i[ 3], mix[11]);
+    d = GMUL(i[ 4], mix[12]);
+    out[ 3] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[13]);
+    b = GMUL(i[ 2], mix[14]);
+    c = GMUL(i[ 3], mix[15]);
+    d = GMUL(i[ 4], mix[16]);
+    out[ 4] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[ 5], mix[ 1]);
+    b = GMUL(i[ 6], mix[ 2]);
+    c = GMUL(i[ 7], mix[ 3]);
+    d = GMUL(i[ 8], mix[ 4]);
+    out[ 5] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[ 5]);
+    b = GMUL(i[ 6], mix[ 6]);
+    c = GMUL(i[ 7], mix[ 7]);
+    d = GMUL(i[ 8], mix[ 8]);
+    out[ 6] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[ 9]);
+    b = GMUL(i[ 6], mix[10]);
+    c = GMUL(i[ 7], mix[11]);
+    d = GMUL(i[ 8], mix[12]);
+    out[ 7] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[13]);
+    b = GMUL(i[ 6], mix[14]);
+    c = GMUL(i[ 7], mix[15]);
+    d = GMUL(i[ 8], mix[16]);
+    out[ 8] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[ 9], mix[ 1]);
+    b = GMUL(i[10], mix[ 2]);
+    c = GMUL(i[11], mix[ 3]);
+    d = GMUL(i[12], mix[ 4]);
+    out[ 9] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[ 5]);
+    b = GMUL(i[10], mix[ 6]);
+    c = GMUL(i[11], mix[ 7]);
+    d = GMUL(i[12], mix[ 8]);
+    out[10] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[ 9]);
+    b = GMUL(i[10], mix[10]);
+    c = GMUL(i[11], mix[11]);
+    d = GMUL(i[12], mix[12]);
+    out[11] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[13]);
+    b = GMUL(i[10], mix[14]);
+    c = GMUL(i[11], mix[15]);
+    d = GMUL(i[12], mix[16]);
+    out[12] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[13], mix[ 1]);
+    b = GMUL(i[14], mix[ 2]);
+    c = GMUL(i[15], mix[ 3]);
+    d = GMUL(i[16], mix[ 4]);
+    out[13] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[ 5]);
+    b = GMUL(i[14], mix[ 6]);
+    c = GMUL(i[15], mix[ 7]);
+    d = GMUL(i[16], mix[ 8]);
+    out[14] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[ 9]);
+    b = GMUL(i[14], mix[10]);
+    c = GMUL(i[15], mix[11]);
+    d = GMUL(i[16], mix[12]);
+    out[15] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[13]);
+    b = GMUL(i[14], mix[14]);
+    c = GMUL(i[15], mix[15]);
+    d = GMUL(i[16], mix[16]);
+    out[16] = XOR(XOR(a, b), XOR(c, d));
+
+    return out;
+end
+
+local keyRound = function(key, round)
+    local i = (round - 1) * 24;
+    local out = key;
+
+    out[25 + i] = XOR(key[ 1 + i], XOR(SBOX[key[22 + i]], RCON[round]));
+    out[26 + i] = XOR(key[ 2 + i], SBOX[key[23 + i]]);
+    out[27 + i] = XOR(key[ 3 + i], SBOX[key[24 + i]]);
+    out[28 + i] = XOR(key[ 4 + i], SBOX[key[21 + i]]);
+
+    out[29 + i] = XOR(out[25 + i], key[ 5 + i]);
+    out[30 + i] = XOR(out[26 + i], key[ 6 + i]);
+    out[31 + i] = XOR(out[27 + i], key[ 7 + i]);
+    out[32 + i] = XOR(out[28 + i], key[ 8 + i]);
+
+    out[33 + i] = XOR(out[29 + i], key[ 9 + i]);
+    out[34 + i] = XOR(out[30 + i], key[10 + i]);
+    out[35 + i] = XOR(out[31 + i], key[11 + i]);
+    out[36 + i] = XOR(out[32 + i], key[12 + i]);
+
+    out[37 + i] = XOR(out[33 + i], key[13 + i]);
+    out[38 + i] = XOR(out[34 + i], key[14 + i]);
+    out[39 + i] = XOR(out[35 + i], key[15 + i]);
+    out[40 + i] = XOR(out[36 + i], key[16 + i]);
+
+    out[41 + i] = XOR(out[37 + i], key[17 + i]);
+    out[42 + i] = XOR(out[38 + i], key[18 + i]);
+    out[43 + i] = XOR(out[39 + i], key[19 + i]);
+    out[44 + i] = XOR(out[40 + i], key[20 + i]);
+
+    out[45 + i] = XOR(out[41 + i], key[21 + i]);
+    out[46 + i] = XOR(out[42 + i], key[22 + i]);
+    out[47 + i] = XOR(out[43 + i], key[23 + i]);
+    out[48 + i] = XOR(out[44 + i], key[24 + i]);
+
+    return out;
+end
+
+local keyExpand = function(key)
+    local bytes = Array.copy(key);
+
+    for i = 1, 8 do
+        keyRound(bytes, i);
+    end
+
+    local keys = {};
+
+    keys[ 1] = Array.slice(bytes, 1, 16);
+    keys[ 2] = Array.slice(bytes, 17, 32);
+    keys[ 3] = Array.slice(bytes, 33, 48);
+    keys[ 4] = Array.slice(bytes, 49, 64);
+    keys[ 5] = Array.slice(bytes, 65, 80);
+    keys[ 6] = Array.slice(bytes, 81, 96);
+    keys[ 7] = Array.slice(bytes, 97, 112);
+    keys[ 8] = Array.slice(bytes, 113, 128);
+    keys[ 9] = Array.slice(bytes, 129, 144);
+    keys[10] = Array.slice(bytes, 145, 160);
+    keys[11] = Array.slice(bytes, 161, 176);
+    keys[12] = Array.slice(bytes, 177, 192);
+    keys[13] = Array.slice(bytes, 193, 208);
+
+    return keys;
+
+end
+
+local addKey = Array.XOR;
+
+
+
+local AES = {};
+
+AES.blockSize = 16;
+
+AES.encrypt = function(_key, block)
+
+    local key = keyExpand(_key);
+
+    --round 0
+    block = addKey(block, key[1]);
+
+    --round 1
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[2]);
+
+    --round 2
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[3]);
+
+    --round 3
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[4]);
+
+    --round 4
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[5]);
+
+    --round 5
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[6]);
+
+    --round 6
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[7]);
+
+    --round 7
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[8]);
+
+    --round 8
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[9]);
+
+    --round 9
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[10]);
+
+    --round 10
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[11]);
+
+    --round 11
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[12]);
+
+    --round 12
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = addKey(block, key[13]);
+
+    return block;
+
+end
+
+AES.decrypt = function(_key, block)
+
+    local key = keyExpand(_key);
+
+    --round 0
+    block = addKey(block, key[13]);
+
+    --round 1
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[12]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 2
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[11]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 3
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[10]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 4
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[9]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 5
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[8]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 6
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[7]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 7
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[6]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 8
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[5]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 9
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[4]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 10
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[3]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 11
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[2]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 12
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[1]);
+
+    return block;
+end
+
+return AES;

lockbox/cipher/aes256.lua

@@ -0,0 +1,498 @@
+local Array = require("lockbox.util.array");
+local Bit = require("lockbox.util.bit");
+
+local XOR = Bit.bxor;
+
+local SBOX = {
+ [0] = 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
+ 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
+ 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
+ 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
+ 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
+ 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
+ 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
+ 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
+ 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
+ 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
+ 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
+ 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
+ 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
+ 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
+ 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
+ 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16};
+
+local ISBOX = {
+ [0] = 0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38, 0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
+ 0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87, 0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
+ 0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D, 0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
+ 0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2, 0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
+ 0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
+ 0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA, 0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
+ 0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A, 0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
+ 0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02, 0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
+ 0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA, 0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
+ 0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85, 0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
+ 0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89, 0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
+ 0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20, 0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
+ 0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31, 0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
+ 0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D, 0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
+ 0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0, 0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
+ 0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26, 0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D};
+
+local ROW_SHIFT =  {  1,  6, 11, 16,  5, 10, 15,  4,  9, 14,  3,  8, 13,  2,  7, 12, };
+local IROW_SHIFT = {  1, 14, 11,  8,  5,  2, 15, 12,  9,  6,  3, 16, 13, 10,  7,  4, };
+
+local ETABLE = {
+ [0] = 0x01, 0x03, 0x05, 0x0F, 0x11, 0x33, 0x55, 0xFF, 0x1A, 0x2E, 0x72, 0x96, 0xA1, 0xF8, 0x13, 0x35,
+ 0x5F, 0xE1, 0x38, 0x48, 0xD8, 0x73, 0x95, 0xA4, 0xF7, 0x02, 0x06, 0x0A, 0x1E, 0x22, 0x66, 0xAA,
+ 0xE5, 0x34, 0x5C, 0xE4, 0x37, 0x59, 0xEB, 0x26, 0x6A, 0xBE, 0xD9, 0x70, 0x90, 0xAB, 0xE6, 0x31,
+ 0x53, 0xF5, 0x04, 0x0C, 0x14, 0x3C, 0x44, 0xCC, 0x4F, 0xD1, 0x68, 0xB8, 0xD3, 0x6E, 0xB2, 0xCD,
+ 0x4C, 0xD4, 0x67, 0xA9, 0xE0, 0x3B, 0x4D, 0xD7, 0x62, 0xA6, 0xF1, 0x08, 0x18, 0x28, 0x78, 0x88,
+ 0x83, 0x9E, 0xB9, 0xD0, 0x6B, 0xBD, 0xDC, 0x7F, 0x81, 0x98, 0xB3, 0xCE, 0x49, 0xDB, 0x76, 0x9A,
+ 0xB5, 0xC4, 0x57, 0xF9, 0x10, 0x30, 0x50, 0xF0, 0x0B, 0x1D, 0x27, 0x69, 0xBB, 0xD6, 0x61, 0xA3,
+ 0xFE, 0x19, 0x2B, 0x7D, 0x87, 0x92, 0xAD, 0xEC, 0x2F, 0x71, 0x93, 0xAE, 0xE9, 0x20, 0x60, 0xA0,
+ 0xFB, 0x16, 0x3A, 0x4E, 0xD2, 0x6D, 0xB7, 0xC2, 0x5D, 0xE7, 0x32, 0x56, 0xFA, 0x15, 0x3F, 0x41,
+ 0xC3, 0x5E, 0xE2, 0x3D, 0x47, 0xC9, 0x40, 0xC0, 0x5B, 0xED, 0x2C, 0x74, 0x9C, 0xBF, 0xDA, 0x75,
+ 0x9F, 0xBA, 0xD5, 0x64, 0xAC, 0xEF, 0x2A, 0x7E, 0x82, 0x9D, 0xBC, 0xDF, 0x7A, 0x8E, 0x89, 0x80,
+ 0x9B, 0xB6, 0xC1, 0x58, 0xE8, 0x23, 0x65, 0xAF, 0xEA, 0x25, 0x6F, 0xB1, 0xC8, 0x43, 0xC5, 0x54,
+ 0xFC, 0x1F, 0x21, 0x63, 0xA5, 0xF4, 0x07, 0x09, 0x1B, 0x2D, 0x77, 0x99, 0xB0, 0xCB, 0x46, 0xCA,
+ 0x45, 0xCF, 0x4A, 0xDE, 0x79, 0x8B, 0x86, 0x91, 0xA8, 0xE3, 0x3E, 0x42, 0xC6, 0x51, 0xF3, 0x0E,
+ 0x12, 0x36, 0x5A, 0xEE, 0x29, 0x7B, 0x8D, 0x8C, 0x8F, 0x8A, 0x85, 0x94, 0xA7, 0xF2, 0x0D, 0x17,
+ 0x39, 0x4B, 0xDD, 0x7C, 0x84, 0x97, 0xA2, 0xFD, 0x1C, 0x24, 0x6C, 0xB4, 0xC7, 0x52, 0xF6, 0x01};
+
+local LTABLE = {
+ [0] = 0x00, 0x00, 0x19, 0x01, 0x32, 0x02, 0x1A, 0xC6, 0x4B, 0xC7, 0x1B, 0x68, 0x33, 0xEE, 0xDF, 0x03,
+ 0x64, 0x04, 0xE0, 0x0E, 0x34, 0x8D, 0x81, 0xEF, 0x4C, 0x71, 0x08, 0xC8, 0xF8, 0x69, 0x1C, 0xC1,
+ 0x7D, 0xC2, 0x1D, 0xB5, 0xF9, 0xB9, 0x27, 0x6A, 0x4D, 0xE4, 0xA6, 0x72, 0x9A, 0xC9, 0x09, 0x78,
+ 0x65, 0x2F, 0x8A, 0x05, 0x21, 0x0F, 0xE1, 0x24, 0x12, 0xF0, 0x82, 0x45, 0x35, 0x93, 0xDA, 0x8E,
+ 0x96, 0x8F, 0xDB, 0xBD, 0x36, 0xD0, 0xCE, 0x94, 0x13, 0x5C, 0xD2, 0xF1, 0x40, 0x46, 0x83, 0x38,
+ 0x66, 0xDD, 0xFD, 0x30, 0xBF, 0x06, 0x8B, 0x62, 0xB3, 0x25, 0xE2, 0x98, 0x22, 0x88, 0x91, 0x10,
+ 0x7E, 0x6E, 0x48, 0xC3, 0xA3, 0xB6, 0x1E, 0x42, 0x3A, 0x6B, 0x28, 0x54, 0xFA, 0x85, 0x3D, 0xBA,
+ 0x2B, 0x79, 0x0A, 0x15, 0x9B, 0x9F, 0x5E, 0xCA, 0x4E, 0xD4, 0xAC, 0xE5, 0xF3, 0x73, 0xA7, 0x57,
+ 0xAF, 0x58, 0xA8, 0x50, 0xF4, 0xEA, 0xD6, 0x74, 0x4F, 0xAE, 0xE9, 0xD5, 0xE7, 0xE6, 0xAD, 0xE8,
+ 0x2C, 0xD7, 0x75, 0x7A, 0xEB, 0x16, 0x0B, 0xF5, 0x59, 0xCB, 0x5F, 0xB0, 0x9C, 0xA9, 0x51, 0xA0,
+ 0x7F, 0x0C, 0xF6, 0x6F, 0x17, 0xC4, 0x49, 0xEC, 0xD8, 0x43, 0x1F, 0x2D, 0xA4, 0x76, 0x7B, 0xB7,
+ 0xCC, 0xBB, 0x3E, 0x5A, 0xFB, 0x60, 0xB1, 0x86, 0x3B, 0x52, 0xA1, 0x6C, 0xAA, 0x55, 0x29, 0x9D,
+ 0x97, 0xB2, 0x87, 0x90, 0x61, 0xBE, 0xDC, 0xFC, 0xBC, 0x95, 0xCF, 0xCD, 0x37, 0x3F, 0x5B, 0xD1,
+ 0x53, 0x39, 0x84, 0x3C, 0x41, 0xA2, 0x6D, 0x47, 0x14, 0x2A, 0x9E, 0x5D, 0x56, 0xF2, 0xD3, 0xAB,
+ 0x44, 0x11, 0x92, 0xD9, 0x23, 0x20, 0x2E, 0x89, 0xB4, 0x7C, 0xB8, 0x26, 0x77, 0x99, 0xE3, 0xA5,
+ 0x67, 0x4A, 0xED, 0xDE, 0xC5, 0x31, 0xFE, 0x18, 0x0D, 0x63, 0x8C, 0x80, 0xC0, 0xF7, 0x70, 0x07};
+
+local MIXTABLE = {
+ 0x02, 0x03, 0x01, 0x01,
+ 0x01, 0x02, 0x03, 0x01,
+ 0x01, 0x01, 0x02, 0x03,
+ 0x03, 0x01, 0x01, 0x02};
+
+local IMIXTABLE = {
+ 0x0E, 0x0B, 0x0D, 0x09,
+ 0x09, 0x0E, 0x0B, 0x0D,
+ 0x0D, 0x09, 0x0E, 0x0B,
+ 0x0B, 0x0D, 0x09, 0x0E};
+
+local RCON = {
+[0] = 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a,
+0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39,
+0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a,
+0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8,
+0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef,
+0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc,
+0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b,
+0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3,
+0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94,
+0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20,
+0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35,
+0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f,
+0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04,
+0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63,
+0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd,
+0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d};
+
+
+local GMUL = function(A, B)
+    if(A == 0x01) then return B; end
+    if(B == 0x01) then return A; end
+    if(A == 0x00) then return 0; end
+    if(B == 0x00) then return 0; end
+
+    local LA = LTABLE[A];
+    local LB = LTABLE[B];
+
+    local sum = LA + LB;
+    if (sum > 0xFF) then sum = sum - 0xFF; end
+
+    return ETABLE[sum];
+end
+
+local byteSub = Array.substitute;
+
+local shiftRow = Array.permute;
+
+local mixCol = function(i, mix)
+    local out = {};
+
+    local a, b, c, d;
+
+    a = GMUL(i[ 1], mix[ 1]);
+    b = GMUL(i[ 2], mix[ 2]);
+    c = GMUL(i[ 3], mix[ 3]);
+    d = GMUL(i[ 4], mix[ 4]);
+    out[ 1] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[ 5]);
+    b = GMUL(i[ 2], mix[ 6]);
+    c = GMUL(i[ 3], mix[ 7]);
+    d = GMUL(i[ 4], mix[ 8]);
+    out[ 2] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[ 9]);
+    b = GMUL(i[ 2], mix[10]);
+    c = GMUL(i[ 3], mix[11]);
+    d = GMUL(i[ 4], mix[12]);
+    out[ 3] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 1], mix[13]);
+    b = GMUL(i[ 2], mix[14]);
+    c = GMUL(i[ 3], mix[15]);
+    d = GMUL(i[ 4], mix[16]);
+    out[ 4] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[ 5], mix[ 1]);
+    b = GMUL(i[ 6], mix[ 2]);
+    c = GMUL(i[ 7], mix[ 3]);
+    d = GMUL(i[ 8], mix[ 4]);
+    out[ 5] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[ 5]);
+    b = GMUL(i[ 6], mix[ 6]);
+    c = GMUL(i[ 7], mix[ 7]);
+    d = GMUL(i[ 8], mix[ 8]);
+    out[ 6] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[ 9]);
+    b = GMUL(i[ 6], mix[10]);
+    c = GMUL(i[ 7], mix[11]);
+    d = GMUL(i[ 8], mix[12]);
+    out[ 7] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 5], mix[13]);
+    b = GMUL(i[ 6], mix[14]);
+    c = GMUL(i[ 7], mix[15]);
+    d = GMUL(i[ 8], mix[16]);
+    out[ 8] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[ 9], mix[ 1]);
+    b = GMUL(i[10], mix[ 2]);
+    c = GMUL(i[11], mix[ 3]);
+    d = GMUL(i[12], mix[ 4]);
+    out[ 9] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[ 5]);
+    b = GMUL(i[10], mix[ 6]);
+    c = GMUL(i[11], mix[ 7]);
+    d = GMUL(i[12], mix[ 8]);
+    out[10] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[ 9]);
+    b = GMUL(i[10], mix[10]);
+    c = GMUL(i[11], mix[11]);
+    d = GMUL(i[12], mix[12]);
+    out[11] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[ 9], mix[13]);
+    b = GMUL(i[10], mix[14]);
+    c = GMUL(i[11], mix[15]);
+    d = GMUL(i[12], mix[16]);
+    out[12] = XOR(XOR(a, b), XOR(c, d));
+
+
+    a = GMUL(i[13], mix[ 1]);
+    b = GMUL(i[14], mix[ 2]);
+    c = GMUL(i[15], mix[ 3]);
+    d = GMUL(i[16], mix[ 4]);
+    out[13] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[ 5]);
+    b = GMUL(i[14], mix[ 6]);
+    c = GMUL(i[15], mix[ 7]);
+    d = GMUL(i[16], mix[ 8]);
+    out[14] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[ 9]);
+    b = GMUL(i[14], mix[10]);
+    c = GMUL(i[15], mix[11]);
+    d = GMUL(i[16], mix[12]);
+    out[15] = XOR(XOR(a, b), XOR(c, d));
+    a = GMUL(i[13], mix[13]);
+    b = GMUL(i[14], mix[14]);
+    c = GMUL(i[15], mix[15]);
+    d = GMUL(i[16], mix[16]);
+    out[16] = XOR(XOR(a, b), XOR(c, d));
+
+    return out;
+end
+
+local keyRound = function(key, round)
+    local i = (round - 1) * 32;
+    local out = key;
+
+    out[33 + i] = XOR(key[ 1 + i], XOR(SBOX[key[30 + i]], RCON[round]));
+    out[34 + i] = XOR(key[ 2 + i], SBOX[key[31 + i]]);
+    out[35 + i] = XOR(key[ 3 + i], SBOX[key[32 + i]]);
+    out[36 + i] = XOR(key[ 4 + i], SBOX[key[29 + i]]);
+
+    out[37 + i] = XOR(out[33 + i], key[ 5 + i]);
+    out[38 + i] = XOR(out[34 + i], key[ 6 + i]);
+    out[39 + i] = XOR(out[35 + i], key[ 7 + i]);
+    out[40 + i] = XOR(out[36 + i], key[ 8 + i]);
+
+    out[41 + i] = XOR(out[37 + i], key[ 9 + i]);
+    out[42 + i] = XOR(out[38 + i], key[10 + i]);
+    out[43 + i] = XOR(out[39 + i], key[11 + i]);
+    out[44 + i] = XOR(out[40 + i], key[12 + i]);
+
+    out[45 + i] = XOR(out[41 + i], key[13 + i]);
+    out[46 + i] = XOR(out[42 + i], key[14 + i]);
+    out[47 + i] = XOR(out[43 + i], key[15 + i]);
+    out[48 + i] = XOR(out[44 + i], key[16 + i]);
+
+
+    out[49 + i] = XOR(SBOX[out[45 + i]], key[17 + i]);
+    out[50 + i] = XOR(SBOX[out[46 + i]], key[18 + i]);
+    out[51 + i] = XOR(SBOX[out[47 + i]], key[19 + i]);
+    out[52 + i] = XOR(SBOX[out[48 + i]], key[20 + i]);
+
+    out[53 + i] = XOR(out[49 + i], key[21 + i]);
+    out[54 + i] = XOR(out[50 + i], key[22 + i]);
+    out[55 + i] = XOR(out[51 + i], key[23 + i]);
+    out[56 + i] = XOR(out[52 + i], key[24 + i]);
+
+    out[57 + i] = XOR(out[53 + i], key[25 + i]);
+    out[58 + i] = XOR(out[54 + i], key[26 + i]);
+    out[59 + i] = XOR(out[55 + i], key[27 + i]);
+    out[60 + i] = XOR(out[56 + i], key[28 + i]);
+
+    out[61 + i] = XOR(out[57 + i], key[29 + i]);
+    out[62 + i] = XOR(out[58 + i], key[30 + i]);
+    out[63 + i] = XOR(out[59 + i], key[31 + i]);
+    out[64 + i] = XOR(out[60 + i], key[32 + i]);
+
+    return out;
+end
+
+local keyExpand = function(key)
+    local bytes = Array.copy(key);
+
+    for i = 1, 7 do
+        keyRound(bytes, i);
+    end
+
+    local keys = {};
+
+    keys[ 1] = Array.slice(bytes, 1, 16);
+    keys[ 2] = Array.slice(bytes, 17, 32);
+    keys[ 3] = Array.slice(bytes, 33, 48);
+    keys[ 4] = Array.slice(bytes, 49, 64);
+    keys[ 5] = Array.slice(bytes, 65, 80);
+    keys[ 6] = Array.slice(bytes, 81, 96);
+    keys[ 7] = Array.slice(bytes, 97, 112);
+    keys[ 8] = Array.slice(bytes, 113, 128);
+    keys[ 9] = Array.slice(bytes, 129, 144);
+    keys[10] = Array.slice(bytes, 145, 160);
+    keys[11] = Array.slice(bytes, 161, 176);
+    keys[12] = Array.slice(bytes, 177, 192);
+    keys[13] = Array.slice(bytes, 193, 208);
+    keys[14] = Array.slice(bytes, 209, 224);
+    keys[15] = Array.slice(bytes, 225, 240);
+
+    return keys;
+
+end
+
+local addKey = Array.XOR;
+
+
+
+local AES = {};
+
+AES.blockSize = 16;
+
+AES.encrypt = function(_key, block)
+
+    local key = keyExpand(_key);
+
+    --round 0
+    block = addKey(block, key[1]);
+
+    --round 1
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[2]);
+
+    --round 2
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[3]);
+
+    --round 3
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[4]);
+
+    --round 4
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[5]);
+
+    --round 5
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[6]);
+
+    --round 6
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[7]);
+
+    --round 7
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[8]);
+
+    --round 8
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[9]);
+
+    --round 9
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[10]);
+
+    --round 10
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[11]);
+
+    --round 11
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[12]);
+
+    --round 12
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[13]);
+
+    --round 13
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = mixCol(block, MIXTABLE);
+    block = addKey(block, key[14]);
+
+    --round 14
+    block = byteSub(block, SBOX);
+    block = shiftRow(block, ROW_SHIFT);
+    block = addKey(block, key[15]);
+
+    return block;
+
+end
+
+AES.decrypt = function(_key, block)
+
+    local key = keyExpand(_key);
+
+    --round 0
+    block = addKey(block, key[15]);
+
+    --round 1
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[14]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 2
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[13]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 3
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[12]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 4
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[11]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 5
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[10]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 6
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[9]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 7
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[8]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 8
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[7]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 9
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[6]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 10
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[5]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 11
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[4]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 12
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[3]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 13
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[2]);
+    block = mixCol(block, IMIXTABLE);
+
+    --round 14
+    block = shiftRow(block, IROW_SHIFT);
+    block = byteSub(block, ISBOX);
+    block = addKey(block, key[1]);
+
+    return block;
+end
+
+return AES;

lockbox/cipher/mode/cbc.lua

@@ -0,0 +1,164 @@
+local Array = require("lockbox.util.array");
+local Stream = require("lockbox.util.stream");
+local Queue = require("lockbox.util.queue");
+
+local CBC = {};
+
+CBC.Cipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = Array.XOR(iv, block);
+                    out = blockCipher.encrypt(key, out);
+                    Array.writeToQueue(outputQueue, out);
+                    iv = out;
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+
+CBC.Decipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = block;
+                    out = blockCipher.decrypt(key, out);
+                    out = Array.XOR(iv, out);
+                    Array.writeToQueue(outputQueue, out);
+                    iv = block;
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+return CBC;
+

lockbox/cipher/mode/cfb.lua

@@ -0,0 +1,163 @@
+local Array = require("lockbox.util.array");
+local Stream = require("lockbox.util.stream");
+local Queue = require("lockbox.util.queue");
+
+local CFB = {};
+
+CFB.Cipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = iv;
+                    out = blockCipher.encrypt(key, out);
+                    out = Array.XOR(out, block);
+                    Array.writeToQueue(outputQueue, out);
+                    iv = out;
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+CFB.Decipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = iv;
+                    out = blockCipher.encrypt(key, out);
+                    out = Array.XOR(out, block);
+                    Array.writeToQueue(outputQueue, out);
+                    iv = block;
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+return CFB;

lockbox/cipher/mode/ctr.lua

@@ -0,0 +1,248 @@
+local Array = require("lockbox.util.array");
+local Stream = require("lockbox.util.stream");
+local Queue = require("lockbox.util.queue");
+
+local Bit = require("lockbox.util.bit");
+
+local AND = Bit.band;
+
+local CTR = {};
+
+CTR.Cipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    local updateIV = function()
+        iv[16] = iv[16] + 1;
+        if iv[16] <= 0xFF then return; end
+        iv[16] = AND(iv[16], 0xFF);
+
+        iv[15] = iv[15] + 1;
+        if iv[15] <= 0xFF then return; end
+        iv[15] = AND(iv[15], 0xFF);
+
+        iv[14] = iv[14] + 1;
+        if iv[14] <= 0xFF then return; end
+        iv[14] = AND(iv[14], 0xFF);
+
+        iv[13] = iv[13] + 1;
+        if iv[13] <= 0xFF then return; end
+        iv[13] = AND(iv[13], 0xFF);
+
+        iv[12] = iv[12] + 1;
+        if iv[12] <= 0xFF then return; end
+        iv[12] = AND(iv[12], 0xFF);
+
+        iv[11] = iv[11] + 1;
+        if iv[11] <= 0xFF then return; end
+        iv[11] = AND(iv[11], 0xFF);
+
+        iv[10] = iv[10] + 1;
+        if iv[10] <= 0xFF then return; end
+        iv[10] = AND(iv[10], 0xFF);
+
+        iv[9] = iv[9] + 1;
+        if iv[9] <= 0xFF then return; end
+        iv[9] = AND(iv[9], 0xFF);
+
+        return;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = iv;
+                    out = blockCipher.encrypt(key, out);
+
+                    out = Array.XOR(out, block);
+                    Array.writeToQueue(outputQueue, out);
+                    updateIV();
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+
+CTR.Decipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    local updateIV = function()
+        iv[16] = iv[16] + 1;
+        if iv[16] <= 0xFF then return; end
+        iv[16] = AND(iv[16], 0xFF);
+
+        iv[15] = iv[15] + 1;
+        if iv[15] <= 0xFF then return; end
+        iv[15] = AND(iv[15], 0xFF);
+
+        iv[14] = iv[14] + 1;
+        if iv[14] <= 0xFF then return; end
+        iv[14] = AND(iv[14], 0xFF);
+
+        iv[13] = iv[13] + 1;
+        if iv[13] <= 0xFF then return; end
+        iv[13] = AND(iv[13], 0xFF);
+
+        iv[12] = iv[12] + 1;
+        if iv[12] <= 0xFF then return; end
+        iv[12] = AND(iv[12], 0xFF);
+
+        iv[11] = iv[11] + 1;
+        if iv[11] <= 0xFF then return; end
+        iv[11] = AND(iv[11], 0xFF);
+
+        iv[10] = iv[10] + 1;
+        if iv[10] <= 0xFF then return; end
+        iv[10] = AND(iv[10], 0xFF);
+
+        iv[9] = iv[9] + 1;
+        if iv[9] <= 0xFF then return; end
+        iv[9] = AND(iv[9], 0xFF);
+
+        return;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = iv;
+                    out = blockCipher.encrypt(key, out);
+
+                    out = Array.XOR(out, block);
+                    Array.writeToQueue(outputQueue, out);
+                    updateIV();
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+
+
+
+return CTR;
+

lockbox/cipher/mode/ofb.lua

@@ -0,0 +1,164 @@
+local Array = require("lockbox.util.array");
+local Stream = require("lockbox.util.stream");
+local Queue = require("lockbox.util.queue");
+
+local OFB = {};
+
+OFB.Cipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = iv;
+                    out = blockCipher.encrypt(key, out);
+                    iv = out;
+                    out = Array.XOR(out, block);
+                    Array.writeToQueue(outputQueue, out);
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+OFB.Decipher = function()
+
+    local public = {};
+
+    local key;
+    local blockCipher;
+    local padding;
+    local inputQueue;
+    local outputQueue;
+    local iv;
+
+    public.setKey = function(keyBytes)
+        key = keyBytes;
+        return public;
+    end
+
+    public.setBlockCipher = function(cipher)
+        blockCipher = cipher;
+        return public;
+    end
+
+    public.setPadding = function(paddingMode)
+        padding = paddingMode;
+        return public;
+    end
+
+    public.init = function()
+        inputQueue = Queue();
+        outputQueue = Queue();
+        iv = nil;
+        return public;
+    end
+
+    public.update = function(messageStream)
+        local byte = messageStream();
+        while (byte ~= nil) do
+            inputQueue.push(byte);
+            if(inputQueue.size() >= blockCipher.blockSize) then
+                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
+
+                if(iv == nil) then
+                    iv = block;
+                else
+                    local out = iv;
+                    out = blockCipher.encrypt(key, out);
+                    iv = out;
+                    out = Array.XOR(out, block);
+                    Array.writeToQueue(outputQueue, out);
+                end
+            end
+            byte = messageStream();
+        end
+        return public;
+    end
+
+    public.finish = function()
+        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
+        public.update(paddingStream);
+
+        return public;
+    end
+
+    public.getOutputQueue = function()
+        return outputQueue;
+    end
+
+    public.asHex = function()
+        return Stream.toHex(outputQueue.pop);
+    end
+
+    public.asBytes = function()
+        return Stream.toArray(outputQueue.pop);
+    end
+
+    return public;
+
+end
+
+
+return OFB;

lockbox/digest/sha1.lua

@@ -0,0 +1,173 @@
+require("lockbox").insecure();
+
+local Bit = require("lockbox.util.bit");
+local String = require("string");
+local Math = require("math");
+local Queue = require("lockbox.util.queue");
+
+local AND = Bit.band;
+local OR  = Bit.bor;
+local XOR = Bit.bxor;
+local LROT = Bit.lrotate;
+local LSHIFT = Bit.lshift;
+local RSHIFT = Bit.rshift;
+
+--SHA1 is big-endian
+local bytes2word = function(b0, b1, b2, b3)
+    local i = b0; i = LSHIFT(i, 8);
+    i = OR(i, b1); i = LSHIFT(i, 8);
+    i = OR(i, b2); i = LSHIFT(i, 8);
+    i = OR(i, b3);
+    return i;
+end
+
+local word2bytes = function(word)
+    local b0, b1, b2, b3;
+    b3 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b2 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b1 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b0 = AND(word, 0xFF);
+    return b0, b1, b2, b3;
+end
+
+local dword2bytes = function(i)
+    local b4, b5, b6, b7 = word2bytes(i);
+    local b0, b1, b2, b3 = word2bytes(Math.floor(i / 0x100000000));
+    return b0, b1, b2, b3, b4, b5, b6, b7;
+end
+
+local F = function(x, y, z) return XOR(z, AND(x, XOR(y, z))); end
+local G = function(x, y, z) return XOR(x, XOR(y, z)); end
+local H = function(x, y, z) return OR(AND(x, OR(y, z)), AND(y, z)); end
+local I = function(x, y, z) return XOR(x, XOR(y, z)); end
+
+local SHA1 = function()
+
+    local queue = Queue();
+
+    local h0 = 0x67452301;
+    local h1 = 0xEFCDAB89;
+    local h2 = 0x98BADCFE;
+    local h3 = 0x10325476;
+    local h4 = 0xC3D2E1F0;
+
+    local public = {};
+
+    local processBlock = function()
+        local a = h0;
+        local b = h1;
+        local c = h2;
+        local d = h3;
+        local e = h4;
+        local temp;
+        local k;
+
+        local w = {};
+        for i = 0, 15 do
+            w[i] = bytes2word(queue.pop(), queue.pop(), queue.pop(), queue.pop());
+        end
+
+        for i = 16, 79 do
+            w[i] = LROT((XOR(XOR(w[i - 3], w[i - 8]), XOR(w[i - 14], w[i - 16]))), 1);
+        end
+
+        for i = 0, 79 do
+            if (i <= 19) then
+                temp = F(b, c, d);
+                k = 0x5A827999;
+            elseif (i <= 39) then
+                temp = G(b, c, d);
+                k = 0x6ED9EBA1;
+            elseif (i <= 59) then
+                temp = H(b, c, d);
+                k = 0x8F1BBCDC;
+            else
+                temp = I(b, c, d);
+                k = 0xCA62C1D6;
+            end
+            temp = LROT(a, 5) + temp + e + k + w[i];
+            e = d;
+            d = c;
+            c = LROT(b, 30);
+            b = a;
+            a = temp;
+        end
+
+        h0 = AND(h0 + a, 0xFFFFFFFF);
+        h1 = AND(h1 + b, 0xFFFFFFFF);
+        h2 = AND(h2 + c, 0xFFFFFFFF);
+        h3 = AND(h3 + d, 0xFFFFFFFF);
+        h4 = AND(h4 + e, 0xFFFFFFFF);
+    end
+
+    public.init = function()
+        queue.reset();
+        h0 = 0x67452301;
+        h1 = 0xEFCDAB89;
+        h2 = 0x98BADCFE;
+        h3 = 0x10325476;
+        h4 = 0xC3D2E1F0;
+        return public;
+    end
+
+
+    public.update = function(bytes)
+        for b in bytes do
+            queue.push(b);
+            if queue.size() >= 64 then processBlock(); end
+        end
+
+        return public;
+    end
+
+    public.finish = function()
+        local bits = queue.getHead() * 8;
+
+        queue.push(0x80);
+        while ((queue.size() + 7) % 64) < 63 do
+            queue.push(0x00);
+        end
+
+        local b0, b1, b2, b3, b4, b5, b6, b7 = dword2bytes(bits);
+
+        queue.push(b0);
+        queue.push(b1);
+        queue.push(b2);
+        queue.push(b3);
+        queue.push(b4);
+        queue.push(b5);
+        queue.push(b6);
+        queue.push(b7);
+
+        while queue.size() > 0 do
+            processBlock();
+        end
+
+        return public;
+    end
+
+    public.asBytes = function()
+        local  b0, b1, b2, b3 = word2bytes(h0);
+        local  b4, b5, b6, b7 = word2bytes(h1);
+        local  b8, b9, b10, b11 = word2bytes(h2);
+        local b12, b13, b14, b15 = word2bytes(h3);
+        local b16, b17, b18, b19 = word2bytes(h4);
+
+        return {b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15, b16, b17, b18, b19};
+    end
+
+    public.asHex = function()
+        local  b0, b1, b2, b3 = word2bytes(h0);
+        local  b4, b5, b6, b7 = word2bytes(h1);
+        local  b8, b9, b10, b11 = word2bytes(h2);
+        local b12, b13, b14, b15 = word2bytes(h3);
+        local b16, b17, b18, b19 = word2bytes(h4);
+
+        return String.format("%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
+                b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15, b16, b17, b18, b19);
+    end
+
+    return public;
+end
+
+return SHA1;

lockbox/digest/sha2_224.lua

@@ -0,0 +1,200 @@
+local Bit = require("lockbox.util.bit");
+local String = require("string");
+local Math = require("math");
+local Queue = require("lockbox.util.queue");
+
+local CONSTANTS = {
+   0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
+   0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3, 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
+   0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
+   0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7, 0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,
+   0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13, 0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,
+   0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3, 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
+   0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5, 0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,
+   0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208, 0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2  };
+
+local fmt = "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x" ..
+            "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x"
+
+local AND = Bit.band;
+local OR  = Bit.bor;
+local NOT = Bit.bnot;
+local XOR = Bit.bxor;
+local RROT = Bit.rrotate;
+local LSHIFT = Bit.lshift;
+local RSHIFT = Bit.rshift;
+
+--SHA2 is big-endian
+local bytes2word = function(b0, b1, b2, b3)
+    local i = b0; i = LSHIFT(i, 8);
+    i = OR(i, b1); i = LSHIFT(i, 8);
+    i = OR(i, b2); i = LSHIFT(i, 8);
+    i = OR(i, b3);
+    return i;
+end
+
+local word2bytes = function(word)
+    local b0, b1, b2, b3;
+    b3 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b2 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b1 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b0 = AND(word, 0xFF);
+    return b0, b1, b2, b3;
+end
+
+local dword2bytes = function(i)
+    local b4, b5, b6, b7 = word2bytes(i);
+    local b0, b1, b2, b3 = word2bytes(Math.floor(i / 0x100000000));
+    return b0, b1, b2, b3, b4, b5, b6, b7;
+end
+
+
+
+
+local SHA2_224 = function()
+
+    local queue = Queue();
+
+    local h0 = 0xc1059ed8;
+    local h1 = 0x367cd507;
+    local h2 = 0x3070dd17;
+    local h3 = 0xf70e5939;
+    local h4 = 0xffc00b31;
+    local h5 = 0x68581511;
+    local h6 = 0x64f98fa7;
+    local h7 = 0xbefa4fa4;
+
+    local public = {};
+
+    local processBlock = function()
+        local a = h0;
+        local b = h1;
+        local c = h2;
+        local d = h3;
+        local e = h4;
+        local f = h5;
+        local g = h6;
+        local h = h7;
+
+        local w = {};
+
+        for i = 0, 15 do
+            w[i] = bytes2word(queue.pop(), queue.pop(), queue.pop(), queue.pop());
+        end
+
+        for i = 16, 63 do
+            local s0 = XOR(RROT(w[i - 15], 7), XOR(RROT(w[i - 15], 18), RSHIFT(w[i - 15], 3)));
+            local s1 = XOR(RROT(w[i - 2], 17), XOR(RROT(w[i - 2], 19), RSHIFT(w[i - 2], 10)));
+            w[i] = AND(w[i - 16] + s0 + w[i - 7] + s1, 0xFFFFFFFF);
+        end
+
+        for i = 0, 63 do
+            local s1 = XOR(RROT(e, 6), XOR(RROT(e, 11), RROT(e, 25)));
+            local ch = XOR(AND(e, f), AND(NOT(e), g));
+            local temp1 = h + s1 + ch + CONSTANTS[i + 1] + w[i];
+            local s0 = XOR(RROT(a, 2), XOR(RROT(a, 13), RROT(a, 22)));
+            local maj = XOR(AND(a, b), XOR(AND(a, c), AND(b, c)));
+            local temp2 = s0 + maj;
+
+            h = g;
+            g = f;
+            f = e;
+            e = d + temp1;
+            d = c;
+            c = b;
+            b = a;
+            a = temp1 + temp2;
+        end
+
+        h0 = AND(h0 + a, 0xFFFFFFFF);
+        h1 = AND(h1 + b, 0xFFFFFFFF);
+        h2 = AND(h2 + c, 0xFFFFFFFF);
+        h3 = AND(h3 + d, 0xFFFFFFFF);
+        h4 = AND(h4 + e, 0xFFFFFFFF);
+        h5 = AND(h5 + f, 0xFFFFFFFF);
+        h6 = AND(h6 + g, 0xFFFFFFFF);
+        h7 = AND(h7 + h, 0xFFFFFFFF);
+    end
+
+    public.init = function()
+        queue.reset();
+
+        h0 = 0xc1059ed8;
+        h1 = 0x367cd507;
+        h2 = 0x3070dd17;
+        h3 = 0xf70e5939;
+        h4 = 0xffc00b31;
+        h5 = 0x68581511;
+        h6 = 0x64f98fa7;
+        h7 = 0xbefa4fa4;
+
+        return public;
+    end
+
+    public.update = function(bytes)
+        for b in bytes do
+            queue.push(b);
+            if queue.size() >= 64 then processBlock(); end
+        end
+
+        return public;
+    end
+
+    public.finish = function()
+        local bits = queue.getHead() * 8;
+
+        queue.push(0x80);
+        while ((queue.size() + 7) % 64) < 63 do
+            queue.push(0x00);
+        end
+
+        local b0, b1, b2, b3, b4, b5, b6, b7 = dword2bytes(bits);
+
+        queue.push(b0);
+        queue.push(b1);
+        queue.push(b2);
+        queue.push(b3);
+        queue.push(b4);
+        queue.push(b5);
+        queue.push(b6);
+        queue.push(b7);
+
+        while queue.size() > 0 do
+            processBlock();
+        end
+
+        return public;
+    end
+
+    public.asBytes = function()
+        local  b0, b1, b2, b3 = word2bytes(h0);
+        local  b4, b5, b6, b7 = word2bytes(h1);
+        local  b8, b9, b10, b11 = word2bytes(h2);
+        local b12, b13, b14, b15 = word2bytes(h3);
+        local b16, b17, b18, b19 = word2bytes(h4);
+        local b20, b21, b22, b23 = word2bytes(h5);
+        local b24, b25, b26, b27 = word2bytes(h6);
+
+        return {  b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15
+                , b16, b17, b18, b19, b20, b21, b22, b23, b24, b25, b26, b27};
+    end
+
+    public.asHex = function()
+        local  b0, b1, b2, b3 = word2bytes(h0);
+        local  b4, b5, b6, b7 = word2bytes(h1);
+        local  b8, b9, b10, b11 = word2bytes(h2);
+        local b12, b13, b14, b15 = word2bytes(h3);
+        local b16, b17, b18, b19 = word2bytes(h4);
+        local b20, b21, b22, b23 = word2bytes(h5);
+        local b24, b25, b26, b27 = word2bytes(h6);
+
+        return String.format(fmt, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15
+                , b16, b17, b18, b19, b20, b21, b22, b23, b24, b25, b26, b27);
+    end
+
+    return public;
+
+end
+
+return SHA2_224;
+

lockbox/digest/sha2_256.lua

@@ -0,0 +1,203 @@
+local Bit = require("lockbox.util.bit");
+local String = require("string");
+local Math = require("math");
+local Queue = require("lockbox.util.queue");
+
+local CONSTANTS = {
+   0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
+   0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3, 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
+   0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
+   0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7, 0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,
+   0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13, 0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,
+   0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3, 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
+   0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5, 0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,
+   0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208, 0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2  };
+
+local fmt = "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x" ..
+            "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x"
+
+local AND = Bit.band;
+local OR  = Bit.bor;
+local NOT = Bit.bnot;
+local XOR = Bit.bxor;
+local RROT = Bit.rrotate;
+local LSHIFT = Bit.lshift;
+local RSHIFT = Bit.rshift;
+
+--SHA2 is big-endian
+local bytes2word = function(b0, b1, b2, b3)
+    local i = b0; i = LSHIFT(i, 8);
+    i = OR(i, b1); i = LSHIFT(i, 8);
+    i = OR(i, b2); i = LSHIFT(i, 8);
+    i = OR(i, b3);
+    return i;
+end
+
+local word2bytes = function(word)
+    local b0, b1, b2, b3;
+    b3 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b2 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b1 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b0 = AND(word, 0xFF);
+    return b0, b1, b2, b3;
+end
+
+local dword2bytes = function(i)
+    local b4, b5, b6, b7 = word2bytes(i);
+    local b0, b1, b2, b3 = word2bytes(Math.floor(i / 0x100000000));
+    return b0, b1, b2, b3, b4, b5, b6, b7;
+end
+
+
+
+
+local SHA2_256 = function()
+
+    local queue = Queue();
+
+    local h0 = 0x6a09e667;
+    local h1 = 0xbb67ae85;
+    local h2 = 0x3c6ef372;
+    local h3 = 0xa54ff53a;
+    local h4 = 0x510e527f;
+    local h5 = 0x9b05688c;
+    local h6 = 0x1f83d9ab;
+    local h7 = 0x5be0cd19;
+
+    local public = {};
+
+    local processBlock = function()
+        local a = h0;
+        local b = h1;
+        local c = h2;
+        local d = h3;
+        local e = h4;
+        local f = h5;
+        local g = h6;
+        local h = h7;
+
+        local w = {};
+
+        for i = 0, 15 do
+            w[i] = bytes2word(queue.pop(), queue.pop(), queue.pop(), queue.pop());
+        end
+
+        for i = 16, 63 do
+            local s0 = XOR(RROT(w[i - 15], 7), XOR(RROT(w[i - 15], 18), RSHIFT(w[i - 15], 3)));
+            local s1 = XOR(RROT(w[i - 2], 17), XOR(RROT(w[i -  2], 19), RSHIFT(w[i - 2], 10)));
+            w[i] = AND(w[i - 16] + s0 + w[i - 7] + s1, 0xFFFFFFFF);
+        end
+
+        for i = 0, 63 do
+            local s1 = XOR(RROT(e, 6), XOR(RROT(e, 11), RROT(e, 25)));
+            local ch = XOR(AND(e, f), AND(NOT(e), g));
+            local temp1 = h + s1 + ch + CONSTANTS[i + 1] + w[i];
+            local s0 = XOR(RROT(a, 2), XOR(RROT(a, 13), RROT(a, 22)));
+            local maj = XOR(AND(a, b), XOR(AND(a, c), AND(b, c)));
+            local temp2 = s0 + maj;
+
+            h = g;
+            g = f;
+            f = e;
+            e = d + temp1;
+            d = c;
+            c = b;
+            b = a;
+            a = temp1 + temp2;
+        end
+
+        h0 = AND(h0 + a, 0xFFFFFFFF);
+        h1 = AND(h1 + b, 0xFFFFFFFF);
+        h2 = AND(h2 + c, 0xFFFFFFFF);
+        h3 = AND(h3 + d, 0xFFFFFFFF);
+        h4 = AND(h4 + e, 0xFFFFFFFF);
+        h5 = AND(h5 + f, 0xFFFFFFFF);
+        h6 = AND(h6 + g, 0xFFFFFFFF);
+        h7 = AND(h7 + h, 0xFFFFFFFF);
+    end
+
+    public.init = function()
+        queue.reset();
+
+        h0 = 0x6a09e667;
+        h1 = 0xbb67ae85;
+        h2 = 0x3c6ef372;
+        h3 = 0xa54ff53a;
+        h4 = 0x510e527f;
+        h5 = 0x9b05688c;
+        h6 = 0x1f83d9ab;
+        h7 = 0x5be0cd19;
+
+        return public;
+    end
+
+    public.update = function(bytes)
+        for b in bytes do
+            queue.push(b);
+            if queue.size() >= 64 then processBlock(); end
+        end
+
+        return public;
+    end
+
+    public.finish = function()
+        local bits = queue.getHead() * 8;
+
+        queue.push(0x80);
+        while ((queue.size() + 7) % 64) < 63 do
+            queue.push(0x00);
+        end
+
+        local b0, b1, b2, b3, b4, b5, b6, b7 = dword2bytes(bits);
+
+        queue.push(b0);
+        queue.push(b1);
+        queue.push(b2);
+        queue.push(b3);
+        queue.push(b4);
+        queue.push(b5);
+        queue.push(b6);
+        queue.push(b7);
+
+        while queue.size() > 0 do
+            processBlock();
+        end
+
+        return public;
+    end
+
+    public.asBytes = function()
+        local  b0, b1, b2, b3 = word2bytes(h0);
+        local  b4, b5, b6, b7 = word2bytes(h1);
+        local  b8, b9, b10, b11 = word2bytes(h2);
+        local b12, b13, b14, b15 = word2bytes(h3);
+        local b16, b17, b18, b19 = word2bytes(h4);
+        local b20, b21, b22, b23 = word2bytes(h5);
+        local b24, b25, b26, b27 = word2bytes(h6);
+        local b28, b29, b30, b31 = word2bytes(h7);
+
+
+        return {  b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15
+                , b16, b17, b18, b19, b20, b21, b22, b23, b24, b25, b26, b27, b28, b29, b30, b31};
+    end
+
+    public.asHex = function()
+        local  b0, b1, b2, b3 = word2bytes(h0);
+        local  b4, b5, b6, b7 = word2bytes(h1);
+        local  b8, b9, b10, b11 = word2bytes(h2);
+        local b12, b13, b14, b15 = word2bytes(h3);
+        local b16, b17, b18, b19 = word2bytes(h4);
+        local b20, b21, b22, b23 = word2bytes(h5);
+        local b24, b25, b26, b27 = word2bytes(h6);
+        local b28, b29, b30, b31 = word2bytes(h7);
+
+        return String.format(fmt, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15
+                , b16, b17, b18, b19, b20, b21, b22, b23, b24, b25, b26, b27, b28, b29, b30, b31);
+    end
+
+    return public;
+
+end
+
+return SHA2_256;
+

lockbox/init.lua

@@ -0,0 +1,22 @@
+local Lockbox = {};
+
+--[[
+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;

lockbox/kdf/pbkdf2.lua

@@ -0,0 +1,114 @@
+local Bit = require("lockbox.util.bit");
+local Array = require("lockbox.util.array");
+local Stream = require("lockbox.util.stream");
+local Math = require("math");
+
+local AND = Bit.band;
+local RSHIFT = Bit.rshift;
+
+local word2bytes = function(word)
+    local b0, b1, b2, b3;
+    b3 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b2 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b1 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b0 = AND(word, 0xFF);
+    return b0, b1, b2, b3;
+end
+
+local PBKDF2 = function()
+
+    local public = {};
+
+    local blockLen = 16;
+    local dKeyLen = 256;
+    local iterations = 4096;
+
+    local salt;
+    local password;
+
+
+    local PRF;
+
+    local dKey;
+
+
+    public.setBlockLen = function(len)
+        blockLen = len;
+        return public;
+    end
+
+    public.setDKeyLen = function(len)
+        dKeyLen = len
+        return public;
+    end
+
+    public.setIterations = function(iter)
+        iterations = iter;
+        return public;
+    end
+
+    public.setSalt = function(saltBytes)
+        salt = saltBytes;
+        return public;
+    end
+
+    public.setPassword = function(passwordBytes)
+        password = passwordBytes;
+        return public;
+    end
+
+    public.setPRF = function(prf)
+        PRF = prf;
+        return public;
+    end
+
+    local buildBlock = function(i)
+        local b0, b1, b2, b3 = word2bytes(i);
+        local ii = {b0, b1, b2, b3};
+        local s = Array.concat(salt, ii);
+
+        local out = {};
+
+        PRF.setKey(password);
+        for c = 1, iterations do
+            PRF.init()
+                .update(Stream.fromArray(s));
+
+            s = PRF.finish().asBytes();
+            if(c > 1) then
+                out = Array.XOR(out, s);
+            else
+                out = s;
+            end
+        end
+
+        return out;
+    end
+
+    public.finish = function()
+        local blocks = Math.ceil(dKeyLen / blockLen);
+
+        dKey = {};
+
+        for b = 1, blocks do
+            local block = buildBlock(b);
+            dKey = Array.concat(dKey, block);
+        end
+
+        if(Array.size(dKey) > dKeyLen) then dKey = Array.truncate(dKey, dKeyLen); end
+
+        return public;
+    end
+
+    public.asBytes = function()
+        return dKey;
+    end
+
+    public.asHex = function()
+        return Array.toHex(dKey);
+    end
+
+    return public;
+end
+
+return PBKDF2;

lockbox/mac/hmac.lua

@@ -0,0 +1,85 @@
+local Bit = require("lockbox.util.bit");
+local Stream = require("lockbox.util.stream");
+local Array = require("lockbox.util.array");
+
+local XOR = Bit.bxor;
+
+local HMAC = function()
+
+    local public = {};
+    local blockSize = 64;
+    local Digest = nil;
+    local outerPadding = {};
+    local innerPadding = {}
+    local digest;
+
+    public.setBlockSize = function(bytes)
+        blockSize = bytes;
+        return public;
+    end
+
+    public.setDigest = function(digestModule)
+        Digest = digestModule;
+        digest = Digest();
+        return public;
+    end
+
+    public.setKey = function(key)
+        local keyStream;
+
+        if(Array.size(key) > blockSize) then
+            keyStream = Stream.fromArray(Digest()
+                        .update(Stream.fromArray(key))
+                        .finish()
+                        .asBytes());
+        else
+            keyStream = Stream.fromArray(key);
+        end
+
+        outerPadding = {};
+        innerPadding = {};
+
+        for i = 1, blockSize do
+            local byte = keyStream();
+            if byte == nil then byte = 0x00; end
+            outerPadding[i] = XOR(0x5C, byte);
+            innerPadding[i] = XOR(0x36, byte);
+        end
+
+        return public;
+    end
+
+    public.init = function()
+        digest.init()
+              .update(Stream.fromArray(innerPadding));
+        return public;
+    end
+
+    public.update = function(messageStream)
+        digest.update(messageStream);
+        return public;
+    end
+
+    public.finish = function()
+        local inner = digest.finish().asBytes();
+        digest.init()
+              .update(Stream.fromArray(outerPadding))
+              .update(Stream.fromArray(inner))
+              .finish();
+
+        return public;
+    end
+
+    public.asBytes = function()
+        return digest.asBytes();
+    end
+
+    public.asHex = function()
+        return digest.asHex();
+    end
+
+    return public;
+
+end
+
+return HMAC;

lockbox/padding/ansix923.lua

@@ -0,0 +1,22 @@
+local ANSIX923Padding = function(blockSize, byteCount)
+
+    local paddingCount = blockSize - (byteCount % blockSize);
+    local bytesLeft = paddingCount;
+
+    local stream = function()
+        if bytesLeft > 1 then
+            bytesLeft = bytesLeft - 1;
+            return 0x00;
+        elseif bytesLeft > 0 then
+            bytesLeft = bytesLeft - 1;
+            return paddingCount;
+        else
+            return nil;
+        end
+    end
+
+    return stream;
+
+end
+
+return ANSIX923Padding;

lockbox/padding/isoiec7816.lua

@@ -0,0 +1,22 @@
+local ISOIEC7816Padding = function(blockSize, byteCount)
+
+    local paddingCount = blockSize - (byteCount % blockSize);
+    local bytesLeft = paddingCount;
+
+    local stream = function()
+        if bytesLeft == paddingCount then
+            bytesLeft = bytesLeft - 1;
+            return 0x80;
+        elseif bytesLeft > 0 then
+            bytesLeft = bytesLeft - 1;
+            return 0x00;
+        else
+            return nil;
+        end
+    end
+
+    return stream;
+
+end
+
+return ISOIEC7816Padding;

lockbox/padding/pkcs7.lua

@@ -0,0 +1,18 @@
+local PKCS7Padding = function(blockSize, byteCount)
+
+    local paddingCount = blockSize - ((byteCount -1) % blockSize) + 1;
+    local bytesLeft = paddingCount;
+
+    local stream = function()
+        if bytesLeft > 0 then
+            bytesLeft = bytesLeft - 1;
+            return paddingCount;
+        else
+            return nil;
+        end
+    end
+
+    return stream;
+end
+
+return PKCS7Padding;

lockbox/padding/zero.lua

@@ -0,0 +1,19 @@
+local ZeroPadding = function(blockSize, byteCount)
+
+    local paddingCount = blockSize - ((byteCount -1) % blockSize) + 1;
+    local bytesLeft = paddingCount;
+
+    local stream = function()
+        if bytesLeft > 0 then
+            bytesLeft = bytesLeft - 1;
+            return 0x00;
+        else
+            return nil;
+        end
+    end
+
+    return stream;
+
+end
+
+return ZeroPadding;

lockbox/util/array.lua

@@ -0,0 +1,211 @@
+
+local String = require("string");
+local Bit = require("lockbox.util.bit");
+local Queue = require("lockbox.util.queue");
+
+local XOR = Bit.bxor;
+
+local Array = {};
+
+Array.size = function(array)
+    return #array;
+end
+
+Array.fromString = function(string)
+    local bytes = {};
+
+    local i = 1;
+    local byte = String.byte(string, i);
+    while byte ~= nil do
+        bytes[i] = byte;
+        i = i + 1;
+        byte = String.byte(string, i);
+    end
+
+    return bytes;
+
+end
+
+Array.toString = function(bytes)
+    local chars = {};
+    local i = 1;
+
+    local byte = bytes[i];
+    while byte ~= nil do
+        chars[i] = String.char(byte);
+        i = i + 1;
+        byte = bytes[i];
+    end
+
+    return table.concat(chars, "");
+end
+
+Array.fromStream = function(stream)
+    local array = {};
+    local i = 1;
+
+    local byte = stream();
+    while byte ~= nil do
+        array[i] = byte;
+        i = i + 1;
+        byte = stream();
+    end
+
+    return array;
+end
+
+Array.readFromQueue = function(queue, size)
+    local array = {};
+
+    for i = 1, size do
+        array[i] = queue.pop();
+    end
+
+    return array;
+end
+
+Array.writeToQueue = function(queue, array)
+    local size = Array.size(array);
+
+    for i = 1, size do
+        queue.push(array[i]);
+    end
+end
+
+Array.toStream = function(array)
+    local queue = Queue();
+    local i = 1;
+
+    local byte = array[i];
+    while byte ~= nil do
+        queue.push(byte);
+        i = i + 1;
+        byte = array[i];
+    end
+
+    return queue.pop;
+end
+
+
+local fromHexTable = {};
+for i = 0, 255 do
+    fromHexTable[String.format("%02X", i)] = i;
+    fromHexTable[String.format("%02x", i)] = i;
+end
+
+Array.fromHex = function(hex)
+    local array = {};
+
+    for i = 1, String.len(hex) / 2 do
+        local h = String.sub(hex, i * 2 - 1, i * 2);
+        array[i] = fromHexTable[h];
+    end
+
+    return array;
+end
+
+
+local toHexTable = {};
+for i = 0, 255 do
+    toHexTable[i] = String.format("%02X", i);
+end
+
+Array.toHex = function(array)
+    local hex = {};
+    local i = 1;
+
+    local byte = array[i];
+    while byte ~= nil do
+        hex[i] = toHexTable[byte];
+        i = i + 1;
+        byte = array[i];
+    end
+
+    return table.concat(hex, "");
+
+end
+
+Array.concat = function(a, b)
+    local concat = {};
+    local out = 1;
+
+    local i = 1;
+    local byte = a[i];
+    while byte ~= nil do
+        concat[out] = byte;
+        i = i + 1;
+        out = out + 1;
+        byte = a[i];
+    end
+
+    i = 1;
+    byte = b[i];
+    while byte ~= nil do
+        concat[out] = byte;
+        i = i + 1;
+        out = out + 1;
+        byte = b[i];
+    end
+
+    return concat;
+end
+
+Array.truncate = function(a, newSize)
+    local x = {};
+
+    for i = 1, newSize do
+        x[i] = a[i];
+    end
+
+    return x;
+end
+
+Array.XOR = function(a, b)
+    local x = {};
+
+    for k, v in pairs(a) do
+        x[k] = XOR(v, b[k]);
+    end
+
+    return x;
+end
+
+Array.substitute = function(input, sbox)
+    local out = {};
+
+    for k, v in pairs(input) do
+        out[k] = sbox[v];
+    end
+
+    return out;
+end
+
+Array.permute = function(input, pbox)
+    local out = {};
+
+    for k, v in pairs(pbox) do
+        out[k] = input[v];
+    end
+
+    return out;
+end
+
+Array.copy = function(input)
+    local out = {};
+
+    for k, v in pairs(input) do
+        out[k] = v;
+    end
+    return out;
+end
+
+Array.slice = function(input, start, stop)
+    local out = {};
+
+    for i = start, stop do
+        out[i - start + 1] = input[i];
+    end
+    return out;
+end
+
+return Array;

lockbox/util/bit.lua

@@ -0,0 +1,25 @@
+local ok, e
+ok = nil
+if not ok then
+    ok, e = pcall(require, "bit") -- the LuaJIT one ?
+end
+if not ok then
+    ok, e = pcall(require, "bit32") -- Lua 5.2
+end
+if not ok then
+    ok, e = pcall(require, "bit.numberlua") -- for Lua 5.1, https://github.com/tst2005/lua-bit-numberlua/
+end
+if not ok then
+    error("no bitwise support found", 2)
+end
+assert(type(e) == "table", "invalid bit module")
+
+-- Workaround to support Lua 5.2 bit32 API with the LuaJIT bit one
+if e.rol and not e.lrotate then
+    e.lrotate = e.rol
+end
+if e.ror and not e.rrotate then
+    e.rrotate = e.ror
+end
+
+return e

lockbox/util/queue.lua

@@ -0,0 +1,47 @@
+local Queue = function()
+    local queue = {};
+    local tail = 0;
+    local head = 0;
+
+    local public = {};
+
+    public.push = function(obj)
+        queue[head] = obj;
+        head = head + 1;
+        return;
+    end
+
+    public.pop = function()
+        if tail < head
+        then
+            local obj = queue[tail];
+            queue[tail] = nil;
+            tail = tail + 1;
+            return obj;
+        else
+            return nil;
+        end
+    end
+
+    public.size = function()
+        return head - tail;
+    end
+
+    public.getHead = function()
+        return head;
+    end
+
+    public.getTail = function()
+        return tail;
+    end
+
+    public.reset = function()
+        queue = {};
+        head = 0;
+        tail = 0;
+    end
+
+    return public;
+end
+
+return Queue;

lockbox/util/stream.lua

@@ -0,0 +1,99 @@
+local Queue = require("lockbox.util.queue");
+local String = require("string");
+
+local Stream = {};
+
+
+Stream.fromString = function(string)
+    local i = 0;
+    return function()
+        i = i + 1;
+        return String.byte(string, i);
+    end
+end
+
+
+Stream.toString = function(stream)
+    local array = {};
+    local i = 1;
+
+    local byte = stream();
+    while byte ~= nil do
+        array[i] = String.char(byte);
+        i = i + 1;
+        byte = stream();
+    end
+
+    return table.concat(array);
+end
+
+
+Stream.fromArray = function(array)
+    local queue = Queue();
+    local i = 1;
+
+    local byte = array[i];
+    while byte ~= nil do
+        queue.push(byte);
+        i = i + 1;
+        byte = array[i];
+    end
+
+    return queue.pop;
+end
+
+
+Stream.toArray = function(stream)
+    local array = {};
+    local i = 1;
+
+    local byte = stream();
+    while byte ~= nil do
+        array[i] = byte;
+        i = i + 1;
+        byte = stream();
+    end
+
+    return array;
+end
+
+
+local fromHexTable = {};
+for i = 0, 255 do
+    fromHexTable[String.format("%02X", i)] = i;
+    fromHexTable[String.format("%02x", i)] = i;
+end
+
+Stream.fromHex = function(hex)
+    local queue = Queue();
+
+    for i = 1, String.len(hex) / 2 do
+        local h = String.sub(hex, i * 2 - 1, i * 2);
+        queue.push(fromHexTable[h]);
+    end
+
+    return queue.pop;
+end
+
+
+
+local toHexTable = {};
+for i = 0, 255 do
+    toHexTable[i] = String.format("%02X", i);
+end
+
+Stream.toHex = function(stream)
+    local hex = {};
+    local i = 1;
+
+    local byte = stream();
+    while byte ~= nil do
+        hex[i] = toHexTable[byte];
+        i = i + 1;
+        byte = stream();
+    end
+
+    return table.concat(hex);
+end
+
+return Stream;

pocket/config.lua

@@ -0,0 +1,23 @@
+local config = {}
+
+-- port of the SCADA supervisor
+config.SCADA_SV_PORT = 16100
+-- port for SCADA coordinator API access
+config.SCADA_API_PORT = 16200
+-- port to listen to incoming packets FROM servers
+config.LISTEN_PORT = 16201
+-- 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
+
+-- 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/coreio.lua

@@ -0,0 +1,35 @@
+--
+-- Core I/O - Pocket Central I/O Management
+--
+
+local psil = require("scada-common.psil")
+
+local coreio = {}
+
+---@class pocket_core_io
+local io = {
+    ps = psil.create()
+}
+
+---@enum POCKET_LINK_STATE
+local LINK_STATE = {
+    UNLINKED = 0,
+    SV_LINK_ONLY = 1,
+    API_LINK_ONLY = 2,
+    LINKED = 3
+}
+
+coreio.LINK_STATE = LINK_STATE
+
+-- get the core PSIL
+function coreio.core_ps()
+    return io.ps
+end
+
+-- set network link state
+---@param state POCKET_LINK_STATE
+function coreio.report_link_state(state)
+    io.ps.publish("link_state", state)
+end
+
+return coreio

pocket/pocket.lua

@@ -0,0 +1,408 @@
+local comms  = require("scada-common.comms")
+local log    = require("scada-common.log")
+local util   = require("scada-common.util")
+
+local coreio = require("pocket.coreio")
+
+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 CAPI_TYPE = comms.CAPI_TYPE
+
+local LINK_STATE = coreio.LINK_STATE
+
+local pocket = {}
+
+-- pocket coordinator + supervisor communications
+---@nodiscard
+---@param version string pocket version
+---@param modem table modem device
+---@param local_port integer local pocket port
+---@param sv_port integer port of supervisor
+---@param api_port integer port of coordinator API
+---@param range integer trusted device connection range
+---@param sv_watchdog watchdog
+---@param api_watchdog watchdog
+function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_watchdog, api_watchdog)
+    local self = {
+        sv = {
+            linked = false,
+            seq_num = 0,
+            r_seq_num = nil,    ---@type nil|integer
+            last_est_ack = ESTABLISH_ACK.ALLOW
+        },
+        api = {
+            linked = false,
+            seq_num = 0,
+            r_seq_num = nil,    ---@type nil|integer
+            last_est_ack = ESTABLISH_ACK.ALLOW
+        },
+        establish_delay_counter = 0
+    }
+
+    comms.set_trusted_range(range)
+
+    -- PRIVATE FUNCTIONS --
+
+    -- configure modem channels
+    local function _conf_channels()
+        modem.closeAll()
+        modem.open(local_port)
+    end
+
+    _conf_channels()
+
+    -- send a management packet to the supervisor
+    ---@param msg_type SCADA_MGMT_TYPE
+    ---@param msg table
+    local function _send_sv(msg_type, msg)
+        local s_pkt = comms.scada_packet()
+        local pkt = comms.mgmt_packet()
+
+        pkt.make(msg_type, msg)
+        s_pkt.make(self.sv.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
+
+        modem.transmit(sv_port, local_port, s_pkt.raw_sendable())
+        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 table
+    local function _send_crd(msg_type, msg)
+        local s_pkt = comms.scada_packet()
+        local pkt = comms.mgmt_packet()
+
+        pkt.make(msg_type, msg)
+        s_pkt.make(self.api.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
+
+        modem.transmit(api_port, local_port, s_pkt.raw_sendable())
+        self.api.seq_num = self.api.seq_num + 1
+    end
+
+    -- send a packet to the coordinator API
+    -----@param msg_type CAPI_TYPE
+    -----@param msg table
+    -- local function _send_api(msg_type, msg)
+    --     local s_pkt = comms.scada_packet()
+    --     local pkt = comms.capi_packet()
+
+    --     pkt.make(msg_type, msg)
+    --     s_pkt.make(self.api.seq_num, PROTOCOL.COORD_API, pkt.raw_sendable())
+
+    --     modem.transmit(api_port, local_port, s_pkt.raw_sendable())
+    --     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 })
+    end
+
+    -- attempt coordinator API connection establishment
+    local function _send_api_establish()
+        _send_crd(SCADA_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() })
+    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() })
+    end
+
+    -- PUBLIC FUNCTIONS --
+
+    ---@class pocket_comms
+    local public = {}
+
+    -- reconnect a newly connected modem
+    ---@param new_modem table
+    function public.reconnect_modem(new_modem)
+        modem = new_modem
+        _conf_channels()
+    end
+
+    -- close connection to the supervisor
+    function public.close_sv()
+        sv_watchdog.cancel()
+        self.sv.linked = false
+        _send_sv(SCADA_MGMT_TYPE.CLOSE, {})
+    end
+
+    -- close connection to coordinator API server
+    function public.close_api()
+        api_watchdog.cancel()
+        self.api.linked = false
+        _send_crd(SCADA_MGMT_TYPE.CLOSE, {})
+    end
+
+    -- close the connections to the servers
+    function public.close()
+        public.close_sv()
+        public.close_api()
+    end
+
+    -- attempt to re-link if any of the dependent links aren't active
+    function public.link_update()
+        if not self.sv.linked then
+            coreio.report_link_state(util.trinary(self.api.linked, LINK_STATE.API_LINK_ONLY, LINK_STATE.UNLINKED))
+
+            if self.establish_delay_counter <= 0 then
+                _send_sv_establish()
+                self.establish_delay_counter = 4
+            else
+                self.establish_delay_counter = self.establish_delay_counter - 1
+            end
+        elseif not self.api.linked then
+            coreio.report_link_state(LINK_STATE.SV_LINK_ONLY)
+
+            if self.establish_delay_counter <= 0 then
+                _send_api_establish()
+                self.establish_delay_counter = 4
+            else
+                self.establish_delay_counter = self.establish_delay_counter - 1
+            end
+        else
+            -- linked, all good!
+            coreio.report_link_state(LINK_STATE.LINKED)
+        end
+    end
+
+    -- parse a packet
+    ---@param side string
+    ---@param sender integer
+    ---@param reply_to integer
+    ---@param message any
+    ---@param distance integer
+    ---@return mgmt_frame|capi_frame|nil packet
+    function public.parse_packet(side, sender, reply_to, message, distance)
+        local pkt = nil
+        local s_pkt = comms.scada_packet()
+
+        -- parse packet as generic SCADA packet
+        s_pkt.receive(side, sender, reply_to, message, distance)
+
+        if s_pkt.is_valid() then
+            -- get as SCADA management packet
+            if s_pkt.protocol() == PROTOCOL.SCADA_MGMT then
+                local mgmt_pkt = comms.mgmt_packet()
+                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()
+                end
+            else
+                log.debug("attempted parse of illegal packet type " .. s_pkt.protocol(), true)
+            end
+        end
+
+        return pkt
+    end
+
+    -- handle a packet
+    ---@param packet mgmt_frame|capi_frame|nil
+    function public.handle_packet(packet)
+        if packet ~= nil then
+            local l_port = packet.scada_frame.local_port()
+            local r_port = packet.scada_frame.remote_port()
+            local protocol = packet.scada_frame.protocol()
+
+            if l_port ~= local_port then
+                log.debug("received packet on unconfigured channel " .. l_port, true)
+            elseif r_port == api_port then
+                -- check sequence number
+                if self.api.r_seq_num == nil then
+                    self.api.r_seq_num = packet.scada_frame.seq_num()
+                elseif self.connected and ((self.api.r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
+                    log.warning("sequence out-of-order: last = " .. self.api.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    return
+                else
+                    self.api.r_seq_num = packet.scada_frame.seq_num()
+                end
+
+                -- feed watchdog on valid sequence number
+                api_watchdog.feed()
+
+                if protocol == PROTOCOL.COORD_API then
+                    ---@cast packet capi_frame
+                elseif protocol == PROTOCOL.SCADA_MGMT then
+                    ---@cast packet mgmt_frame
+                    if packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                        -- connection with coordinator established
+                        if packet.length == 1 then
+                            local est_ack = packet.data[1]
+
+                            if est_ack == ESTABLISH_ACK.ALLOW then
+                                log.info("coordinator connection established")
+                                self.establish_delay_counter = 0
+                                self.api.linked = true
+
+                                if self.sv.linked then
+                                    coreio.report_link_state(LINK_STATE.LINKED)
+                                else
+                                    coreio.report_link_state(LINK_STATE.API_LINK_ONLY)
+                                end
+                            elseif est_ack == ESTABLISH_ACK.DENY then
+                                if self.api.last_est_ack ~= est_ack then
+                                    log.info("coordinator connection denied")
+                                end
+                            elseif est_ack == ESTABLISH_ACK.COLLISION then
+                                if self.api.last_est_ack ~= est_ack then
+                                    log.info("coordinator connection denied due to collision")
+                                end
+                            elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
+                                if self.api.last_est_ack ~= est_ack then
+                                    log.info("coordinator comms version mismatch")
+                                end
+                            else
+                                log.debug("coordinator SCADA_MGMT establish packet reply unsupported")
+                            end
+
+                            self.api.last_est_ack = est_ack
+                        else
+                            log.debug("coordinator SCADA_MGMT establish packet length mismatch")
+                        end
+                    elseif self.api.linked then
+                        if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                            -- keep alive request received, echo back
+                            if packet.length == 1 then
+                                local timestamp = packet.data[1]
+                                local trip_time = util.time() - timestamp
+
+                                if trip_time > 750 then
+                                    log.warning("pocket coordinator KEEP_ALIVE trip time > 750ms (" .. trip_time .. "ms)")
+                                end
+
+                                -- log.debug("pocket coordinator RTT = " .. trip_time .. "ms")
+
+                                _send_api_keep_alive_ack(timestamp)
+                            else
+                                log.debug("coordinator SCADA keep alive packet length mismatch")
+                            end
+                        elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                            -- handle session close
+                            api_watchdog.cancel()
+                            self.api.linked = false
+                            log.info("coordinator server connection closed by remote host")
+                        else
+                            log.debug("received unknown SCADA_MGMT packet type " .. packet.type .. " from coordinator")
+                        end
+                    else
+                        log.debug("discarding coordinator non-link SCADA_MGMT packet before linked")
+                    end
+                else
+                    log.debug("illegal packet type " .. protocol .. " from coordinator", true)
+                end
+            elseif r_port == sv_port then
+                -- check sequence number
+                if self.sv.r_seq_num == nil then
+                    self.sv.r_seq_num = packet.scada_frame.seq_num()
+                elseif self.connected and ((self.sv.r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
+                    log.warning("sequence out-of-order: last = " .. self.sv.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    return
+                else
+                    self.sv.r_seq_num = packet.scada_frame.seq_num()
+                end
+
+                -- feed watchdog on valid sequence number
+                sv_watchdog.feed()
+
+                -- handle packet
+                if protocol == PROTOCOL.SCADA_MGMT then
+                    ---@cast packet mgmt_frame
+                    if packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                        -- connection with supervisor established
+                        if packet.length == 1 then
+                            local est_ack = packet.data[1]
+
+                            if est_ack == ESTABLISH_ACK.ALLOW then
+                                log.info("supervisor connection established")
+                                self.establish_delay_counter = 0
+                                self.sv.linked = true
+
+                                if self.api.linked then
+                                    coreio.report_link_state(LINK_STATE.LINKED)
+                                else
+                                    coreio.report_link_state(LINK_STATE.SV_LINK_ONLY)
+                                end
+                            elseif est_ack == ESTABLISH_ACK.DENY then
+                                if self.sv.last_est_ack ~= est_ack then
+                                    log.info("supervisor connection denied")
+                                end
+                            elseif est_ack == ESTABLISH_ACK.COLLISION then
+                                if self.sv.last_est_ack ~= est_ack then
+                                    log.info("supervisor connection denied due to collision")
+                                end
+                            elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
+                                if self.sv.last_est_ack ~= est_ack then
+                                    log.info("supervisor comms version mismatch")
+                                end
+                            else
+                                log.debug("supervisor SCADA_MGMT establish packet reply unsupported")
+                            end
+
+                            self.sv.last_est_ack = est_ack
+                        else
+                            log.debug("supervisor SCADA_MGMT establish packet length mismatch")
+                        end
+                    elseif self.sv.linked then
+                        if packet.type == SCADA_MGMT_TYPE.KEEP_ALIVE then
+                            -- keep alive request received, echo back
+                            if packet.length == 1 then
+                                local timestamp = packet.data[1]
+                                local trip_time = util.time() - timestamp
+
+                                if trip_time > 750 then
+                                    log.warning("pocket supervisor KEEP_ALIVE trip time > 750ms (" .. trip_time .. "ms)")
+                                end
+
+                                -- log.debug("pocket supervisor RTT = " .. trip_time .. "ms")
+
+                                _send_sv_keep_alive_ack(timestamp)
+                            else
+                                log.debug("supervisor SCADA keep alive packet length mismatch")
+                            end
+                        elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
+                            -- handle session close
+                            sv_watchdog.cancel()
+                            self.sv.linked = false
+                            log.info("supervisor server connection closed by remote host")
+                        else
+                            log.debug("received unknown SCADA_MGMT packet type " .. packet.type .. " from supervisor")
+                        end
+                    else
+                        log.debug("discarding supervisor non-link SCADA_MGMT packet before linked")
+                    end
+                else
+                    log.debug("illegal packet type " .. protocol .. " from supervisor", true)
+                end
+            else
+                log.debug("received packet from unconfigured channel " .. r_port, true)
+            end
+        end
+    end
+
+    -- check if we are still linked with the supervisor
+    ---@nodiscard
+    function public.is_sv_linked() return self.sv.linked end
+
+    -- check if we are still linked with the coordinator
+    ---@nodiscard
+    function public.is_api_linked() return self.api.linked end
+
+    return public
+end
+
+
+return pocket

pocket/renderer.lua

@@ -0,0 +1,80 @@
+--
+-- Graphics Rendering Control
+--
+
+local main_view  = require("pocket.ui.main")
+local style      = require("pocket.ui.style")
+
+local flasher    = require("graphics.flasher")
+
+local DisplayBox = require("graphics.elements.displaybox")
+
+local renderer = {}
+
+local ui = {
+    display = nil
+}
+
+-- start the pocket GUI
+function renderer.start_ui()
+    if ui.display == nil then
+        -- reset screen
+        term.setTextColor(colors.white)
+        term.setBackgroundColor(colors.black)
+        term.clear()
+        term.setCursorPos(1, 1)
+
+        -- set overridden colors
+        for i = 1, #style.colors do
+            term.setPaletteColor(style.colors[i].c, style.colors[i].hex)
+        end
+
+        -- init front panel view
+        ui.display = DisplayBox{window=term.current(),fg_bg=style.root}
+        main_view(ui.display)
+
+        -- start flasher callback task
+        flasher.run()
+    end
+end
+
+-- close out the UI
+function renderer.close_ui()
+    if ui.display ~= nil then
+        -- stop blinking indicators
+        flasher.clear()
+
+        -- hide to stop animation callbacks
+        ui.display.hide()
+
+        -- clear root UI elements
+        ui.display = nil
+
+        -- 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 terminal
+        term.setTextColor(colors.white)
+        term.setBackgroundColor(colors.black)
+        term.clear()
+        term.setCursorPos(1, 1)
+    end
+end
+
+-- is the UI ready?
+---@nodiscard
+---@return boolean ready
+function renderer.ui_ready() return ui.display ~= nil end
+
+-- handle a mouse event
+---@param event mouse_interaction|nil
+function renderer.handle_mouse(event)
+    if ui.display ~= nil and event ~= nil then
+        ui.display.handle_mouse(event)
+    end
+end
+
+return renderer

pocket/startup.lua

@@ -1,5 +1,180 @@
 --
--- SCADA Coordinator Access on a Pocket Computer
+-- SCADA System Access on a Pocket Computer
 --
 
 require("/initenv").init_env()
+
+local crash        = require("scada-common.crash")
+local log          = require("scada-common.log")
+local ppm          = require("scada-common.ppm")
+local tcallbackdsp = require("scada-common.tcallbackdsp")
+local util         = require("scada-common.util")
+
+local core         = require("graphics.core")
+
+local config       = require("pocket.config")
+local coreio       = require("pocket.coreio")
+local pocket       = require("pocket.pocket")
+local renderer     = require("pocket.renderer")
+
+local POCKET_VERSION = "alpha-v0.3.1"
+
+local println = util.println
+local println_ts = util.println_ts
+
+----------------------------------------
+-- config validation
+----------------------------------------
+
+local cfv = util.new_validator()
+
+cfv.assert_port(config.SCADA_SV_PORT)
+cfv.assert_port(config.SCADA_API_PORT)
+cfv.assert_port(config.LISTEN_PORT)
+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")
+
+----------------------------------------
+-- log init
+----------------------------------------
+
+log.init(config.LOG_PATH, config.LOG_MODE, config.LOG_DEBUG == true)
+
+log.info("========================================")
+log.info("BOOTING pocket.startup " .. POCKET_VERSION)
+log.info("========================================")
+
+crash.set_env("pocket", POCKET_VERSION)
+
+----------------------------------------
+-- main application
+----------------------------------------
+
+local function main()
+    ----------------------------------------
+    -- system startup
+    ----------------------------------------
+
+    -- mount connected devices
+    ppm.mount_all()
+
+    ----------------------------------------
+    -- setup communications & clocks
+    ----------------------------------------
+
+    coreio.report_link_state(coreio.LINK_STATE.UNLINKED)
+
+    -- get the communications modem
+    local modem = ppm.get_wireless_modem()
+    if modem == nil then
+        println("startup> wireless modem not found: please craft the pocket computer with a wireless modem")
+        log.fatal("startup> no wireless modem on startup")
+        return
+    end
+
+    -- create connection watchdogs
+    local conn_wd = {
+        sv = util.new_watchdog(config.COMMS_TIMEOUT),
+        api = util.new_watchdog(config.COMMS_TIMEOUT)
+    }
+
+    conn_wd.sv.cancel()
+    conn_wd.api.cancel()
+
+    log.debug("startup> conn watchdogs created")
+
+    -- start comms, open all channels
+    local pocket_comms = pocket.comms(POCKET_VERSION, modem, config.LISTEN_PORT, config.SCADA_SV_PORT,
+                                        config.SCADA_API_PORT, config.TRUSTED_RANGE, conn_wd.sv, conn_wd.api)
+    log.debug("startup> comms init")
+
+    -- base loop clock (2Hz, 10 ticks)
+    local MAIN_CLOCK = 0.5
+    local loop_clock = util.new_clock(MAIN_CLOCK)
+
+    ----------------------------------------
+    -- start the UI
+    ----------------------------------------
+
+    local ui_ok, message = pcall(renderer.start_ui)
+    if not ui_ok then
+        renderer.close_ui()
+        println(util.c("UI error: ", message))
+        log.error(util.c("startup> GUI crashed with error ", message))
+    else
+        -- start clock
+        loop_clock.start()
+    end
+
+    ----------------------------------------
+    -- main event loop
+    ----------------------------------------
+
+    if ui_ok then
+        -- start connection watchdogs
+        conn_wd.sv.feed()
+        conn_wd.api.feed()
+        log.debug("startup> conn watchdog started")
+    end
+
+    -- main event loop
+    while ui_ok do
+        local event, param1, param2, param3, param4, param5 = util.pull_event()
+
+        -- handle event
+        if event == "timer" then
+            if loop_clock.is_clock(param1) then
+                -- main loop tick
+
+                -- relink if necessary
+                pocket_comms.link_update()
+
+                loop_clock.start()
+            elseif conn_wd.sv.is_timer(param1) then
+                -- supervisor watchdog timeout
+                log.info("supervisor server timeout")
+                pocket_comms.close_sv()
+            elseif conn_wd.api.is_timer(param1) then
+                -- coordinator watchdog timeout
+                log.info("coordinator api server timeout")
+                pocket_comms.close_api()
+            else
+                -- a non-clock/main watchdog timer event
+                -- notify timer callback dispatcher
+                tcallbackdsp.handle(param1)
+            end
+        elseif event == "modem_message" then
+            -- 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
+            -- handle a monitor touch event
+            renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3))
+        end
+
+        -- check for termination request
+        if event == "terminate" or ppm.should_terminate() then
+            log.info("terminate requested, closing server connections...")
+            pocket_comms.close()
+            log.info("connections closed")
+            break
+        end
+    end
+
+    renderer.close_ui()
+
+    println_ts("exited")
+    log.info("exited")
+end
+
+if not xpcall(main, crash.handler) then
+    pcall(renderer.close_ui)
+    crash.exit()
+else
+    log.close()
+end

pocket/ui/components/boiler_page.lua

@@ -0,0 +1,22 @@
+-- local style   = require("pocket.ui.style")
+
+local core    = require("graphics.core")
+
+local Div     = require("graphics.elements.div")
+local TextBox = require("graphics.elements.textbox")
+
+-- local cpair = core.cpair
+
+local TEXT_ALIGN = core.TEXT_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}
+
+    return main
+end
+
+return new_view

pocket/ui/components/conn_waiting.lua

@@ -0,0 +1,41 @@
+--
+-- Connection Waiting Spinner
+--
+
+local style       = require("pocket.ui.style")
+
+local core        = require("graphics.core")
+
+local Div         = require("graphics.elements.div")
+local TextBox     = require("graphics.elements.textbox")
+
+local WaitingAnim = require("graphics.elements.animations.waiting")
+
+local TEXT_ALIGN = core.TEXT_ALIGN
+
+local cpair = core.cpair
+
+-- create a waiting view
+---@param parent graphics_element parent
+---@param y integer y offset
+local function init(parent, y, is_api)
+    -- root div
+    local root = Div{parent=parent,x=1,y=1}
+
+    -- bounding box div
+    local box = Div{parent=root,x=1,y=y,height=5}
+
+    local waiting_x = math.floor(parent.width() / 2) - 1
+
+    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)}
+    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)}
+    end
+
+    return root
+end
+
+return init

pocket/ui/components/home_page.lua

@@ -0,0 +1,22 @@
+-- local style   = require("pocket.ui.style")
+
+local core    = require("graphics.core")
+
+local Div     = require("graphics.elements.div")
+local TextBox = require("graphics.elements.textbox")
+
+-- local cpair = core.cpair
+
+local TEXT_ALIGN = core.TEXT_ALIGN
+
+-- new home 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="HOME",x=1,y=1,height=1,alignment=TEXT_ALIGN.CENTER}
+
+    return main
+end
+
+return new_view

pocket/ui/components/reactor_page.lua

@@ -0,0 +1,22 @@
+-- local style   = require("pocket.ui.style")
+
+local core    = require("graphics.core")
+
+local Div     = require("graphics.elements.div")
+local TextBox = require("graphics.elements.textbox")
+
+-- local cpair = core.cpair
+
+local TEXT_ALIGN = core.TEXT_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}
+
+    return main
+end
+
+return new_view