License activation#

Application packages are licensed per device. Before the SDK can load a package’s shared library, you must activate this device with the abr-sdk activate command. Activation binds your license key to this machine and writes a signed license file that the SDK reads when it loads a package.

abr-sdk activate is part of the Python package: it contacts the licensing service, which the C binding does not do. Install it with pip install abr-sdk (Python 3.10 or later) on the device you are activating, or on any machine for a device that cannot run it.

You only need to activate once per device.

Get a license key#

License keys are issued per account. Register on the ABR developer portal to get one; registration is self-serve, and evaluation is free.

Activate this device#

Run abr-sdk activate, pointing it at the shared library (.so) from your extracted application package and passing your license key:

abr-sdk activate /path/to/niagara-38m-live.en-linux-x86_64/libniagara_38m_live.so --key YOUR_LICENSE_KEY

To keep the key out of your shell history, write it to a file and use --key-file instead:

abr-sdk activate /path/to/niagara-38m-live.en-linux-x86_64/libniagara_38m_live.so --key-file ~/abr-license.key

On success the command prints where the license was installed:

abr-sdk: activation succeeded; license installed in ~/.local/state/abr-sdk/license

That is the directory the examples pass as the license_dir configuration option when they create an application, through the session.h helper. Pass a different license_dir to abr_lib.app_create if you installed the license elsewhere with --license-dir.

Activate another device#

A device that cannot run abr-sdk, such as a microcontroller, reports its own fingerprint: 64 hexadecimal characters, printed by the application package’s sample when it runs unlicensed. Pass that fingerprint in place of the library, and name a file for the license:

abr-sdk activate --fingerprint FINGERPRINT --key-file ~/abr-license.key --output license.lic

The package’s README says how to give license.lic to the device.

Options#

Option

Description

library (positional)

Path to the application package’s shared library (.so). The device fingerprint is read from it.

--key STRING

Your ABR license key. Mutually exclusive with --key-file; one of the two is required.

--key-file FILE

Path to a file containing the license key. Surrounding whitespace is trimmed.

--license-dir DIR

Directory to write the license into. Defaults to ~/.local/state/abr-sdk/license.

--fingerprint HEX

Fingerprint of another device to activate, in place of library. Needs --output.

--output FILE

File to write the other device’s license to.

Troubleshooting#

If activation fails, abr-sdk activate will tell you why. The most common causes are:

  • Network errors: the licensing service could not be reached. Check your connection and retry.

  • License errors: the key is invalid, or already bound to too many different devices. Confirm the key and the library path, or contact support@appliedbrainresearch.com.

Next steps

With your device activated, produce your first transcript in the ASR quickstart or synthesize speech in the TTS quickstart.