Requirements
Licence
How LumiScan Cockpit is licensed depends on where you bought it and where it runs:
| Bought from | Runs on | Licensing |
|---|---|---|
HD Vision Systems |
Windows 11 or Ubuntu 24.04 |
The licence is held on your LumiScan Key. It is a one-time purchase and needs no renewal. |
ctrlX Store |
Windows 11 |
The licence is held in ctrlX WORKS. The LumiScan Key is required in addition; it protects the software against reverse engineering. |
ctrlX Store |
ctrlX OS (ctrlX CORE or IPC) |
ctrlX licence |
Each device on which LumiScan Cockpit runs at the same time needs its own LumiScan Key. Keys can be exchanged between devices.
How to install CodeMeter Runtime and how to request, renew and move licences is described in LumiScan Licensing.
On ctrlX OS, the application shuts down shortly after starting if the licence is missing; the reason is written to the system log.
Where Cockpit runs
| Cockpit runs on | Data Layer |
|---|---|
ctrlX OS (ctrlX CORE or ctrlX IPC) |
the ctrlX Data Layer |
a PC |
LumiScan Keryx (see Opening the Cockpit and LumiScan Keryx on a PC) |
On a PC, building Cockpit’s pages from source needs Node.js with npm.
The applications it shows
Cockpit displays other applications' data, so on its own it shows an empty overview. The applications whose images and results it draws must run on the same device — the same ctrlX CORE or ctrlX IPC, or the same PC — because Cockpit reads them from the Data Layer there.
In practice the starting point is LumiScan Cam Driver with a configured camera: it publishes the image the other applications read and the results are drawn on.
A browser, or Cockpit’s window
On ctrlX OS: Cockpit is reached from the ctrlX web interface, so any browser that can open the ctrlX interface can open Cockpit. Views are ordinary browser tabs.
On a PC: Cockpit shows its pages in a window of its own. Started with --no-gui, Cockpit opens no
window and its pages are opened in a browser. Cockpit answers on 127.0.0.1 only, so the browser has
to run on the same PC.
(Windows) Cockpit’s window needs the Microsoft Edge WebView2 Runtime; without it, Cockpit opens its pages in the default browser instead.
On both, a view that is not visible stops asking for updates, so views left open in background browser tabs cost nothing. A live view is an MJPEG stream, which every current browser shows in an ordinary image.
|
(ctrlX OS) Whether the ctrlX web interface passes a live view through without holding it back has not yet been verified on a device. If it does not, a live view shows still images instead - see Live Updates. |
Storage
Cockpit stores one thing: its settings file, a few kilobytes of JSON in the application’s data directory, holding the optional overlays and the live view settings. It keeps no images — every frame is fetched from the publishing application when it is shown. See Overlays and Live view settings.