From 4fed77d88153eabe8cf4e283bd065983b8994ca4 Mon Sep 17 00:00:00 2001 From: Mikayla Date: Tue, 20 Jun 2023 22:49:49 -0400 Subject: [PATCH] Updated Project Files (markdown) --- Project-Files.md | 217 ++++++++++++++++++++++++++++++----------------- 1 file changed, 137 insertions(+), 80 deletions(-) diff --git a/Project-Files.md b/Project-Files.md index b1de956..4ec9b72 100644 --- a/Project-Files.md +++ b/Project-Files.md @@ -1,24 +1,81 @@ -``` + # Project Directory Layout and File Overviews @@ -38,80 +95,80 @@ cc-mek-scada/ cc-mek-scada/ ├── coordinator/ │ ├── session/ -│ │ ├── apisessions.lua : Session manager for API -│ │ └── pocket.lua : Pocket API session +│ │ ├── apisessions.lua - session manager for API +│ │ └── pocket.lua - pocket API session │ ├── ui/ -│ │ ├── components/ : UI element components/ -│ │ │ ├── boiler.lua -│ │ │ ├── imatrix.lua -│ │ │ ├── processctl.lua -│ │ │ ├── reactor.lua -│ │ │ ├── turbine.lua -│ │ │ ├── unit_detail.lua -│ │ │ └── unit_overview.lua -│ │ ├── layout/ : Display layouts (main and unit)/ -│ │ │ ├── main_view.lua -│ │ │ └── unit_view.lua -│ │ ├── dialog.lua : Functions for terminal dialogs -│ │ └── style.lua : Stylesheet for coordinator UI formatting -│ ├── config.lua : Coordinator configuration file -│ ├── coordinator.lua : Coordinator comms and monitor configuration -│ ├── iocontrol.lua : I/O data and PSIL for unit & facility statuses and builds -│ ├── 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 +│ │ ├── components/ +│ │ │ ├── boiler.lua - boiler display for overview +│ │ │ ├── imatrix.lua - induction matrix display on main screen +│ │ │ ├── processctl.lua - process control interface on main screen +│ │ │ ├── reactor.lua - reactor display for overview +│ │ │ ├── turbine.lua - turbine display for overview +│ │ │ ├── unit_detail.lua - unit detail display on unit monitors +│ │ │ └── unit_overview.lua - unit overview on primary monitor +│ │ ├── layout/ +│ │ │ ├── main_view.lua - main screen on primary monitor +│ │ │ └── unit_view.lua - unit screens on unit monitors +│ │ ├── dialog.lua - functions for terminal dialogs +│ │ └── style.lua - 'stylesheet' for coordinator UI formatting +│ ├── config.lua - coordinator configuration file +│ ├── coordinator.lua - coordinator comms and monitor configuration +│ ├── 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/ -│ │ │ └── waiting.lua - loading spinning animation +│ │ │ └── waiting.lua - loading spinning animation │ │ ├── controls/ -│ │ │ ├── hazard_button.lua - button with hazard pattern around it -│ │ │ ├── multi_button.lua - multi-choice button -│ │ │ ├── push_button.lua - push button, single press then releases -│ │ │ ├── radio_button.lua - multi-choice vertical radio button -│ │ │ ├── sidebar.lua - sidebar vertical tab selector -│ │ │ ├── spinbox_numeric.lua - fixed-point number spinbox input -│ │ │ ├── switch_button.lua - switch button, single press toggles state -│ │ │ └── tabbar.lua - horizontal tab selector +│ │ │ ├── hazard_button.lua - button with hazard pattern around it +│ │ │ ├── multi_button.lua - multi-choice button +│ │ │ ├── push_button.lua - push button, single press then releases +│ │ │ ├── radio_button.lua - multi-choice vertical radio button +│ │ │ ├── sidebar.lua - sidebar vertical tab selector +│ │ │ ├── spinbox_numeric.lua - fixed-point number spinbox input +│ │ │ ├── switch_button.lua - switch button, single press toggles state +│ │ │ └── tabbar.lua - horizontal tab selector │ │ ├── indicators/ -│ │ │ ├── alight.lua - alarm light indicator (quad-state) -│ │ │ ├── coremap.lua - reactor core map -│ │ │ ├── data.lua - numerical data indicator w/ labels & units -│ │ │ ├── hbar.lua - horizontal bar 'plot' (single bar) -│ │ │ ├── icon.lua - single character indicator w/ color -│ │ │ ├── led.lua - tiny rectangle 'LED' indicator (on/off) -│ │ │ ├── ledpair.lua - tiny rectangle 'LED' indicator (tri-state) -│ │ │ ├── ledrgb.lua - tiny rectangle 'LED' indicator (n-state) -│ │ │ ├── light.lua - square light indicator (on/off) -│ │ │ ├── power.lua - numerical indicator for power (auto-scaled units) -│ │ │ ├── rad.lua - numerical indicator for radiation (auto-scaled units) -│ │ │ ├── state.lua -│ │ │ ├── trilight.lua -│ │ │ └── vbar.lua -│ │ ├── colormap.lua -│ │ ├── displaybox.lua -│ │ ├── div.lua -│ │ ├── listbox.lua -│ │ ├── multipane.lua -│ │ ├── pipenet.lua -│ │ ├── rectangle.lua -│ │ ├── textbox.lua -│ │ └── tiling.lua -│ ├── core.lua : Core graphics utilities -│ ├── element.lua : Base "class" of all graphics elements -│ ├── events.lua : Mouse/keyboard event handling -│ └── flasher.lua : Handler for flashing indicators -├── lockbox/ : Select lua-lockbox files +│ │ │ ├── alight.lua - alarm light indicator (quad-state) +│ │ │ ├── coremap.lua - reactor core map +│ │ │ ├── data.lua - numerical data indicator w/ labels & units +│ │ │ ├── hbar.lua - horizontal percentage bar +│ │ │ ├── icon.lua - single character indicator w/ color +│ │ │ ├── led.lua - tiny rectangle 'LED' indicator (on/off) +│ │ │ ├── ledpair.lua - tiny rectangle 'LED' indicator (tri-state) +│ │ │ ├── ledrgb.lua - tiny rectangle 'LED' indicator (n-state) +│ │ │ ├── light.lua - square light indicator (on/off) +│ │ │ ├── power.lua - numerical indicator for power (auto-scaled units) +│ │ │ ├── rad.lua - numerical indicator for radiation (auto-scaled units) +│ │ │ ├── state.lua - text + color state indicator +│ │ │ ├── trilight.lua - square light indicator (tri-state) +│ │ │ └── vbar.lua - vertical percentage bar +│ │ ├── colormap.lua - color map (for testing, shows all colors in a row) +│ │ ├── displaybox.lua - container element used as the root of the element tree, uses a window object as parent +│ │ ├── div.lua - container element, uses a normal element as its parent +│ │ ├── listbox.lua - scrolling listbox +│ │ ├── multipane.lua - multi-pane, to be used with a tab control to show multiple views in the same place +│ │ ├── pipenet.lua - pipe network, used on main screen (as an example) +│ │ ├── rectangle.lua - container element with an optional boarder, uses a normal element as its parent +│ │ ├── textbox.lua - text box, supports text alignment and wrapping +│ │ └── tiling.lua - alternating tiling pattern element +│ ├── core.lua - core graphics utilities +│ ├── element.lua - base "class" of all graphics elements +│ ├── events.lua - mouse/keyboard event handling +│ └── flasher.lua - handler for flashing indicators +├── lockbox/ - select lua-lockbox files ├── pocket/ │ ├── ui/ │ │ └── components/ │ │ └── conn_waiting.lua -│ ├── config.lua : Pocket configuration file -│ ├── coreio.lua : I/O data and PSIL for pocket -│ ├── pocket.lua : Pocket comms -│ ├── renderer.lua : GUI renderer control -│ └── startup.lua : Main pocket application +│ ├── config.lua - pocket configuration file +│ ├── coreio.lua - I/O data and PSIL for pocket +│ ├── pocket.lua - pocket comms +│ ├── renderer.lua - GUI renderer control +│ └── startup.lua - main pocket application ├── reactor-plc/ ├── rtu/ ├── scada-common/