# LumiScan Licensing 1.0.4 – complete documentation

> All pages of the LumiScan Licensing 1.0.4 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-licensing/1.0.4/

# LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/index.html

|   |   |   |
| --- | --- | --- |
| ![LumiScan Key USB stick with serial number 3-1234567](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/intro/step-1.svg)<br><br>**Find your licensing path.** LumiScan Key, ctrlX WORKS or ctrlX OS License Manager. | ![Licence update file going into CodeMeter](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/intro/step-2.svg)<br><br>**Import the licence update.** Into the LumiScan Key with CodeMeter Runtime. | Example licences<br><br><br><br><br><br><br>LumiScan Key<br>3-1234567<br><br><br>Cam Driver<br>2 cameras<br><br><br>Object Finder<br>10 modules<br><br><br>Training<br>annual<br><br>**Your products are licensed.** Engineering apps by subscription, runtimes once. |

LumiScan Licensing explains how to license every LumiScan product in one place: installing, requesting, renewing and moving licences. Which path applies depends on where you bought the software and where it runs: the LumiScan Key for software bought from HD Vision Systems, ctrlX WORKS on Windows, or the ctrlX OS License Manager. Engineering apps are an annual subscription; runtimes and vision apps are a one-time purchase.

This manual explains how to license LumiScan software. It applies to every LumiScan product: the engineering apps (such as LumiScan Annotation Framework, LumiScan Training Framework and LumiScan VGR Engineering) and the runtimes and vision apps (such as LumiScan VGR, LumiScan CamDriver and the code readers).

The product manuals only state **which** licence a product needs. **How** to install, request, renew and move a licence is described here, once, for all products.

## Start here

1. Find your case in [Which Licensing Path Applies](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/which-licensing-path.html). It depends on where you bought the software and where it runs.
2. If your case uses the LumiScan Key, read [The LumiScan Key](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html) and install [CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html).
3. Follow the page for your licensing path.

Quick answers to common questions: [Licensing FAQ](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/faq.html).

## Contact

Send licence requests and licensing questions to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). Please always state your company name, the order or invoice number, and the serial number of your LumiScan Key.

# Which Licensing Path Applies – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/which-licensing-path.html

Two things decide how your LumiScan software is licensed: where you bought it, and where it runs.

**Where the software was bought and where it runs decide the licensing path**

```mermaid
%% Which licensing path applies. Rendered by Mermaid in the browser; edit and preview at https://mermaid.live
flowchart LR
  subgraph bought["Bought from"]
    direction TB
    hdvs["`**HD Vision Systems**`"]
    store["`**ctrlX Store**
    Bosch Rexroth`"]
  end
  subgraph runs["Runs on"]
    direction TB
    pc["Windows 11 or Ubuntu 24.04"]
    win["`Windows 11
    engineering apps, runtimes`"]
    os["`ctrlX OS
    CORE or IPC, runtimes`"]
  end
  subgraph lic["Licensing"]
    direction TB
    key["`**Licence on the LumiScan Key**
    Engineering apps: update every year
    Runtimes: activate once`"]
    works["`**Licence in ctrlX WORKS**
    + LumiScan Key for software protection
    Key updated only for new products`"]
    ctrlx["`**ctrlX licence in ctrlX OS**
    License Manager of ctrlX OS
    No LumiScan Key`"]
  end
  hdvs --> pc --> key
  store --> win --> works
  store --> os --> ctrlx
  class key,works,ctrlx key
  classDef key fill:#faf6dc,stroke:#a8961f,color:#1f2328
```

| Bought from | Runs on | Where the licence is held | Role of the LumiScan Key |
| --- | --- | --- | --- |
| HD Vision Systems | Windows 11 or Ubuntu 24.04 | On the LumiScan Key | Carries the licence. Engineering apps need a licence update every year. |
| ctrlX Store (Bosch Rexroth) | Windows 11 | In ctrlX WORKS | Required in addition. It protects the software against reverse engineering; it does not carry the licence. It is updated only when you add a new LumiScan product. |
| ctrlX Store (Bosch Rexroth) | ctrlX OS on a ctrlX CORE or an IPC (runtimes running natively on ctrlX OS) | In the License Manager of ctrlX OS | Not used. |

Continue with the page for your path:

- [Bought from HD Vision Systems](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-hdvs.html)
- [Bought in the ctrlX Store, running on Windows](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-windows.html)
- [Bought in the ctrlX Store, running on ctrlX OS](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-os.html)

> [!NOTE]
> If you use several LumiScan products, each one can follow a different path. For example, LumiScan Annotation Framework bought in the ctrlX Store is licensed in ctrlX WORKS on your Windows PC, while LumiScan AI Object Matching running on a ctrlX CORE has a ctrlX licence there.

# The LumiScan Key – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html

The LumiScan Key is the USB licence key for LumiScan software. It is a CodeMeter container by WIBU-SYSTEMS AG. In all LumiScan documentation and communication it is called LumiScan Key.

## Recognising the key {#recognising-the-key}

CodeMeter Control Center lists every licence container available on the PC on its **License** tab. The LumiScan Key appears as **CmStick/C** with a serial number of the form `3-1234567`. The serial number is also printed on the key.

![CodeMeter Control Center](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cc-license-tab.png)

*Figure 1. The LumiScan Key (CmStick/C) on the License tab of CodeMeter Control Center*

Other entries, for example **MVTec SW Container**, belong to software from other vendors and are not relevant for LumiScan licensing.

On a PC without a graphical interface, `cmu --list` shows the same information (see [Checking the installation](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html#checking-the-installation)).

## What the key does

Depending on your licensing path, the LumiScan Key has one of two roles:

- **Licence carrier:** For software bought from HD Vision Systems, the licences are stored on the key. A PC can run the licensed products only while the key is available.
- **Software protection:** For apps bought in the ctrlX Store and running on Windows 11, the licence is held in ctrlX WORKS. The key is still required, because it protects the software against reverse engineering. It does not hold a second licence, and you do not pay twice.

See [Which Licensing Path Applies](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/which-licensing-path.html) for which role applies to you.

## One key for several products

A single LumiScan Key can carry licences for several LumiScan products. When you buy an additional product, HD Vision Systems adds it to your existing key with a licence update (see [Requesting a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html)). You do not need an additional key for the new product.

## One key per device {#one-key-per-device}

You need one LumiScan Key for each device on which LumiScan software runs at the same time. For example, to run the software on three PCs simultaneously, you need three keys.

The keys are not bound to a device. You can exchange a LumiScan Key between different devices at any time, for example to move it from a test PC to the production PC (see [Moving the Key to Another PC](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/moving-the-key.html)).

If the licences on a key are already in use, the application reports `User maximum reached!` (see [Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#user-maximum-reached)).

## Handling the key

- Keep the key in a safe place. The licences are stored on it, so a lost key means lost licences.
- Do not remove the key while a LumiScan application is running or while a licence update is being written.
- If the key stays plugged in at a machine, secure it against being pulled out by accident, for example with a short USB extension fixed inside the control cabinet.

# Installing CodeMeter Runtime – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html

Every PC that uses a LumiScan Key needs the CodeMeter Runtime by WIBU-SYSTEMS AG. This applies to both licensing paths that use the key: software bought from HD Vision Systems, and software bought in the ctrlX Store that runs on Windows 11.

LumiScan software requires CodeMeter Runtime **9.00 or later**. This minimum applies to all LumiScan products. If an older version is installed, update it before installing or starting LumiScan software.

> [!TIP]
> Applications running natively on ctrlX OS do not need CodeMeter Runtime (see [Bought in the ctrlX Store, Running on ctrlX OS](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-os.html)).

## Windows 11

1. Download the **CodeMeter User Runtime for Windows** from the [WIBU-SYSTEMS user software page](https://www.wibu.com/support/user/user-software.html).

2. Run the installer and follow the manufacturer’s instructions. Administrator rights are required.

3. Connect the LumiScan Key to a free USB port.

   The LED on the key flashes briefly, and Windows detects the new USB device.

4. Open **CodeMeter Control Center**, for example through the Windows search.

   ![Windows search showing CodeMeter Control Center](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cc-windows-search.png)

   The LumiScan Key appears on the **License** tab as **CmStick/C** (see [Recognising the key](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#recognising-the-key)).

## Ubuntu 24.04

1. Download the **CodeMeter User Runtime for Linux** as a `.deb` package for your architecture (x86_64 or arm64) from the [WIBU-SYSTEMS user software page](https://www.wibu.com/support/user/user-software.html).
2. Install the package:
   ```bash
   sudo apt install ./codemeter_*.deb
   ```
3. Check that the CodeMeter service is running:
   ```bash
   systemctl status codemeter
   ```
4. Connect the LumiScan Key to a free USB port.

## Checking the installation {#checking-the-installation}

On both systems, the command-line tool `cmu` shows the installed version and the connected containers. On Windows, it is called `cmu32` and is available in the **CodeMeter Command Prompt**.

```bash
cmu --version
cmu --list
```

`cmu --list` lists the LumiScan Key with its serial number. If it reports `0 CmContainer(s) listed`, see [Key not detected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#key-not-detected).

## Virtual machines and containers {#virtual-machines-and-containers}

The LumiScan Key is a USB device. If LumiScan software runs in a virtual machine, pass the USB device through to the virtual machine and install CodeMeter Runtime inside it.

If LumiScan software runs in a container, run CodeMeter Runtime with the key on the host and let the software in the container access it over the network. To do so, enable the network server in CodeMeter WebAdmin on the host (**Configuration › Server › Server Access**). The software then reaches the key on TCP port 22350.

# Bought from HD Vision Systems – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-hdvs.html

This path applies to LumiScan software you bought directly from HD Vision Systems and run on Windows 11 or Ubuntu 24.04. The licences are stored on your LumiScan Key.

## What you need

- One LumiScan Key for each device on which the software runs at the same time. Keys can be exchanged between devices (see [One key per device](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#one-key-per-device)).
- CodeMeter Runtime 9.00 or later (see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html)).

## Engineering apps and runtimes

| Product type | Licence | What you have to do |
| --- | --- | --- |
| Engineering apps<br> (for example LumiScan Annotation Framework, LumiScan Training Framework, LumiScan VGR Engineering) | Annual subscription. It consists of a one-time entry fee and an annual licence fee, which includes maintenance and updates. | Activate once, then renew every year with a licence update. The renewal requires a valid subscription. Without it, the app can no longer be used. |
| Runtimes and vision apps<br> (for example LumiScan VGR, LumiScan CamDriver, the code readers) | One-time purchase, unlimited use. | Activate once. No renewal. |

## Activating your licences

If your LumiScan Key was delivered with your licences already on it, connect the key and start the software.

To add licences to the key, for example for a further product:

1. [Create a licence request](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html) and send it to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com).
2. [Import the licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html) that you receive from HD Vision Systems.

## Every year: renewing engineering licences

Engineering licences run for one year. Renew them before they expire, as described in [Renewing Engineering Licences](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/renewing-engineering-licences.html).

# Bought in the ctrlX Store, Running on Windows – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-windows.html

This path applies to LumiScan software that you bought in the Bosch Rexroth ctrlX Store and run on Windows 11: engineering apps (for example LumiScan Annotation Framework) as well as runtimes (for example LumiScan VGR or a vision app on a Windows IPC).

Two things are needed. They have different jobs:

|   | Job | Renewal |
| --- | --- | --- |
| Licence in ctrlX WORKS | Entitles you to use the app. | As agreed with Bosch Rexroth. |
| LumiScan Key | Protects the software against reverse engineering. It does not carry the licence. | None. It is updated only when you add a new LumiScan product. |

## What you need

- The licence for the app, bought in the ctrlX Store and activated in ctrlX WORKS. Follow the Bosch Rexroth documentation for ctrlX WORKS.
- One LumiScan Key for each Windows PC on which the software runs at the same time. You buy it in the Bosch Rexroth store; it is delivered with a basic setup. Keys can be exchanged between PCs (see [One key per device](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#one-key-per-device)).
- CodeMeter Runtime 9.00 or later (see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html)).

## Setting up

1. Install CodeMeter Runtime and connect the LumiScan Key (see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html)).
2. Activate the app licence in ctrlX WORKS.
3. Install and start the LumiScan app.

## Adding another LumiScan product

When you buy a further LumiScan product in the ctrlX Store for Windows 11, your LumiScan Key must be enabled for it once:

1. [Create a licence request](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html) from your LumiScan Key.
2. Send it to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with your ctrlX Store order number and the product you added.
3. [Import the licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html) that you receive from HD Vision Systems.

There is no annual update of the LumiScan Key on this path.

# Bought in the ctrlX Store, Running on ctrlX OS – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-os.html

This path applies to LumiScan runtimes and vision apps that you bought in the Bosch Rexroth ctrlX Store and run natively on ctrlX OS, either on a ctrlX CORE or on an IPC with ctrlX OS (for example a Bosch Rexroth ctrlX IPC). The LumiScan Key and CodeMeter Runtime are not used.

## How it works

- Each LumiScan app needs its own ctrlX licence. Its part number is listed in [Licence Reference](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html) and on the **Requirements** page of the app’s manual.
- You buy the licence in the ctrlX Store and activate it in the License Manager of ctrlX OS. Follow the Bosch Rexroth documentation for ctrlX OS.
- The licence must be available on the ctrlX OS device on which the app runs.

## Behaviour of the apps

- When the app starts, it reserves the licences it needs. While it runs, it renews them every 30 minutes.
- If a required licence is missing, the app stops shortly after starting. The reason is written to the ctrlX OS system log.
- If a licence is no longer available while the app is running, the app stops.
- Some apps need more than one licence, for example LumiScan CamDriver needs one licence per camera. See [Counting rules](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html#counting-rules).

# Requesting a Licence Update – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html

You can add or extend licences on your LumiScan Key without sending the key in. The procedure has three steps:

**Requesting a licence update: request, update, import**

```mermaid
%% Requesting a licence update. Rendered by Mermaid in the browser; edit and preview at https://mermaid.live
sequenceDiagram
  participant P as Your PC + LumiScan Key
  participant H as HD Vision Systems
  Note over P: 1 · Create request<br/>3-1234567.WibuCmRaC
  P->>H: e-mail to licenses@hdvisionsystems.com
  Note over H: 2 · Create update<br/>matching this key only
  H->>P: e-mail back to you
  Note over P: 3 · Import update<br/>3-1234567.WibuCmRaU
```

1. You create a licence request file (`.WibuCmRaC`) and send it to HD Vision Systems.
2. HD Vision Systems sends you a matching licence update file (`.WibuCmRaU`).
3. You [import the update file](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html) onto the LumiScan Key.

The request file describes only the current state of your LumiScan Key. It contains no personal data and does not change your licences.

> [!IMPORTANT]
> An update file matches only the LumiScan Key and the state from which the request was created. Each update file can be imported only once. Until you have imported the update from HD Vision Systems, do not import any other licence updates onto this LumiScan Key.

## Prerequisites

- CodeMeter Runtime is installed (see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html)).
- The LumiScan Key is connected to the PC.

## Creating the request in CodeMeter Control Center

1. Open **CodeMeter Control Center**, for example through the Windows search.

2. On the **License** tab, select your LumiScan Key on the left and click **License Update**.

   ![License tab with the LumiScan Key selected and the License Update button highlighted](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cc-license-tab.png)

   The CmFAS Assistant opens.

3. On the welcome page, click **Next**.

   ![CmFAS Assistant welcome page](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-welcome.png)

4. Select **Create license request** and click **Next**.

   ![CmFAS Assistant with Create license request selected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-create-request.png)

5. Select **Extend existing license** and click **Next**.

   ![CmFAS Assistant with Extend existing license selected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-extend-existing.png)

6. Select **HD Vision Systems GmbH (6000380)** and click **Next**.

   ![CmFAS Assistant vendor list with HD Vision Systems GmbH (6000380) selected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-select-vendor.png)
   > [!NOTE]
   > If **HD Vision Systems GmbH (6000380)** is not listed, you did not select the LumiScan Key in step 2. Close the assistant and start again at step 2.

7. Check the location and the file name, and click **Commit**.

   The suggested file name contains the serial number of the LumiScan Key, for example `3-1234567.WibuCmRaC`. Keep this name so that the file can be matched to your key.

   ![CmFAS Assistant with the file name of the request file](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-request-filename.png)

   The request file is created at the location you specified.

   ![Icon of the created .WibuCmRaC file](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/request-file-created.png)

8. Send the `.WibuCmRaC` file by e-mail to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). In the e-mail, state your order or quotation number and the LumiScan products you want.

## Creating the request on the command line {#command-line}

On a PC without a graphical interface, for example Ubuntu 24.04 without a desktop, use `cmu`. On Windows, it is called `cmu32` and is available in the **CodeMeter Command Prompt**.

1. Show the serial number of the LumiScan Key:
   ```bash
   cmu --list
   ```
2. Create the request file. Replace `3-1234567` with the serial number of your LumiScan Key:
   ```bash
   cmu --context 6000380 --serial 3-1234567 --file 3-1234567.WibuCmRaC
   ```
3. Send the `.WibuCmRaC` file by e-mail to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), as described above.

# Importing a Licence Update – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html

When HD Vision Systems has processed your [licence request](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html), you receive a licence update file (`.WibuCmRaU`). Its file name contains the serial number of the LumiScan Key it is intended for.

> [!IMPORTANT]
> Do not remove the LumiScan Key while the licence update is being written.

## Importing with the CmFAS Assistant

1. Save the `.WibuCmRaU` file on the PC to which the LumiScan Key is connected.

2. Check that the serial number in the file name matches the serial number of your LumiScan Key.

3. Open **CodeMeter Control Center**.

4. On the **License** tab, select your LumiScan Key on the left and click **License Update**.

   The CmFAS Assistant opens.

5. On the welcome page, click **Next**.

6. Select **Import license update** and click **Next**.

   ![CmFAS Assistant with Import license update selected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-import-update.png)

7. Click **…**, select the `.WibuCmRaU` file and click **Commit**.

   ![CmFAS Assistant with the path of the update file](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cmfas-update-filename.png)

   The licence update is written to the LumiScan Key.

8. Click **Finish**.

The new licences are available immediately. LumiScan applications that are already running may have to be restarted to use them.

## Importing from the menu

You can also import the update file without the CmFAS Assistant:

1. In CodeMeter Control Center, select **File > Import License…**.

   ![CodeMeter Control Center File menu with Import License](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/cc-file-import-license.png)

2. Select the `.WibuCmRaU` file and click **Open**.

   ![File dialog with a .WibuCmRaU file selected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/import-file-dialog.png)

> [!TIP]
> You can also drag the `.WibuCmRaU` file onto the CodeMeter Control Center window.

## Importing on the command line

On a PC without a graphical interface, use `cmu` (on Windows: `cmu32` in the **CodeMeter Command Prompt**). Replace `3-1234567` with the serial number of your LumiScan Key:

```bash
cmu --import --file 3-1234567.WibuCmRaU
```

If the import fails with error 705, see [Error 705 during import](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#error-705).

# Renewing Engineering Licences – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/renewing-engineering-licences.html

Engineering apps bought from HD Vision Systems are licensed as an annual subscription. The licence on your LumiScan Key runs for one year and must be renewed with a licence update every year.

> [!NOTE]
> This page applies only to engineering apps bought from HD Vision Systems. Runtimes are bought once and need no renewal. For software bought in the ctrlX Store, the LumiScan Key needs no annual update (see [Bought in the ctrlX Store, Running on Windows](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-windows.html)).

## Checking the expiry date

- **In CodeMeter WebAdmin:**
  1. In CodeMeter Control Center, click **WebAdmin**.
  2. Open **Container > Licenses** and select your LumiScan Key.
  3. The expiry date is shown for each licence.

- **On the command line:** Replace `3-1234567` with the serial number of your LumiScan Key:
  ```bash
  cmu --list-content --serial 3-1234567
  ```

  The entry **Expiration Time** of each licence shows its expiry date.

## Renewing

A renewal requires a valid subscription. HD Vision Systems issues the licence update only while your subscription for the engineering app is active, that is, the annual licence fee for the coming year has been agreed. If your subscription has been cancelled or has ended, contact [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com) to renew the subscription first.

We recommend starting the renewal about four weeks before the expiry date.

1. [Create a licence request](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html) from your LumiScan Key.
2. Send it to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). In the e-mail, state that you want to renew your engineering licences, and give your customer or order number.
3. [Import the licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html) that you receive from HD Vision Systems.

The renewal is written to the key. You do not need to reinstall the software.

## When the subscription has expired

Without a valid subscription, the engineering app can no longer be used. Your projects and data are not affected. As soon as your subscription is valid again and you have imported the renewal, the app can be used again.

# Moving the Key to Another PC – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/moving-the-key.html

Licences on the LumiScan Key are not bound to a device. You can exchange a key between different devices at any time; one key is needed for each device on which the software runs at the same time (see [One key per device](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#one-key-per-device)).

To use LumiScan software on another PC:

1. Close all LumiScan applications on the current PC.
2. Remove the LumiScan Key.
3. On the other PC, install CodeMeter Runtime 9.00 or later (see [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html)) and the LumiScan software.
4. Connect the LumiScan Key and start the software.

You do not need to contact HD Vision Systems or request a licence update to move the key.

> [!NOTE]
> For apps bought in the ctrlX Store and running on Windows 11, the licence is held in ctrlX WORKS. Moving that licence to another PC follows the Bosch Rexroth rules for ctrlX WORKS. The LumiScan Key itself moves as described above.

# Licence Reference – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html

This page lists the ctrlX licences of the LumiScan apps and the rules for how many licences an app needs.

## ctrlX licence part numbers

These part numbers apply to apps bought in the ctrlX Store and running on ctrlX OS (see [Bought in the ctrlX Store, Running on ctrlX OS](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-os.html)).

| App | Standard licence | Advanced licence |
| --- | --- | --- |
| LumiScan AI Object Matching | `SWL-W-XCx-OBJxMATCHxHDVSx-V2NN` | – |
| LumiScan Area Detector | `SWL-W-XCx-AxxDETECTxHDVSx-V1NN` | – |
| LumiScan Aztec Code Reader | `SWL-W-XCx-AZTECCRDSxHDVSx-V1NN` | `SWL-W-XCx-AZTECCRDAxHDVSx-V1NN` |
| LumiScan Barcode Reader | `SWL-W-XCx-BARxxCRDSxHDVSx-V1NN` | `SWL-W-XCx-BARxxCRDAxHDVSx-V1NN` |
| LumiScan Calibration | `SWL-W-XCx-CALIBRATExHDVSx-V2NN` | – |
| LumiScan CamDriver | `SWL-W-XCx-CAMDRIVERxHDVSx-V2NN` | – |
| LumiScan Cockpit | `SWL-W-XCx-COCKPITxxxHDVSx-V1NN` | – |
| LumiScan Dimensional Inspect | `SWL-W-XCx-DxINSPECTxHDVSx-V1NN` | – |
| LumiScan DMC Reader | `SWL-W-XCx-DMxxxCRDSxHDVSx-V1NN` | `SWL-W-XCx-DMxxxCRDAxHDVSx-V1NN` |
| LumiScan Object Finder | `SWL-W-XCx-OBJECTxFDxHDVS-V1NN` | – |
| LumiScan QR Code Reader | `SWL-W-XCx-QRxxxCRDSxHDVSx-V1NN` | `SWL-W-XCx-QRxxxCRDAxHDVSx-V1NN` |
| LumiScan Template Finder | `SWL-W-XCx-TEMPLxFDxxHDVS-V1NN` | – |
| LumiScan Text Reader | `SWL-W-XCx-TEXTxxRDSxHDVSx-V1NN` | `SWL-W-XCx-TEXTxxRDAxHDVSx-V1NN` |

The last group of a part number is the licence version. Version 2 of LumiScan AI Object Matching, LumiScan Calibration and LumiScan CamDriver requires the `-V2NN` licence. Licences ending in `-NNNN` belong to earlier versions and do not work with version 2.

## Counting rules {#counting-rules}

| App | Licences needed |
| --- | --- |
| LumiScan CamDriver | One licence per connected camera. Three cameras need three licences. |
| LumiScan Area Detector, LumiScan Object Finder, LumiScan Template Finder, LumiScan Text Reader | One licence per ten modules. The eleventh module needs a second licence. |
| All other apps | One licence per app instance, for any number of modules. |

## Standard and Advanced {#standard-and-advanced}

The code readers (Aztec, Barcode, DMC, QR) and the Text Reader are available as Standard and Advanced:

- An Advanced licence is always used together with a Standard licence. To run an app with Advanced functions, you need both.
- If an Advanced licence is available, the app uses it automatically.
- A module gets its tier when it is created. A newly added Advanced licence applies to modules created afterwards, or to all modules after a restart.
- By default, if the Advanced licence is no longer available while the app is running, the app continues with Standard functions. The setting `licenseFallback` in the `system` section of the app configuration can change this (`USE_BASIC`, `SKIP`, `STOP_APP`).

## Engineering apps and runtimes

For software bought from HD Vision Systems, all licences are held on the LumiScan Key:

- Engineering apps: annual subscription, renewed with a licence update (see [Renewing Engineering Licences](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/renewing-engineering-licences.html)).
- Runtimes and vision apps: one-time purchase, no renewal.

# Licensing FAQ – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/faq.html

Short answers to the questions customers ask most often about licensing. Each answer links to the page with the full procedure. For error messages, see also [Troubleshooting](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html).

> [!TIP]
> Each entry has a fixed anchor (for example `#faq-one-key-per-device`), so you can link to it directly.

## Which licence do I need?

### Which licensing path applies to me? {#faq-which-path}

It depends on where you bought the software and where it runs:

- Bought from HD Vision Systems, running on Windows 11 or Ubuntu 24.04: the licence is on your LumiScan Key.
- Bought in the ctrlX Store, running on Windows 11: the licence is in ctrlX WORKS, and a LumiScan Key is required in addition.
- Bought in the ctrlX Store, running on ctrlX OS (ctrlX CORE or an IPC with ctrlX OS): a ctrlX licence in the License Manager of ctrlX OS; no LumiScan Key.

Details: [Which Licensing Path Applies](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/which-licensing-path.html).

### Where do I find the licence part number for my app? {#faq-which-key-code}

The ctrlX part numbers (for example `SWL-W-XCx-CAMDRIVERxHDVSx-V2NN`) and the counting rules are listed in [Licence Reference](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html). The **Requirements** page of each product manual also names the licence that product needs.

### How many licences does an app need? {#faq-how-many-licences}

LumiScan CamDriver needs one licence per connected camera. LumiScan Area Detector, Object Finder, Template Finder and Text Reader need one licence per ten modules. All other apps need one licence per app instance. See [Counting rules](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html#counting-rules).

### What is the difference between Standard and Advanced? {#faq-standard-advanced}

The code readers (Aztec, Barcode, DMC, QR) and the Text Reader exist as Standard and Advanced. An Advanced licence is always used together with a Standard licence. If an Advanced licence is available, the app uses it automatically; otherwise it runs with Standard functions. See [Standard and Advanced](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html#standard-and-advanced).

## The LumiScan Key

### What is the LumiScan Key? {#faq-what-is-key}

The USB licence key for LumiScan software, a CodeMeter container by WIBU-SYSTEMS AG. CodeMeter Control Center shows it as **CmStick/C** with a serial number such as `3-1234567`; the serial number is also printed on the key. See [The LumiScan Key](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html).

### Do I need one LumiScan Key per PC? {#faq-one-key-per-device}

Yes. You need one LumiScan Key for each device on which LumiScan software runs at the same time. To run the software on three PCs simultaneously, you need three keys. See [One key per device](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#one-key-per-device).

### Can I use my LumiScan Key on another PC? {#faq-move-key}

Yes. Keys are not bound to a device and can be exchanged between devices at any time. Close the LumiScan applications, remove the key, connect it to the other PC (with CodeMeter Runtime installed) and start the software. You do not need to contact HD Vision Systems. See [Moving the Key to Another PC](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/moving-the-key.html).

### Can one key hold licences for several products? {#faq-several-products}

Yes. HD Vision Systems adds further products to your existing key with a licence update. See [Requesting a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html).

### I bought the app in the ctrlX Store. Why do I need a LumiScan Key on Windows? {#faq-ctrlx-why-key}

On Windows 11, the licence is held in ctrlX WORKS, and the LumiScan Key protects the software against reverse engineering. It does not hold a second licence, and you do not pay twice. The key is updated only when you add a new LumiScan product. See [Bought in the ctrlX Store, Running on Windows](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-windows.html).

### Do I need a LumiScan Key on a ctrlX CORE or a ctrlX IPC? {#faq-ctrlx-os-no-key}

No. Apps running natively on ctrlX OS - on a ctrlX CORE or on an IPC with ctrlX OS - use a ctrlX licence in the License Manager of ctrlX OS. Neither the LumiScan Key nor CodeMeter Runtime is used. See [Bought in the ctrlX Store, Running on ctrlX OS](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-os.html).

## Installing and activating

### Which CodeMeter Runtime version do I need? {#faq-codemeter-version}

CodeMeter Runtime 9.00 or later, for all LumiScan products. Check the installed version with `cmu --version` (on Windows `cmu32` in the CodeMeter Command Prompt). See [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html).

### How do I get a licence onto my LumiScan Key? {#faq-request-licence}

1. Create a licence request file (`.WibuCmRaC`) from the key in CodeMeter Control Center (**License Update** > **Create license request** > **Extend existing license** > **HD Vision Systems GmbH (6000380)**), or with `cmu --context 6000380 --serial <serial> --file <serial>.WibuCmRaC`.
2. Send it to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com) with your order or quotation number and the products you want.
3. Import the licence update file (`.WibuCmRaU`) that you receive.

See [Requesting a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html) and [Importing a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html).

### Does the licence request file contain personal data? {#faq-request-personal-data}

No. It only describes the current state of your LumiScan Key and does not change your licences.

### Can I use the LumiScan Key in a virtual machine or a container? {#faq-vm-container}

Yes. For a virtual machine, pass the USB device through and install CodeMeter Runtime inside the VM. For a container, run CodeMeter Runtime with the key on the host, enable the network server in CodeMeter WebAdmin and let the software in the container access it on TCP port 22350. See [Virtual machines and containers](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html#virtual-machines-and-containers).

## Renewal and subscription

### Do I have to renew my licences every year? {#faq-renewal-needed}

Only engineering apps bought from HD Vision Systems (for example LumiScan Annotation Framework, LumiScan Training Framework, LumiScan VGR Engineering). They are an annual subscription and are renewed with a licence update every year. Runtimes and vision apps are a one-time purchase and need no renewal. See [Renewing Engineering Licences](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/renewing-engineering-licences.html).

### When should I start the renewal? {#faq-renewal-when}

About four weeks before the expiry date. A renewal requires a valid subscription. You can check the expiry date in CodeMeter WebAdmin (**Container** > **Licenses**) or with `cmu --list-content --serial <serial>`.

### What happens when the subscription expires? {#faq-subscription-expired}

The engineering app can no longer be used. Your projects and data are not affected. As soon as your subscription is valid again and you have imported the renewal, the app works again - no reinstallation needed.

## Troubleshooting {#troubleshooting}

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

- [The key is not detected](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#key-not-detected)
- [HD Vision Systems GmbH is not listed in the CmFAS Assistant](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#faq-vendor-missing)
- [Error 705 when importing a licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#error-705)
- [The app does not see the new licence after the import](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#faq-restart-after-update)
- ["User maximum reached!" when starting a LumiScan application](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#user-maximum-reached)
- [An engineering app no longer starts](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#ts-engineering-app-not-starting)
- [A ctrlX app stops shortly after starting](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#faq-ctrlx-app-stops)

## Contact

Licensing questions and licence requests: [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). Please state your company, the order or invoice number, the serial number of your LumiScan Key and the exact error message.

# Troubleshooting – LumiScan Licensing

URL: https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html

Start with the [General checks](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#general-checks): they help with every licensing problem. Then find your symptom in the sections below and work through its steps in order. The last section lists what to send to HD Vision Systems if the problem persists.

## General checks {#general-checks}

Check these points first:

- **Your licensing path.** Where you bought the software and where it runs decide where the licence is held: on the LumiScan Key, in ctrlX WORKS, or in the License Manager of ctrlX OS. Apps running natively on ctrlX OS use neither the LumiScan Key nor CodeMeter Runtime. See [Which Licensing Path Applies](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/which-licensing-path.html).
- **The CodeMeter Runtime version.** `cmu --version` shows it (on Windows `cmu32` in the **CodeMeter Command Prompt**). LumiScan software requires CodeMeter Runtime 9.00 or later. See [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html).
- **The key is available.** On the **License** tab of CodeMeter Control Center, the LumiScan Key appears as **CmStick/C** with a serial number of the form `3-1234567`. On a PC without a graphical interface, `cmu --list` lists it. See [Recognising the key](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#recognising-the-key).
- **The licences on the key and their expiry dates.** In CodeMeter WebAdmin (**Container > Licenses**), or with `cmu --list-content --serial <serial>` (entry **Expiration Time**).
- **On ctrlX OS: the system log.** If a required licence is missing, the ctrlX OS system log names it.

## The LumiScan Key and CodeMeter {#key-and-codemeter}

### Problem: The key is not detected {#key-not-detected}

**Symptoms**

CodeMeter Control Center does not show the LumiScan Key, or `cmu --list` reports `0 CmContainer(s) listed`.

**Possible causes**

- CodeMeter Runtime is not installed on the PC.
- The CodeMeter service is not running. `cmu --list` then reports `CodeMeter not running`.
- The key is not recognised at its USB port, for example when it is connected through a hub.
- In a virtual machine: the USB device is not passed through to the virtual machine.
- In a container: the software cannot reach CodeMeter Runtime on the host.

**Diagnostic procedure**

1. Run `cmu --version` (on Windows `cmu32` in the **CodeMeter Command Prompt**) - expected: CodeMeter Runtime 9.00 or later is installed.
2. Check the CodeMeter service - expected: on Windows, the status line of CodeMeter Control Center shows **CodeMeter service is running**; on Ubuntu, `systemctl status codemeter` shows that the service is running.
3. Connect the key to a free USB port, directly at the PC - expected: the LED on the key flashes briefly, and Windows detects the new USB device.
4. Run `cmu --list` - expected: it lists the LumiScan Key with its serial number.
5. In a virtual machine: check that the USB device is passed through to the virtual machine, and that CodeMeter Runtime is installed inside it.
6. In a container: check on the host that the network server is enabled in CodeMeter WebAdmin (**Configuration › Server › Server Access**) - expected: the software reaches the key on TCP port 22350.

**Resolution**

- **If CodeMeter Runtime is not installed:** install CodeMeter Runtime 9.00 or later as described in [Installing CodeMeter Runtime](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html).
- **If the CodeMeter service is not running:** start the service.
- **If the key is not recognised at its USB port:** connect it to another USB port, preferably directly to the PC rather than through a hub.
- **If the USB device is not passed through to the virtual machine:** pass it through, and install CodeMeter Runtime inside the virtual machine.
- **If the software in a container cannot reach the key:** run CodeMeter Runtime with the key on the host, and enable the network server in CodeMeter WebAdmin on the host. See [Virtual machines and containers](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/installing-codemeter.html#virtual-machines-and-containers).

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the output of `cmu --version` and `cmu --list`, and whether the PC is a virtual machine or the software runs in a container.

## Licence updates {#licence-updates}

### Problem: HD Vision Systems GmbH is not listed in the CmFAS Assistant {#faq-vendor-missing}

**Symptoms**

When you create a licence request, the vendor list of the CmFAS Assistant does not show **HD Vision Systems GmbH (6000380)**.

**Possible causes**

- The LumiScan Key was not selected on the **License** tab before you clicked **License Update**.

**Diagnostic procedure**

1. Check the **License** tab of CodeMeter Control Center - expected: your LumiScan Key (**CmStick/C**) is selected on the left before you click **License Update**.

**Resolution**

- **If the key was not selected:**

  a. Close the assistant.

  b. On the **License** tab, select your LumiScan Key on the left and click **License Update**.

  c. Create the request again as described in [Requesting a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html).

On a PC without a graphical interface, create the request with `cmu` instead, see [Creating the request on the command line](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html#command-line).

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the output of `cmu --list`.

### Problem: Error 705 when importing a licence update {#error-705}

**Symptoms**

CodeMeter reports error 705 when you import a licence update file (`.WibuCmRaU`).

![CodeMeter error message: Update for CmContainer FirmItem 6000380](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/_images/error-705.jpg)

*Figure 1. Error 705 when importing a licence update*

**Possible causes**

- The update has already been imported. Each update file can be used only once.
- Another licence update was imported onto the LumiScan Key after the request was created: the update file no longer matches the current state of the key.
- The update is intended for another LumiScan Key.

**Diagnostic procedure**

1. Check whether the new licences are already on the key, in CodeMeter WebAdmin (**Container > Licenses**) or with `cmu --list-content --serial <serial>` - expected: if they are listed, the update has already been imported.
2. Compare the serial number in the file name with the serial number of your LumiScan Key - expected: the same serial number. The serial number is printed on the key and shown in CodeMeter Control Center.
3. Check whether another licence update was imported onto this key after you created the request.

**Resolution**

- **If the update has already been imported:** nothing more to do. The new licences are available.
- **If another update was imported in between, or the update is intended for another key:** if the new licences are not available, [create a new licence request](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html) from your LumiScan Key and send it to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). Until you have imported the new update, do not import any other licence updates onto this key.

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the name of the update file.

### Problem: The app does not see the new licence after the import {#faq-restart-after-update}

**Symptoms**

You imported the licence update without an error, but a LumiScan application does not use the new licence.

**Possible causes**

- The application was already running during the import. Applications that were already running may have to be restarted to use the new licences.
- The update was not written to the key, see [Problem: Error 705 when importing a licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#error-705).

**Diagnostic procedure**

1. Check whether the new licence is on the key, in CodeMeter WebAdmin (**Container > Licenses**) or with `cmu --list-content --serial <serial>` - expected: it is listed.
2. Check whether the application was started before the import.

**Resolution**

- **If the application was already running:** restart it.
- **If the licence is not on the key:** import the update again as described in [Importing a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html). If the import fails with error 705, see [Problem: Error 705 when importing a licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#error-705).

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the output of `cmu --list-content --serial <serial>`.

## Starting an application {#starting-an-application}

### Problem: "User maximum reached!" when starting a LumiScan application {#user-maximum-reached}

**Symptoms**

A LumiScan application reports `User maximum reached!` when it starts.

**Possible causes**

- All licences on the LumiScan Key for this application are already in use by other instances of the application that use this key.
- The software is to run on several devices at the same time with one LumiScan Key. One key is needed for each device on which the software runs at the same time.

**Diagnostic procedure**

1. Check whether other instances of the application use this LumiScan Key - expected: none, or fewer than the licences on the key allow.

**Resolution**

- **If other instances use the licences:** close them and click **Retry**.
- **If the software is to run on several devices at the same time:** use one LumiScan Key per device. See [One key per device](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/lumiscan-key.html#one-key-per-device).
- **If you permanently need more licences at the same time:** create a licence request and state the number you need in the e-mail. See [Requesting a Licence Update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html).

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the number of instances you need to run at the same time.

### Problem: An engineering app no longer starts {#ts-engineering-app-not-starting}

**Symptoms**

An engineering app bought from HD Vision Systems, for example LumiScan Annotation Framework, LumiScan Training Framework or LumiScan VGR Engineering, can no longer be used.

**Possible causes**

- The annual subscription has expired.

**Diagnostic procedure**

1. Check the expiry date of the licence - expected: it lies in the future.

   a. In CodeMeter Control Center, click **WebAdmin**, open **Container > Licenses** and select your LumiScan Key; or

   b. run `cmu --list-content --serial <serial>` and read the entry **Expiration Time**.

**Resolution**

- **If the subscription has expired:** renew the licence as described in [Renewing Engineering Licences](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/renewing-engineering-licences.html):

  a. The renewal requires a valid subscription. If your subscription has been cancelled or has ended, contact [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com) to renew the subscription first.

  b. [Create a licence request](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/requesting-a-licence-update.html) and send it to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). State that you want to renew your engineering licences, and give your customer or order number.

  c. [Import the licence update](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/importing-a-licence-update.html) that you receive.

     You do not need to reinstall the software. Your projects and data are not affected.

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the expiry date shown for the licence.

### Problem: A ctrlX app stops shortly after starting {#faq-ctrlx-app-stops}

**Symptoms**

A LumiScan app on ctrlX OS stops shortly after it starts, or stops while it runs.

**Possible causes**

- A required ctrlX licence is missing on the ctrlX OS device on which the app runs.
- The app needs more licences than are installed, for example LumiScan CamDriver needs one per camera.
- The licence has the wrong version: version 2 of LumiScan AI Object Matching, LumiScan Calibration and LumiScan CamDriver requires the `-V2NN` licence. Licences ending in `-NNNN` do not work with version 2.
- A licence is no longer available while the app is running. The app renews its licences every 30 minutes.

**Diagnostic procedure**

1. Read the ctrlX OS system log - expected: it names the missing licence.
2. Compare the licence with the part numbers and the counting rules in [Licence Reference](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html) - expected: the right part number, and as many licences as the app needs.
3. Check the License Manager of ctrlX OS on the device on which the app runs - expected: the licence is available there.

**Resolution**

- **If the licence is missing, or of the wrong version:** buy the licence in the ctrlX Store and activate it in the License Manager of ctrlX OS on this device. Follow the Bosch Rexroth documentation for ctrlX OS.
- **If the app needs more licences:** add licences until they match the [counting rules](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/licence-reference.html#counting-rules).
- **If a licence is no longer available:** make it available again in the License Manager of ctrlX OS, then start the app again.

See [Bought in the ctrlX Store, Running on ctrlX OS](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/path-ctrlx-os.html).

**If the problem persists**

Send the information listed under [Information for support](https://docs.hdvisionsystems.com/en/lumiscan-licensing/1.0.4/troubleshooting.html#support-information) to [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com), together with the lines of the ctrlX OS system log that name the licence.

## Information for support {#support-information}

If the problem persists, contact [licenses@hdvisionsystems.com](mailto:licenses@hdvisionsystems.com). Please state:

- your company, and the order or invoice number;
- the serial number of your LumiScan Key, if your licensing path uses one;
- the product and its version;
- the exact error message, and the date and time it appeared;
- the operating system: Windows 11, Ubuntu 24.04, or ctrlX OS and its version, and whether the software runs in a virtual machine or a container;
- the licensing path: bought from HD Vision Systems or in the ctrlX Store;
- the CodeMeter Runtime version (`cmu --version`) and the output of `cmu --list` and `cmu --list-content --serial <serial>`;
- on ctrlX OS, the lines of the ctrlX OS system log that name the licence;
- for a problem with a licence update, the name of the request file (`.WibuCmRaC`) or the update file (`.WibuCmRaU`).
