Skip to content

Pocket Configurator

Mikayla edited this page Dec 23, 2025 · 9 revisions

Warning

This page's documentation and screenshots are currently being updated as part of #680. Most information here is incomplete.

Pocket Configurator Tool

The Pocket configurator tool can be brought up any time from the terminal by running configure on a Pocket computer after installing the pocket application. It will automatically come up on application startup if there is no valid configuration present, as shown in the first screenshot below.

General Tips:

  • You can paste values into number/text fields
  • You can navigate around with tab and shift+tab (and arrow keys where applicable)
  • You can ctrl+a or double click number/text fields to select all
  • When configuring the system, fields will be pre-filled with any valid existing configuration data
  • You will be shown a summary of settings before any are saved

Table of Contents

  1. Main Menu
  2. Change Log
  3. View Configuration
  4. Configure System
    1. Network Configuration
    2. Facility Configuration
    3. Coordinator UI Configuration
    4. Logging Configuration
    5. Apply the Configuration

Main Menu

Below are two examples of the main menu. If the configurator is started by the Pocket app itself due to a lack of a valid configuration, the red warning text in the first example will be present. If any previous configuration is present, the view option will be enabled.

image image

Change Log

There is an embedded configuration file change log that will show what fields have been changed, added, or removed. This will help you figure out why a previously valid configuration may no longer be valid.

image

View Configuration

This option shows the currently active configuration of the device. Facility authentication keys will be censored via asterisks, but can be shown via the unhide button.

image

Configure System

Images

image image image image image image image image image image

Homepage

  1. User Manual
    1. System Setup Guide
      1. Device Layout
        1. Coordinator Displays
      2. Connecting to Mekanism Machines
      3. Application Installation
        1. Space Requirements
        2. Installation
        3. Updating
        4. Uninstalling
      4. SCADA Network
        1. Network Channels
        2. Network Connectivity
      5. Setup & Configuration
        1. Supervisor Setup
        2. Coordinator Setup
        3. Reactor PLC Setup
        4. RTU Gateway Setup
      6. Initial Startup
    2. Configurator Tools
      1. Supervisor Configurator
      2. Coordinator Configurator
      3. Reactor PLC Configurator
      4. RTU Gateway Configurator
      5. Pocket Configurator
    3. Redstone Waste Setup Guide
    4. TL;DR Quickstart
    5. FAQ and Common Problems
    6. Colorblind Accessibility
    7. Annunciator Panels
    8. Alarms
    9. System Views
      1. Main View Screen
      2. Valve & Flow Screen
      3. Unit View Screens
    10. Operating Procedure
    11. Status Messages
    12. Glossary
  2. Computer Applications
    1. Reactor PLC
      1. Front Panel
      2. Non-Networked Mode
      3. RPS
      4. PLC Emergency Coolant
    2. RTU Gateway
      1. Front Panel
    3. Supervisory Computer
      1. Front Panel
    4. Coordinator Computer
      1. Front Panel
    5. Pocket
      1. Home and Navigation
      2. Connectivity
      3. Main Applications
      4. System Details and Testing
  3. Notable System Components
    1. Co-routine Threading
    2. Project File Layout/Overview
    3. PPM - Protected Peripherals Manager
    4. RSIO - Redstone I/O
    5. Utility Classes
    6. Networking
  4. Notes
    1. Known Issues
    2. Process Closed Loop Controller
    3. Project Files and Layout
    4. Alternative Installation Strategies
  5. Investigations
    1. Startup Rate High
    2. Reactor Temperature Calculation
  6. References & Resources
    1. CC: Tweaked Character Set
    2. Mekanism API Notes
    3. Design & Regulatory References
  7. Legacy
    1. coord.settings File
    2. config.lua Files
      1. Supervisor config.lua
      2. Coordinator config.lua
      3. Reactor PLC config.lua
      4. RTU Gateway config.lua

Clone this wiki locally