HelmOS Server Guide

NORTHSTARSHOW SYSTEMS

HelmOS Server Guide

Overview of the HelmOS venue runtime

Document NumberRevisionDatePlatform Version
NSSS-DOC-0030A2026-05-201.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

SpecificationValue
HTTP + WebSocketTCP 3000 (configurable via HELMOS_HTTP_PORT)
Polaris UDPUDP 8888 (configurable via HELMOS_UDP_PORT)
Bind address0.0.0.0 by default (configurable via HELMOS_BIND)

Environment Variables

VariableDefaultPurpose
HELMOS_HTTP_PORT3000Dashboard + API port
HELMOS_UDP_PORT8888Polaris listening port
HELMOS_BIND0.0.0.0Listening interface
HELMOS_BRIDGE_PORT(empty)COM port for Bridge USB; empty disables USB Bridge
HELMOS_BRIDGE_BAUD115200Baud rate for Bridge serial
HELMOS_HEARTBEAT_TIMEOUT_MS30000Time before a silent node is marked offline
HELMOS_OTA_CONCURRENCY5Rolling-update batch size
  • NSSS-DOC-0031HelmOS Installation
  • NSSS-DOC-0071HelmOS HTTP API Reference

Revision History

RevisionDateDescription
A2026-05-20Initial publication