Pocket Computer
The Pocket computer application provides portable Coordinator-style functionality, along with added detail views and testing tools.
Documentation for the setup/configurator of the Pocket be found on the page for the GUI-based Pocket Configurator tool.
Main Features
- Portable in-game access to a significant portion of the Wiki information
- Control of the SCADA system to the same level of the Coordinator
- Viewing of the SCADA system data to higher levels of detail than the Coordinator
- Alarm audio simulation testing
Table of Contents
- Home Page and Navigation
- Connecting and Connection Status
- Main Applications
- System Details and Testing Applications
Home Page and Navigation
The Pocket launches to an app home page like a smartphone or tablet regardless of connections. When you start an app that requires a Coordinator and/or Supervisor connection, you will see a loading screen for that connection. Some apps do not require a connection, most importantly the Guide app that lets you read information that might help you fix connection issues.
Within some apps, you'll find back/forward navigation arrows at the top of the screen that either let you navigate back to the prior page or switch between multiple options, like multiple reactors in the unit app.
Home Page
The two screenshots below show the two app pages in the main home view. The pages can be switched between by dragging the mouse left or right a bit, as though you are swiping on a smartphone home page. You may also use the scroll wheel or press one of the page dots at the bottom. The current page dot is highlighted in white vs the gray other pages.
Navigation
There is always a back arrow in the bottom left of the screen that lets you go back to the prior page, or the home page. The green # tab button will always take you back to the home page.
The specific "back" implementation is generally more of an "up" navigation, where it goes to the parent pages all the way back to home, rather than tracking each page you open and going back to that.
Connecting and Connection Status
A colored set of spinning squares are used on the connection loading views. You'll see the S at the top right indicate the Supervisor connection status and the C indicate the Coordinator connection status (x is disconnected, a bar is connected). The "signal" bar indicates RTT with the associated device, not actual connection "signal", since that isn't measurable. If things get a bit slow it'll go yellow or red just like RTT lists on the Coordinator and Supervisor.
Note
"API" refers to the Coordinator's API, which currently only serves Pocket computers but may be expanded in the future.
Main Applications
There are numerous sub-applications present within the Pocket application, providing access to the functionality of the Coordinator, but with much more detail. Some apps are dependent on being connected to the Supervisor and/or Coordinator while others (like the guide app) can be launched without having set anything up. This is important for the guide app, as it will provide instructions for setup.
Note
All apps only stream data while actively in view, and some only stream a subset of data when certain pages are visible. This reduces network traffic to the Supervisor and/or Coordinator. You may have to wait a moment before data refreshes upon re-opening an app.
Status Indicators
The Pocket uses color coded symbol indicators rather than the colored lights the Coordinator uses. The symbols offer clarity on if something is good/okay/bad/etc regardless of color. Context based on your knowledge of how things work on the Coordinator and what the check itself is (so, what the expected good state is) should allow most if not all to be self explanatory. Below is a general list of the symbols, but some uses may be different than others.
Tip
Make sure you understand these before reading on as they are not described in more detail, except for the less intuitive cases.
Reactor Status Indicators
| Indicator | Meaning |
|---|---|
| Reactor disabled, but not SCRAM'd. | |
| Reactor SCRAM'd. | |
| Reactor active, manual control. | |
| Reactor active, automatic control. |
Check Status Indicators
| Indicator | Meaning |
|---|---|
| No data or neutral, unactivated state. | |
| A feature/function is available, such as emergency coolant. | |
| A check failed. Red means this is an urgent warning. | |
| A check failed or a fault occurred. Yellow means this is a less urgent warning. | |
| A hazard/caution symbol indicating an abnormal/warning state. | |
| An aggregate check such as the RPS or RCS on the main page of the unit app has all its checks passing, or a feature/function has been activated, such as emergency coolant. | |
| A check is passing/OK. | |
| An automatic operation is being conducted, such as plutonium fallback. |
Units App
The Units app contains a vast detailed set of information about reactor units and their cooling systems. Controls are not found here, instead they are in the Process and Control apps.
This encompasses the information present on the Coordinator's unit monitors and adds additional details from the unit diagrams on the Coordinator's main view screen. Within the tabs in this app, you can find more detailed status information about the multiblocks belonging to the selected unit, along with a helpful diagnostics display listing the current status and any actions to fix problems.
Overviews
This view is the initial view and can be brought up by pressing the U-# button on the sidebar, where # is the current unit ID.
The unit overviews can be navigated between with yellow arrows if you have multiple units. These overviews show the current status of the reactor and its associated systems.
See Reactor Status Indicators for details on the Control State symbols.
Status Info Display
The status info display gives status information and more detailed info on problems when they occur. If you see a ? next to an entry, you can click that to open the Guide app and show help information for that line item.
Green text is nominal operating state/idle operation, white is details, yellow is warnings, red is urgent warnings, and blue is recommended actions you should take. Some users may notice this is reminiscent of an ECAM.
Reactor Protection System
This page is the Pocket view of the Reactor Protection System annunicator panel on the Coordinator's unit displays, showing the current status of the unit's RPS. You can review that linked section for more information on the meanings of these indicators.
Reactor Details
This page provides details on the reactor as shown on the Coordinator's main display and unit display. You can review those linked sections for more information.
For further reactor details, you can click MORE at the bottom.
Reactor Coolant System
This provides the reactor coolant system annunicator information as shown on the Coordinator unit display's RCS annunciator panel. You can review that linked section for more information on the meanings of these indicators.
For emergency coolant available, a circle with a white background is used to indicate that an emergency coolant valve is connected to this unit, similar to the white light on the unit's RCS panel on the Coordinator. If a - is shown here instead, no valve is connected.
Boilers
The boiler information from the Coordinator's main view is shown here, along with boiler-related annunciator values from the unit's RCS annunciator panel. You can review those pages for additional information.
In addition to this data displayed on the Coordinator, more boiler stats are provided if you click MORE.
Turbines
The turbine information from the Coordinator's main view is shown here, along with turbine-related annunciator values from the unit's RCS annunciator panel. You can review those pages for additional information.
In addition to this data displayed on the Coordinator, more turbine stats are provided if you click MORE.
Unit Dynamic Tank
The dynamic tank connected to the reactor can be viewed on the DYN page. You should be familiar with the dynamic tank status displays to understand this page.
If the unit has a unit tank assigned, it will be shown here. If it has a facility one configured for it, that will be shown instead. If no tank is configured for this unit, this tab won't be shown on the sidebar.
Facility App
This app provides views of facility assigned devices including the induction matrix, SPS, and dynamic tanks.
You should be familiar with the facility annunciator, the induction matrix view, and the SPS status display to understand these pages.
Review the earlier section on unit overviews for details on the Control State symbols.
Induction matrix details are found on the MTX tab, with more info available with the MORE button at the bottom of that page.
SPS details are found on the SPS tab, with more info available with the MORE button at the bottom of that page.
And lastly is the dynamic tank overview, which just shows the connection status of all the configured tanks. Open the unit app's dynamic tank details to see more information on a given tank.
Control App
This app provides the basic manual controls offered by the units, plus the facility SCRAM and ACK buttons on the Coordinator's main display. You can review those linked subsections of the Coordinator's main display and unit display for more information.
Review the earlier section on unit overviews for details on the Control State symbols.
Process App
This app provides management for automatic control of the system. Throughout its pages, it provides the functionality found in the Coordinator's process control UI, which you should refer to for details. Options and controls are similarly disabled when the system is running, so you must stop control to edit them as you would on the Coordinator. The system will attempt to sync the field values between the Coordinator and Pocket when applied. The rate limits can be found in the individual unit pages due to space constraints.
The unit automatic process control options and UI is also based off the Coordinator, except in this case it's the unit monitor displays.
Waste App
This app allows controlling and monitoring waste productions.
The main page WST provides some of the same controls and shows most of the same information as the facility waste production on the Coordinator's main UI, so you can refer to that for more information. Fallback Active will be a + with a white background when active and a - with a gray background when inactive. SPS Disabled LC will be a - with a yellow background when disabling antimatter production at low charge and a + with a gray background when allowing antimatter production.
You can click PROD RATES to view information on waste production rates found on the Coordinator's flow monitor. The SPS tab shows the SPS related information also found on that monitor.
The waste control options that don't fit on the WST tab are provided on the OPT tab.
You can click between your units on the sidebar to see their individual waste details and check the SNA details with a button at the bottom of their pages.
Guide App
This app is effectively a portable in-game copy of the Wiki, though some sections contain more information or less information from the Wiki, so they work best together. The app takes a while to load due to how it renders all the sections and subsections, so you'll see information about which sections and subsections are being loaded as it goes. You'll only need to load this once per Pocket computer boot, not each time you open the app.
Within the Guide app, you can navigate through the sections and subsections or you can search for key words. You'll be able to find documentation for nearly everything, but if something is missing let me know!
Guide sections include text, headers, lists, indicator colored lists, and more to help make it more readable.
About App
This app provides information about the Pocket computer and network environment.
From the main page, you can open network details, firmware version details, and host environment details. Device addresses in the network details are formatted as Computer ID:channel.
Radiation App
This app lists radiation readings for the facility and units as collected by environment detectors. The main page gives overviews of the max readings, then the facility and unit pages list all the connected environment detectors.
Note
You can have multiple detectors per facility/unit assignment as long as they have unique IDs per facility/unit assignment. The maximum reading is always used for safety checks, but with this application you can look at all the different readings by ID.
System Details and Testing Applications
Important
In order to use any testing application controls (indicators will still update), Pocket Testing must be enabled in the Supervisor configuration in addition to Pocket Access.
Alarm App
This app provides the ability to simulate audio alarms. Indicators on the coordinator displays will not show these simulated alarms, and no actions will be taken as a result of them. Specific tones can be played, or specific alarms can be played. Layering alarms will still be subject to the preemption rules of alarm tones, but layering tones manually will not (careful what you wish for, be ready to press the stop button).
Important
In order to set tones or alarms using this interface, the system must be in a safe idle state. This means all units must have their Reactor PLCs connected, their reactors have to be stopped, the RPS cannot be tripped, and all of the unit alarms must be inactive.
-- check if the reactor is connected, is stopped, the RPS is not tripped, and no alarms are active
---@nodiscard
function public.is_safe_idle()
-- can't be disconnected
if self.plc_i == nil then return false end
-- reactor must be stopped and RPS can't be tripped
if self.plc_i.get_status().status or self.plc_i.get_db().rps_tripped then return false end
-- alarms must be inactive and not tripping
for _, alarm in pairs(self.alarms) do
if not (alarm.state == AISTATE.INACTIVE or alarm.state == AISTATE.RING_BACK) then return false end
end
return true
end
Alarm Testing
Two pages and an information page are provided within this app. The !! page provides control by alarm and the music note page provides control by tone.
Each of the 8 tones can manually be enabled in the "Tones" list via the TEST 1 through TEST 8 buttons, then stopped with the STOP button (or the test button can be un-pressed).
"States" indicates the state of each of the 8 tones.
"Alarms" allows enabling particular alarms, which was described more in the prior section. They can be stopped with the STOP !! button.
Computers App
This app polls for data from the Supervisor for the computers connected to the SCADA network. The RTTs shown are recorded by the Supervisor, not the Pocket computer. The main page has the Supervisor and Coordinator connection status, the PLC page has the connected Reactor PLC computers, the RTU page has the connected RTU Gateway computers, and the PKT page has the connected Pocket computers.