# LumiScan VGR Engineering 1.0.0.3 – complete documentation

> All pages of the LumiScan VGR Engineering 1.0.0.3 manual (language: en) by HD Vision Systems GmbH, in navigation order. Each page starts with a level-1 heading followed by its URL; cite that URL. Manual: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/

# LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/index.html

|   |   |   |
| --- | --- | --- |
| ![Camera, detection and robot elements connected in a row](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/_images/intro/step-1.svg)<br><br>**Build your cell from elements.** Cameras, object detections and robots, connected. | ![Point cloud preview next to sliders with suggested values marked](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/_images/intro/step-2.svg)<br><br>**Tune with live preview.** Only the settings that matter, with suggested values. | ![ZIP file going to LumiScan VGR](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/_images/intro/step-3.svg)<br><br>**Export for LumiScan VGR.** A configuration VGR reads directly. |

LumiScan VGR Engineering is the guided configuration tool for LumiScan VGR, so you do not edit the settings file by hand. You connect cameras, object detections and robots as elements; the tool shows the settings that matter, previews their effect on the live image and point cloud and suggests sensible values. It exports the configuration in the format LumiScan VGR reads. For commissioning a cell, changing a camera or gripper, or adding an object.

LumiScan VGR Engineering is the configuration tool for LumiScan VGR. You describe your application as elements - cameras, object detections, robots - connect them, check each one in a live preview and export the result as a settings file that LumiScan VGR uses directly.

## Where to start

| You want to | Read |
| --- | --- |
| know what the tool does and how it fits in with LumiScan VGR | [Description](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/description.html) |
| set up the IPC and the camera, install the software | [System Requirements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html), [Installation](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html) |
| build your first configuration from camera to exported settings | [Getting Started](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/getting-started.html) |
| find your way around the window | [User Interface](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html) |
| know what a camera, object detection or robot element contains | [Configuration Elements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html) |
| look up a quick answer or an error message | [FAQ](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/faq.html) |

For licensing, see [Licence](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html#licence). The settings that LumiScan VGR Engineering produces are described in the [LumiScan VGR manual](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings.html).

# Description – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/description.html

LumiScan VGR Engineering guides you through configuring other HD Vision Systems software, above all LumiScan VGR. Instead of editing a settings file by hand, you work with the elements of your application: the tool shows the settings that matter for each element, previews the effect of the current values and suggests sensible ones. When a camera is configured, for example, it lists the cameras that are available, shows their live image and point cloud with the settings you have chosen, and so makes it obvious whether the settings are suitable. The finished configuration is exported in the format that LumiScan VGR reads directly.

## How it fits in with LumiScan VGR

LumiScan VGR runs the vision-guided robotics application on the production system; its behaviour is defined by a JSON settings file (see [JSON Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings.html) in the LumiScan VGR manual). LumiScan VGR Engineering is the tool that creates and maintains this file:

1. You build the configuration from three kinds of [elements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html) - **cameras**, **object detections** and **robots** - and connect them: a camera produces an image, an object detection consumes it, and the result is used to control a robot.
2. The preview shows, for the selected element, what LumiScan VGR will see with the current settings.
3. **Download** exports the configuration as a `.zip` file that contains the settings both in the format of LumiScan VGR Engineering (to continue editing later) and in the format of LumiScan VGR or other compatible software (to put into operation).

A configuration can be saved and re-opened at any time, and files that the settings refer to - a `.hdvcal` camera calibration file, for example - are uploaded into the tool.

## Who it is for

LumiScan VGR Engineering is intended for the integrator or engineer who sets up and maintains a LumiScan VGR application: commissioning a new cell, changing a camera or gripper, adding an object, or checking a configuration before it goes into production. Day-to-day operation of the running application takes place in LumiScan VGR itself.

# System Requirements – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html

## IPC

The IPC running LumiScan VGR Engineering requires:

- Windows 11
- An NVIDIA GPU that supports CUDA 11.8
- CUDA Toolkit 11.8
- cuDNN 8.8.1

The required CUDA and cuDNN installers are provided by HD Vision Systems. Install them before LumiScan VGR Engineering (see [Installation](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html)).

> [!TIP]
> These are the same requirements as for LumiScan VGR, so a configuration can be built on the production IPC itself or on a separate engineering PC that meets them.

## Camera {#camera}

To show the camera preview, LumiScan VGR Engineering needs a LumiScanX or other compatible camera connected to the IPC via Ethernet. Without a camera the configuration can still be edited, saved and exported, but the image and point cloud previews stay empty.

Before installing and operating LumiScan VGR Engineering, make sure that the camera network is configured correctly, and check the Windows Firewall and virus protection settings. The required network, firewall and virus protection settings are described in the [LumiScan X manual](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/index.html) or, for other cameras, in the manual provided by the camera manufacturer.

## Licence {#licence}

How LumiScan VGR Engineering is licensed depends on where you bought it and where it runs:

| Bought from | Runs on | Licensing |
| --- | --- | --- |
| HD Vision Systems | Windows 11 | The licence is held on your LumiScan Key. It is an annual subscription and must be renewed every year; the renewal requires a valid subscription.<br><br>[Licensing path: bought from HD Vision Systems](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-hdvs.html) |
| ctrlX Store | Windows 11 | The licence is held in ctrlX WORKS. The LumiScan Key is required in addition; it protects the software against reverse engineering.<br><br>[Licensing path: ctrlX Store, Windows](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-windows.html) |

Each device on which LumiScan VGR Engineering runs at the same time needs its own LumiScan Key. Keys can be exchanged between devices.

How to install CodeMeter Runtime and how to request, renew and move licences is described in [LumiScan Licensing](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/index.html).

# Installation – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html

Install in this order:

1. CUDA Toolkit 11.8 and cuDNN 8.8.1 (installers provided by HD Vision Systems), see [System Requirements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html).
2. CodeMeter Runtime and the LumiScan Key, see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html#installing-codemeter-runtime).
3. The LumiScanX camera, set up according to the [LumiScan X manual](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/index.html) - the camera is needed for the preview, not for the installation itself.
4. LumiScan VGR Engineering, see [Installing LumiScan VGR Engineering](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html#installing-lumiscan-vgr-engineering).

## Installing CodeMeter Runtime {#installing-codemeter-runtime}

LumiScan VGR Engineering is licensed with the LumiScan Key and needs CodeMeter Runtime 9.00 or later. Install CodeMeter Runtime and connect the LumiScan Key as described in [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html).

## Installing LumiScan VGR Engineering {#installing-lumiscan-vgr-engineering}

1. Close all open applications.
2. Navigate to the location of the LumiScan VGR Engineering installer and launch it.
3. Wait until the licence agreement window opens.
4. Accept the licence terms by clicking **Accept**.
5. To change the default installation location, click **Browse**, select the desired location and click **OK**.
6. Click **Next** to continue.
7. If desired, select a **Start Menu** folder for the program links. To avoid creating shortcuts, select **Do not create links**.
8. Click **Install**.
9. When the installation is complete, click **OK**.
10. Click **Finish**.

> [!NOTE]
> Depending on the installation package, the Start Menu selection may be omitted.

## Starting the application {#starting}

Start LumiScan VGR Engineering from the Start Menu or from the installation folder, with the LumiScan Key connected (see [Licence](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html#licence)). The first steps are described in [Getting Started](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/getting-started.html).

# Getting Started – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/getting-started.html

This page walks through a first configuration: one camera, one object detection, one robot, exported for LumiScan VGR. The window and its panels are described on the [User Interface](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html) page; what each element contains is described under [Configuration Elements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html).

## Before you begin

- LumiScan VGR Engineering is installed and started ([Installation](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html)).
- The camera is connected, reachable over the network and set up according to its manual - the preview needs it.
- You have the files the configuration refers to at hand, for example the `.hdvcal` calibration file of the camera and the robot description (`.urdf`) with the hand-eye calibration.

## 1. Add a camera

1. In the graph overview at the bottom of the window, type a unique ID into the **id** field of the **Cameras** column - for example `cam_main` - and click **Add**. IDs name the element in the exported settings, so choose names you will recognise later.
2. Click the new element. The editor panel on the right shows its settings, the preview panel on the left shows what the camera sees.
3. Enter the settings of the camera. If the settings refer to a file, such as the `.hdvcal` calibration file, upload it with **Upload** in the configuration panel (or drag it onto the buttons) and select it in the editor.
4. Check the preview. Switch between the image and the point cloud with the buttons in the top-right corner of the preview; rotate, pan and zoom the point cloud with the mouse. The preview follows every change of a setting that affects the camera, so adjust until image and point cloud look right.

## 2. Add an object detection and connect it to the camera

1. Type an ID into the **id** field of the **ObjectDetections** column - for example `detection_network` - and click **Add**.
2. Drag from the camera element to the new object detection element. The connection tells LumiScan VGR which camera’s image this detection works on. A camera can feed several detections.
3. Select the object detection and configure it in the editor: which network and which objects are to be detected, and how. The preview shows the element with the current settings.

## 3. Add a robot and connect it to the detection

1. Type an ID into the **id** field of the **Robots** column - for example `robot_arm` - and click **Add**.
2. Drag from the object detection element to the robot element: the detection result is used to control this robot.
3. Select the robot and configure it in the editor - its description, the hand-eye calibration that places it relative to the camera, and the gripper.

## 4. Save and export

1. Click **Save** in the configuration panel. **Save** keeps the current state in LumiScan VGR Engineering; **Reload** brings the last saved state back and discards unsaved changes.
2. Click **Download**. You receive a `.zip` file with the configuration in two formats: the format of LumiScan VGR Engineering, to continue working on it later, and the settings for LumiScan VGR or other compatible software.
3. Install the settings on the LumiScan VGR system as described in the [LumiScan VGR manual](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings.html).

## Continuing later

Upload the `.zip` file you downloaded (**Upload**, or drag and drop onto the configuration panel): the configuration is restored and can be edited, saved and downloaded again.

## Tips

- Give every element an ID that says what it is (`cam_bags`, `network_bags`, `robot_arm`) - the IDs appear in the graph overview and in the exported settings.
- Remove an element with the **X** in its top-right corner (visible when it is selected); remove a connection by double-clicking it.
- If you prefer to see the settings as a whole, switch the editor to **Raw JSON**. The form and the JSON view show the same data; a change in one is a change in the other.

# User Interface – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html

The window of LumiScan VGR Engineering has four parts:

- The **configuration panel** at the top holds the buttons that act on the configuration as a whole
  - save, reload, download, upload.
- The **graph overview** at the bottom shows the elements of the configuration in their categories and how they are connected.
- The **preview panel** on the left shows the element selected in the graph overview and how the current settings affect it.
- The **editor panel** on the right shows the settings of the selected element and is where they are changed.

![LumiScan VGR Engineering: configuration panel at the top, preview (left) and editor (right) in the middle, graph overview with the Cameras, ObjectDetections and Robots columns at the bottom](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/_images/VGREngineeringOverview.png)

## Configuration panel {#configuration-panel}

The four buttons act on the entire configuration. Files can also be dropped onto the buttons instead of using **Upload**.

**Table 1. Buttons of the configuration panel**

| Button | Function |
| --- | --- |
| **Save** | Saves the current state of the settings. |
| **Reload** | Loads the last saved settings back into the user interface. Use it to revert unsaved changes. |
| **Download** | Downloads a `.zip` file that contains the settings in the format of LumiScan VGR Engineering and in the format used by LumiScan VGR or other compatible software. |
| **Upload** | Uploads a file into the configuration: either a `.zip` file that was downloaded from LumiScan VGR Engineering, which restores that configuration, or a file that the settings refer to, for example a `.hdvcal` camera calibration file. |

## Graph overview {#graph-overview}

The graph overview shows the elements of the configuration as columns, one per category, connected from left to right: a configured camera produces an image, an object detection consumes it, and the detection result is used to control a robot. Each category can hold several elements, and an element can be connected to several elements of the next category.

- **Select:** Click an element. The preview and the editor switch to it.
- **Add:** Type a unique ID into the **id** field at the bottom of the column and click **Add**.
- **Remove:** Select the element and click the **X** that appears in its top-right corner.
- **Connect:** Drag from the source element to the target element.
- **Disconnect:** Double-click the connection. The mouse pointer changes when it is over a connection.

What the elements of each category contain is described under [Configuration Elements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html).

## Editor panel {#editor-panel}

The editor shows the settings of the element selected in the graph overview and is where they are edited. It has two views, switched with the buttons in its top-right corner:

- **Form** - the settings as input fields with labels, grouped by topic.
- **Raw JSON** - the same settings as JSON text.

Both views show exactly the same information and allow the same changes; use whichever suits the task.

## Preview panel {#preview-panel}

The preview shows the element selected in the graph overview. What it shows depends on the type of the element, and it is updated whenever a setting that affects the element is changed. Many element types offer two views, switched with the buttons in the top-right corner of the preview:

- **Image** - the camera image.
- **Point cloud** - the 3D data, which can be navigated with the mouse:
  - drag with the left mouse button to rotate,
  - drag with the right mouse button to pan,
  - turn the mouse wheel to zoom.

The point cloud view also shows the coordinate system: a red, a green and a blue line mark the x, y and z axis. They start at the coordinate origin and each has a length of 1.

# Configuration Elements – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/elements.html

A configuration consists of elements of three categories, shown as the three columns of the [graph overview](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#graph-overview). Every element has a unique ID, its own settings in the editor and its own preview. The connections between the elements define the data flow of the application: camera → object detection → robot.

## Cameras {#cameras}

A camera element stands for one physical camera - usually a LumiScanX - and the way it acquires data: identification of the camera, exposure, depth estimation and the corrections applied to the camera data. A calibration file (`.hdvcal`) belongs to each camera; upload it with **Upload** and select it in the editor.

- **Preview:** The live image of the camera, and the point cloud computed from it, both with the current settings. Use it to check exposure, the depth range and the corrections before any detection is configured.
- **Exported as:** the `cameras` and `recordings` sections of the LumiScan VGR settings - see [Camera Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings/cameras.html) in the LumiScan VGR manual.
- **Connections:** A camera is the source of one or more object detections.

Several cameras can be configured when the application uses more than one, for example one camera per container (`cam_main`, `cam_bags`).

## Object detections {#object-detections}

An object detection element describes how objects are found in the data of the connected camera: which neural network is used, which objects are to be detected and localised, and how - in 2D, in 3D or with both combined - and how the results are filtered and sorted.

- **Preview:** The selected detection with the current settings on the current camera data.
- **Exported as:** the `networks`, `objects` and `pipelines` sections of the LumiScan VGR settings - see [Network Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings/networks.html), [Object Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings/objects.html) and [Pipeline Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings/pipelines.html) in the LumiScan VGR manual.
- **Connections:** Input from one camera; output to one or more robots.

Neural networks are trained with the [LumiScan Training Framework](https://docs.hdvisionsystems.com/en/lumiscan-training/2.3.0/index.html) on images annotated with the [LumiScan Annotation Framework](https://docs.hdvisionsystems.com/en/lumiscan-annotation/1.8.4/index.html).

## Robots {#robots}

A robot element describes a robot - or one robot with one particular gripper - that acts on the results of the connected object detection: the robot description (`.urdf`), the hand-eye calibration that places the robot relative to the camera, the gripper, and the positions and motion segments used to approach and execute a grip. If collision avoidance is used, the 3D data of robot, gripper and container are configured here as well.

- **Preview:** The robot in relation to the camera data with the current settings.
- **Exported as:** the `robots` section of the LumiScan VGR settings - see [Robot Settings](https://docs.hdvisionsystems.com/en/lumiscan-vgr/1.8.4/json-settings/robots.html) in the LumiScan VGR manual.
- **Connections:** Input from one or more object detections.

A physical robot can be represented by several robot elements, for example one per gripper.

## Element IDs {#ids}

The ID entered when an element is added identifies it in the graph overview and in the exported settings. IDs must be unique within their category. Choose descriptive names - `cam_bags`, `network_bags`, `robot_arm` - rather than numbers; they are what you will see in LumiScan VGR.

# FAQ – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/faq.html

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).

# Troubleshooting – LumiScan VGR Engineering

URL: https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/troubleshooting.html

This page starts with general checks that you do first. Then find your symptom and work through the diagnostic procedure and the resolution. If the problem persists, send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/troubleshooting.html#support-information) to support.

## General checks {#general-checks}

- Check that the IPC meets the [System Requirements](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html): Windows 11, an NVIDIA GPU that supports CUDA 11.8, CUDA Toolkit 11.8 and cuDNN 8.8.1.
- Check that CodeMeter Runtime 9.00 or later is installed and the LumiScan Key is connected (see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/installation.html#installing-codemeter-runtime)). Licence problems - a key that is not detected, the message `User maximum reached!`, an engineering app that no longer starts because the annual subscription has expired - are described in [Licensing: Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html).
- For the preview, check that the camera is connected to the IPC via Ethernet and set up according to its manual (see [Camera](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/system-requirements.html#camera)). Messages and point cloud problems of the LumiScanX camera itself are described in [LumiScan X: Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/troubleshooting.html).

## Problem: The preview stays empty {#faq-preview-empty}

**Symptoms**

The preview panel shows no camera image and no point cloud for the camera element.

**Possible causes**

- No camera is connected. Without a camera, the configuration can be edited, saved and exported, but the image and point cloud previews stay empty.
- The camera network is not configured correctly.
- The Windows Firewall or the virus protection blocks the connection to the camera.

**Diagnostic procedure**

1. Check that a LumiScanX or other compatible camera is connected to the IPC via Ethernet - expected: the camera is connected and set up according to its manual.
2. Check the network configuration of the camera as described in [LumiScan X: Network Settings](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/installation.html#sec-network-settings) (for other cameras, in the manual provided by the camera manufacturer) - expected: the settings match the manual.
3. Check the settings of the Windows Firewall and the virus protection as described in [LumiScan X: Windows Firewall](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/installation.html#sec-windows-firewall) and [LumiScan X: Virus Protection](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/installation.html#sec-virus-protection) - expected: they do not block the camera.
4. Select the camera element again in the [graph overview](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#graph-overview) - expected: the [preview panel](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#preview-panel) shows the camera image or the point cloud. The preview is updated whenever a setting that affects the element changes.

**Resolution**

- **If no camera is connected:** connect a LumiScanX or other compatible camera to the IPC via Ethernet and set it up according to its manual. Then select the camera element again.
- **If the camera network is not configured correctly:** configure it as described in the [LumiScan X manual](https://docs.hdvisionsystems.com/en/lumiscan-x/2.0.0/index.html) or, for other cameras, in the manual of the camera manufacturer. Then select the camera element again.
- **If the Windows Firewall or the virus protection blocks the connection:** change their settings as described in the LumiScan X manual (see the diagnostic procedure). Then select the camera element again.

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/troubleshooting.html#support-information) to support, together with the camera model and serial number and a screenshot of the empty preview.

## Information for support {#support-information}

Have this information ready when you contact support:

- Product and version: LumiScan VGR Engineering and its software version.
- Operating system: Windows 11, with the installed versions of CUDA Toolkit and cuDNN.
- Where you bought the software: HD Vision Systems or the ctrlX Store.
- The serial number of the LumiScan Key (`3-…`, printed on the key) and, if relevant, the serial number of the camera.
- The exact error message, a screenshot and the date and time the problem occurred.
- The configuration: the `.zip` file that **Download** creates in the [configuration panel](https://docs.hdvisionsystems.com/en/lumiscan-vgr-engineering/1.0.0/user-interface.html#configuration-panel), and the files that the settings refer to, for example the `.hdvcal` calibration file and the robot description (`.urdf`).

Contact customer success at [customer.success@hdvisionsystems.com](mailto:customer.success@hdvisionsystems.com) or by phone at +49 6221 6721905. For licences, contact [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com).
