Troubleshooting

Start with the General checks: they help with every problem in LumiScan Cockpit. Then find your symptom in the sections below and work through its steps in order. The last section lists what to send to support if the problem persists.

General checks

Check these points first:

  • The applications run on the same device. Cockpit shows other applications' data: the applications whose images and results it draws must run on the same ctrlX CORE or ctrlX IPC, or the same PC. On its own, Cockpit shows an empty overview. See Requirements.

  • The application overview. It lists every compatible HD Vision Systems application currently running, and the views each one offers. See Opening the Cockpit.

  • On a PC: the same broker address. Cockpit and the applications must use the same address. Without options they all do; an address passed with --keryx-url has to be passed to every one of them. With LumiScan Keryx installed, the Data Layer page http://127.0.0.1:7555/ shows the tree. See Broker, Window and Pages (PC).

  • The settings file is read once, at start-up. Only the live view settings, changed in the settings panel, apply at once. See Overlays.

  • The log.

    Platform Log

    ctrlX OS

    the ctrlX OS system log: the Logbook of the ctrlX web interface, or journalctl. See ctrlX Data Layer on ctrlX OS

    Windows

    %LOCALAPPDATA%\LumiScan Cockpit\logs\lumiscan-cockpit.log. Started from a console as lumiscan-cockpit, Cockpit also writes its log to that console

Opening Cockpit

Problem: On ctrlX OS, Cockpit shuts down shortly after starting

Symptoms

On ctrlX OS, the Cockpit application shuts down shortly after it starts.

Possible causes
  • The licence is missing. The ctrlX licence for LumiScan Cockpit is SWL-W-XCx-COCKPITxxxHDVSx-V1NN.

Diagnostic procedure
  1. Read the ctrlX OS system log - expected: it gives the reason why the application shut down.

  2. Check the sidebar of the ctrlX web interface - expected: the LumiScan Cockpit link. The application adds it when it is installed and running.

Resolution
  • If the licence is missing: activate the ctrlX licence SWL-W-XCx-COCKPITxxxHDVSx-V1NN on the device, then start the application again. See Licence and LumiScan Licensing.

If the problem persists

Send the information listed under Information for support to support, together with the lines of the system log that give the reason.

Problem: On a PC, Cockpit says its port is taken and ends

Symptoms

On a PC, Cockpit shows a message that its port is taken, and ends.

Possible causes
  • Cockpit serves its pages on port 8000. Another program already uses this port.

  • A Cockpit started with --no-gui already uses this port.

Diagnostic procedure
  1. Check whether a Cockpit started with --no-gui runs - expected: none, if you want to start Cockpit with its window.

  2. Check whether another program uses port 8000.

Resolution
  • If another program or a Cockpit started with --no-gui uses the port: end it, then start Cockpit again.

  • If the port must stay with the other program: start Cockpit with --port and another port.

If the problem persists

Send the information listed under Information for support to support, together with the message Cockpit shows and the options it was started with.

Problem: On Windows, Cockpit opens in the browser instead of its own window

Symptoms

On Windows, Cockpit opens its pages in the default browser instead of its own window, and shows a message. Clicking OK in the message ends Cockpit.

Possible causes
  • The Microsoft Edge WebView2 Runtime is missing. Cockpit’s window shows its pages with it.

Diagnostic procedure
  1. Check whether Cockpit was started with --no-gui - expected: not, if you want its window. With --no-gui, Cockpit opens no window by design.

  2. Check whether the Microsoft Edge WebView2 Runtime is installed on the PC.

Resolution
  • If the WebView2 Runtime is missing: install it, then start Cockpit again. Or use Cockpit in the browser.

If the problem persists

Send the information listed under Information for support to support, together with the message Cockpit shows.

Problem: The overview shows no applications

Symptoms

The application overview lists no applications.

Possible causes
  • The applications are not running.

  • The applications do not run on the same device as Cockpit.

  • On a PC: Cockpit and the applications do not use the same broker. An address passed with --keryx-url was not passed to every one of them.

  • On a PC: no broker was started. This happens with an ipc:// address relative to the folder a program is started in, and with --no-keryx-autostart or LUMISCAN_KERYX_AUTOSTART=0.

Diagnostic procedure
  1. Check that the applications run on the same device as Cockpit.

  2. On a PC, compare the options Cockpit and the applications were started with - expected: the same --keryx-url, or none.

  3. On a PC with LumiScan Keryx, open the Data Layer page http://127.0.0.1:7555/ - expected: the tree shows the running applications.

Resolution
  • If the applications are not running: start them.

  • If the applications run on another device: run them on the same device as Cockpit.

  • If they use different broker addresses: pass the same --keryx-url to every application, Cockpit included, or start them all without the option.

  • If no broker was started: start krxsystem --backend hdv --url <address> yourself first. With a relative ipc:// address, start the broker and every application from the same folder.

If the problem persists

Send the information listed under Information for support to support, together with the options Cockpit and the applications were started with.

Views and results

Problem: A view shows a message instead of an image

Symptoms

A view reports why it has nothing to show, instead of an empty frame.

Possible causes
Diagnostic procedure
  1. Read the reason the view shows.

  2. For a publishing application: check whether it has run since it started.

  3. For one of the eight applications that draw findings: read the module’s input-image-address - expected: a camera’s image node.

Resolution
If the problem persists

Send the information listed under Information for support to support, together with the reason the view shows and the module’s input-image-address.

Problem: Findings are not drawn, and a note shows which size the result belongs to

Symptoms

The view shows the image without findings, and a note says which image size the result belongs to.

Possible causes
  • The last result was found in a camera image of a different size than the one displayed, usually because the camera resolution changed after the last run.

Diagnostic procedure
  1. Compare the size in the note with the current camera resolution - expected: they differ.

Resolution
  • If the camera resolution changed after the last run: run the application again to refresh the result against the new resolution.

If the problem persists

Send the information listed under Information for support to support, together with the size shown in the note and the camera resolution.

Problem: An AI Object Matching view on a stream says approximate

Symptoms

The live view of an AI Object Matching module shows the note approximate. While the scene moves, a box may be a little off.

Possible causes
  • The module took longer to infer than Cockpit keeps the camera’s recent frames (64 MB). The frame the result was found in is no longer kept, so the boxes are drawn on the newest frame instead.

Diagnostic procedure
  1. Check that the module infers on a camera’s image stream - expected: its control/subscribe/output/stream/active is true. The note appears only on such a live view.

Resolution
  • If the frame is no longer kept: no action is needed. The boxes are drawn on the newest frame and marked approximate. When a result arrives in time, its boxes are drawn on the very frame it was found in.

If the problem persists

Contact support with the information listed under Information for support, if boxes that are a little off are a problem for your application.

Live updates

Problem: A view only updates every two seconds

Symptoms

A view shows a new picture only every two seconds.

Possible causes
  • More than eight views stream at once, still images or live. Beyond eight, a view falls back to re-fetching its image every two seconds.

  • The connection through a proxy does not allow streaming.

Diagnostic procedure
  1. Count the views that are open - expected: eight or fewer.

  2. Check whether the browser reaches Cockpit through a proxy.

Resolution
  • If more than eight views are open: close views you do not need.

  • If a proxy does not allow streaming: the view keeps re-fetching its image every two seconds. The picture stays correct; it just arrives later.

If the problem persists

Send the information listed under Information for support to support, together with the number of open views and whether a proxy is used.

Problem: A camera streams, but its view shows still images instead of LIVE

Symptoms

The camera streams its images, but its view shows still images, and LIVE does not appear beside the view’s name.

Possible causes
  • More than four live views are open at once, counting every tab and window. Beyond four, a live view shows still images and tries again every five seconds.

  • The stream was not started with LumiScan Cam Driver’s control/publish/execute. A view turns live only then. The view of an AI Object Matching module turns live when the module infers on camera streams.

  • On ctrlX OS: the ctrlX web interface does not pass the live view through. Whether it does has not yet been verified on a device.

Diagnostic procedure
  1. Count the live views open in every tab and window - expected: four or fewer.

  2. On the camera, read control/publish/output/stream/active of LumiScan Cam Driver - expected: true. See The producer: the Cam Driver.

Resolution
  • If more than four live views are open: close live views you do not need. The view tries again every five seconds.

  • If the stream was not started: start it with the Cam Driver’s control/publish/execute. See the Cam Driver’s manual, "Streaming Images".

  • If the ctrlX web interface does not pass the live view through: the view shows still images. The picture stays correct; it just arrives later.

See Live view.

If the problem persists

Send the information listed under Information for support to support, together with the number of open live views and the value of control/publish/output/stream/active.

Overlays

Problem: An overlay change has no effect, or a shape is drawn white

Symptoms

After you edited Cockpit’s settings file, the overlay does not change; or a shape is drawn in white instead of its colour.

Possible causes
  • Cockpit has not been restarted since the edit. The settings file is read only once, at start-up.

  • The color value cannot be read. A colour that cannot be read is drawn white instead of being refused.

  • A position or size of 1.0 or above is in absolute pixels: 1.0 is one pixel, not the far edge or the full width.

Diagnostic procedure
  1. Check whether Cockpit was restarted after the file was edited.

  2. Check the color value of every white shape - expected: red, green, blue, black, white, yellow, cyan, magenta, or six hex digits RRGGBB (the may be left off).

  3. Check centerX, centerY, width and height - expected: values below 1.0 where you mean relative values.

Resolution
  • If Cockpit was not restarted: restart the Cockpit application.

  • If the colour cannot be read: correct the typo in the color value, then restart Cockpit.

  • If a value of 1.0 was meant as the far edge or the full width: use a value just under 1.0, then restart Cockpit.

See Overlays.

If the problem persists

Send the information listed under Information for support to support, together with Cockpit’s settings file.

Information for support

Contact HD Vision Systems customer success at customer.success@hdvisionsystems.com or +49 6221 6721905; for licences, licenses@hdvisionsystems.com. Please send:

  • the version of LumiScan Cockpit;

  • the platform: ctrlX OS and its version on a ctrlX CORE or ctrlX IPC, or a PC and its operating system;

  • the date and time of the error;

  • the log: on ctrlX OS from the system log (Logbook of the ctrlX web interface, or journalctl); on Windows %LOCALAPPDATA%\LumiScan Cockpit\logs\lumiscan-cockpit.log;

  • the communication status: the applications and views the overview lists, and on a PC the Data Layer address (--keryx-url) passed to Cockpit and to the applications;

  • the message or note the view shows;

  • the configuration: Cockpit’s settings file (lumiscan-cockpit.json on a PC), and on a PC the options Cockpit was started with.