Sign In
Sign Out

Tutorial: Using the License Service Client Executable

In this tutorial, we will walk you through the process of setting up the License Service Client to connect to Carmen Cloud's public license service. This client makes it simpler to use the company's image recognition engines without the need for a hardware key.

Prerequisites​

  1. Register on the Carmen Cloud website to obtain an API key.
  2. Subscribe to the Carmen® License Service (for Carmen Go and Carmen Video SDK, use the "Carmen GO for video processing" option; for all other products (e.g., Carmen FreeFlow SDK) choose "Carmen FreeFlow"). The number of options you purchase determines the maximum number of license locks (image reads) in parallel.
  3. Download the appropriate executable for your system. LSC is available in Linux x86_64, Linux arm64, and Windows x86_64.

Steps:​

1. Run the License Service Client​

Use the command line to run the executable with the appropriate options. Below is a description of the available options:

lsc-4.6.0

usage: lsc [-a <arg>] [-ak <arg>] [-h] [-ls <arg>] [-n <arg>] [-p <arg>]
       [-sa <arg>] [-sp <arg>] [-th <arg>] [-v]
Start the License Service Client with a Carmen Cloud API key or License
Server Address(es).
 -a,--address <arg>            License Service Client address (defaults to
                               '0.0.0.0')
 -ak,--api-key <arg>           Carmen Cloud API key
 -h,--help                     Print this message
 -ls,--license-servers <arg>   License Server addresses (in ip[:port]
                               format separated by commas, port is not
                               required, defaults to 8998, e.g.
                               "192.168.1.1:8999,192.1681.2")
 -n,--name <arg>               License Service Client name (defaults to
                               'Carmen Cloud License Service Client')
 -p,--port <arg>               License Service Client port (defaults to
                               '8998')
 -sa,--status-address <arg>    Status address
 -sp,--status-port <arg>       Status port
 -th,--thread-count <arg>      Processing thread count (defaults to '2')
 -v,--version                  Print version information

Please report issues at support@carmencloud.com

The main parameters:

  • ApiKey: This is the API key you obtained after registering on the Carmen Cloud website.
  • ThreadCount: Optional; defaults to 2. The License Service Client puts all incoming requests into a thread safe queue and by default uses 2 worker threads to serve them. The number of workers can be increased if the Client proves to be a bottleneck in serving requests, provided that the underlying hardware allows it.

Minimal Command example on Windows:

lsc-4.6.0.exe -ak YOUR_API_KEY_HERE

2. Test the Setup​

Once the License Service Client is running, you can connect your software components to it depending on the product you are using:

  • Carmen FreeFlow: Refer to the CONFIGLSCLIENT section of the Carmen® User Manual for detailed instructions on configuring FreeFlow with the License Server.
  • Carmen OCR: Refer to the CONFIGLSCLIENT section of the Carmen® User Manual for detailed instructions on configuring Carmen OCR with the License Server.
  • Carmen Axis: Refer to CONFIGURING THE LICENSE SERVER section of the Carmen® Axis Video App User Manual for detailed instructions on configuring Carmen Axis with the License Server.
  • Carmen GO: Refer to CONTROL PANEL section of the Carmen® GO User Manual for detailed instructions on configuring Carmen GO with the License Server.

Conclusion​

With the License Service Client executable files, it becomes very convenient to use the company's image recognition engines. Always remember to keep your API key confidential to ensure the security of your cloud resources.