From b7b4a2490a90dcb6f852d68836e3093f336980d2 Mon Sep 17 00:00:00 2001
From: Mikayla <mikayla@ky8.io>
Date: Tue, 20 Jun 2023 23:09:19 -0400
Subject: [PATCH] Updated Project Files (markdown)

---
 Project-Files.md | 86 ++++++++++++++++++++++++------------------------
 1 file changed, 43 insertions(+), 43 deletions(-)

diff --git a/Project-Files.md b/Project-Files.md
index f5cc595..39ad89d 100644
--- a/Project-Files.md
+++ b/Project-Files.md
@@ -173,29 +173,29 @@ 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/
-│   │   │   ├── 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
+│   │   │   ├── 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
+│   │   │   ├── 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
+│   ├── 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/
@@ -237,34 +237,34 @@ cc-mek-scada/
 │   ├── 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
+├── lockbox/                         - select lua-lockbox files
 ├── pocket/
 │   ├── ui/
 │   │   ├── components/
-│   │   │   └── conn_waiting.lua
+│   │   │   └── conn_waiting.lua     - connection waiting spinners
 │   │   ├── pages/
-│   │   │   ├── boiler_page.lua
-│   │   │   ├── home_page.lua
-│   │   │   ├── reactor_page.lua
-│   │   │   ├── turbine_page.lua
-│   │   │   └── unit_page.lua
-│   │   ├── main.lua
-│   │   └── style.lua
-│   ├── config.lua
-│   ├── coreio.lua
-│   ├── pocket.lua
-│   ├── renderer.lua
-│   └── startup.lua
+│   │   │   ├── boiler_page.lua      - boiler tab page
+│   │   │   ├── home_page.lua        - home tab page
+│   │   │   ├── reactor_page.lua     - reactor tab page
+│   │   │   ├── turbine_page.lua     - turbine tab page
+│   │   │   └── unit_page.lua        - unit overview tab page
+│   │   ├── main.lua                 - main UI display
+│   │   └── style.lua                - styling constants for pocket UI
+│   ├── config.lua                   - pocket configuration file
+│   ├── coreio.lua                   - core pocket I/O (PSIL and data)
+│   ├── pocket.lua                   - pocket core functions: comms
+│   ├── renderer.lua                 - GUI renderer control
+│   └── startup.lua                  - main pocket application
 ├── reactor-plc/
 │   ├── panel/
-│   │   ├── front_panel.lua
-│   │   └── style.lua
-│   ├── config.lua
-│   ├── databus.lua
-│   ├── plc.lua
-│   ├── renderer.lua
-│   ├── startup.lua
-│   └── threads.lua
+│   │   ├── front_panel.lua          - PLC front panel UI
+│   │   └── style.lua                - styling constants for PLC UI
+│   ├── config.lua                   - PLC configuration file
+│   ├── databus.lua                  - front panel PSIL
+│   ├── plc.lua                      - PLC core functions: RPS and comms
+│   ├── renderer.lua                 - GUI renderer control
+│   ├── startup.lua                  - PLC startup application
+│   └── threads.lua                  - PLC runtime "threads" (co-routines, main app)
 ├── rtu/
 │   ├── dev/
 │   │   ├── boilerv_rtu.lua
@@ -292,7 +292,7 @@ cc-mek-scada/
 │   ├── log.lua
 │   ├── mqueue.lua
 │   ├── ppm.lua
-│   ├── psil.lua
+│   ├── psil.lua                     - PSIL - publisher-subscriber interface layer
 │   ├── rsio.lua
 │   ├── tcd.lua
 │   ├── types.lua