Carrida Licensing

How to license Carrida for Linux on x86, and embedded ARM platforms

Revision: 1.1
Date: 2018-02-05
Contact: alpr.support@vision-components.com
Copyright: 1996-2018 Carrida Technologies GmbH, Ettlingen, Germany
Author: VC Support

Home page

Table of Contents

1   Introduction

The installation of a SW License for CARRIDA requires two steps:
  1. create a hardware fingerprint of your system as basis for licensing
  2. activate a Carrida license on your system

Both steps are implemented using the fplc software tool. The fplc program is available for x86 Linux and Linux on ARM systems.

Definition of terms:

fingerprint file
For a license to become valid, a description of the specific hardware, which you want to license, is created and stored in a fingerprint file. Any modification of the underlying hardware will invalidate its fingerprint information and require you to re-license Carrida.
activation file
The corresponding activation data, which is created by Vision Components, is stored and transferred in the activation file. The fplc tool uses this activation file to create and a store a specific Carrida license on your system.

2   The licensing workflow

The basic licensing workflow is as follows:

  1. Use the fplc tool to create a fingerprint file out.c2v for your system and send it to Vision Components in electronic form by mail.
  2. The returned license file activate.v2c needs to be copied to a location, which is accessible from your system. Then install and activate the license using the fplc tool.

Note

Note Sign

For licensing and activation, a writable partition must be present on your board. This writable location must not be a mounted network folder.

The fplc tool manages licenses on our system. Calling the program without options, or with the -h option, displays a short list of command line parameters:

./fplc -h
 fplc [options]:
 -h [ --help ]         print a help message
 -f [ --fingerprint ]  create the HW fingerprint file (default: out.c2v)
 -a [ --activate ]     activate using vendor license file (default: activate.v2c)
 -u [ --update ]       update using vendor license file (default: update.v2c)
 -v [ --verbose ]      verbose mode
 -o [ --output ] arg   fingerprint file output, replaces default out.c2v
 -i [ --input ] arg    license file input, used instead of default activate.v2c

The required files, which are needed by fplc, have default names. Only if you need to override these names, input or output parameters are required. For example, if you want to store the fingerprint of a file under a specific name (e.g. the serial number of a board), you can call fplc with the following syntax (serial in the example below is the serial number of the board):

./fplc -f -o serial.c2v

2.1   Optional: Prepare your system

This section is only required if your system has a read only file system by default, or if it has only a few specific writable directories available. In these cases, the CARRIDA licensing software needs to know where it can store the licensing information.

Create a writable partition on the system and make this location: the current working directory:

cd /my_writable_folder

Then create a folder, which is used as storage area for the license information:

mkdir ./fp
chmod a+rwx ./fp

Then inform the licensing library where to find license keys using an environment variable:

export HASPUSER_PREFIX=/my_writable_folder/fp

The environment variable HASPUSER_PREFIX needs to be setup each time before CARRIDA is used, and it must not change from the initially defined value. Any modification after creating the fingerprint or after activation will invalidate the license.

Finally, either copy the fplc tool to the writable folder, or add it to a location from where it can be invoked. The following sections assume that fplc resides in the location /my_writable_folder.

2.2   Create a fingerprint file

Invoke the fplc program from the command line to create a fingerprint file. The fingerprint file is named out.c2v by default, and it is placed in the working directory. Use the -o option if you want to change the name of the fingerprint file.

./fplc -f [-o my_out.c2v]

This will create an out.c2v file, or my_out.c2v if the -o option was used as shown above.

/my_writable_folder/out.c2v

2.3   Send the fingerprint file to Vision Components

Send the fingerprint file just created to Vision Components, where it will be checked and processed. A license file, by default activate.c2v will be generated and sent back to you.

2.4   Activate the license on the camera

You should have received a licensing file activate.v2c from Vision Components. Copy this file to your local writable folder (see Section 2.1) or to any suitable place, which is accessible by your system.

/my_writable_folder/activate.v2c

Invoke the fplc program from the command line to activate the CARRIDA license for your system using the activation file.

./fplc -a [-i my_activate.v2c]

If only the -a option is used, the default activate.v2c file from the current working directory is used. You can specify an alternative input file using the -i option as shown above.

Now the CARRIDA library should be activated for your board.

Note

Note Sign If you have set a location using the HASPUSER_PREFIX environment variable, you need to set this variable before any use of the CARRIDA software. The environment variable must be set to the same location as it has been defined with the procedure described in Section 2.1.