Updated Project Files (markdown)

Mikayla 2023-06-20 23:01:31 -04:00
parent 4fed77d881
commit b91b51fc52

@ -2,54 +2,54 @@
cc-mek-scada/
coordinator/
session/
apisessions.lua - session manager for API
pocket.lua - pocket API session
apisessions.lua
pocket.lua
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
imatrix.lua
processctl.lua
reactor.lua
turbine.lua
unit_detail.lua
unit_overview.lua
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 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
main_view.lua
unit_view.lua
dialog.lua
style.lua
config.lua
coordinator.lua
iocontrol.lua
process.lua
renderer.lua
sounder.lua
startup.lua
graphics/
elements/
animations/
waiting.lua - loading spinning animation
waiting.lua
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
multi_button.lua
push_button.lua
radio_button.lua
sidebar.lua
spinbox_numeric.lua
switch_button.lua
tabbar.lua
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)
alight.lua
coremap.lua
data.lua
hbar.lua
icon.lua
led.lua
ledpair.lua
ledrgb.lua
light.lua
power.lua
rad.lua
state.lua
trilight.lua
vbar.lua
@ -62,32 +62,110 @@ cc-mek-scada/
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
core.lua
element.lua
events.lua
flasher.lua
lockbox/
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
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
reactor-plc/
panel/
front_panel.lua
style.lua
config.lua
databus.lua
plc.lua
renderer.lua
startup.lua
threads.lua
rtu/
dev/
boilerv_rtu.lua
envd_rtu.lua
imatrix_rtu.lua
redstone_rtu.lua
sna_rtu.lua
sps_rtu.lua
turbinev_rtu.lua
panel/
front_panel.lua
style.lua
config.lua
databus.lua
modbus.lua
renderer.lua
rtu.lua
startup.lua
threads.lua
scada-common/
comms.lua
constants.lua
crash.lua
crypto.lua
log.lua
mqueue.lua
ppm.lua
psil.lua
rsio.lua
tcd.lua
types.lua
util.lua
supervisor/
test/
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
imgen.py
initenv.lua
install_manifest.json
startup.lua
```-->
<!--https://tree.nathanfriend.io/?s=(%27opKs!(%27fancy!true~fullPath!fXse~trailNgSlash!true~rootDot!fXse)~wrce!(%27wrce!%27cc-mek-scada6c56*sJi76Bapi4B2Pocket%20APZsJi70BapisJi7s4zSJi7%20manage8fo8APIVui6BR%2F2UZelemqt%20R0Blayout%2FB2Display%20layouts%20%7BmaN3unit%7D0BdiXog4B*9FuncKsEo8tTmNX%20diXogs0Bstyle4*2StylesheetEo8c5%20UIEormattNgVQ4BB*9C5%20QuraKEileVc542C5%20comms3m7ito8QuraKVioH4*2I%2FO%20data3PSILEo8Xl%20unit3facility%20statuses3buildsVprocJ4B2ProcJ%20HEuncKs3settNgsYccJVrqdTT4BB9GUZrqdTe8HVwndT4B2Speake8wnde8t7e%20gqTaK3HVWB2MaNYpplicaK0graphics6lockbox6pocket6reactor-plc6rtu6scada-comm76supTvisor6test6ccmsi40imgq.py0Nitqv40NstXl_manifest.js70W%27)~vTsi7!%271%27)*%20%200%5Cn*2Bz3Ynd%204.lua5oordNator6%2F07on8rz%3A%20B**E%20fHc7trolJessKti7NinQc7figRcomp7qtsTerV0*Wstartup4XalY%20aZI%20qenwsouz%209%01zwqZYXWVTRQNKJHEB987654320*-->
<!--https://tree.nathanfriend.io/?s=(%27opti9s!(%27fancy!true~fullPath!false~trailTgSlash!true~rootDot!false)~source!(%27source!%27cc-mek-scada%2FJG2EOapiEs8L*uiAM3R3processctl3V3IHdetailHoverview8layoutO0maT_viewHview8dialog5G*ioc9trol*process6sounder*F4graphics2ejmUsOanimati9sO0waitTg8c9trolsO0hazardBmultiBpushBradioBsidebar3spTbox_numeric3switchBtabbar8TdicatorsO0aYcoQmap3data3hbar3ic93jd3jdpair3jdrgb3Ypower3rad3state3triYvbar8colormap8displaybox8div8listbox8multipane8pipenet8Qctangj8textbox8tilTg*coQ*ejmU*evUs*flasher4lockbox%2FJL2uiAc9n_waitTg8KsJ000M_K3home_K3V_K3I_KHK8maT5coQio*L6F4V-plc2COW5Nplc6F*thQads472devOMvXenvdXRXQdst9eXsnaXspsXIv_7*COW5Nmodbus67*F*thQads4scada-comm92comms*c9stants*crash*crypto*log*mqueue*ppm*psil*rsio*tcd*types*util4Z2CApdg_Ury37_Ury8W8pgi8styj*EO7O0Mv3envd3R3qtypes3Qdst9e3sna3sps3Iv3txnctrlHE8G8plc8L8rsctl878svqtypes8svEs*c9fig*Nfacility6F*Z*unit*unitlogic4ccmsi4Titenv4F.lua%27)~versi9!%271%27)*400%20%202%2FJ03804.luaJ58styj*c9fig*6*QndeQr*7rtu8*09onAOcomp9UsO0B_butt93CpanelEsessi9Fsta7pGcoordTatorH3unit_IturbTeJ%5Cn0KpageLpocketMboijrNdatabus*O20QreRimatrixTinUentVQactorWfr9t_CX_78Ylight3Zsupervisorjle%01jZYXWVUTRQONMLKJIHGFECBA987654320*-->
# Project Directory Layout and File Overviews
@ -162,21 +240,99 @@ cc-mek-scada/
├── 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
│ │ ├── components/
│ │ │ └── conn_waiting.lua
│ │ ├── 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
├── reactor-plc/
│ ├── panel/
│ │ ├── front_panel.lua
│ │ └── style.lua
│ ├── config.lua
│ ├── databus.lua
│ ├── plc.lua
│ ├── renderer.lua
│ ├── startup.lua
│ └── threads.lua
├── rtu/
│ ├── dev/
│ │ ├── boilerv_rtu.lua
│ │ ├── envd_rtu.lua
│ │ ├── imatrix_rtu.lua
│ │ ├── redstone_rtu.lua
│ │ ├── sna_rtu.lua
│ │ ├── sps_rtu.lua
│ │ └── turbinev_rtu.lua
│ ├── panel/
│ │ ├── front_panel.lua
│ │ └── style.lua
│ ├── config.lua
│ ├── databus.lua
│ ├── modbus.lua
│ ├── renderer.lua
│ ├── rtu.lua
│ ├── startup.lua
│ └── threads.lua
├── scada-common/
│ ├── comms.lua
│ ├── constants.lua
│ ├── crash.lua
│ ├── crypto.lua
│ ├── log.lua
│ ├── mqueue.lua
│ ├── ppm.lua
│ ├── psil.lua
│ ├── rsio.lua
│ ├── tcd.lua
│ ├── types.lua
│ └── util.lua
├── supervisor/
├── test/
│ ├── 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
├── imgen.py
├── initenv.lua
├── install_manifest.json
└── startup.lua
```