# LumiScan File Transfer 1.8.4.3 – complete documentation

> All pages of the LumiScan File Transfer 1.8.4.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-file-transfer/1.8.4/

# LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/index.html

|   |   |   |
| --- | --- | --- |
| ![Production PC labelled Runner with images](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/intro/step-1.svg)<br><br>**The Runner collects images.** On the production system, generated and annotated. | ![Runner sends images to the Trainer, the Trainer sends networks back](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/intro/step-2.svg)<br><br>**Images go to the Trainer.** Newly trained networks come back. | ![Network file in the Runner project folder](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/intro/step-3.svg)<br><br>**The Runner uses the new network.** It lands in the Runner project, ready to use. |

LumiScan File Transfer closes the retraining loop between the production system and the training system. The Runner sends generated and annotated images to the Trainer, which stores them for training and sends newly trained networks back to the Runner project. The Runner deletes images only after a successful transfer. It runs on Windows 11.

For licensing, see [Licence](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-installation.html#licence). Questions or an error message? See the [FAQ](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/faq.html).

# Description – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/description.html

LumiScan File Transfer is divided into two roles: Runner and Trainer, which have two different tasks.

- The **Runner** transfers the generated and annotated images to the Trainer to further improve the neural networks.
- The **Trainer** receives the images generated by the Runner and stores them in the specified folder for training.\
  You can also use the Trainer to send the newly trained neural networks (also called models) back to the Runner.

# Before Installation – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-installation.html

## Installing CodeMeter Runtime {#installing-the-codemeter-runtime-environment-3}

LumiScan File Transfer 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).

## Licence {#licence}

How LumiScan File Transfer 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.<br><br>[Licensing path: bought from HD Vision Systems](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-hdvs.html) |

Each device on which LumiScan File Transfer 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).

# Installing LumiScan File Transfer on Windows

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/installing-lumiscan-file-transfer-on-windows.html

1. Navigate to the location of the LumiScan installer.
2. Double-click on the file: `Installer_LumiScan_File_Transfer_va_b_c_d.exe`\*.
3. The installation is prepared and the license agreement window opens.
4. Accept the license terms by clicking on **Accept**.
5. If you want to change the default installation location, click **Browse**.
6. Navigate to the desired storage location.
7. Press **OK** to confirm your selection.
8. Otherwise, click the **Next** button to continue.
9. If desired, select the **Start Menu** folder for the program links.
10. If you do not want to create shortcuts, select the **Do not create links** option.
11. Then click on **Install**.
12. When the installation is complete, you will see a dialog box.
13. Click **OK**.
14. Click **Finish**.
    - where **a**, **b**, **c**, **d** are variables that depend on the version of the software.

# Before Starting the Program – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-starting-the-program.html

## Folder Structure {#folder-structure-2}

The folders for the training data and the trained data must have a specific structure and name. It is therefore advisable to create them before starting the program.\
The easiest way is to create a folder for **Runner** and one for **Trainer** on the computers on which they are running. Each of these two folders has a specific structure:

- **The Runner folder**: This folder must have two subfolders whose names are predefined and cannot be changed: **networks** and **training_data**:
  - The **networks** folder, which is empty at the beginning, contains the trained networks sent by the Trainer.

  - The **training_data** folder contains the image data sent by LumiScan Annotation. This folder is sent to the Trainer and saved in one of his folders.

    The Runner folder with both subfolders is selected in the Runner settings for the **Annotated Data Directory**.

  - **The Trainer Folder:** This folder should also contain two subfolders, which you can name as you wish:
    - A subfolder contains the training data received from the Runner. This folder will be specified later in the trainer settings for the **Training Data Directory**.
    - The second subfolder should contain subfolders with specific date names according to the key: **yyyy-mm-dd**.\
      This is where the trained networks are stored that can later be sent to the Runner.\
      This folder is selected in the trainer settings for the directory of trained networks.

# Switching Roles – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/switching-roles.html

To switch roles between Runner and Trainer:

1. Go to the file‘s location:\
   `C:\Users\<UserName>\AppData\Local\HD Vision Systems GmbH\LumiScan File Transfer\settings\settings.json`
2. The JSON configuration file opens (Fig. 23).

# Starting the Program for the First Time – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/starting-the-program-for-the-first-time.html

When you run the program for the first time, a message appears on the screen telling you where the files were created (Fig. 22).

> [!NOTE]
> When the program is started for the first time, it opens in the Runner role.

1. Enter the new role in the window that opens.
2. Save changes with Ctrl+S.

> [!NOTE]
> The names of RUNNER and TRAINER should be written in **capital letters only**.

![A code editor window displays a JSON file with a single key-value pair where the key is 'profile' and the value is 'RUNNER'](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/changingROLE.png) ![A LumiScan File Transfer window displays a message stating no settings file is present and shows the file path where the settings file was created, with an OK button below](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/s1.png)

After changing the settings, the program should be reopened so that both the Runner and Trainer interfaces are visible at the same time.

When you start the Runner for the first time, the following window appears\
(Fig. 24).

# LumiScan File Transfer Runner

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-runner.html

The Runner sends the generated and annotated images to the trainers to further improve the neural networks, and receives the neural networks back from the Trainer.

## User Interface {#user-interface-4}

The various elements of the user interface are shown in [Fig. 25](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/starting-the-program-for-the-first-time.html) below.\
They are explained in the following [Table 13](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-runner.html#user-interface-4).

![A software window titled LumiScan File Transfer Runner shows a project directory input with the name projectFolder, a disabled Send button, an active Start Runner button, and status indicators showing Inactive status and Remote Offline in red, with File Transfer waiting](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/r1.png) ![A software window titled LumiScan File Transfer Runner shows a project directory named projectFolder with status indicators for inactive status and offline remote connection, and buttons for sending and starting the runner](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/r1.png)

| Nr. | Description |
| --- | --- |
| 1 | Path to your LumiScan File Transfer Project Directory. |
| 2 | Button to send images to the Trainer. |
| 3 | Button to start/stop the Runner. |
| 4 | Indication of whether the Runner has started or not. |
| 5 | Indication that the Trainer is started and connected. |
| 6 | Display of the current status of the Runner. |

Table 13: LumiScan File Transfer Runner: Standard user interface

To use Runner:

1. Set the LumiScan File Transfer Project Directory.
2. Click on **Menu **button**.**
3. Click on **Settings.**

![A software window titled LumiScan File Transfer Runner shows a project directory named projectFolder with status inactive, file transfer waiting, and remote offline indicated in red](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/runnersetting.png)

1. Configure the network settings.

### Settings {#settings-2}

You can set the following parameters in **Settings**:

- **Annotated Data Directory**: Directory of the Runner projects. All images, networks and configuration files for Runner can be found here.
- **Port**: The network port on which this tool waits for incoming file transfers. This port should be used as the target port in the Trainer.\
  Please contact your IT department to find out which ports you can use and which are permitted in your firewall settings.
- **Destination IP**: The IPv4 address of the system on which the Trainer is running. Please ask your IT department for the correct address.
- **Destination-Port**: The network port on which the trainer waits for incoming connections.

When you click the **Save** button, the settings are checked. If an error occurs, a message is displayed explaining which setting is incorrect (Fig. 28).

![A software settings window shows fields for annotated data directory, port, destination IP, destination port, and a save button with version information displayed](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/annotateddatadirectory.png) ![A software error message indicates invalid settings due to missing project folder, networks folder, and training_data folder](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/invalidsettings.png)

If all settings have been checked successfully, they will be saved in the registry and will be automatically loaded the next time the program is started.

## File Transfer {#file-transfer}

Once you have set up the Runner and successfully saved your settings, you can start the Runner:

1. Click on the button **Start Runner**.
2. The status changes to **Active** (Fig. 29).
3. Next to the status, the parameter **Port** is displayed with the address from which the data is sent.
4. If the connection to the Trainer is successful, the **Online** message will appear on the remote display (Fig. 30).
5. Now you can click on **Send** to send the images captured by the Runner software to the Trainer.

![A software window titled LumiScan File Transfer Runner shows a project directory path, buttons for sending and stopping the runner, and status indicators with the local status marked active in green and the remote status marked offline in red](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/runneractiveoffline.png) ![A software window titled LumiScan File Transfer Runner shows a project directory path, buttons to send and stop the runner, and status indicators displaying active status and online remote connection with file transfer waiting](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/runneractiveonline.png)

> [!NOTE]
> The Runner will delete images from the Runner folder only after they have been successfully transferred. Newly captured images will not be deleted.

Once the transfer has been successfully completed, the network is stored in the corresponding folder in the Runner Project Directory.

When a user sends a new neural network from the Trainer, the **File Transfer** screen informs the user of the incoming data and shows the current progress of the transfer (Fig. 31).\

![A software window titled LumiScan File Transfer Runner shows a file transfer project directory path, active status, online remote connection, and a message indicating the file was sent successfully](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/runnerfilesentsuccess.png)

The Trainer receives the images generated by the Runner and stores them in the specified folder in order to process them for training. You can also use the Trainer to transfer the newly trained neural networks to the system on which the Runner is running.

# LumiScan File Transfer Trainer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html

## User Interface {#user-interface-5}

When you start the Trainer for the first time, the following window appears\
(Fig. 32).

The various elements of the user interface are shown in [Fig. 33](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html#user-interface-5) below.\
They are explained in the following [Table 14](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html#user-interface-5).

![A software window titled LumiScan File Transfer Trainer shows directory paths for training data and trained network, with status indicators displaying inactive and offline, and buttons for starting the trainer and sending data](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/trainer.png)

| Nr. | Description |
| --- | --- |
| 1 | Path to your Data Directory where the images received by the Runner will be stored. |
| 2 | Path to the Network Directory where the neural networks for recognition are stored. |
| 3 | Button to start/stop the Trainer. |
| 4 | Combo box to select which neural network to Transfer. |
| 5 | Button for sending the model to the Runner. |
| 6 | Display whether the Trainer has started or not. |
| 7 | Indication that Runner is started and connected. |
| 8 | Display of the current status of the Trainer. |

To use Trainer:

1. Set the **Training Data Directory**
2. Set the **Trained** **Network Directory**
3. Adjust the network settings in **Settings**\*:\*
4. Click on **Menu**.
5. Click on **Settings \*([Fig. 34](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html#user-interface-5))**.\*

Table 14: LumiScan File Transfer Trainer: Standard user interface

![A software interface titled LumiScan File Transfer Trainer shows fields for training data and network directories, a network date, status indicators marked inactive and offline, and a waiting file transfer message](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/trainer.png) ![A software window titled LumiScan File Transfer Trainer shows settings for a trained network directory, a network date selection, status indicators marked inactive and offline in red, and a file transfer status labeled waiting](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/trainersettings.png)

### Settings {#settings-3}

You can set the following parameters in the settings window:

- **Training Data Directory**: Folder where images received by the runner will be saved.
- **Trained Network Directory**: Folder containing the neural networks generated by the Trainer.
- **Port**: The network port on which this tool waits for incoming file transfers. This port should be used as the destination port in the Runner. **Check with your IT department about which ports you can use and which are allowed in your firewall settings.**
- **Destination IP**: The IPv4 address of the system on which the Runner is running. **Ask your IT department how to obtain the correct address**.
- **Destination Port**: The network port on which the Runner waits for incoming connections.

![Settings window showing directories for training data and trained network, port and destination IP and port fields, and a save button](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/trainersettings2.png)

When you click the **Save** button, the settings are checked. If an error occurs, a message will appear indicating which setting is incorrect (Fig. 36).\

If all settings have been checked successfully, they will be saved in the registry and will be automatically loaded the next time the program is started.

## File Transfer {#file-transfer-2}

Once you have set up the trainer and successfully saved your settings, you can start the Trainer:

1. Click on the button **Start Trainer.**
2. The status changes to **Active** ([Fig. 37](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html#file-transfer-2)).
3. Next to the status, the **Port** parameter is displayed with the address from which the data is being sent.

![A software error message indicates invalid settings because the upload folder and data directory folder do not exist, with an OK button to close the message](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/tr4invaliddata.png)

1. If the connection to the Runner is successful, the **Remote** displays **Online**. (Fig. 38 ).
2. Now you can select in **Network** which neural network should be sent to the Runner.
3. Click on the **Send** button to start the transfer.

![A software window titled LumiScan File Transfer Trainer shows directories for training data and trained network, a network date selection, status indicators with active port and offline remote, and a waiting file transfer message](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/Traineractiveoffline.png) ![A software interface for LumiScan File Transfer Trainer showing directory paths, network status as active and online, and file transfer waiting](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/Traineractiveonlinemeldung.png)

When a user sends new images from the Runner, the status bar at the bottom will notify you of the incoming data and display the current transfer progress (Fig. 39).

If the transfer is successful, the data will be saved in the data directory.

![A software interface shows a file transfer trainer with directories for training data and trained network, a network date selection, status indicators for active connection and online remote, and a message confirming successful file transfer](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/trainerfilesentsuccess.png)

> [!NOTE]
> If the camera or robot has been moved, the hand-eye calibration must be repeated. Even small movements, such as a bump on the camera, require a new calibration.

> [!NOTE]
> If this type of calibration is used, it must always be checked whether new coordinates are sent via the PLC. The coordinates can be viewed for each shot in the Pose Editor.

# Getting Hardware Ready – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/getting-hardware-ready.html



# FAQ – LumiScan File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/faq.html

Short answers to common questions and error messages for LumiScan File Transfer. 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-network-settings`).

## Installation and licensing

### What do the Runner and Trainer roles do? {#faq-runner-trainer}

- **Answer:**
  - The **Runner** sends the generated and annotated images to the Trainer and receives the trained neural networks (models) back.
  - The **Trainer** receives the images from the Runner, stores them in the specified folder for training, and sends newly trained neural networks back to the Runner.
- **More:** [Description](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/description.html)

### How do I install LumiScan File Transfer? {#faq-installation}

- **Answer:**
  1. Install CodeMeter Runtime 9.00 or later and connect the LumiScan Key.
  2. Double-click `Installer_LumiScan_File_Transfer_va_b_c_d.exe` (**a** to **d** depend on the software version).
  3. Accept the licence terms with **Accept**, optionally change the location with **Browse**, then click **Next** and **Install**.
  4. When the installation is complete, click **OK** and **Finish**.
- **More:** [Installing LumiScan File Transfer on Windows](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/installing-lumiscan-file-transfer-on-windows.html), [Before Installation](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-installation.html#installing-the-codemeter-runtime-environment-3)

### How is LumiScan File Transfer licensed? {#faq-licence}

- **Answer:** The licence is on the LumiScan Key (Windows 11). CodeMeter Runtime 9.00 or later must be installed. 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-file-transfer/1.8.4/before-installation.html#licence), [Licensing FAQ](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/faq.html)

### Which folders do I need to create before starting? {#faq-folder-structure}

- **Answer:** Create one folder for the Runner and one for the Trainer on the computers on which they run:
  - Runner folder: must contain the subfolders `networks` (trained networks received from the Trainer, empty at the beginning) and `training_data` (image data). These names are predefined and cannot be changed. Select this folder as **Annotated Data Directory**.
  - Trainer folder: two subfolders with names of your choice. One receives the training data from the Runner (**Training Data Directory**); the other holds the trained networks in subfolders named `yyyy-mm-dd` (**Trained Network Directory**).
- **More:** [Before Starting the Program](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-starting-the-program.html#folder-structure-2)

## Roles and settings

### How do I switch between Runner and Trainer? {#faq-switch-role}

- **Answer:** On first start, the program opens in the Runner role. To change the role:
  1. Open `C:\Users\<UserName>\AppData\Local\HD Vision Systems GmbH\LumiScan File Transfer\settings\settings.json`.
  2. Enter the new role as the value of `profile`: `RUNNER` or `TRAINER`, in capital letters only.
  3. Save with Ctrl+S and reopen the program.
- **More:** [Switching Roles](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/switching-roles.html), [Starting the Program for the First Time](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/starting-the-program-for-the-first-time.html)

### How do I set the ports and IP addresses? {#faq-network-settings}

- **Answer:** Open **Menu** > **Settings** and set the following values. Ask your IT department for the correct addresses and for the ports that are permitted in your firewall.
  - **Port**: the port on which this tool waits for incoming transfers. Use it as the destination port on the other side.
  - **Destination IP**: the IPv4 address of the system on which the other role (Trainer or Runner) runs.
  - **Destination Port**: the port on which the other role waits for incoming connections.
- **More:** [Runner: Settings](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-runner.html#settings-2), [Trainer: Settings](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html#settings-3)

## Troubleshooting {#troubleshooting}

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

- [**Save** reports invalid settings](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/troubleshooting.html#faq-invalid-settings)
- [The remote display stays **Offline**](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/troubleshooting.html#faq-remote-offline)

## Transferring files

### How do I send images from the Runner to the Trainer? {#faq-send-images}

- **Answer:** The Trainer shows the incoming data and the transfer progress in its status bar and saves the data in its data directory after a successful transfer.
  1. Click **Start Runner**; the status changes to **Active**.
  2. Wait until the remote display shows **Online** (connection to the Trainer successful).
  3. Click **Send**.
- **More:** [Runner: File Transfer](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-runner.html#file-transfer)

### How do I send a trained network back to the Runner? {#faq-send-network}

- **Answer:** The Runner shows the progress on the **File Transfer** screen and stores the network in the corresponding folder of the Runner project directory.
  1. In the Trainer, click **Start Trainer**; the status changes to **Active**.
  2. Wait until **Remote** shows **Online**.
  3. Select the network in **Network** and click **Send**.
- **More:** [Trainer: File Transfer](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-trainer.html#file-transfer-2)

### Does the Runner delete images after sending them? {#faq-images-deleted}

- **Answer:** The Runner deletes images from the Runner folder only after they have been transferred successfully. Newly captured images are not deleted.
- **More:** [Runner: File Transfer](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/lumiscan-file-transfer-runner.html#file-transfer)

## 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 File Transfer

URL: https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/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-file-transfer/1.8.4/troubleshooting.html#support-information) to support.

## General checks {#general-checks}

- 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-file-transfer/1.8.4/before-installation.html#installing-the-codemeter-runtime-environment-3)). Licence problems - for example a key that is not detected or the message `User maximum reached!` - are described in [Licensing: Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html).
- Check the role of each system. At the first start, the program opens in the Runner role. The role is the value of `profile` in `C:\Users\<UserName>\AppData\Local\HD Vision Systems GmbH\LumiScan File Transfer\settings\settings.json`: `RUNNER` or `TRAINER`, in capital letters only (see [Switching Roles](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/switching-roles.html)).
- Check that the folders for the Runner and the Trainer exist and have the required structure (see [Folder Structure](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-starting-the-program.html#folder-structure-2)).
- Settings that have been checked successfully are saved in the registry and loaded automatically the next time the program is started.

## Problem: **Save** reports invalid settings {#faq-invalid-settings}

**Symptoms**

When you click **Save** in the settings window, a message about invalid settings is displayed. The message names the setting that is incorrect, for example a directory that does not exist.

![A software error message indicates invalid settings due to missing project folder, networks folder, and training_data folder](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/invalidsettings.png) ![A software error message indicates invalid settings because the upload folder and data directory folder do not exist, with an OK button to close the message](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/tr4invaliddata.png)

**Possible causes**

- A configured directory does not exist.
- Runner: the **Annotated Data Directory** does not contain the subfolders `networks` and `training_data`.

**Diagnostic procedure**

1. Read the message - expected: it names the setting that is incorrect.
2. Check the configured directories in the settings window (**Menu** > **Settings**) - expected: every directory exists. Runner: **Annotated Data Directory**. Trainer: **Training Data Directory** and **Trained Network Directory**.
3. Runner: check the content of the **Annotated Data Directory** - expected: it contains the subfolders `networks` and `training_data`. These names are predefined and cannot be changed.

**Resolution**

- **If a configured directory does not exist:**
  1. Create the directory, or select an existing directory in the settings window.

  2. Click **Save** again.

     The settings are checked again. If they are correct, they are saved in the registry and loaded automatically the next time the program is started.

- **If the Runner subfolders are missing:**
  1. Create the subfolders `networks` and `training_data` in the Runner folder, as described under [Folder Structure](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/before-starting-the-program.html#folder-structure-2).
  2. Select the Runner folder as **Annotated Data Directory** and click **Save** again.

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/troubleshooting.html#support-information) to support, together with a screenshot of the message and the paths of the configured directories.

## Problem: The remote display stays **Offline** {#faq-remote-offline}

**Symptoms**

After **Start Runner** or **Start Trainer**, the status changes to **Active**, but the remote display (**Remote**) shows **Offline** instead of **Online**.

![A software window titled LumiScan File Transfer Runner shows a project directory path, buttons for sending and stopping the runner, and status indicators with the local status marked active in green and the remote status marked offline in red](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/runneractiveoffline.png) ![A software window titled LumiScan File Transfer Trainer shows directories for training data and trained network, a network date selection, status indicators with active port and offline remote, and a waiting file transfer message](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/_images/Traineractiveoffline.png)

**Possible causes**

- The other role has not been started. **Online** appears only when the other role is started and connected.
- **Destination IP** is not the IPv4 address of the system on which the other role runs.
- **Port** and **Destination Port** do not match on both sides.
- The ports are not permitted in the firewall.

**Diagnostic procedure**

1. Check the status display of the other role (Runner or Trainer) - expected: **Active**.
2. On both systems, open **Menu** > **Settings** and check **Destination IP** - expected: the IPv4 address of the system on which the other role runs.
3. Compare the ports on both systems - expected: the **Port** of the Runner is the **Destination Port** of the Trainer, and the **Port** of the Trainer is the **Destination Port** of the Runner.
4. Ask your IT department whether the ports are permitted in the firewall - expected: both ports are permitted.

**Resolution**

- **If the other role has not been started:** click **Start Runner** or **Start Trainer** on the other system. Wait until the remote display shows **Online**.
- **If Destination IP is wrong:** enter the IPv4 address of the other system as **Destination IP** and click **Save**. Ask your IT department for the correct address.
- **If the ports do not match:** set **Port** and **Destination Port** so that they match on both sides and click **Save** on both systems.
- **If the firewall blocks the ports:** ask your IT department which ports you can use and which are permitted in your firewall settings, and set them on both systems.

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-file-transfer/1.8.4/troubleshooting.html#support-information) to support, together with the **Port**, **Destination IP** and **Destination Port** of both systems and screenshots of both windows.

## Information for support {#support-information}

Have this information ready when you contact support:

- Product and version: LumiScan File Transfer and its version. The version is part of the installer file name `Installer_LumiScan_File_Transfer_va_b_c_d.exe`; the settings window also shows version information.
- Operating system: Windows 11.
- The serial number of the LumiScan Key (`3-…`, printed on the key).
- The role of each system (Runner or Trainer) and the network settings of both systems: **Port**, **Destination IP** and **Destination Port**.
- The status and remote displays of both systems (status **Active** or not, remote **Online** or **Offline**).
- The exact error message, a screenshot and the date and time the problem occurred.
- The settings file `C:\Users\<UserName>\AppData\Local\HD Vision Systems GmbH\LumiScan File Transfer\settings\settings.json`.

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