--- title: "LumiScan Documentation" description: "Manuals, tutorials and reference for LumiScan by HD Vision Systems: the LumiScan X 3D light-field camera, vision-guided robotics, vision apps for ctrlX OS, Windows and Ubuntu, AI training and licensing." product: "LumiScan Documentation" component: "ROOT" language: "en" url: "https://docs.hdvisionsystems.com/en/index.html" --- # LumiScan Documentation ## Choose your starting point {#start} Three ways into LumiScan – depending on what you want to do. 1. Users · 10 minutes\ **[First Image in 10 Minutes](https://docs.hdvisionsystems.com/en/getting-started/first-image.html)**\ A LumiScan X image and point cloud on screen – and saved. 2. System integrators\ **[Your First Industrial Vision Application](https://docs.hdvisionsystems.com/en/getting-started/first-application.html)**\ Camera, vision app and PLC working together. 3. Software developers\ **[Integrating LumiScan into Your Application](https://docs.hdvisionsystems.com/en/getting-started/integrating.html)**\ Your own program calls the apps. ## All manuals {#manuals} Every app, every tool, every camera – with installation, configuration, interfaces and examples. ### Core components {#cat-core} The foundation of every LumiScan application: camera connection, common interface and live view. - K **[LumiScan Keryx](https://docs.hdvisionsystems.com/en/lumiscan-keryx/1.0.0/index.html)**\ Addresses, handshake, execute and stream calls, status codes – what all LumiScan apps have in common. - **[LumiScan Cam Driver](https://docs.hdvisionsystems.com/en/lumiscan-cam-driver/2.2.1/index.html)**\ Connects GenICam cameras to ctrlX OS or a PC and publishes images and camera functions on the Data Layer. - **[LumiScan Cockpit](https://docs.hdvisionsystems.com/en/lumiscan-cockpit/1.2.0/index.html)**\ Live view of the images and results of all vision apps – in the browser on ctrlX OS, in its own window on a PC. ### 3D vision-guided robotics {#cat-vgr} Robots that see: bin picking, machine tending and automated assembly. - **[LumiScan VGR](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/index.html)**\ 3D vision-guided robotics for bin picking and automated assembly. - FT **[LumiScan File Transfer](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/index.html)**\ Exchanges annotated images and trained models between the production system and the training computer. ### Object detection {#cat-detect} Find, match and locate parts – with templates, shapes or neural networks. - **[LumiScan AI Object Matching](https://docs.hdvisionsystems.com/en/lumiscan-ai-object-matching/2.1.0/index.html)**\ Detects trained objects with neural networks and reports their position and orientation. - **[LumiScan Template Finder](https://docs.hdvisionsystems.com/en/lumiscan-template-finder/1.1.0/index.html)**\ Locates a known part from a template image – with position, confidence, scale and rotation. - **[LumiScan Object Finder](https://docs.hdvisionsystems.com/en/lumiscan-object-finder/1.1.0/index.html)**\ Locates known objects by their shape from one or more template images. - **[LumiScan Area Detector](https://docs.hdvisionsystems.com/en/lumiscan-area-detector/1.2.0/index.html)**\ Finds regions in an image and reports the size of each. ### Reading codes and text {#cat-read} Traceability on the part: read codes and plain text reliably. - **[LumiScan Aztec Code Reader](https://docs.hdvisionsystems.com/en/lumiscan-aztec-code-reader/1.2.0/index.html)**\ Finds Aztec codes and reports their content and position. - **[LumiScan Barcode Reader](https://docs.hdvisionsystems.com/en/lumiscan-barcode-reader/1.0.0/index.html)**\ Finds barcodes and reports their content and position. - **[LumiScan DMC Reader](https://docs.hdvisionsystems.com/en/lumiscan-dmc-reader/1.1.0/index.html)**\ Finds Data Matrix codes and reports their content and position. - **[LumiScan QR Code Reader](https://docs.hdvisionsystems.com/en/lumiscan-qr-code-reader/1.0.0/index.html)**\ Finds QR codes and reports their content and position. - **[LumiScan Text Reader](https://docs.hdvisionsystems.com/en/lumiscan-text-reader/1.1.0/index.html)**\ Reads printed text such as part numbers, batch and date codes or labels. ### Processing {#cat-proc} From pixel to robot coordinate. - **[LumiScan Calibration](https://docs.hdvisionsystems.com/en/lumiscan-calibration/2.0.0/index.html)**\ Converts 2D image coordinates into 3D coordinates on a calibrated plane, e.g. for picking and placing. ### Engineering software {#cat-eng} Teach your own objects and configure applications step by step – without writing vision code. - **[LumiScan Annotation Framework](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/index.html)**\ Annotates objects in images to create the training data for neural networks. - **[LumiScan Training Framework](https://docs.hdvisionsystems.com/en/lumiscan-training/2.3.0/index.html)**\ Trains neural networks for object detection and localisation. - VE **[LumiScan VGR Engineering](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/index.html)**\ Guided configuration of LumiScan VGR and other LumiScan software, with camera preview and suggested settings. ### 3D vision hardware and licensing {#cat-hw} The light-field camera and everything about licences. - X **[LumiScan X](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/index.html)**\ The 3D light-field camera: hardware, safe installation and use, and the software that comes with it. - L **[LumiScan Licensing](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/index.html)**\ LumiScan Key, CodeMeter Runtime, licence updates and ctrlX licences for all products. ## Help when you need it {#help} - **[FAQ](https://docs.hdvisionsystems.com/en/faq.html)**\ Quick answers to common questions. - **[Troubleshooting](https://docs.hdvisionsystems.com/en/troubleshooting.html)**\ Understand error messages and fix problems. - **[Glossary & Terminology](https://docs.hdvisionsystems.com/en/glossary/index.html)**\ Terms from Data Layer to hand-eye calibration. - **[Introduction](https://docs.hdvisionsystems.com/en/introduction.html)**\ What LumiScan is and how the products work together. Didn’t find what you need? Our team is happy to help: [info@hdvisionsystems.com](mailto:info@hdvisionsystems.com) · [+49 6221 67219-00](tel:+4962216721900) ## Imprint {#imprint} HD Vision Systems GmbH\ Palo-Alto-Platz 11\ 69124 Heidelberg Phone +49 6221 67219-00\ Fax +49 6221 67219-01\ Email: [info@hdvisionsystems.com](mailto:info@hdvisionsystems.com)\ Web: [hdvisionsystems.com](https://www.hdvisionsystems.com/) CEO: PD Dr. Christoph Garbe\ Register court: Amtsgericht Mannheim\ Register number: HRB 726917 Copyright © 2026 HD Vision Systems GmbH. All rights reserved. The vision system and software described in this documentation are the intellectual property of HD Vision Systems GmbH, Heidelberg. No part of this documentation may be reproduced without the written permission of the publisher. Subject to technical changes. See also the [General Disclaimer](https://docs.hdvisionsystems.com/en/general-disclaimer.html).