Scadex documentation
Scadex is a SCADA gateway: a tag runtime that reads from your devices, keeps every value and its history, raises alarms, runs scripts and serves HMI screens and a dashboard from one process. It runs as one container, and everything in it is optional and separately versioned: the drivers, the historian, the cron scheduler.
These pages describe gateway version 0.1. The version switcher in the top bar selects the release you run.
InstallationRun the appliance with Docker, create the first account, serve it under your own domain.QuickstartConnect a device, create tags, add an alarm and draw a first screen in one session.ConceptsTags, tag types, alarms, history and replay, and how the gateway is put together.ScreensThe screen editor, every widget, start screens, templates and popups.ModulesOPC UA, MQTT, the historian and cron jobs; installing, licensing and writing your own.ScriptingExpression tags, screen scripts, cron scripts and the system.* API.AdministrationUsers and roles, API keys, sign-in providers, databases, logs, backup and restore.API referenceThe REST API, the live WebSocket and the TypeScript SDK.ExamplesStep-by-step guides, from a Siemens S7 over OPC UA to a React app on the SDK.
How the pieces fit
| Part | What it does | Read |
|---|---|---|
| Gateway | The server: tag runtime, alarms, history, scripts, API, and the web dashboard it serves itself | Architecture |
| Tags | Every value in the system, with quality and timestamp; memory, driver, derived, expression and system tags | Tags |
| Tag types | Reusable structures (UDTs) with parameters, members, inheritance and alarm templates | Tag types |
| Modules | Optional drivers and services loaded at run time, each with its own version and licence | Modules |
| Screens | HMI pages drawn in the editor and run in the browser, bound to tags | Screens |
| Alarms | Conditions on tags with acknowledgement, shelving, history and webhook pipelines | Alarms |
| History and replay | The historian keeps values; replay plays the plant back as it was | History and replay |
| Scripting | JavaScript in a sandbox: expression tags, screen events, cron jobs | Scripting |
| API | REST under /api/v1, the /sync WebSocket, and @scadex.io/sdk for React | API reference |