---
title: "FAQ"
description: "Frequently asked questions about LumiScan VGR - system requirements, installation, starting, PROFINET and OPC UA communication, return codes and troubleshooting."
product: "LumiScan VGR"
component: "lumiscan-vgr"
version: "1.8.4"
display_version: "1.8.4.6"
latest_version: true
language: "en"
url: "https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/faq.html"
---

# FAQ – LumiScan VGR

Short answers to common questions and error messages for LumiScan VGR. Each entry links to the page with the details.

> [!TIP]
> Search this page for the exact error message. Each entry has a fixed anchor (for example `#faq-return-codes`).

## Requirements, installation and licensing

### What does the IPC need to run LumiScan VGR? {#faq-system-requirements}

- **Answer:**
  - Windows 11
  - An NVIDIA GPU that supports CUDA 11.8, with CUDA Toolkit 11.8 and cuDNN 8.8.1 (the installers are provided by HD Vision Systems)
  - A LumiScanX camera connected to the IPC via Ethernet
  - At least one interface to the control system: PROFINET or OPC UA
- **More:** [System Requirements](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/system-requirements.html)

### What must be installed and checked before installing LumiScan VGR? {#faq-install-prerequisites}

- **Answer:**
  - CodeMeter Runtime 9.00 or later, with the LumiScan Key connected.
  - CUDA 11.8.0 and cuDNN 8.8.1.
  - The LumiScanX camera, installed and configured according to the LumiScanX manual, including its network, Windows Firewall and virus protection settings.
- **More:** [Installation](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/installation.html#installing-lumiscan-vgr)

### How is LumiScan VGR licensed? {#faq-licence}

- **Answer:**
  - Bought from HD Vision Systems: the licence is on the LumiScan Key. Install CodeMeter Runtime 9.00 or later and connect the key.
  - Bought in the ctrlX Store for Windows 11: you need ctrlX WORKS and a LumiScan Key.
  - One LumiScan Key is needed per device that runs the software at the same time. Keys can be exchanged between devices.
- **More:** [Licence](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/system-requirements.html#licence), [Licensing FAQ](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/faq.html)

## Starting and configuration

### How do I start LumiScan VGR? {#faq-start}

- **Answer:** In the Start Menu window, enter the path to the configuration file (or click **Load** and select it) and click **Start**. From the command line, specify at least the settings file with `-s` or `--settings <filepath>`; `-v` shows the version and `-h` the command-line help.
- **More:** [Starting LumiScan VGR](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/start-menu.html)

### Can I test LumiScan VGR without a camera or PLC? {#faq-simulation}

- **Answer:** Yes. Enable the simulation options in the Start Menu, or use the command-line options:
  - `--simulate-camera`: images and point clouds are loaded from disk instead of a camera. The path is set with `loadFilePath`; a center image (`.png`) and a point cloud (`.ply`) with the same base name must exist.
  - `--simulate-sps`: no physical PLC is needed; PLC communication can be simulated through the **PROFINET** tab.
- **More:** [Starting LumiScan VGR](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/start-menu.html), [RecordingSystemSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/recording-system-settings.html#recording-system-settings-load-file-path)

### What does the JSON settings file contain, and how do I convert an old one? {#faq-settings-file}

- **Answer:** The settings file contains the sections `cameras`, `recordings`, `networks`, `robots`, `objects` and `pipelines`, plus the optional `user` and `system` sections. The metadata format changed after version 1.7.0.0: the file information (`inputFileType`, `inputFileVersion`, `targetMachine`, `programName`, `programVersion`) is now grouped in a `meta` object instead of top-level fields such as `VGRVersion`. New configurations should use the `meta` structure. `--gen-settings` creates a settings file.
- **More:** [JSON Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings.html), [Meta Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings/meta.html)

### How do I open admin mode or debug mode, and why are the admin controls inactive? {#faq-admin-debug-mode}

- **Answer:**
  - **Ctrl + Shift + A** switches admin mode on or off, **Ctrl + Shift + D** debug mode, and **Ctrl + Shift + V** shows the build version.
  - The **Scene** and **PROFINET** tabs are only visible in admin mode.
  - The admin controls (A2 to A14) are only active in manual mode, so that the automatic process is paused.
  - Passwords can be set with `adminPassword` and `manualModePassword` in the `user` section; if left empty, no password is required. If `system/enableExternalAdminModeControl` is `true`, the PLC switches admin mode with `IN_EnableAdminMode` and admin password protection is disabled.
- **More:** [Admin and Debug Modes](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/admin-mode.html), [User Interface](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/user-interface.html)

## Operation and PLC communication (PROFINET)

### What is the difference between Get Best Result and Grip Best Result? {#faq-get-vs-grip-best-result}

- **Answer:** Both calculate grip points for the active robot from the most recent object poses and return the highest-priority valid grip. Grip Best Result additionally tells the system that the selected result has been or will be gripped; via OPC UA, each `GripBestResult` call returns the next candidate in ranked order. Get Best Result does not consume the result.
- **More:** [PROFINET Interface Reference](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/profinet.html), [OPC UA Client Integration Guide](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/opcua/opc-ua-client-integration-guide.html)

### My project has several cameras, pipelines or robots. Which one is used? {#faq-multiple-components}

- **Answer:** All calculations use the currently active camera, pipeline and robot. Select them before each function: via PROFINET with `OUT_SetParameter` (`IN_ParamId` `1` = `SET_CAMERA_ID`, `2` = `SET_PIPELINE_ID`, `3` = `SET_ROBOT_ID`, ID in `IN_ParamArgString`), via OPC UA with `SetActiveCamera`, `SetActivePipeline` and `SetActiveRobot`. An unknown ID returns `ID_DOES_NOT_EXIST`.
- **More:** [PLC Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/plc-settings.html)

## OPC UA

### How do I connect an OPC UA client to LumiScan VGR? {#faq-opcua-connect}

- **Answer:** Connect to `opc.tcp://<host>:4840`. Security policy and mode are None with anonymous login; at most 2 clients can be connected at the same time, and the recommended session timeout is 10 s. All nodes are under `Objects/LumiScanVGR` (namespace index 1). Because there is no authentication, make the server accessible only within the plant network.
- **More:** [OPC UA Client Integration Guide](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/opcua/opc-ua-client-integration-guide.html)

### In which order do I call the OPC UA methods? {#faq-opcua-call-sequence}

- **Answer:** For standard production, `ExecuteSimpleRecipe` (camera, pipeline and robot IDs) or `ExecuteRecipe` (pre-configured recipe ID) runs the capture-and-grip sequence in one call. For finer control, use the individual steps:
  1. Check the mode with `GetOperationMode`; if it is not `AUTOMATIC`, call `SetOperationMode`.
  2. Call `SetupSystem` and wait for `SUCCESS`.
  3. Select the configuration with `SetActiveCamera`, `SetActivePipeline` and `SetActiveRobot`.
  4. Call `CaptureImage`, then `ComputeObjects`.
  5. Call `GetBestResult` (does not consume the result) and/or `GripBestResult` (returns the next candidate on each call).
- **More:** [OPC UA Client Integration Guide](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/opcua/opc-ua-client-integration-guide.html)

## Return codes and log files

### What do the return codes mean? {#faq-return-codes}

- **Answer:** The result of each action is shown in the status window (for example **SUCCESS**) and, for PROFINET, as a number in `OUT_ReturnCode`. OPC UA methods return the code as the string `ReturnCode`.
  - `0` `SUCCESS`: no error
  - `1` `UNKNOWN_ERROR`: unknown error; check the log
  - `2` `CAMERA_NOT_INITIALIZED`: active camera not initialized or does not exist; run Setup first
  - `3` `CAMERA_NOT_CONNECTED`: no connection to the camera
  - `4` `CAMERA_ACQUISITION_ERROR`: error while communicating with or acquiring data from the camera
  - `5` `PIPELINE_NOT_INITIALIZED` / `6` `ROBOT_NOT_INITIALIZED`: active pipeline or robot not initialized or does not exist
  - `7` `MISSING_DATA`: required data, such as a recording or a previous calculation result, is missing
  - `8` `ID_DOES_NOT_EXIST`: the camera, pipeline or robot ID is not configured
  - `9` `MISSING_TRANSFORM`: coordinate transformation not available, for example missing hand-eye calibration data for a robot-camera pair
  - `10` `RESULTS_EMPTY`: no valid grip points for the active robot
  - `12` `CAMERA_HARDWARE_TRIGGER_AGAIN`: auto-exposure was unsuccessful; trigger the camera again
  - `13` `CAMERA_BAD_EXPOSURETIME_SETTING`: the requested exposure time cannot be reached; check the auto-exposure settings
  - OPC UA only: `CAMERA_RESTART_REQUIRED` (call `ResetCamera`) and `OPERATION_MODE_INVALID` (server is not in `AUTOMATIC`; call `SetOperationMode` with `1`)
- **More:** [PLC Settings: Status Information](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/plc-settings.html#status-information), [OPC UA Client Integration Guide](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/opcua/opc-ua-client-integration-guide.html)

### Where are log files, recordings and training data stored? {#faq-logs-output-data}

- **Answer:** `HDVAppData` is `C:\Users\<UserName>\AppData\Local\HD Vision Systems GmbH`.
  - Log files: `<HDVAppData>\LumiScan VGR\logs` (rotating, max. 10 MB per file, max. five files). The log window opens with S3 in the user interface; debug mode shows the detailed log output in the console.
  - Crash dumps: `<HDVAppData>\LumiScan VGR`.
  - Recorded and calculated data: the output folder set in the settings file (`saveFilePath`, default `data`). Some export options can be switched in **Admin Settings** (A1) in admin mode.
  - Training data: the `training_data` folder in the project **Settings** folder.
- **More:** [Generated Data and Files](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/output-data.html), [RecordingSystemSettings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/api/settings/recording-system-settings.html#recording-system-settings-save-file-path)

## Troubleshooting {#troubleshooting}

Problems and error messages are described step by step in [Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html):

- [The camera is not recognized or no image is captured after start-up](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#faq-setup-required)
- [Image capture fails with a camera return code](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-camera-error-code)
- [A timeout message appears or only a black image is captured, although the camera is detected](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#faq-black-image-timeout)
- [LumiScan VGR does not respond after GripBestResult](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#faq-no-reaction-plc-request)
- [The PLC cannot start any functions after manual mode](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#faq-manual-mode-plc)
- [OPC UA calls fail with `BadTimeout` or `BadResourceUnavailable`](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#faq-opcua-timeout)
- [OPC UA methods return `OPERATION_MODE_INVALID`](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-opcua-operation-mode-invalid)
- [`CameraTemperature` is `-273.1528`](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-opcua-camera-temperature)
- [`Shutdown` has no effect](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-opcua-shutdown-no-effect)
- [`RESULTS_EMPTY` is returned](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#faq-results-empty)
- [No objects are detected (object count is `0`)](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-no-objects-detected)
- [No point cloud matching can be performed](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-no-point-cloud-matching)
- [A function returns `ID_DOES_NOT_EXIST`](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-id-does-not-exist)
- [A function returns `MISSING_TRANSFORM`](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-missing-transform)
- [Pose Status shows "Can not be interpreted"](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-hand-eye-cannot-be-interpreted)
- [Pose Status shows "Bad pose quality."](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-hand-eye-bad-pose-quality)
- [No image is added after capture](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-hand-eye-no-image-added)
- [The calibration result is very poor](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/troubleshooting.html#ts-hand-eye-poor-result)

## Support

### Where can I get further help? {#faq-support}

- **Answer:** See the site-wide [LumiScan FAQ](https://docs.hdvisionsystems.com/en/faq.html). Diagnostic information can be collected with S4 in the user interface and sent encrypted to HD Vision Systems. Contact customer success at [customer.success@hdvisionsystems.com](mailto:customer.success@hdvisionsystems.com) or +49 6221 6721905; for licences, contact [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com).
- **More:** [User Interface](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/user-interface.html)