From 017deec06e367c25f268eb0811352b1743755d3b Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Mon, 1 Sep 2025 17:05:31 -0400 Subject: [PATCH] #403 unit display documentation --- pocket/ui/apps/guide.lua | 4 ++-- pocket/ui/docs.lua | 28 +++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/pocket/ui/apps/guide.lua b/pocket/ui/apps/guide.lua index f482622..8571de2 100644 --- a/pocket/ui/apps/guide.lua +++ b/pocket/ui/apps/guide.lua @@ -215,8 +215,8 @@ local function new_view(root) PushButton{parent=coord_div,x=2,y=1,text="<",fg_bg=btn_fg_bg,active_fg_bg=btn_active,callback=uis_page.nav_to} local main_disp_page = guide_section(sect_construct_data, coord_page, "Main Display", docs.c_ui.main, 300) - local flow_disp_page = guide_section(sect_construct_data, coord_page, "Flow Display", docs.annunc.unit.rps_section, 100) - local unit_disp_page = guide_section(sect_construct_data, coord_page, "Unit Display", docs.annunc.unit.rcs_section, 170) + local flow_disp_page = guide_section(sect_construct_data, coord_page, "Flow Display", docs.c_ui.flow, 300) + local unit_disp_page = guide_section(sect_construct_data, coord_page, "Unit Display", docs.c_ui.unit, 150) PushButton{parent=coord_div,y=3,text="Main Display >",fg_bg=btn_fg_bg,active_fg_bg=btn_active,callback=main_disp_page.nav_to} PushButton{parent=coord_div,text="Flow Display >",fg_bg=btn_fg_bg,active_fg_bg=btn_active,callback=flow_disp_page.nav_to} diff --git a/pocket/ui/docs.lua b/pocket/ui/docs.lua index 7cc8814..5b10e66 100644 --- a/pocket/ui/docs.lua +++ b/pocket/ui/docs.lua @@ -182,7 +182,7 @@ sect("Facility Status") note("The annunciator here is described in Operator UIs > Annunciators.") doc("ui_fac_scram", "FAC SCRAM", "This SCRAMs all units in the facility.") doc("ui_fac_ack", "ACK \x13", "This acknowledges (mutes) all alarms for all units in the facility.") -doc("ui_fac_rad", "Radiation", "The facility radiation, which is the maximum of all connected facility radiation monitors (excludes unit monitors).") +doc("ui_fac_rad", "Radiation", "The facility radiation, which is the current maximum of all connected facility radiation monitors (excludes unit monitors).") doc("ui_fac_linked", "Linked RTUs", "The number of RTU Gateways connected.") sect("Automatic Control") text("This interface is used for managing automatic facility control, which only applies to units set via the unit display to be under auto control. This includes setpoints, status, configuration, and control.") @@ -216,6 +216,32 @@ doc("ui_fac_im_charge", "Discharging", "Charge is draining (more output than inp doc("ui_fac_im_charge", "Max I/O Rate", "The induction providers are at their maximum rate.") doc("ui_fac_eta", "ETA", "The ETA is based off a longer average so it may take a minute to stabilize, but will give a rough estimate of time to charge/discharge.") +target = docs.c_ui.flow +sect("Flow Diagram") +text("TBD") + +target = docs.c_ui.unit +sect("Data Display") +text("The unit monitor contains extensive data information, including annunciator and alarm displays described in the associated sections in the Operator UIs section.") +doc("ui_unit_core", "Core Map", "A core map diagram is shown at the top right, colored by core temperature. The layout is based off of the multiblock dimensions.") +list(DOC_LIST_TYPE.BULLET, { "Gray <= 300\xb0C", "Blue <= 350\xb0C", "Green < 600\xb0C", "Yellow < 100\xb0C", "Orange < 1200\xb0C", "Red < 1300\xb0C", "Pink >= 1300\xb0C" }) +text("Internal tanks (fuel, cooled coolant, heated coolant, and waste) are displayed below the core map, labeled F, C, H, and W, respectively.") +doc("ui_unit_rad", "Radiation", "The unit radiation, which is the current maximum of all connected radiation monitors assigned to this unit.") +text("Multiple other data values are shown but should be self-explanatory.") +sect("Controls") +text("A set of buttons and the burn rate input are used for manual reactor control. When in auto mode, unavailable controls are disabled. The burn rate is only applied after SET is pressed.") +doc("ui_unit_start", "START", "This starts the reactor at the requested burn rate.") +doc("ui_unit_scram", "SCRAM", "This SCRAMs the reactor.") +doc("ui_unit_ack", "ACK \x13", "This acknowledges alarms on this unit.") +doc("ui_unit_reset", "RESET", "This resets the RPS for this unit.") +sect("Auto Control") +text("To put this unit under auto control, select an option other than Manual. You must press SET to apply this, but cannot change this while auto control is active. The priorities available are described in System Usage > Automatic Control.") +doc("ui_unit_prio", "Prio. Group", "This displays the unit's auto control priority group.") +doc("ui_unit_ready", "READY", "This indicates if the unit is ready for auto control. A unit is only ready for auto control if all multiblocks are formed, online with data received, and there is no RPS trip.") +doc("ui_unit_standby", "STANDBY", "This indicates if the unit is set to auto control and that is active, but the auto control does not currently need this reactor to run at the moment, so it is idle.") +sect("Waste Processing") +text("The unit's waste output configuration can be set via these buttons. Auto will put this unit under control of the facility waste control, otherwise the system will always command the requested option for this unit.") + docs.fp = { common = {}, r_plc = {}, rtu_gw = {}, supervisor = {}, coordinator = {} }