Skip to main content
Version: Next

Modes

This page is for administrators. A mode is a named state of the gateway, such as Production, Commissioning or Maintenance. One mode is active at a time; anyone signed in can see which, and an administrator switches.

note

Today a mode is a label. The gateway stores which mode is active and when it was activated, and the dashboard shows it, but nothing reacts to the active mode yet: no alarm, pipeline, script, screen or driver changes its behavior with it. Scripts can read the list through the API if they need to branch on it themselves.

The Modes page​

Open Gateway, then System, then Modes. The page lists modes with State, Name and Last active, and has row actions to activate, edit and delete. Anyone who is not an administrator sees "Only administrators can change modes."

Creating a mode​

  1. Add a mode; a panel opens beside the list.
  2. Enter a Name of up to 40 characters. Names are unique, ignoring case.
  3. Optionally enter a Description of up to 300 characters. It is shown under the name, so people know when to use the mode.
  4. Save.

A gateway can hold at most 50 modes.

Activating a mode​

Use the activate action on a row. The previous active mode stops being active, and the new one records the time. The panel's History section shows Created and Last active ("Active now", a time, or "Never").

Deleting a mode​

The active mode cannot be deleted: switch to another first. The API answers 400 "Switch to another mode before deleting the active one."

Limits​

  • One active mode, gateway-wide; no per-area or per-line modes.
  • Nothing acts on the active mode. There is no mode-dependent alarm suppression, no mode condition in pipelines, and no mode variable in screens or scripts beyond reading the API.
  • No @gateway tag publishes the active mode.

API​

Reading needs the viewer role; everything else needs admin. The full reference is in Other APIs.

RouteRolePurpose
GET /api/v1/modesviewerEvery mode: id, name, description, active, createdAt, activatedAt
POST /api/v1/modesadminCreate {name, description?}
PUT /api/v1/modes/{id}adminRename or re-describe
POST /api/v1/modes/{id}/activateadminMake it the one active mode
DELETE /api/v1/modes/{id}adminDelete; 400 for the active mode