Updated Project Files (markdown)
Mikayla
parent
5e1c76cc04
commit
4fed77d881
179
Project-Files.md
179
Project-Files.md
@ -1,24 +1,81 @@
|
|||||||
```
|
<!--```
|
||||||
cc-mek-scada/
|
cc-mek-scada/
|
||||||
coordinator/
|
coordinator/
|
||||||
session/
|
session/
|
||||||
api.lua : Pocket API session
|
apisessions.lua - session manager for API
|
||||||
apisessions.lua : Session manager for API
|
pocket.lua - pocket API session
|
||||||
ui/
|
ui/
|
||||||
components/ : UI element components
|
components/
|
||||||
layout/ : Display layouts (main and unit)
|
boiler.lua - boiler display for overview
|
||||||
dialog.lua : Functions for terminal dialogs
|
imatrix.lua - induction matrix display on main screen
|
||||||
style.lua : Stylesheet for coordinator UI formatting
|
processctl.lua - process control interface on main screen
|
||||||
config.lua : Coordinator configuration file
|
reactor.lua - reactor display for overview
|
||||||
coordinator.lua : Coordinator comms and monitor configuration
|
turbine.lua - turbine display for overview
|
||||||
iocontrol.lua : I/O data and PSIL for all unit and facility status and builds
|
unit_detail.lua - unit detail display on unit monitors
|
||||||
process.lua : Process control functions and settings access
|
unit_overview.lua - unit overview on primary monitor
|
||||||
renderer.lua : GUI renderer control
|
layout/
|
||||||
sounder.lua : Speaker sounder tone generation and control
|
main_view.lua - main screen on primary monitor
|
||||||
startup.lua : Main application
|
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
|
||||||
graphics/
|
graphics/
|
||||||
lockbox/
|
elements/
|
||||||
|
animations/
|
||||||
|
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
|
||||||
|
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
|
||||||
pocket/
|
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
|
||||||
reactor-plc/
|
reactor-plc/
|
||||||
rtu/
|
rtu/
|
||||||
scada-common/
|
scada-common/
|
||||||
@ -29,7 +86,7 @@ cc-mek-scada/
|
|||||||
initenv.lua
|
initenv.lua
|
||||||
install_manifest.json
|
install_manifest.json
|
||||||
startup.lua
|
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=(%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*-->
|
||||||
|
|
||||||
# Project Directory Layout and File Overviews
|
# Project Directory Layout and File Overviews
|
||||||
@ -38,29 +95,29 @@ cc-mek-scada/
|
|||||||
cc-mek-scada/
|
cc-mek-scada/
|
||||||
├── coordinator/
|
├── coordinator/
|
||||||
│ ├── session/
|
│ ├── session/
|
||||||
│ │ ├── apisessions.lua : Session manager for API
|
│ │ ├── apisessions.lua - session manager for API
|
||||||
│ │ └── pocket.lua : Pocket API session
|
│ │ └── pocket.lua - pocket API session
|
||||||
│ ├── ui/
|
│ ├── ui/
|
||||||
│ │ ├── components/ : UI element components/
|
│ │ ├── components/
|
||||||
│ │ │ ├── boiler.lua
|
│ │ │ ├── boiler.lua - boiler display for overview
|
||||||
│ │ │ ├── imatrix.lua
|
│ │ │ ├── imatrix.lua - induction matrix display on main screen
|
||||||
│ │ │ ├── processctl.lua
|
│ │ │ ├── processctl.lua - process control interface on main screen
|
||||||
│ │ │ ├── reactor.lua
|
│ │ │ ├── reactor.lua - reactor display for overview
|
||||||
│ │ │ ├── turbine.lua
|
│ │ │ ├── turbine.lua - turbine display for overview
|
||||||
│ │ │ ├── unit_detail.lua
|
│ │ │ ├── unit_detail.lua - unit detail display on unit monitors
|
||||||
│ │ │ └── unit_overview.lua
|
│ │ │ └── unit_overview.lua - unit overview on primary monitor
|
||||||
│ │ ├── layout/ : Display layouts (main and unit)/
|
│ │ ├── layout/
|
||||||
│ │ │ ├── main_view.lua
|
│ │ │ ├── main_view.lua - main screen on primary monitor
|
||||||
│ │ │ └── unit_view.lua
|
│ │ │ └── unit_view.lua - unit screens on unit monitors
|
||||||
│ │ ├── dialog.lua : Functions for terminal dialogs
|
│ │ ├── dialog.lua - functions for terminal dialogs
|
||||||
│ │ └── style.lua : Stylesheet for coordinator UI formatting
|
│ │ └── style.lua - 'stylesheet' for coordinator UI formatting
|
||||||
│ ├── config.lua : Coordinator configuration file
|
│ ├── config.lua - coordinator configuration file
|
||||||
│ ├── coordinator.lua : Coordinator comms and monitor configuration
|
│ ├── coordinator.lua - coordinator comms and monitor configuration
|
||||||
│ ├── iocontrol.lua : I/O data and PSIL for unit & facility statuses and builds
|
│ ├── iocontrol.lua - I/O data and PSIL for unit & facility statuses and build
|
||||||
│ ├── process.lua : Process control functions and settings access
|
│ ├── process.lua - process control functions and settings access
|
||||||
│ ├── renderer.lua : GUI renderer control
|
│ ├── renderer.lua - GUI renderer control
|
||||||
│ ├── sounder.lua : Speaker sounder tone generation and control
|
│ ├── sounder.lua - speaker sounder tone generation and control
|
||||||
│ └── startup.lua : Main coordinator application
|
│ └── startup.lua - main coordinator application
|
||||||
├── graphics/
|
├── graphics/
|
||||||
│ ├── elements/
|
│ ├── elements/
|
||||||
│ │ ├── animations/
|
│ │ ├── animations/
|
||||||
@ -78,7 +135,7 @@ cc-mek-scada/
|
|||||||
│ │ │ ├── alight.lua - alarm light indicator (quad-state)
|
│ │ │ ├── alight.lua - alarm light indicator (quad-state)
|
||||||
│ │ │ ├── coremap.lua - reactor core map
|
│ │ │ ├── coremap.lua - reactor core map
|
||||||
│ │ │ ├── data.lua - numerical data indicator w/ labels & units
|
│ │ │ ├── data.lua - numerical data indicator w/ labels & units
|
||||||
│ │ │ ├── hbar.lua - horizontal bar 'plot' (single bar)
|
│ │ │ ├── hbar.lua - horizontal percentage bar
|
||||||
│ │ │ ├── icon.lua - single character indicator w/ color
|
│ │ │ ├── icon.lua - single character indicator w/ color
|
||||||
│ │ │ ├── led.lua - tiny rectangle 'LED' indicator (on/off)
|
│ │ │ ├── led.lua - tiny rectangle 'LED' indicator (on/off)
|
||||||
│ │ │ ├── ledpair.lua - tiny rectangle 'LED' indicator (tri-state)
|
│ │ │ ├── ledpair.lua - tiny rectangle 'LED' indicator (tri-state)
|
||||||
@ -86,32 +143,32 @@ cc-mek-scada/
|
|||||||
│ │ │ ├── light.lua - square light indicator (on/off)
|
│ │ │ ├── light.lua - square light indicator (on/off)
|
||||||
│ │ │ ├── power.lua - numerical indicator for power (auto-scaled units)
|
│ │ │ ├── power.lua - numerical indicator for power (auto-scaled units)
|
||||||
│ │ │ ├── rad.lua - numerical indicator for radiation (auto-scaled units)
|
│ │ │ ├── rad.lua - numerical indicator for radiation (auto-scaled units)
|
||||||
│ │ │ ├── state.lua
|
│ │ │ ├── state.lua - text + color state indicator
|
||||||
│ │ │ ├── trilight.lua
|
│ │ │ ├── trilight.lua - square light indicator (tri-state)
|
||||||
│ │ │ └── vbar.lua
|
│ │ │ └── vbar.lua - vertical percentage bar
|
||||||
│ │ ├── colormap.lua
|
│ │ ├── colormap.lua - color map (for testing, shows all colors in a row)
|
||||||
│ │ ├── displaybox.lua
|
│ │ ├── displaybox.lua - container element used as the root of the element tree, uses a window object as parent
|
||||||
│ │ ├── div.lua
|
│ │ ├── div.lua - container element, uses a normal element as its parent
|
||||||
│ │ ├── listbox.lua
|
│ │ ├── listbox.lua - scrolling listbox
|
||||||
│ │ ├── multipane.lua
|
│ │ ├── multipane.lua - multi-pane, to be used with a tab control to show multiple views in the same place
|
||||||
│ │ ├── pipenet.lua
|
│ │ ├── pipenet.lua - pipe network, used on main screen (as an example)
|
||||||
│ │ ├── rectangle.lua
|
│ │ ├── rectangle.lua - container element with an optional boarder, uses a normal element as its parent
|
||||||
│ │ ├── textbox.lua
|
│ │ ├── textbox.lua - text box, supports text alignment and wrapping
|
||||||
│ │ └── tiling.lua
|
│ │ └── tiling.lua - alternating tiling pattern element
|
||||||
│ ├── core.lua : Core graphics utilities
|
│ ├── core.lua - core graphics utilities
|
||||||
│ ├── element.lua : Base "class" of all graphics elements
|
│ ├── element.lua - base "class" of all graphics elements
|
||||||
│ ├── events.lua : Mouse/keyboard event handling
|
│ ├── events.lua - mouse/keyboard event handling
|
||||||
│ └── flasher.lua : Handler for flashing indicators
|
│ └── flasher.lua - handler for flashing indicators
|
||||||
├── lockbox/ : Select lua-lockbox files
|
├── lockbox/ - select lua-lockbox files
|
||||||
├── pocket/
|
├── pocket/
|
||||||
│ ├── ui/
|
│ ├── ui/
|
||||||
│ │ └── components/
|
│ │ └── components/
|
||||||
│ │ └── conn_waiting.lua
|
│ │ └── conn_waiting.lua
|
||||||
│ ├── config.lua : Pocket configuration file
|
│ ├── config.lua - pocket configuration file
|
||||||
│ ├── coreio.lua : I/O data and PSIL for pocket
|
│ ├── coreio.lua - I/O data and PSIL for pocket
|
||||||
│ ├── pocket.lua : Pocket comms
|
│ ├── pocket.lua - pocket comms
|
||||||
│ ├── renderer.lua : GUI renderer control
|
│ ├── renderer.lua - GUI renderer control
|
||||||
│ └── startup.lua : Main pocket application
|
│ └── startup.lua - main pocket application
|
||||||
├── reactor-plc/
|
├── reactor-plc/
|
||||||
├── rtu/
|
├── rtu/
|
||||||
├── scada-common/
|
├── scada-common/
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user