---
title: "FAQ"
description: "Frequently asked questions about LumiScan VGR Engineering - system requirements, camera, installation, licensing, elements, exporting and importing settings."
product: "LumiScan VGR Engineering"
component: "lumiscan-vgr-engineering"
version: "1.0.0"
display_version: "1.0.0.3"
latest_version: true
language: "en"
url: "https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/faq.html"
---

# FAQ – LumiScan VGR Engineering

Short answers to common questions and error messages for LumiScan VGR Engineering. 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-export-settings`).

## Requirements, installation and licensing

### What is LumiScan VGR Engineering used for? {#faq-what-is-vgr-engineering}

- **Answer:** It is the configuration tool for LumiScan VGR and other HD Vision Systems software. You build the configuration from cameras, object detections and robots, check each element in a live preview and export the settings in the format LumiScan VGR reads directly.
- **More:** [Description](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/description.html)

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

- **Answer:**
  - Windows 11
  - An NVIDIA GPU that supports CUDA 11.8
  - CUDA Toolkit 11.8 and cuDNN 8.8.1 (the installers are provided by HD Vision Systems)
- **More:** [System Requirements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html)

### Do I need a camera? {#faq-camera-required}

- **Answer:** Only for the preview: a LumiScanX or other compatible camera connected to the IPC via Ethernet. Without a camera the configuration can be edited, saved and exported, but the image and point cloud previews stay empty. Before installing and operating the software, make sure the camera network is configured correctly and check the Windows Firewall and virus protection settings as described in the LumiScan X manual.
- **More:** [System Requirements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html#camera)

### How do I install LumiScan VGR Engineering? {#faq-installation}

- **Answer:**
  1. Install CUDA Toolkit 11.8 and cuDNN 8.8.1.
  2. Install CodeMeter Runtime 9.00 or later and connect the LumiScan Key.
  3. Set up the LumiScanX camera according to its manual.
  4. Close all open applications and launch the LumiScan VGR Engineering installer.
  5. Accept the licence terms with **Accept**, optionally change the location with **Browse**, then click **Next** and **Install**.
  6. When the installation is complete, click **OK** and **Finish**.
- **More:** [Installation](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html)

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

- **Answer:**
  - Bought from HD Vision Systems: the licence is on the LumiScan Key and is an annual subscription; renewal requires a valid subscription. CodeMeter Runtime 9.00 or later is required.
  - 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-engineering/1.0.0/system-requirements.html#licence), [Licensing FAQ](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/faq.html)

## Building a configuration

### How do I build my first configuration? {#faq-first-configuration}

- **Answer:** Add a camera (**id** field in the **Cameras** column, **Add**), check its preview, add an object detection and drag a connection from the camera to it, add a robot and connect the detection to it, then **Save** and **Download**.
- **More:** [Getting Started](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/getting-started.html)

### What are cameras, object detections and robots? {#faq-elements}

- **Answer:** The three kinds of element of a configuration. A camera element is one physical camera and its acquisition settings, an object detection describes which objects are found in the camera data and how, and a robot element describes a robot (and gripper) with its hand-eye calibration and motions. Connected left to right they define the data flow: camera → detection → robot.
- **More:** [Configuration Elements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html)

### How do I add, remove or connect elements? {#faq-graph-overview}

- **Answer:**
  - Add: enter a unique ID in the **id** field of the column and click **Add**.
  - Remove: select the element and click the **X** in its top-right corner.
  - Connect: drag from the source element to the target element. To remove a connection, double-click it.
- **More:** [Graph overview](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#graph-overview)

### What is the element ID for, and can I change it? {#faq-element-id}

- **Answer:** The ID identifies the element in the graph overview and in the exported settings; it must be unique within its category. Choose a descriptive name when adding the element - the ID is entered once, when the element is created.
- **More:** [Element IDs](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html#ids)

### Can I edit the settings as JSON? {#faq-raw-json}

- **Answer:** Yes. The editor panel can be switched between the **Form** view and the **Raw JSON** view. Both views show the same information and allow the same changes.
- **More:** [Editor panel](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#editor-panel)

### How do I navigate the point cloud preview? {#faq-point-cloud-preview}

- **Answer:** Drag with the left mouse button to rotate, drag with the right mouse button to pan, and turn the mouse wheel to zoom. The buttons in the top-right corner of the preview switch between image and point cloud view. The red, green and blue lines show the x, y and z axes at the coordinate origin.
- **More:** [Preview panel](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#preview-panel)

## Troubleshooting {#troubleshooting}

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

- [The preview stays empty](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/troubleshooting.html#faq-preview-empty)

## Saving, exporting and importing settings

### How do I save my work or undo changes? {#faq-save-reload}

- **Answer:** **Save** saves the current state of the settings. **Reload** loads the last saved settings back into the user interface, which reverts unsaved changes.
- **More:** [Configuration panel](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#configuration-panel)

### How do I get the configured settings into LumiScan VGR? {#faq-export-settings}

- **Answer:** Click **Download** in the configuration panel. It downloads a `.zip` file that contains the settings both in the format used by LumiScan VGR Engineering and in the format used by LumiScan VGR or other compatible software. Install the LumiScan VGR settings as described in the LumiScan VGR manual.
- **More:** [Getting Started](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/getting-started.html), [LumiScan VGR: JSON Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings.html)

### How do I import existing settings or a calibration file? {#faq-upload}

- **Answer:** Click **Upload** or drag and drop the file onto the buttons in the configuration panel. You can upload a `.zip` file that was downloaded from LumiScan VGR Engineering - this restores that configuration - or a file that is referenced in the settings, for example a `.hdvcal` camera calibration file.
- **More:** [Configuration panel](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#configuration-panel)

## Support

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

- **Answer:** See the site-wide [LumiScan FAQ](https://docs.hdvisionsystems.com/en/faq.html). 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).