diff --git a/Project-Files.md b/Project-Files.md index 3cc13c9..0b33868 100644 --- a/Project-Files.md +++ b/Project-Files.md @@ -170,13 +170,13 @@ cc-mek-scada/ # Project Directory Layout and File Overviews ``` -cc-mek-scada/ -├── coordinator/ -│ ├── session/ +cc-mek-scada/ = ComputerCraft Mekanism SCADA system +├── coordinator/ = coordinator application +│ ├── session/ = coordinator device sessions │ │ ├── apisessions.lua - session manager for API │ │ └── pocket.lua - pocket API session -│ ├── ui/ -│ │ ├── components/ +│ ├── ui/ = coordinator UI definitions +│ │ ├── 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/ -│ ├── elements/ -│ │ ├── animations/ +├── graphics/ = graphics library +│ ├── elements/ = all graphics elements +│ │ ├── 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/ -│ ├── ui/ -│ │ ├── components/ +├── pocket/ = pocket computer application +│ ├── ui/ = pocket UI definitions +│ │ ├── 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/ -│ ├── panel/ +├── reactor-plc/ = reactor PLC application +│ ├── 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/ -│ ├── dev/ +├── rtu/ = RTU gateway application +│ ├── 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/ -│ ├── panel/ -│ │ ├── components/ -│ │ │ ├── pdg_entry.lua -│ │ │ └── rtu_entry.lua -│ │ ├── front_panel.lua -│ │ ├── pgi.lua -│ │ └── style.lua -│ ├── session/ -│ │ ├── rtu/ -│ │ │ ├── boilerv.lua -│ │ │ ├── envd.lua -│ │ │ ├── imatrix.lua -│ │ │ ├── qtypes.lua -│ │ │ ├── redstone.lua -│ │ │ ├── sna.lua -│ │ │ ├── sps.lua -│ │ │ ├── turbinev.lua -│ │ │ ├── txnctrl.lua -│ │ │ └── unit_session.lua -│ │ ├── coordinator.lua -│ │ ├── plc.lua -│ │ ├── pocket.lua -│ │ ├── rsctl.lua -│ │ ├── rtu.lua -│ │ ├── svqtypes.lua -│ │ └── svsessions.lua -│ ├── config.lua -│ ├── databus.lua -│ ├── facility.lua -│ ├── renderer.lua -│ ├── startup.lua -│ ├── supervisor.lua -│ ├── unit.lua -│ └── unitlogic.lua -├── ccmsi.lua -├── initenv.lua -└── startup.lua +├── supervisor/ = supervisor application +│ ├── panel/ = supervisor front panel +│ │ ├── components/ = front panel UI componenets +│ │ │ ├── pdg_entry.lua - pocket diagnostics list entry +│ │ │ └── rtu_entry.lua - RTU list entry +│ │ ├── front_panel.lua - supervisor front panel UI +│ │ ├── pgi.lua - protected graphics interface for managing list elements +│ │ └── style.lua - styling constants for supervisor UI +│ ├── session/ = supervisor device sessions +│ │ ├── rtu/ = RTU session individual unit handlers +│ │ │ ├── boilerv.lua - boiler [valve] unit handler +│ │ │ ├── envd.lua - environement detector unit handler +│ │ │ ├── imatrix.lua - induction matrix unit handler +│ │ │ ├── qtypes.lua - RTU queue data types +│ │ │ ├── redstone.lua - redstone unit handler +│ │ │ ├── sna.lua - solar neutron activator unit handler +│ │ │ ├── sps.lua - supercritical phase shifter unit handler +│ │ │ ├── turbinev.lua - turbine [valve] unit handler +│ │ │ ├── txnctrl.lua - MODBUS transaction control handler +│ │ │ └── unit_session.lua - RTU unit session generic base class +│ │ ├── coordinator.lua - coordinator session handler +│ │ ├── plc.lua - PLC session handler +│ │ ├── pocket.lua - pocket diagnostics session handler +│ │ ├── rsctl.lua - redstone RTU session I/O controller +│ │ ├── rtu.lua - RTU gateway session handler +│ │ ├── svqtypes.lua - supervisor session queue types +│ │ └── svsessions.lua - supervisor session manager +│ ├── config.lua - supervisor configuration file +│ ├── databus.lua - front panel PSIL +│ ├── facility.lua - SCADA core facility management +│ ├── renderer.lua - GUI renderer control +│ ├── startup.lua - main supervisor application +│ ├── supervisor.lua - supervisor core functions: comms +│ ├── unit.lua - SCADA core reactor unit management +│ └── unitlogic.lua - reactor unit management functions (unit.lua would otherwise exceed 1000 lines) +├── ccmsi.lua - cc-mek-scada installer +├── initenv.lua - application environment initialization (for subdirectories) +└── startup.lua - core startup program ("bootloader") ``` \ No newline at end of file