Troubleshooting

The app is not running.

The app uses another broker than the program you look with (PC).

The settings file could not be loaded.

The licence is missing. On ctrlX OS, an app without a valid licence stops shortly after it starts.

The module name contains capital letters or other characters than a-z, 0-9, - and _. The Cam Driver and AI Object Matching refuse such a module.

Cam Driver, AI Object Matching, Calibration: the module file was activated with system/control/activate-module/execute, but the app has not restarted since.

Template Finder, Object Finder, Area Detector, Text Reader: the module was made with system/create-module/execute and not saved, and the app has restarted since.

If the app is not running: start it, and wait until it has finished starting.

If the app uses another broker: pass the same --keryx-url to every app, to Cockpit and to the OPC UA Connector.

If the settings file could not be loaded: correct it, and start the app again. On a PC, the settings are files in the app’s settings folder (on Windows C:\ProgramData\HD Vision Systems GmbH\LumiScan Vision Suite\<program>\etc\<settings folder>); the option --generate-settings writes an example. See Where the files are. On ctrlX OS, upload them as the app’s manual describes under Uploading Data.

If the licence is missing: see LumiScan Licensing.

If the module name is not valid: use lower-case module names.

If the app has not restarted since the activation: call hdvisionsystems/<app>/system/control/restart/execute.

If a finder module was not saved:

The case or spelling of the address is wrong. Addresses are lower case.

The node moved. Several nodes moved in the upcoming releases without an alias at the old address, for example the Cam Driver’s stream from input/stream/enable to control/publish/input/enable.

The app is restarting: its nodes disappear until it is up again.

The module is missing, see Problem: An app or a module is missing from the tree.

If the case or spelling is wrong: correct the address.

If the node moved: change your program to the address in the Data Layer Reference of the app version you run.

If the app is restarting: wait until system/restart-required can be read again.

If the module is missing: see Problem: An app or a module is missing from the tree.

TooManyOperations (ctrlX DL_TOO_MANY_OPERATIONS, OPC UA BadTooManyOperations): another operation of the same module runs - an execute, a handshake, or in the finders a frame of a stream.

InvalidOperationMode (ctrlX DL_INVALID_OPERATION_MODE, OPC UA BadInvalidState): the function is not ready. Its ready is false, for example because there is no licence, the camera is not connected, or a stream runs.

ResourceUnavailable (ctrlX DL_RESOURCE_UNAVAILABLE, OPC UA BadResourceUnavailable): a restart is required after a change through system/settings (status -5), the app is stopping, or an AI module is in error.

Rejected (ctrlX DL_INVALID_VALUE, OPC UA BadRequestNotAllowed): an input is not valid; nothing changed.

NodeNotFound (ctrlX DL_INVALID_ADDRESS, OPC UA BadNodeIdUnknown): an image, a source, a module or the node itself was not found.

CreationFailed (ctrlX DL_CREATION_FAILED): something could not be written or made, for example a file, an existing module or an unavailable licence.

InternalError (ctrlX DL_FAILED, OPC UA BadInternalError): the operation failed.

If another operation of the module runs (TooManyOperations): retry. The same call succeeds once the running operation has finished.

If the function is not ready (InvalidOperationMode): bring the module into the required state first, for example connect the camera. Retrying alone keeps failing: do not retry in a loop. The Cam Driver’s capture and AI Object Matching’s inference are not ready while their stream runs: stop the stream first, see Streams and single operations. The app’s manual says when each ready is true.

If a restart is required (ResourceUnavailable, status -5): see Problem: Status -5 (restartRequired), or ResourceUnavailable on every call.

If the app is stopping or an AI module is in error (ResourceUnavailable): read the status, and restart the app when required.

If an input is not valid (Rejected): correct the input and call again.

If something was not found (NodeNotFound): check the address and its case, see Problem: A node is "not found".

If something could not be written or made (CreationFailed), or the operation failed (InternalError): read the log and the status; they say why.

The settings were changed through system/settings. They apply at the next start.

If the settings were changed through system/settings:

The operation ran but failed. The result of the write only says that the operation ran. Whether it succeeded is in the module status.

If the status is below 0: remove the cause the code names, for example correct an input (-3, invalidInput), or restart the app (-5, see Problem: Status -5 (restartRequired), or ResourceUnavailable on every call). Then call again.

In your program, always read control/status/code after the call. See Where the inputs, outputs and outcome are.

request is still true: the module waits for request to fall, for as long as it takes.

Two programs write the same request node, and a request is lost.

Cam Driver capture: a failed capture ends at status 3, not at its own error code, and capture/ready stays false until a reset succeeds. A failed reset, save or load also stays until a reset succeeds.

AI Object Matching inference: every inference ends at status 3 whatever its outcome. After a failed inference, and while the module has an error, every request but reset is ignored. While the stream runs, inference/ready is false and a request gets status 100002.

Cam Driver: any other error stays on the status for about 100 ms only.

Cam Driver without a licence: every ready is false and the status is -4.

If request is still true: set request to false.

If two programs write request: let only one program write it. A program that cannot coordinate with others uses the execute method, which refuses a second call while one runs.

If a capture or an inference ends at status 3: this is how they end. Use output/package-identifier to tell success, or use the execute method: the status then keeps the operation’s own code. After a failed capture, run reset.

If AI Object Matching ignores requests after a failed inference: run reset; it runs at once.

If the AI Object Matching stream runs (status 100002): stop the stream first.

If a Cam Driver error disappears from the status after about 100 ms: check a connection with device-info/is-connected, not with the status.

If the Cam Driver has no licence (status -4): see LumiScan Licensing.

The inputs were written, but execute was not called. The inputs take effect only on execute; writing enable alone starts nothing.

enable is true without an address. The call is refused (Rejected, ctrlX DL_INVALID_VALUE), and nothing changes.

The consumer’s address is not the producer’s stream folder.

The module cannot run: licence, network not loaded, or restart required.

The Cam Driver restarted: its stream and the camera connection are not kept across a restart.

connect-camera, disconnect-camera or reset stopped the Cam Driver’s stream.

Nothing triggers the camera. The Cam Driver never triggers the camera by itself.

Calibration: its stream section has no onEntry step that says how to read the source.

If execute was not called: after writing the inputs, call control/subscribe/execute (a consumer) or control/publish/execute (the Cam Driver). Then wait until output/stream/active is true.

If enable is true without an address: write control/subscribe/input/address, then call control/subscribe/execute.

If the address is not the producer’s stream folder: write the folder, for example hdvisionsystems/lumiscan-cam-driver/camera1/control/publish/output/stream, and call execute.

If the module cannot run: remove the cause that control/status/code and the log name. For a required restart, see Problem: Status -5 (restartRequired), or ResourceUnavailable on every call.

If the Cam Driver restarted, or the stream was stopped by connect-camera, disconnect-camera or reset:

If nothing triggers the camera: check its trigger mode, or call control/trigger/execute.

If the Calibration onEntry step is missing: add it to the stream section. See the Calibration manual.

Your program read while a new result was written.

If your program reads while a new result is written: read the outputs when output/package-identifier changes, or subscribe to a single node such as Calibration’s plain-points. See Keep latest output.