FAQ

The application reads the image node of another application that runs on the same device - the same ctrlX CORE or ctrlX IPC, or the same PC (remote Data Layer access is not supported), normally LumiScan Cam Driver, for example hdvisionsystems/lumiscan-cam-driver/camera1/output/image. The node must provide data (raw, uncompressed uint8 pixel data), width, height and pixel-type. Supported pixel formats are Mono8, Mono12, RGB8, RGB12, BGR8, BGR12, BayerGR8, BayerGR12, BayerRG8 and BayerRG12; Bayer images are converted to colour and 12-bit images scaled down to 8 bit before reading. Any other pixel format is rejected with status code -3.

Requirements

No setting recovers text the camera did not capture. As a rule of thumb:

Requirements

Set <module>/read-text/input/input-image-address, write to <module>/read-text/execute (a blocking call) and check output/status-code. On 1, read output/result: text is the whole reading as the engine laid it out and is not filtered by min-score; words[] holds each word with its score and box, filtered by min-score; word_count, mean_score and the language, engine and layout actually used are also reported. In production, check word_count and words[0].score before comparing words[0].text with the expected value.

Reading Text, How To: Read a Part Marking from a Camera Image

English (eng) and osd ship with the application.

Language Models

Yes, from the next read-text on, without a restart. The recognition engine is built once per module and kept, but before every read the reader checks the model file’s size and time and, when either changed, compares its content with the one the engine was built from. A changed model is loaded again; the log says The '<language>' model in '<directory>' changed on disk; loading it again. An image stream also reads the next frame with the model as it is on disk.

If a read fails with -7 right after the replacement, the file could not be loaded yet - an upload still in progress, for example.

Read again once the upload has completed; that read loads the new model.

Language Models

Subscribe a module to the Cam Driver’s stream (experimental): write the camera’s stream folder, for example hdvisionsystems/lumiscan-cam-driver/camera1/control/publish/output/stream, to <module>/control/subscribe/input/address, set control/subscribe/input/enable to true and write to control/subscribe/execute. Each frame is read with the inputs of read-text, and one result per frame is published on control/subscribe/output/stream/result. To read the latest result as a plain read-text/output/result, set control/subscribe/input/keep-latest-output to true.

Reading Text on an Image Stream, Streams

Check the sign of output/status-code: greater than 0 is success, 0 means the operation has not run since the application started, less than 0 means it failed and produced nothing. The reason is on output/status-text. A failed write to execute answers only with a status code (over REST, a bare 400), so read output/status-text afterwards; the text is also in the application log: on ctrlX OS in the ctrlX Logbook or journalctl, on a PC in the application’s console output. -1 means the module was busy; nothing was done and the previous reading is left alone. Every other execute empties output/result as it starts, so read the result before triggering the next reading.

Execute a Method, Execution Status, Reading Text

One licence covers ten modules; the eleventh module acquires a second licence of the same key, and a module is refused with status -11 when no licence on the device covers it. Purchase routes:

Requirements, Module Management, Licensing FAQ

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

Licensing FAQ