FAQ

Cockpit shows what the vision applications on a ctrlX CORE or ctrlX IPC, or on a PC, are looking at and what they found: on ctrlX OS in a web browser, on a PC in a window of its own. It is a viewer only: it shows the images published by LumiScan Cam Driver and LumiScan AI Object Matching, and draws the findings of eight further applications on the image they were found in. It configures nothing in those applications.

Description

The applications whose images and results Cockpit shows 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 (the ctrlX Data Layer on ctrlX OS, LumiScan Keryx on a PC); on its own it shows an empty overview. In practice, start with LumiScan Cam Driver and a configured camera. On ctrlX OS, any browser that can open the ctrlX web interface can open Cockpit; on a PC, Cockpit opens a window of its own (on Windows with the Microsoft Edge WebView2 Runtime). Cockpit stores only its settings file (the optional overlays and the live view settings) and keeps no images.

Requirements

On ctrlX OS, open the ctrlX CORE web interface in a browser and click LumiScan Cockpit in the sidebar; the application adds this link when it is installed and running. Clicking a view opens it in a new browser tab. On a PC, start the applications and lumiscan-cockpit: the LumiScan Cockpit window opens, and a view opens in the same window. The page that opens is the application overview: every compatible HD Vision Systems application currently running and the views each offers.

Opening the Cockpit

No. Cockpit provides no Data Layer output of its own; the drawing exists only in the browser or in Cockpit’s window. To act on a result programmatically, read that application’s own result nodes.

Description

Findings are drawn in green on the image they were found in:

Viewing Results

An application with modules is listed by module, and each module is one view. A code reader has no modules, so it has a single view named after the code it reads: datamatrix-code, qr-code, aztec-code or bar-code.

Viewing Results

The label has the form <label>:<area>. The number before the colon is the region’s number in output/blob-labels, which also selects the region’s colour, so an area on screen can be traced to the pixels it was measured from. Regions are tinted instead of boxed because overlapping rectangles cannot show whether touching parts were separated or merged.

Viewing Results

For the four applications with modules, a view shows the region that was searched, at its own size; a module without a crop searches and shows the whole frame. A code reader’s view is always the whole picture it read. The region comes from the result itself, not from the current crop settings, so editing the crop does not change the view until the next run.

The View Region

While a view shows still images, Cockpit checks the application about five times a second and notifies the browser at most twice a second; the browser then fetches the newest frame, so no frame queue builds up. While a camera streams, the view is live and shows the frames as they arrive, at most at the frame rate set in the live view settings (default 10 per second). A view that is not visible stops asking, so background tabs cost nothing.

Live Updates

Click the gear (⚙) at the top of any page. Frames per second, at most (1 to 30, default 10) and JPEG quality (50 to 95, default 85) apply at once to every live view, and are kept in the liveView section of Cockpit’s settings file.

Live view settings

Configure an overlay in Cockpit’s settings file and restart Cockpit. On ctrlX OS the file is reached through the file view on the ctrlX home screen; on a PC it is lumiscan-cockpit.json in Cockpit’s settings folder (on Windows, C:\ProgramData\HD Vision Systems GmbH\LumiScan Vision Suite\lumiscan-cockpit\etc\lumiscan-cockpit, or %APP_RESOURCE_DIR%\etc\lumiscan-cockpit when APP_RESOURCE_DIR is set). On a PC, lumiscan-cockpit --generate-settings <folder> writes an example.

Overlays

Both are possible, for position and size alike. Values below 1.0 are relative to the image dimensions (0.0 = left or top edge, 0.5 = middle); values of 1.0 and above are absolute pixels. 1.0 is therefore one pixel, not the far edge: use a value just under 1.0 for the far edge, and note that a width of 1.0 is one pixel wide.

Overlays

The ctrlX licence for LumiScan Cockpit is SWL-W-XCx-COCKPITxxxHDVSx-V1NN. Bought in the ctrlX Store for ctrlX OS, it is a ctrlX licence and needs no LumiScan Key. On ctrlX OS, the application shuts down shortly after starting if the licence is missing; the reason is in the system log. For a PC, see the licence section on the Requirements page.

Requirements, Licensing FAQ

See the site-wide LumiScan FAQ. For the Data Layer on both platforms, see the Data Layer FAQ. Contact HD Vision Systems customer success at customer.success@hdvisionsystems.com or +49 6221 6721905; for licences, licenses@hdvisionsystems.com.

Licensing FAQ