Troubleshooting
This page describes problems and error messages of LumiScan Object Finder, grouped by category. Start with the general checks, then find your symptom below: each problem lists its symptoms, the possible causes, a diagnostic procedure and the resolution. Problems of the Data Layer itself are described in Data Layer troubleshooting, licence problems in Licensing troubleshooting.
General checks
-
Check the status code. Read
output/status-codeof the operation that failed. Expected:1. A value greater than 0 means success,0means the operation has not run since the application started, and a value less than 0 means it failed and produced nothing. The codes are listed in Execution Status. -
Read the status text. Read
output/status-textof the same operation. It starts withok:orerror:and names every invalid input and the value it holds. A failed write toexecuteanswers with a status code only (over REST, a bare400), so the reason is only onoutput/status-text. -
Read the application log. It holds the same text, with one warning line for each invalid input: on ctrlX OS in the ctrlX Logbook or with
journalctl, on a PC in the application’s console output. How much is logged is set withlogLevelin thesystemblock oflumiscan-object-finder.json(TRACE,DEBUG,INFO,WARN,ERROR,FATALorOFF). It is read at startup, so restart the application after you change it. See Data Layer Reference. -
Check the image source. The camera application, normally LumiScan Cam Driver, must run on the same device - the same ctrlX CORE or ctrlX IPC, or the same PC - and must have captured an image. Remote Data Layer access is not supported. Expected: the node named in
input/input-image-addressprovidesdata,width,heightandpixel-type. -
Check the order of the calls. A module runs one operation at a time, and every run clears its outputs as it starts. Expected: your program waits for
executeto return, reads the outputs, and only then triggers the next run. -
Check the licence (ctrlX OS). Expected: the application keeps running after it starts. Without a licence it shuts down shortly after starting; see Problem: The application stops shortly after starting.
The configuration directory holds lumiscan-object-finder.json, the module files <module-id>.json, the objects and settings-history/:
| Platform | Configuration directory |
|---|---|
ctrlX OS |
|
PC (Windows) |
|
Status codes and error messages
Problem: Status code -1 (busy)
output/status-code of find-object is -1. The write to execute answers TooManyOperations (ctrlX: DL_TOO_MANY_OPERATIONS). Nothing was done, and output/result keeps its value. With a camera streaming, this happens often. system/remove-module can answer -1 (busy) as well.
-
Another operation of the same module was still running. A second call is not queued; it returns at once and does nothing.
-
The module’s image stream is searching a frame. The stream and
find-objectnever run at the same time on one module.
-
Check in your program whether it writes to
executeof the same module again before the previous write has returned. Expected: one call per module at a time. -
Read
<module-id>/control/subscribe/output/stream/active.truemeans that the stream of this module runs.
-
If another operation was still running: wait for the running
executeto return, then call the method again. The lock is per module, so other modules are not held up. -
If the stream of the module runs:
-
Stop the stream before you call the method: set
control/subscribe/input/enabletofalseand write tocontrol/subscribe/execute. Or call the method again. -
To use the results of the stream instead, switch on
control/subscribe/input/keep-latest-outputand readfind-object/output/result.
-
-
If
system/remove-moduleanswers busy: stop the stream of the module first. Removing a module stops its stream.
Send the information listed under Information for support to support, together with the module id, the answer of the write to execute and the value of control/subscribe/output/stream/active.
Problem: Status code -2 (invalid input)
output/status-code is -2. output/status-text starts with error: and names each input that cannot be used, together with the value it holds. All invalid inputs are reported together.
-
A required input is empty.
input/object-idoffind-objectis required. -
The image address points at this application itself.
-
input/object-idofsystem/create-objectorinput/object-dirofsystem/set-object-diris an absolute path, or a path that climbs out of the configuration directory with...
-
Read
output/status-textof the operation. Expected: it names the offending input and its value. -
Read the application log. Each invalid input has its own warning line.
-
If a required input is empty: set it. For
find-object, setinput/object-idto an entry ofsystem/objects. -
If the image address points at this application: set
input/input-image-addressto the image node of the camera application, for examplehdvisionsystems/lumiscan-cam-driver/camera1/output/image. -
If a path is absolute or leaves the configuration directory: give it relative to the configuration directory, for example
production-parts.
Then run the operation again. Expected: output/status-code is 1. See Execution Status and Object Storage.
Send the information listed under Information for support to support, together with the content of output/status-text.
Problem: Status code -3 (image read failed)
output/status-code of find-object or system/create-object is -3.
-
The camera application is not running, or it runs on another device.
-
The camera application has not captured an image yet.
-
The address in
input/input-image-addressis wrong. -
The image node at the address is missing, empty or inconsistent.
-
The image uses an unsupported pixel format. Supported are
Mono8,Mono12,RGB8,RGB12,BGR8,BGR12,BayerGR8,BayerGR12,BayerRG8andBayerRG12.
-
Check that the camera application, normally LumiScan Cam Driver, runs on the same device. Expected: it runs on the same ctrlX CORE or ctrlX IPC, or on the same PC.
-
Compare
input/input-image-addresswith the address of the camera’s image node, for examplehdvisionsystems/lumiscan-cam-driver/camera1/output/image. Expected: identical. -
Read
width,heightandpixel-typeof the image node. Expected: values greater than 0, and apixel-typefrom the list above.
-
If the camera application is not running: start it on the same device and capture an image.
-
If no image has been captured yet: capture an image in the camera application.
-
If the address is wrong: correct
input/input-image-address. -
If the pixel format is not supported: use one of the supported pixel formats, see Requirements.
Then run the operation again. Expected: output/status-code is 1.
Send the information listed under Information for support to support, together with the content of output/status-text, the image address and the pixel-type of the image node.
Problem: Status code -4 (source not found)
output/status-code of find-object is -4.
-
The object’s picture is missing or unreadable:
input/object-idnames no entry ofsystem/objects. -
The object directory is missing or unreadable.
-
The picture is in another directory than the one in use.
-
Compare
input/object-idwithsystem/objects. Expected: the id is listed, spelled the same way. -
Read
system/object-dir. Expected: it names the directory that holds the object’s.png. -
Check the file in that directory. Expected: a lower case
.pngat the top of the directory, named after the object.
-
If the object id is not listed: correct
input/object-id, or teach the object withsystem/create-object. A file you put into the directory by other means is listed only after a refresh, see Problem: An uploaded.pngdoes not appear onsystem/objects. -
If the directory is not the one you expect: switch with
system/set-object-dir, see Object Storage.
Then run find-object again. Expected: output/status-code is 1.
Send the information listed under Information for support to support, together with the content of output/status-text, input/object-id, system/object-dir and system/objects.
Problem: The crop region does not fit the image
system/create-object answers status -5 (invalid crop region), and output/status-text names the edge and the image size, for example:
error: Crop region does not fit inside the 1920x1080 image: crop/startY + crop/height (1000 + 200 = 1200) exceeds the image height 1080
For find-object, output/status-text names the input and the limit it broke, for example error: crop/startX + crop/width (100 + 900 = 1000) exceeds the image width 640. In the image stream, the frame fails, and control/subscribe/output/stream/last-failure names a crop region that does not fit the frame.
-
The region reaches past an edge of the image. The whole crop must lie inside the image; it is refused, not trimmed.
-
For
system/create-object,input/crop/widthorinput/crop/heightis 0. Both must be greater than 0.
-
Read the image size from the message, or
widthandheightof the image node. -
Add
input/crop/startXandinput/crop/width, andinput/crop/startYandinput/crop/height. Expected: the sums are not larger than the image width and the image height.
-
If the region reaches past an edge: correct
input/crop/startX,startY,widthorheight, so that the region fits the image size given in the message. -
If width or height is 0 (
create-object): set both to the size of the region, greater than 0.
Then run the operation again. Expected: output/status-code is 1. See Creating an Object.
Send the information listed under Information for support to support, together with the content of output/status-text and the four input/crop/ values.
Problem: The run fails and names the object
find-object fails with a negative status code, and output/status-text names the object. This often happens after input/preprocess/bin-size was raised. It is never reported as an empty result.
-
The object is binned too far. Its picture then no longer has the edges the detector keys on, and the detector refuses it, for example a 128x128 object at
bin-size8 (reduced to 16x16). Small objects reach this limit sooner than large ones. -
The picture was cropped along the part’s silhouette when the object was taught. A picture must yield a minimum number of strong gradient points, and a crop that stops at the silhouette hides the outline from the detector.
-
Read
input/preprocess/bin-sizeof the module. Lower it by one step and runfind-objectagain. Expected:output/status-codeis1. -
If the run still fails at
bin-size1, open the object’s.pngin the object directory. Expected: a thin, even band of background, about 5 pixels, around the part.
-
If the object is binned too far: lower
input/preprocess/bin-sizeagain. Raise it one step at a time and stop when the scores start dropping towards the threshold. -
If the picture was cropped at the silhouette: teach the object again with
system/create-object, with about 5 pixels of background around the part. See Creating an Object.
Send the information listed under Information for support to support, together with the content of output/status-text, the value of bin-size and the object’s .png.
Problem: Status code -6 (write failed)
output/status-code of system/save-module-inputs or system/create-object is -6.
-
A file could not be written - usually a permission problem or a full disk.
-
Read
output/status-textof the operation. Expected: it names the file that could not be written. -
Read the application log at the time of the call.
-
Check the configuration directory (see General checks). Expected: it exists and the application can write to it.
-
If it is a permission problem: make the configuration directory writable for the application.
-
If the disk is full: free disk space on the device.
Then run the operation again. Expected: output/status-code is 1.
Send the information listed under Information for support to support, together with the content of output/status-text.
Search results
Problem: The result is empty although the status code is 1
output/status-code of find-object is 1, but matches in output/result is empty (best_score 0.0, best_object_id empty). Or a genuine part is found in some images and missed in others: only in some orientations, or only at some working distances.
An empty result with status code 1 means that the object was not in the searched image, and nothing else. Every other reason - missing picture, unusable image, invalid pyramid level, bin-size leaving too little of the object - is reported as a negative status code. If a genuine part is missed:
-
input/cropexcludes the part. -
The scores of the genuine parts are below
input/confidence-threshold(default0.6). A threshold at or above0.9usually rejects everything. -
The part arrives in an orientation that no object was taught for. The detector does not rotate a picture.
-
The part sits closer to or further from the camera than in the picture it was taught from.
-
Read
output/status-code. Expected:1. If it is negative, the run failed: readoutput/status-textand see the entries under Status codes and error messages. -
Check that
input/object-idis listed onsystem/objects. -
Read the four
input/crop/values. Expected: all0(the whole image), or a region that contains the part. -
Set
input/confidence-thresholdto0.4, run against real parts and note thescoreof the genuine matches inoutput/result. Expected: the threshold you use lies below the worst score of a genuine part. -
Compare an image in which the part is missed with the image the object was taught from. Expected: the same orientation and working distance.
-
If the crop excludes the part: widen the region, or set all four
input/crop/values to0. -
If the scores are just below the threshold: set
input/confidence-thresholda little below the worst score a genuine part produces. If the scores hover near the threshold or the images are noisy, setinput/preprocess/blur-sigma-xto1.0(blur is off by default) and measure again. -
If the part is missed at particular orientations: teach another object at the orientation being missed, for example
screw-m6-tilted, and search for it in its own run. No setting fixes this. -
If the part is missed at another working distance: teach an object at that distance.
-
If the part was not in the image: the result is correct; nothing needs to be changed.
See Finding an Object and Tuning the Search.
Send the information listed under Information for support to support, together with input/object-id, the threshold, the scores you measured and the object’s .png.
Problem: One part is reported several times
matches in output/result holds a cluster of matches a few pixels apart for one part.
-
input/nms-min-distis0(the default), which keeps every match. -
input/nms-min-distis smaller than the distance between the matches of one part.
-
Read
input/nms-min-distof the module.0keeps every match. -
Compare
xandyof the matches of one part with the size of the part in pixels.
-
Set
input/nms-min-distto roughly half the size of the part in pixels, for example40. Where several matches fall within that distance, only the highest scoring one is kept.
The default of 0 is only useful when parts genuinely sit closer together than their own size. See Tuning the Search.
Send the information listed under Information for support to support, together with output/result and the value of input/nms-min-dist.
Problem: output/result is empty although the search worked a moment ago
A run produced matches, and shortly afterwards output/result is empty.
-
The next run has started. Every run clears its own outputs as soon as it begins, before anything that can fail. A run that fails for any reason leaves them empty.
-
A call refused with
-1(busy) clears nothing, so this is not the cause when the second call was refused.
-
Check the order of the calls in your program. Expected: it reads
output/resultbefore it triggers the nextexecute. -
Read
output/status-codeof the latest run. A negative value means that this run failed and leftoutput/resultempty.
-
If the next run started too early: wait for
executeto return, read the outputs, and only then trigger the next run. -
If the latest run failed: follow the entry for its status code.
See Execute a Method.
Send the information listed under Information for support to support, together with the sequence of calls your program makes.
Objects
Problem: An uploaded .png does not appear on system/objects
A .png file is in the object directory, but system/objects does not list it.
-
The list was not refreshed.
system/objectsis refreshed only at startup, whensystem/set-object-dirswitches directory and whensystem/create-objectsaves a template. Files added by other means - an upload or an SSH session on ctrlX OS, a file copied in by hand on a PC - are picked up at the next of these. -
The file name does not end in a lower case
.png..PNGfiles are skipped. -
The file is in a subdirectory. Only files at the top of the object directory are listed.
-
The file is in another directory than the one
system/object-dirnames.
-
Read
system/object-dir. Expected: it names the directory that holds the file. -
Check the file name. Expected: it ends in a lower case
.png, and the file is at the top of the directory.
-
If the file name or the place is wrong: use a lower case
.pngfile name at the top of the object directory. -
Then: run
system/set-object-diror restart the application. Expected:system/objectslists the object.
See Object Storage.
Send the information listed under Information for support to support, together with system/object-dir, system/objects and the file name.
Image stream (experimental)
Problem: The image stream delivers no results
control/subscribe/output/stream/active stays false, no results arrive on control/subscribe/output/stream/result, or control/subscribe/output/stream/statistics/failed-frames grows.
-
Only the inputs were written. Writing
control/subscribe/input/enablealone starts nothing;control/subscribe/executeapplies the inputs. -
control/subscribe/executewas refused (Rejected, ctrlX:DL_INVALID_VALUE): stream mode without an address, or a queue size outside1to64. -
The settings file
<module-id>.jsoncould not be written, for example because it is not valid JSON (CreationFailed, ctrlX:DL_CREATION_FAILED). Nothing changed. -
The stream of the Cam Driver does not run, so no frames arrive.
-
The source cannot be subscribed to. The module tries it again every 5 seconds while the stream runs, and logs the first failure.
-
Frames cannot be searched, for the reasons
find-objectgives in itsstatus-text.
-
Read
hdvisionsystems/lumiscan-cam-driver/<camera name>/control/publish/output/stream/active. Expected:true. -
Read
setting/stream/enableandsetting/stream/addressof the module. Expected:trueand the camera’s stream folder, for examplehdvisionsystems/lumiscan-cam-driver/camera1/control/publish/output/stream. They show what was applied last. -
Check the answer of the write to
control/subscribe/execute. Expected:Ok(ctrlX:DL_OK). These methods have nostatus-text; the reason for a refusal is in the application log. -
Read
control/subscribe/output/stream/active. Expected:true. -
Read
received-frames,processed-framesandfailed-framesundercontrol/subscribe/output/stream/statistics/. The first counter that does not grow shows where the chain stops. -
If
failed-framesgrows, readcontrol/subscribe/output/stream/last-failure. It says why the last frame failed, for example:a frame of 'hdvisionsystems/lumiscan-cam-driver/camera1/control/publish/output/stream' failed: invalid input: object-id is empty - name the object to search for, see system/objects
-
If only the inputs were written: set
control/subscribe/input/enabletotrueand write tocontrol/subscribe/execute. Wait untilcontrol/subscribe/output/stream/activeistrue. -
If the call was refused (
Rejected,DL_INVALID_VALUE): write the camera’s stream folder tocontrol/subscribe/input/address, setcontrol/subscribe/input/queue-sizeto a value from1to64, and write tocontrol/subscribe/executeagain. -
If the settings file could not be written (
CreationFailed,DL_CREATION_FAILED): make<module-id>.jsonin the configuration directory valid JSON again, without comments, then write tocontrol/subscribe/executeagain. -
If the stream of the Cam Driver does not run: start it. It is not kept after a restart: call its
control/publish/executewithenable=trueafter every start, and connect the camera first. See A stream delivers nothing. -
If the source cannot be subscribed to: check that
control/subscribe/input/addressis the camera’s stream folder and that the Cam Driver runs on the same device. -
If frames fail: correct the input that
last-failurenames, as for a singlefind-objectcall.
Send the information listed under Information for support to support, together with the values under setting/stream/, the counters under control/subscribe/output/stream/statistics/, control/subscribe/output/stream/last-failure and the module’s <module-id>.json.
Modules, settings and licensing
Problem: My settings or modules are gone after a restart
After a restart of the application, a module is missing from system/modules, or a module’s inputs are back at their defaults.
-
The module list was not saved. Settings and new modules take effect immediately but are not saved until you ask; the module list and each module’s settings are saved separately.
-
The module’s settings were not saved.
-
A save failed:
system/save-module-inputsorsystem/save-current-modulesdid not report status1. -
<module-id>.jsoncontains comments. The stream reads such a file, but the module’s inputs are then not restored at start; the log reports the file as unreadable. -
A setting whose node no longer exists after a software update is skipped, with a log entry.
-
Read
system/modulesafter the restart. Expected: all your modules. -
Check the configuration directory (see General checks). Expected:
lumiscan-object-finder.jsonnames your modules, and there is a<module-id>.jsonfor each module whose settings you saved. -
Read the application log of the start. Expected: no module file reported as unreadable, no skipped setting.
-
If the settings or the module list were not saved:
-
Set
system/save-module-inputs/input/module-id(for examplemodule-1) and write tosystem/save-module-inputs/execute. Do this for each module. -
Write to
system/save-current-modules/execute. -
Check that both report status
1.
-
-
If the module file contains comments: remove them from
<module-id>.json. Changes made to the file by hand take effect at the next start. -
If a setting was skipped after an update: set the input again and save the module’s settings.
A module’s image stream settings need no extra step: control/subscribe/execute saves them in <module-id>.json itself. To have the module itself back, save the module list as well. See Module Management and Kept in the settings file.
Send the information listed under Information for support to support, together with lumiscan-object-finder.json and the module files <module-id>.json.
Problem: The application stops shortly after starting
On ctrlX OS, the application shuts down shortly after it starts. Its nodes under hdvisionsystems/lumiscan-object-finder disappear from the Data Layer.
-
The licence is missing. The reason is written to the system log.
-
The application needs more licences than are installed. One licence covers ten modules, see Problem: Status code
-11(licence unavailable).
-
Open the ctrlX OS system log (ctrlX Logbook or
journalctl). Expected: it names the reason and the missing licence. -
Compare the licence with the ctrlX licence of LumiScan Object Finder,
SWL-W-XCx-OBJECTxFDxHDVS-V1NN. Expected: it is installed on the device on which the application runs.
-
If the licence is missing: install a valid licence on the device and start the application again. Expected: it keeps running, and its nodes are on the Data Layer.
Send the information listed under Information for support to support, together with the lines of the system log that name the licence. For licences, contact licenses@hdvisionsystems.com.
Problem: Status code -11 (licence unavailable)
A module is refused with status code -11.
-
No licence on the device covers the module. One licence covers ten modules; the eleventh module acquires a second licence of the same key.
-
Count the entries of
system/modules. Expected: no more than ten modules for each licence on the device. -
Read
output/status-textof the operation that answered-11.
-
If more modules exist than the licences cover: remove the modules you do not need with
system/remove-moduleand save the module list withsystem/save-current-modules, or obtain another licence.
See Module Management.
Send the information listed under Information for support to support, together with system/modules. For licences, contact licenses@hdvisionsystems.com.
Information for support
If a problem persists, send this information to support:
-
Software version: the version of LumiScan Object Finder you run. The files in
settings-history/in the configuration directory record it assoftware.version. -
Platform: ctrlX OS (ctrlX CORE or ctrlX IPC) and its ctrlX OS version, or a PC with Windows 11 or Ubuntu 24.04. Also say where you bought the software: from HD Vision Systems or in the ctrlX Store.
-
Data Layer: the ctrlX Data Layer (ctrlX OS) or LumiScan Keryx (PC). On a PC, also the Data Layer address the application uses.
-
Log: the application log from the time of the error - on ctrlX OS from the ctrlX Logbook or
journalctl, on a PC the application’s console output. -
Time: the date and time of the error.
-
Communication status:
output/status-codeandoutput/status-textof the operation that failed, and the answer of the write toexecute(for exampleTooManyOperationsorDL_TOO_MANY_OPERATIONS). -
Configuration files:
lumiscan-object-finder.json, the<module-id>.jsonof the module concerned and, for the image stream, the file insettings-history/that its settings hash names. Where they are is listed under General checks.
Contact HD Vision Systems customer success at customer.success@hdvisionsystems.com or +49 6221 6721905; for licences, licenses@hdvisionsystems.com. See also Before you contact support in the LumiScan FAQ.