HelmOS Server Guide
NORTHSTARSHOW SYSTEMS
HelmOS Server Guide
Overview of the HelmOS venue runtime
| Document Number | Revision | Date | Platform Version |
|---|---|---|---|
| NSSS-DOC-0030 | A | 2026-05-20 | 1.0 |
Role
HelmOS is the central runtime that orchestrates a Northstar venue. It runs headless on a venue-local Intel NUC and is responsible for:
- Receiving deployed .nsss.compose archives
- Tracking Polaris node registrations, heartbeats, and firmware versions
- Dispatching cues based on incoming events
- Serving the Cuemaster operator dashboard
- Pushing firmware updates to Polaris nodes via ArduinoOTA
- Enforcing the license gate and the Maintenance Mode interlock
Install Layout
C:\Program Files\Northstar\HelmOS\
├── HELM_OS.exe The runtime binary (Node.js, pkg-bundled)
├── web/
│ ├── index.html Cuemaster operator dashboard
│ └── admin.html Server admin page
├── data/
│ ├── license.dat Activated license token
│ ├── active.txt Path to currently-loaded project file
│ ├── projects/ Every deployed .nsss.compose archive
│ ├── firmware/ Extracted .bin files + manifest.json
│ └── log/ Daily-rotated log files
└── arduino-cli/ Bundled toolchain (optional server-side compile)
Auto-Start
INSTALL_HELM_OS.exe registers a Scheduled Task named "Northstar HelmOS" that runs HELM_OS.exe at every system boot under the SYSTEM account with highest privileges. Control with:
schtasks /query /tn "Northstar HelmOS"
schtasks /run /tn "Northstar HelmOS"
schtasks /end /tn "Northstar HelmOS"
Listening Sockets
| Specification | Value |
|---|---|
| HTTP + WebSocket | TCP 3000 (configurable via HELMOS_HTTP_PORT) |
| Polaris UDP | UDP 8888 (configurable via HELMOS_UDP_PORT) |
| Bind address | 0.0.0.0 by default (configurable via HELMOS_BIND) |
Environment Variables
| Variable | Default | Purpose |
|---|---|---|
| HELMOS_HTTP_PORT | 3000 | Dashboard + API port |
| HELMOS_UDP_PORT | 8888 | Polaris listening port |
| HELMOS_BIND | 0.0.0.0 | Listening interface |
| HELMOS_BRIDGE_PORT | (empty) | COM port for Bridge USB; empty disables USB Bridge |
| HELMOS_BRIDGE_BAUD | 115200 | Baud rate for Bridge serial |
| HELMOS_HEARTBEAT_TIMEOUT_MS | 30000 | Time before a silent node is marked offline |
| HELMOS_OTA_CONCURRENCY | 5 | Rolling-update batch size |
Related Documents
- NSSS-DOC-0031HelmOS Installation
- NSSS-DOC-0071HelmOS HTTP API Reference
Revision History
| Revision | Date | Description |
|---|---|---|
| A | 2026-05-20 | Initial publication |