Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


...

Note

This procedure does not apply to: Linux SL / Control Win SL / Control RTE SL / Linux Arm SL

...

!


Warning

After the activation of activating the license on the device, the license should be backed up so that it is available for a re-installation of in case the SD/OS image needs to be restored in the future.


Note

A soft-license can only be restored on the same Raspberry Pi device and cannot be not transferred to another. 
Alternatively, there is a possibility to use a a license can be installed on a CODESYS dongle that can be used on any Raspberry Pi. This means you can simply move the USB dongle if your Raspberry Pi breaks, you upgrade to a Raspberry Pi 5, or if you have two Raspberry Pi controlled machines that you run only one at a time.

Backing up a license

There are two possibilities to do this:

  1. Backup the license update file CMLicenseNew.WibuCmRaU
  2. If you used CODESYS >= 3.5SP13 you'll find the license backup file in: “c:\Program Data\CODESYS\Licenses\license ticket number” (on the PC where you have licensed the PI)
  3. Restore the license via the server

Backing up the license update file CMLicenseNew.WibuCmRau via the CODESYS file manager

Image Removed

Backing up the license update file from “c:\Program Data\CODESYS\Licenses\license ticket number” (on the PC where you have licensed the PI)

...

's.


Note

There are differences to versions, before and after CODESYS 3.5 SP17 or SL runtime, smaller than v4.1.0.0 - see information notices.


Quick links:

Table of Contents

How to back up a license file

There are two ways to do this:

  1. Back up from the device via the CODESYS file manager 
    After establishing a connection to the device,
    1. Select the Files tab of the Device window
    2. Choose a location to save the file in your PC or an external drive
    3. Click on the Refresh button on the Runtime side
    4. Select the "CMLicenseNew.WibuCmRaU" file in the Runtime's file system
    5. Click on the "<<" button

      Image Added


  2. Only when using CODESYS >= 3.5 SP13: There should be a back-up already on the PC where the license was activated from
    If the license was originally activated using CODESYS V3.5 SP13 or newer, the license backup file can be found under:

    "C:\ProgramData\CODESYS\Licenses\

...

  1. <license ticket

...

  1. number>" (there will be a folder for every license ticket)

    The license file will have the following naming format: "<Hardware serial number of the device>.WibuCmRau". For example:

    Image Added


How to restore a license

There are two ways to do this:


Note

From version CODESYS 3.5 SP17 (4.1.0.0) on forward, the content can only be deleted using the command:

Info
iconfalse


sudo rm /var/opt/codesys/.cmact_licenses/**

Expand
  • rm *file*
    Used to delete files with certain names in their names. The asterisks cause all files to be deleted that contain the designation in the file name and any characters before and after it.
  • rm -r foldername/*
    Delete all files and subfolders in the specified folder.
  • rm -r foldername
    Delete all files and subfolders, including the folder itself.



Info
titleFor versions < CODESYS 3.5 SP17 or SL runtime smaller than v 4.1.0.0

In older versions, the path is " /var/opt/codesys/cmact_licenses/ " without the dot at the beginning of the last folder name.

If you are using an image or another license had already been activated on the device, delete the cmact_license folder from the Runtime's file system,
and restart the device before proceeding to restore the license.

Image Added


Info

The Codesys File manager does not show the dot for the " .cmact_licenses " folder name!


  1. Restore the license with the activation ticket
    Using the License Manager (Tools>License Manager...),
    1. Click on Additional Functions
    2. Enter the license activation ticket
    3. Click Restore

      Image Added


  2. Restore the license from the license file
    Open the License Manager (Tools>License Manager...) and
    1. Click on Install Licenses...
    2. Select Install license and click Next >
    3. Select the license file and click Finish

      Image Added

      Info

      If using CODESYS V3.5 older than Service Pack 13, instead of the License Manager,
      there is the Edit Licenses option found in the PLC Settings tab of the Device window:

      Image Added

for example: 0000000077754dd5.WibuCmRau  0000000077754dd5 is the hardware serial number of your Pi.

How to find the serial number of the connected Pi ( this is needed because you could only activate the license update to the correct PI – Serial number must fit)

See the screenshot - you could get the serial number of you Pi by the  “Pi Update Tool”:

Image Removed

Restore the license via the server

Image Removed

Restoring the license on a reinstalled device

If you use an Image where another (incorrect) license was already active, please you must first delete the cmact_licenses directory by CODESYS file browser, then restart the plc, and then activate the license with the license file ...

Image Removed

Restoring the license from the file CMLicenseNew.WibuCmRau

As of SP13:

...

Image Removed

...

Up to SP13:

...