Get started / NEXT HMI documentation
NEXT HMI documentation
A task-oriented guide to building operator dashboards: projects, the editor, widgets, layout, OPC-UA data, dynamic properties, actions, theming, translations, alarms, recipes, the historian, users and custom widgets.
Get started
| Page | What it covers |
|---|---|
| Overview | The mental model — runtime and editor together, a project is a folder, every property can bind, one socket for data |
| Getting started | Choosing how to run it, the first run step by step, and a ten-minute walkthrough that builds a working screen with no PLC |
| Installing and running | Docker and portable-binary installation, HTTPS, the on-disk model |
| Managing projects | What's in a project folder, the Manager dashboard, downloading, uploading, adding and removing projects |
| Files & assets | Images, icons, third-party libraries — where they live and how to add them |
| Licence | AGPL-3.0 in plain terms, your project content, and when you'd want a commercial licence |
The editor
| Page | What it covers |
|---|---|
| The editor workspace | The config areas and the working habits worth knowing |
| Pages & navigation | Adding pages, grouping and nesting, giving operators a way around |
| Adding & arranging widgets | Placing widgets, schema-driven properties, making controls do something |
| Layout & responsive design | Containers, shell regions, free placement, one project on every screen size |
| Actions & events | Every action a control can run, the async result handlers, and the project-wide lifecycle events |
Data
| Page | What it covers |
|---|---|
| Connecting to data | The OPC-UA wizard, and designing offline with a static datasource |
| Binding & subscribing | How a bound value reaches the screen, and what a subscription costs |
| Dynamic properties | Type vs. source, the value types, every source, and how they nest |
| Historian & trends | Recording tag history, sampling and retention, and plotting it |
Widgets & styling
| Page | What it covers |
|---|---|
| Built-in widget catalog | Every shipped widget and its properties — generated from the registry |
| Theming | Design tokens, and theming your own widgets |
| Translations & languages | Dictionaries, $loc keys, letting operators switch language |
| Alarms & recipes | Condition-based alarms, and parameter sets you load to live variables |
| Building your own widgets | The custom-widget SDK, the build pipeline, and authoring rules |
Operations
| Page | What it covers |
|---|---|
| Users, groups & permissions | Accounts and groups, signing in, gating what each role sees and may change |
| Diagnostics & troubleshooting | The Admin area, the manager's Settings page, the warnings pill, and the common symptoms |
| AI agents over MCP | Letting an assistant read and edit a project — enabling it, tokens, connecting a client, the starter prompts, and the limits |
Project
| Page | What it covers |
|---|---|
| Changelog | What shipped in each release |
| Security Policy | Supported versions, and how to report a vulnerability |
Licensing
| Page | What it covers |
|---|---|
| Commercial licensing | When you need it, and what it grants beyond AGPL |
| License | The project's licence file as shipped |
| License (AGPL full text) | The AGPL-3.0-or-later full text |
| Project-content exception | Why your project content isn't AGPL-covered |
| Notice | Third-party attributions |
Enterprise
| Page | What it covers |
|---|---|
| Licensing | Activating an enterprise build with a license key, and what add-on modules ride on top of it |
| Audit records | The append-only, attributed record of operator actions — an add-on module |
Working on NEXT HMI itself rather than building with it? The architecture and API reference is in docs/dev.