diff --git a/pocket/ui/apps/guide.lua b/pocket/ui/apps/guide.lua index 7bdd5a8..ae56f40 100644 --- a/pocket/ui/apps/guide.lua +++ b/pocket/ui/apps/guide.lua @@ -191,7 +191,7 @@ local function new_view(root) load_text(false, "Auto Control") local auto_ctrl_page = guide_section(sect_construct_data, use_page, "Auto Control", docs.usage.auto, 200) load_text(false, "Waste Control") - local waste_ctrl_page = guide_section(sect_construct_data, use_page, "Waste Control", docs.usage.waste, 100) + local waste_ctrl_page = guide_section(sect_construct_data, use_page, "Waste Control", docs.usage.waste, 120) PushButton{parent=use,y=3,text="Configuring Devices >",fg_bg=btn_fg_bg,active_fg_bg=btn_active,dis_fg_bg=btn_disable,callback=function()end}.disable() PushButton{parent=use,text="Connecting Devices >",fg_bg=btn_fg_bg,active_fg_bg=btn_active,dis_fg_bg=btn_disable,callback=function()end}.disable() diff --git a/pocket/ui/docs.lua b/pocket/ui/docs.lua index 8512b68..f513b3b 100644 --- a/pocket/ui/docs.lua +++ b/pocket/ui/docs.lua @@ -95,7 +95,30 @@ text("The reactor can be stopped via SCRAM, then the RPS needs to be reset via R target = docs.usage.auto sect("Overview") -text("TBD") +text("A main feature of this system is automatic reactor control that supports various managed control modes.") +tip("You should first review the Main Display and Unit Display documentation under Operator UIs > Coordinator before proceeding if you are not familiar with the interfaces.") +sect("Configuration") +note("Configurations cannot be modified while auto control is active.") +doc("usage_auto_assign", "Unit Assignments", "Auto control only applies to units set to a mode other than Manual. To prefer certain units or only use the minimum number necessary, priority groups are used to split up the required burn rate.") +text("Primary units will be used first, followed by secondary, etc. If multiple are assigned to a group, burn rate will be assigned evenly between them.") +text("The next priority group will only be used once the previous one cannot keep up with the total required burn rate for auto control at that moment.") +doc("usage_auto_setpoints", "Setpoints", "Three setpoint spinner inputs are available for the three setpoint-based auto control modes. The system will do its best to meet the requested value, with the current value listed below the input.") +doc("usage_auto_limits", "Unit Limits", "Each unit can be limited to a maximum auto control burn rate to prevent exceeding any safe levels that you know of.") +doc("usage_auto_states", "Unit States", "Any assigned units must be shown as Ready and not Degraded to use auto control. See Operator UIs > Coordinator > Main Display for more.") +sect("Operation Modes") +text("Four auto control modes are available that function based on configurations set on the main display. All modes except Monitored Max Burn will try to only use the primary group until it can't keep up, then the secondary, etc.") +note("No units will be set to a burn rate higher than their limit.") +doc("usage_op_mon_max", "Monitored Max Burn", "This mode runs all units assigned to auto control at their unit limit burn rate regardless of priority group.") +doc("usage_op_com_rate", "Combined Burn Rate", "Assigned units will be commanded to meet the Burn Target setpoint.") +doc("usage_op_chg_level", "Charge Level", "Assigned units will be commanded to bring the induction matrix up to the requested Charge Target.") +doc("usage_op_gen_rate", "Generation Rate", "Assigned units will be commanded to maintain the requested Generation Target.") +note("The rate used is the input rate into the induction matrix, so using other power generation sources may disrupt this control mode.") +sect("Start and Stop") +text("A text box is used to indicate the system status. It will also provide information of why the system has paused control or failed to start.") +text("You cannot start auto control until all assigned units have all their devices connected and functional and the reactor's RPS is not tripped.") +doc("usage_op_save", "SAVE", "SAVE will save the configuration without starting control.") +doc("usage_op_start", "START", "START will attempt to start auto control, which includes first saving the configuration.") +doc("usage_op_stop", "STOP", "STOP will stop all reactors assigned to automatic control.") target = docs.usage.waste sect("Overview")