Skip to content

About HALCON licensesπŸ”—

To run HALCON on a computer, you need a license. For HALCON Steady, licenses are always issued for a certain HALCON version (i.e., major release, see this section). However, a license is not exclusively bound to this version: It is upward compatible within the version number, i.e., licenses for major releases are also valid for follow-up maintenance releases. For HALCON Progress, licenses are issued for the subscription period.

The license file is typically called license.dat. Between β€œlicense” and β€œ.dat”, arbitrary information can be included. Thus, different licenses for different versions (for example, license-26.11.dat for version 26.11) can be stored in the same directory.

The three possible licensing types mainly correspond to the different HALCON versions described in HALCON editions, configurations, and versions.

Evaluation license
To evaluate the full power of HALCON, you can obtain an evaluation license from your local distributor free of charge. This type of license is not bound to any computer hardware, i.e., you can use HALCON on any computer on which you installed it. However, an evaluation license is only valid for a limited time, typically for a month. You may not use this license to develop commercial applications.
Development license
To develop HALCON applications, whether in HDevelop or via a programming language, you need a development license. In contrast to the evaluation license, this license is permanent. Furthermore, this license is bound to a certain hardware component (network card or dongle). If you want to use HALCON on multiple computers simultaneously, you need a license for each of them.
Runtime license
If you finished developing your application based on HALCON and now want to install and run it on a customer’s computer, you only need a runtime license. Like development licenses, runtime licenses are permanent and bound to a certain hardware component (network card or dongle). You can obtain runtime licenses that cover only parts of the functionality (so-called modules). Please contact your local distributor for more information.

What is a license?πŸ”—

HALCON licenses are stored in so-called license files. The content of these files specifies

  • what is licensed (for example, development version, runtime version, etc.),
  • which modules are licensed (for example, Calibration, Matching, etc.),
  • whether the license is temporary (for example, evaluation license) or permanent,
  • the hardware to which the license is bound (see below).

License files are named license.dat (or license-26.11.dat or similar) and reside in the subdirectory license of the directory where you installed HALCON.

Warning

HALCON will not run if you modify the license keys within the license file manually.

A single license allows you to run a specific version of HALCON by one user on one system. The system is identified by a unique host ID. Depending on the type of host ID, you may install HALCON on any number of computers. In any case, you must use it only on the one computer to which the host ID is attached. Further information about licenses can be found in the EULA .

The license is not bound to a specific user. Consequently, different users may use the licensed HALCON version, but not simultaneously. To have multiple users run HALCON at the same time, the corresponding number of licenses is needed.
Each system service or daemon that executes HALCON is also counted as a user. Thus, if only one license is available and a system service executes HALCON, the regular user is not able to run another instance of HALCON in parallel.

Temporary licenses and system timeπŸ”—

For time-limited licenses like evaluation and Progress licenses, the system time must be synchronized to the real-world time.

Important

If you change the system time, the license may become invalid.

Network card versus dongle bindingπŸ”—

As noted in before, development and runtime licenses are bound to a certain hardware component. This is either the network card or a dongle.

Dongle-bound licenses allow using HALCON on different computers by moving the dongle. While network cards can also be switched between computers, in practice they can be regarded as fixed. Thus, if you want to develop applications with HALCON on more than one stand-alone computer at different times, the easiest solution is to obtain a dongle-bound license.

How to identify the hardwareπŸ”—

The license manager software identifies a network card or a HALCON dongle by a so-called host ID. A valid host ID is the unique, immutable, machine-readable identification of an actual piece of hardware as devised by the hardware vendor.

HALCON includes a tool to query the host IDs from the command line. Open a Command Prompt window or a Linux shell, and then enter the following command:

hhostid

This command produces a list of host IDs, which are available for licensing. For example:

0d00cafebabe 3-3123456

Use hhostid -i to get additional information, such as the type of a certain host ID:

hhostid -i
#0: 0d00cafebabe [MAC] <Local Area Connection>
#1: 3-3123456 [CM] <CM Container>

Each output line lists the following properties:

  • The running number, followed by the actual host ID
  • In the case of network adapters, the permanent MAC address
  • Host ID type in square brackets (MAC for network adapters, CM for HALCON dongles)
  • Interface name in angle brackets as reported by the operating system

If the currently assigned MAC address of a network adapter differs from its permanent address, it is reported here as well. HALCON only supports MAC-based licenses bound to universally administered, permanent MAC addresses. Locally administered MAC addresses are rejected.

More Info

For troubleshooting information, see Problems when extracting host IDs.

HDevelop automatically checks whether any network cards or HALCON dongles are present and displays their host IDs via Help > About.

Example

The following information will be displayed on a computer equipped with a network card and a dongle:

HALCON 26.11 Progress-Steady

HDevelop version: 26.11.1.0 (11.11.2026)
HALCON version: 26.11.1.0 (11.11.2026)

Platform version: x64-win64 (avx2)

(c) 1996-2026
MVTec Software GmbH, Munich, Germany

The host IDs of this computer are:
0d00cafebabe                           (network card ID)
3-3123456                              (dongle ID)

The first line shows the HALCON edition (Progress, Steady, or Steady Deep Learning); see HALCON editions, configurations, and versions.

How to use evaluation licensesπŸ”—

With an evaluation license, you can evaluate the full functionality of HALCON free of charge on any computer. The only restrictions are that evaluation licenses are valid only for a limited time (typically a month), and no commercial applications may be developed.

To use an evaluation license:

  1. Obtain the license.
    You can obtain an evaluation license from your local distributor.
  2. Install the license.
    β€œInstalling” the license simply means placing the license file into the subdirectory license of the directory where you installed HALCON. If necessary, rename the file to license.dat (or license-26.11.dat or similar; see About HALCON licenses).

Note

You can evaluate HALCON on any computer where you installed HALCON just by copying the evaluation license file into the corresponding subdirectory license. You can also evaluate HALCON under different operating systems.

How to use devevelopment licensesπŸ”—

A development license allows you to use the full functionality of your HALCON edition, including the development tools like HDevelop. It must be bound to a certain hardware component.

Using a license bound to a network cardπŸ”—

  1. Extract the host ID.
    The easiest way to extract the host ID is to execute the following command from a Windows command prompt or a Linux shell:

    hhostid -i
    
    All host IDs of type MAC can be used for licensing. For more information, see Identifying the hardware.
  2. Obtain the license.
    Send the host ID of the network card to your local distributor. The distributor then sends you a license file.

  3. Install the license.
    Place the license file into the subdirectory license of the directory where you installed HALCON. If necessary, rename the file to license.dat (or license-26.11.dat or similar).

Using a license bound to a dongleπŸ”—

  1. Obtain dongle and license.

    Important

    You cannot use any dongle but only those supplied by MVTec via your local distributor.

    HALCON supports USB dongles. The distributor will send you the dongle together with a corresponding license file. The dongle ID is printed on the dongle.

  2. Install the license.
    Place the license file into the subdirectory license of the directory where you installed HALCON. If necessary, rename the file to license.dat (or license-26.11.dat or similar).

    If you want to use HALCON on more than one computer by switching the dongle between them, repeat this step for every computer.

Using a license bound to a remote dongleπŸ”—

Starting with HALCON 21.05, you can use a dongle that is connected to the same computer running the VM/docker via the local virtual network.

  1. Plug the remote dongle into a computer with a running CodeMeter Runtime, version 6.50 or later, that is configured to allow remote clients to acquire licenses.

    Important

    For security reasons, MVTec recommends using CodeMeter Runtime version 7.10 or later.

    See the CodeMeter Runtime documentation on how to configure the CodeMeter Runtime correctly.

  2. Ensure that the communication between client and server is possible and is not blocked by a firewall, for example. By default, TCP port 22350 is used.

  3. Tell HALCON how to contact the dongle:
    Add the server=<hostnames> tag to the end of the license string for the dongle in the license file. <hostnames> is a comma-separated list of hostnames to contact. These can be either fully qualified domain names, IP addresses, or the special keyword _local. _local instructs HALCON to use a dongle connected to the local computer.

    Example

    The following example license file shows a HALCON runtime license for the dongle ID 3-3668597. HALCON first looks for the dongle locally, then attempts to contact the CodeMeter Runtime at the IPv4 address 10.0.0.5 and, if this fails, contacts the CodeMeter Runtime at license.example.com:

    LICENSE MVTec_HALCON 26.11 MODULES=fc123bdomit ID=CM:3-3668597 \
            FLAGS=PROGRESS_OK SESSIONS=1 SIGNATURE="F155 C6B7 5E24 5FAF 224D B779 \
            93D7 65B1 1F0C CCD9 CE94 03D0 0D79 066D C66F F869 A92D EC52 B7A2 04A7 \
            874C B503 BE19 B150 C9C1 592F 41EB C808 8479 380C CE95 1408" \
            server=_local,10.0.0.5,license.example.com
    

The hhostid tool and the get_system('hostids') HALCON operator call can only find dongles connected directly to the computer on which HALCON is running and will not find remote dongles.

How to use runtime licensesπŸ”—

In contrast to a development license, a runtime license only allows you to run HALCON applications. Furthermore, a runtime license can be restricted to a set of selected modules if your application does not require the full functionality of HALCON.

Getting a runtime license restricted to specific modulesπŸ”—

In the following we list the steps to determine the used modules, obtain an appropriate runtime license, and install it.

  1. Extract the required modules.

    To extract the modules that are used by an application, proceed as follows:

    • If the application is running in HDevelop, select the menu item File > Properties, which will open a dialog. In its tab Used Modules, the used modules are listed.
      Click Copy to Clipboard to save the required modules in the clipboard, from where you can insert them in other applications.

      Note

      This method determines the list of used modules by inspecting all operators of the current program, no matter if they can be reached or not. If the program contains operator calls that are never executed, deactivate the corresponding program lines before opening the dialog to get a correct list of used modules.

    • If the application is written in a programming language (C, C++, C#, VB.NET, etc.), insert the operator get_modules at the end of the program.

      Important

      The operator get_modules will only return the correct modules if all HALCON operators used in the application are executed at least once.

    Deep-learning-based methods

    In case of the modules for deep-learning-based methods, the required license does not depend on the used operator, but on the used model type (dynamic module). See this section for further details.

  2. Extract the host ID.

    See Using a license bound to a network card for information about how to extract the host ID. If you choose a dongle-bound license, no further action is required as you get the dongle together with the license (see Using a license bound to a dongle).

  3. Obtain the license.

    Send the determined module names and, unless using a dongle-bound license, the extracted host ID to your local distributor. The distributor then sends you a license file. If you requested a dongle-bound license, you will also receive the dongle.

  4. Install the license.

    Place the license file into the subdirectory license of the directory where you installed HALCON. If necessary, rename the file to license.dat (or license-26.11.dat or similar).

Dynamic modules for deep-learning-based applicationsπŸ”—

For some HALCON deep learning operators, the required licensed module is dynamic. This is the case if the respective operator can be used for methods of different modules. Thus, the license needed does not depend on the operator, but on the used model type of the used deep learning network. What kind of licenses may be required by an operator can be queried using get_operator_info.

Table 1 shows the required module licenses to run the different types of the deep learning models with a deep learning operator.

Table 1: Module licenses necessary to run the different types of deep learning models with a deep learning operator
'type' Module license for training Module license for inference
'3d_gripping_point_detection' 3D Metrology 3D Metrology
'anomaly_detection' Deep Learning Professional Deep Learning Professional
'classification' Deep Learning Enhanced,
Deep Learning Professional
Deep Learning Professional
'classification' with OOD Deep Learning Professional (fitting) Deep Learning Professional
'code_reading_detection' Data Code1 Data Code2
'counting' Matching Matching
'deep_matching_3d' 3D Metrology 3D Metrology
'detection' Deep Learning Enhanced,
Deep Learning Professional
Deep Learning Professional
'gc_anomaly_detection' Deep Learning Professional Deep Learning Professional
'generic' Deep Learning Enhanced,
Deep Learning Professional
Deep Learning Professional
'multi_label_classification' Deep Learning Professional Deep Learning Professional
'ocr_detection' OCR/OCV OCR/OCV
'ocr_recognition' OCR/OCV OCR/OCV
'segmentation' Deep Learning Enhanced,
Deep Learning Professional
Deep Learning Professional
'edge_extraction = "segmentation"' Deep Learning Enhanced,
Deep Learning Professional
Deep Learning Professional

How to upgrade a licenseπŸ”—

If you upgrade a HALCON license to a newer version, your distributor provides you with a new license file, which contains new license keys. This new license file should replace the old one in %HALCONROOT%\license\license.dat.

Licensing on Arm-based platformsπŸ”—

The licensing on Arm-based platforms is either based on a product license dongle or a Card IDentification (CID) number of an SD card or other memory cards.

To access a dongle, the hidraw device must exist, that is, it must be enabled in the kernel configuration. If necessary, a custom kernel needs to be compiled using the kernel option CONFIG_HIDRAW=y.

A USB port is required to connect the dongle. In case of a card identification number, hardware support for the memory device is required. You can query the CID numbers provided by your system by calling the HALCON command-line tool hhostid -i.

How to check the genuineness of HALCON (Windows)πŸ”—

To verify that your HALCON installation is genuine, you can check the digital signature of the file halcon.dll. Make sure that your Windows installation is fully updated. Otherwise, the signature verification might not work as expected.

  1. Right-click the file %HALCONROOT%\bin\%HALCONARCH%\halcon.dll.
  2. Select Properties.
  3. Select the tab Digital Signature.
  4. Select the signature MVTec Software GmbH and click Details.

If your version of HALCON is genuine, the dialog reads β€œThis digital signature is OK”. Otherwise, your version of HALCON has been tampered with. This might lead to unexpected behavior of HALCON.

License watchdog process for floating licenses (Windows)πŸ”—

On Windows, socket communication is not possible during process termination. As a result, a process using HALCON on Windows cannot return a floating license automatically when it is terminated.

To avoid the need for HALCON applications to manually return floating licenses on Windows, HALCON provides the license watchdog hlwd. The watchtdog is started as a separate process whenever HALCON acquires a floating license. If the HALCON process is terminated before it could return its license, the watchdog returns the license instead and then terminates itself.


  1. train_dl_model_batch is not supported for version 26.11. β†©

  2. apply_dl_model is not supported for version 26.11. β†©