---
title: "Platform Overview"
description: "The LumiScan platform at a glance - cameras, vision apps, the Data Layer, LumiScan VGR, the AI tools, supported hardware, what to install and how to connect your controller."
product: "LumiScan Documentation"
component: "ROOT"
language: "en"
url: "https://docs.hdvisionsystems.com/en/getting-started/platform-overview.html"
---

# Platform Overview – LumiScan Documentation

LumiScan consists of cameras, vision apps that process their images, tools that prepare neural networks, and the robot guidance software LumiScan VGR. This page shows how they fit together, what runs where, and what you need to install for your application.

**The LumiScan platform**

```mermaid
%% The LumiScan platform. Rendered by Mermaid in the browser; edit and preview at https://mermaid.live
flowchart TB
  subgraph cams["Cameras"]
    genicam["`**GenICam cameras**
    Basler, Baumer, IDS,
    LUCID, Hikvision, Balluff`"]
  end
  subgraph apps["Vision apps"]
    cd["`**Cam Driver**
    images from the camera`"]
    proc["`**Processing**
    Finders · Code readers · Text Reader
    AI Object Matching · Area Detector`"]
    calib["`**Calibration**
    pixel to 3D coordinates`"]
    cockpit["`**Cockpit**
    shows images and results`"]
  end
  dl(["`**Data Layer**
  ctrlX OS: ctrlX Data Layer · PC: LumiScan Keryx`"])
  subgraph ctrl["Your controller"]
    cplc["`**ctrlX PLC**
    on the same ctrlX device`"]
    opc["`**OPC UA client**
    PLC or SCADA, PC`"]
    prog["`**Your program**
    Data Layer or OPC UA`"]
  end
  genicam --> cd
  cd --> proc & calib
  cd & proc & calib & cockpit <--> dl
  dl <--> cplc & opc & prog
  subgraph vgrg["Robot guidance"]
    lsx["`**LumiScan X**
    3D light-field camera`"]
    vgre["`**VGR Engineering**
    builds its settings`"]
    vgr["`**LumiScan VGR**
    bin picking, Windows IPC`"]
    plc2["`**PLC**
    PROFINET or OPC UA`"]
  end
  lsx --> vgr
  vgre --> vgr
  vgr --> plc2
  subgraph aiw["AI workflow"]
    ann["`**Annotation**
    annotate images`"]
    train["`**Training**
    train the network`"]
    model["`**Model**
    .onnx + .json`"]
  end
  ann --> train --> model
  model -.-> proc
  model -.-> vgr
  class cd,vgr,dl key
  classDef key fill:#faf6dc,stroke:#a8961f,color:#1f2328
```

## The building blocks

| Building block | What it does | Runs on |
| --- | --- | --- |
| [LumiScan X](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/index.html) | 3D light-field camera: 13 cameras in one housing deliver images and a point cloud. Comes with the **LumiScan Viewer** to set up the camera, capture and export data. | camera + Windows PC |
| [LumiScan Cam Driver](https://docs.hdvisionsystems.com/en/lumiscan-cam-driver/2.2.1/index.html) | Connects GenICam cameras and makes their images and camera functions available on the Data Layer - the start of every vision app chain. | ctrlX OS or PC |
| Processing apps | Find a part ([Template Finder](https://docs.hdvisionsystems.com/en/lumiscan-template-finder/1.1.0/index.html), [Object Finder](https://docs.hdvisionsystems.com/en/lumiscan-object-finder/1.1.0/index.html), [AI Object Matching](https://docs.hdvisionsystems.com/en/lumiscan-ai-object-matching/2.1.0/index.html)), measure regions ([Area Detector](https://docs.hdvisionsystems.com/en/lumiscan-area-detector/1.2.0/index.html)), read codes and text ([Aztec](https://docs.hdvisionsystems.com/en/lumiscan-aztec-code-reader/1.2.0/index.html), [Barcode](https://docs.hdvisionsystems.com/en/lumiscan-barcode-reader/1.0.0/index.html), [DMC](https://docs.hdvisionsystems.com/en/lumiscan-dmc-reader/1.1.0/index.html), [QR Code Reader](https://docs.hdvisionsystems.com/en/lumiscan-qr-code-reader/1.0.0/index.html), [Text Reader](https://docs.hdvisionsystems.com/en/lumiscan-text-reader/1.1.0/index.html)). | ctrlX OS or PC |
| [LumiScan Calibration](https://docs.hdvisionsystems.com/en/lumiscan-calibration/2.0.0/index.html) | Converts pixel coordinates of a result into 3D coordinates on a calibrated plane, for example for a robot. | ctrlX OS or PC |
| [LumiScan Cockpit](https://docs.hdvisionsystems.com/en/lumiscan-cockpit/1.2.0/index.html) | Shows the images and results of the running apps - in the browser on ctrlX OS, in its own window on a PC. It only displays; it configures nothing. | ctrlX OS or PC |
| [LumiScan Keryx](https://docs.hdvisionsystems.com/en/lumiscan-keryx/1.0.0/index.html) | How the vision apps talk to each other and to your controller: every function is a node that is read, written or called. ctrlX OS provides the **ctrlX Data Layer**; on a PC **LumiScan Keryx** provides the same interface. | ctrlX OS or PC |
| [LumiScan VGR](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/index.html) | 3D vision-guided robotics: finds objects in the point cloud of a LumiScan X, calculates grip points and sends the best one to the PLC. Configured with [LumiScan VGR Engineering](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/index.html). | Windows 11 IPC with NVIDIA GPU |
| [Annotation](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/index.html), [Training](https://docs.hdvisionsystems.com/en/lumiscan-training/2.3.0/index.html), [File Transfer](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/index.html) | Prepare neural networks: annotate images, train a network, export the model (`.onnx` + `.json`) for AI Object Matching or LumiScan VGR; File Transfer moves images and models between the production system and the training PC. | Windows 11 PC; Training needs an NVIDIA RTX GPU |
| [Licensing](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/index.html) | One licensing scheme for all products: LumiScan Key with CodeMeter Runtime, or a ctrlX licence. | - |

## Two platforms for the vision apps {#platforms}

The vision apps run on either platform with the **same node addresses and call patterns**. A program written against one works against the other.

|   | ctrlX OS | PC |
| --- | --- | --- |
| Devices | ctrlX CORE or ctrlX IPC | Windows 11 or Ubuntu 24.04 |
| Data Layer | ctrlX Data Layer, provided by ctrlX OS | LumiScan Keryx: the first app that starts launches its broker |
| Installation | the apps as ctrlX apps | LumiScan Keryx first, then the app installers (as administrator) |
| Looking at the nodes | the ctrlX OS web interface | the Keryx page `http://127.0.0.1:7555/`, `krxclient` |
| Connecting a PLC | ctrlX PLC on the same device | the OPC UA Connector (`opc.tcp://<pc>:4840`) |
| Licence | ctrlX licence in the License Manager of ctrlX OS | LumiScan Key; bought in the ctrlX Store: licence in ctrlX WORKS, plus the LumiScan Key |

Details: [ctrlX Data Layer and LumiScan Keryx](https://docs.hdvisionsystems.com/en/lumiscan-keryx/1.0.0/platforms.html).

## What do I need to install? {#what-to-install}

| Your application | Install | Hardware |
| --- | --- | --- |
| Look at LumiScan X images and point clouds | CodeMeter Runtime + LumiScan Key, LumiScan software (LumiScan Viewer) | LumiScan X, 24 V supply or PoE, Windows PC |
| Find a part, read a code or text, measure an area, on ctrlX OS | Cam Driver + the processing app(s), Cockpit to look at the results; ctrlX licences | GenICam camera, ctrlX CORE or ctrlX IPC |
| The same on a PC | LumiScan Keryx, Cam Driver + the processing app(s), Cockpit; OPC UA Connector for a PLC; LumiScan Key or ctrlX licence | GenICam camera, Windows 11 or Ubuntu 24.04 PC (NVIDIA GPU for AI Object Matching) |
| Pick parts with a robot (bin picking, assembly) | LumiScan VGR, LumiScan VGR Engineering; CUDA 11.8 + cuDNN 8.8.1 (installers from HD Vision Systems) | LumiScan X, Windows 11 IPC with NVIDIA GPU, PROFINET or OPC UA to the PLC |
| Train your own neural network | LumiScan Annotation, LumiScan Training (CUDA 11.8), optionally File Transfer | Windows 11 PC; for Training Windows 11 Pro or Enterprise with an NVIDIA RTX GPU |

Every product manual lists its exact requirements on its **Requirements** or **System Requirements** page.

## Supported hardware {#hardware}

| Type | Supported |
| --- | --- |
| 3D camera | [LumiScan X](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/product-description.html) in three variants (60°, 40°, 30° opening angle), working distance 250-3000 mm; used by the LumiScan Viewer and LumiScan VGR |
| 2D cameras for the vision apps | Ethernet-enabled, GenICam-compliant cameras; tested with selected models from Basler, Baumer, IDS, LUCID Vision Labs, Hikvision and Balluff. Other cameras may lack functions - see the [Cam Driver requirements](https://docs.hdvisionsystems.com/en/lumiscan-cam-driver/2.2.1/lumiscan-camdriver/requirements.html) |
| Controllers and PCs | ctrlX CORE and ctrlX IPC with ctrlX OS; PCs with Windows 11 or Ubuntu 24.04; for LumiScan VGR and LumiScan Training a Windows 11 PC with an NVIDIA GPU |
| Accelerators | NVIDIA GPU (CUDA) on a PC; optional TPU for AI Object Matching on ctrlX OS, see its [requirements](https://docs.hdvisionsystems.com/en/lumiscan-ai-object-matching/2.1.0/lumiscan-ai-object-matching/requirements.html) |

## Connecting your controller {#controller}

| Controller | How it reaches the apps |
| --- | --- |
| ctrlX PLC | reads, writes and calls the app nodes directly on the same ctrlX device, see [ctrlX Data Layer on ctrlX OS](https://docs.hdvisionsystems.com/en/lumiscan-keryx/1.0.0/ctrlx-data-layer.html) |
| Any PLC or SCADA system with OPC UA | through the [OPC UA Connector](https://docs.hdvisionsystems.com/en/lumiscan-keryx/1.0.0/opc-ua.html) on the PC |
| PLC of a LumiScan VGR cell | PROFINET or OPC UA, see [LumiScan VGR](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/index.html) |
| Your own software | a Data Layer client or OPC UA, see [Integrating LumiScan into Your Application](https://docs.hdvisionsystems.com/en/getting-started/integrating.html) |

## Next

Pick your path on the [Getting Started](https://docs.hdvisionsystems.com/en/getting-started/index.html) page.
