Updated Project Files (markdown)

Project-Files.md

@@ -170,13 +170,13 @@ cc-mek-scada/
 # Project Directory Layout and File Overviews
 
 ```
-cc-mek-scada/
+cc-mek-scada/                        = ComputerCraft Mekanism SCADA system
-├── coordinator/
+├── coordinator/                     = coordinator application
-│   ├── session/
+│   ├── session/                     = coordinator device sessions
 │   │   ├── apisessions.lua          - session manager for API
 │   │   └── pocket.lua               - pocket API session
-│   ├── ui/
+│   ├── ui/                          = coordinator UI definitions
-│   │   ├── components/
+│   │   ├── components/              = coordinator UI componenets
 │   │   │   ├── boiler.lua           - boiler display for overview
 │   │   │   ├── imatrix.lua          - induction matrix display on main screen
 │   │   │   ├── processctl.lua       - process control interface on main screen
@@ -184,23 +184,23 @@ cc-mek-scada/
 │   │   │   ├── turbine.lua          - turbine display for overview
 │   │   │   ├── unit_detail.lua      - unit detail display on unit monitors
 │   │   │   └── unit_overview.lua    - unit overview on primary monitor
-│   │   ├── layout/
+│   │   ├── layout/                  = monitor UI layout files
 │   │   │   ├── main_view.lua        - main screen on primary monitor
 │   │   │   └── unit_view.lua        - unit screens on unit monitors
 │   │   ├── dialog.lua               - functions for terminal dialogs
 │   │   └── style.lua                - styling constants for coordinator UI
 │   ├── config.lua                   - coordinator configuration file
-│   ├── coordinator.lua              - coordinator core functions: comms and monitor configuration
+│   ├── coordinator.lua              - coordinator core functions: comms, monitor configuration, dmesg helpers
 │   ├── iocontrol.lua                - I/O data and PSIL for unit & facility statuses and build
 │   ├── process.lua                  - process control functions and settings access
 │   ├── renderer.lua                 - GUI renderer control
 │   ├── sounder.lua                  - speaker sounder tone generation and control
 │   └── startup.lua                  - main coordinator application
-├── graphics/
+├── graphics/                        = graphics library
-│   ├── elements/
+│   ├── elements/                    = all graphics elements
-│   │   ├── animations/
+│   │   ├── animations/              = animated elements
 │   │   │   └── waiting.lua          - loading spinning animation
-│   │   ├── controls/
+│   │   ├── controls/                = control elements
 │   │   │   ├── hazard_button.lua    - button with hazard pattern around it
 │   │   │   ├── multi_button.lua     - multi-choice button
 │   │   │   ├── push_button.lua      - push button, single press then releases
@@ -209,7 +209,7 @@ cc-mek-scada/
 │   │   │   ├── spinbox_numeric.lua  - fixed-point number spinbox input
 │   │   │   ├── switch_button.lua    - switch button, single press toggles state
 │   │   │   └── tabbar.lua           - horizontal tab selector
-│   │   ├── indicators/
+│   │   ├── indicators/              = indicator elements
 │   │   │   ├── alight.lua           - alarm light indicator (quad-state)
 │   │   │   ├── coremap.lua          - reactor core map
 │   │   │   ├── data.lua             - numerical data indicator w/ labels & units
@@ -238,11 +238,11 @@ cc-mek-scada/
 │   ├── events.lua                   - mouse/keyboard event handling
 │   └── flasher.lua                  - handler for flashing indicators
 ├── lockbox/                         - select lua-lockbox files
-├── pocket/
+├── pocket/                          = pocket computer application
-│   ├── ui/
+│   ├── ui/                          = pocket UI definitions
-│   │   ├── components/
+│   │   ├── components/              = pocket UI componenets
 │   │   │   └── conn_waiting.lua     - connection waiting spinners
-│   │   ├── pages/
+│   │   ├── pages/                   = pocket tabbed pages
 │   │   │   ├── boiler_page.lua      - boiler tab page
 │   │   │   ├── home_page.lua        - home tab page
 │   │   │   ├── reactor_page.lua     - reactor tab page
@@ -255,8 +255,8 @@ cc-mek-scada/
 │   ├── pocket.lua                   - pocket core functions: comms
 │   ├── renderer.lua                 - GUI renderer control
 │   └── startup.lua                  - main pocket application
-├── reactor-plc/
+├── reactor-plc/                     = reactor PLC application
-│   ├── panel/
+│   ├── panel/                       = PLC front panel
 │   │   ├── front_panel.lua          - PLC front panel UI
 │   │   └── style.lua                - styling constants for PLC UI
 │   ├── config.lua                   - PLC configuration file
@@ -265,8 +265,8 @@ cc-mek-scada/
 │   ├── renderer.lua                 - GUI renderer control
 │   ├── startup.lua                  - PLC startup application
 │   └── threads.lua                  - PLC runtime "threads" (co-routines, main app)
-├── rtu/
+├── rtu/                             = RTU gateway application
-│   ├── dev/
+│   ├── dev/                         = RTU interfaces
 │   │   ├── boilerv_rtu.lua          - boiler [valve] RTU interface
 │   │   ├── envd_rtu.lua             - environment detector RTU interface
 │   │   ├── imatrix_rtu.lua          - induction matrix RTU interface
@@ -274,7 +274,7 @@ cc-mek-scada/
 │   │   ├── sna_rtu.lua              - solar neutron activator RTU interface
 │   │   ├── sps_rtu.lua              - supercritical phase shifter RTU interface
 │   │   └── turbinev_rtu.lua         - turbine [valve] RTU interface
-│   ├── panel/
+│   ├── panel/                       = RTU front panel
 │   │   ├── front_panel.lua          - RTU front panel UI
 │   │   └── style.lua                - styling constants for RTU UI
 │   ├── config.lua                   - RTU configuration file
@@ -284,7 +284,7 @@ cc-mek-scada/
 │   ├── rtu.lua                      - RTU core functions: comms and RTU unit init
 │   ├── startup.lua                  - RTU startup application
 │   └── threads.lua                  - RTU runtime "threads" (co-routines, main app)
-├── scada-common/
+├── scada-common/                    = common and system files
 │   ├── comms.lua                    - system communications protocol and packet constructors
 │   ├── constants.lua                - system-wide constants, safety thresholds, and conversion factors
 │   ├── crash.lua                    - crash message handling
@@ -297,42 +297,42 @@ cc-mek-scada/
 │   ├── tcd.lua                      - TCD - timer callback dispatcher (call functions after a delay)
 │   ├── types.lua                    - common data types and constructors
 │   └── util.lua                     - system utility functions (prints, math, strings, clock & watchdog timers, etc)
-├── supervisor/
+├── supervisor/                      = supervisor application
-│   ├── panel/
+│   ├── panel/                       = supervisor front panel
-│   │   ├── components/
+│   │   ├── components/              = front panel UI componenets
-│   │   │   ├── pdg_entry.lua
+│   │   │   ├── pdg_entry.lua        - pocket diagnostics list entry
-│   │   │   └── rtu_entry.lua
+│   │   │   └── rtu_entry.lua        - RTU list entry
-│   │   ├── front_panel.lua
+│   │   ├── front_panel.lua          - supervisor front panel UI
-│   │   ├── pgi.lua
+│   │   ├── pgi.lua                  - protected graphics interface for managing list elements
-│   │   └── style.lua
+│   │   └── style.lua                - styling constants for supervisor UI
-│   ├── session/
+│   ├── session/                     = supervisor device sessions
-│   │   ├── rtu/
+│   │   ├── rtu/                     = RTU session individual unit handlers
-│   │   │   ├── boilerv.lua
+│   │   │   ├── boilerv.lua          - boiler [valve] unit handler
-│   │   │   ├── envd.lua
+│   │   │   ├── envd.lua             - environement detector unit handler
-│   │   │   ├── imatrix.lua
+│   │   │   ├── imatrix.lua          - induction matrix unit handler
-│   │   │   ├── qtypes.lua
+│   │   │   ├── qtypes.lua           - RTU queue data types
-│   │   │   ├── redstone.lua
+│   │   │   ├── redstone.lua         - redstone unit handler
-│   │   │   ├── sna.lua
+│   │   │   ├── sna.lua              - solar neutron activator unit handler
-│   │   │   ├── sps.lua
+│   │   │   ├── sps.lua              - supercritical phase shifter unit handler
-│   │   │   ├── turbinev.lua
+│   │   │   ├── turbinev.lua         - turbine [valve] unit handler
-│   │   │   ├── txnctrl.lua
+│   │   │   ├── txnctrl.lua          - MODBUS transaction control handler
-│   │   │   └── unit_session.lua
+│   │   │   └── unit_session.lua     - RTU unit session generic base class
-│   │   ├── coordinator.lua
+│   │   ├── coordinator.lua          - coordinator session handler
-│   │   ├── plc.lua
+│   │   ├── plc.lua                  - PLC session handler
-│   │   ├── pocket.lua
+│   │   ├── pocket.lua               - pocket diagnostics session handler
-│   │   ├── rsctl.lua
+│   │   ├── rsctl.lua                - redstone RTU session I/O controller
-│   │   ├── rtu.lua
+│   │   ├── rtu.lua                  - RTU gateway session handler
-│   │   ├── svqtypes.lua
+│   │   ├── svqtypes.lua             - supervisor session queue types
-│   │   └── svsessions.lua
+│   │   └── svsessions.lua           - supervisor session manager
-│   ├── config.lua
+│   ├── config.lua                   - supervisor configuration file
-│   ├── databus.lua
+│   ├── databus.lua                  - front panel PSIL
-│   ├── facility.lua
+│   ├── facility.lua                 - SCADA core facility management
-│   ├── renderer.lua
+│   ├── renderer.lua                 - GUI renderer control
-│   ├── startup.lua
+│   ├── startup.lua                  - main supervisor application
-│   ├── supervisor.lua
+│   ├── supervisor.lua               - supervisor core functions: comms
-│   ├── unit.lua
+│   ├── unit.lua                     - SCADA core reactor unit management
-│   └── unitlogic.lua
+│   └── unitlogic.lua                - reactor unit management functions (unit.lua would otherwise exceed 1000 lines)
-├── ccmsi.lua
+├── ccmsi.lua                        - cc-mek-scada installer
-├── initenv.lua
+├── initenv.lua                      - application environment initialization (for subdirectories)
-└── startup.lua
+└── startup.lua                      - core startup program ("bootloader")
 ```