diff --git a/Project-Files.md b/Project-Files.md index 4ec9b72..f5cc595 100644 --- a/Project-Files.md +++ b/Project-Files.md @@ -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 ```--> - + # 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 ``` \ No newline at end of file