Deployment Manual (for Linux)

1. System and Software Requirements

Please check whether the relevant items meet the requirements before deployment.

Please use a root account or execute all the following commands with sudo privileges from a non-root account.

2. Resource Package

3. Quick Start Guide

Please use the root account, or execute all the following commands with sudo privileges from a non-root account.

3.1. Install the Dongle Driver

Please use the command service senseshield status or systemctl status senseshield to check if the driver has already been installed. If the response is senseshield.service not found or a similar message, please refer to the Dongle User Manual to complete the driver installation. If not, it indicates that the driver has already been installed; please skip the installation steps and proceed directly to activation.

3.2. Activation

3.2.1. Perform Activation

• Online Binding

  In an online environment, enter the following command in the terminal, and then proceed with the "Confirm Activation Status" steps below.

  ssclt --online_bind_license_key --license_key xxxx-xxxx-xxxx-xxxx (the authorization code provided by the pre-sales)

• Offline Binding

  In an offline environment, you can use offline binding for activation.

  Run the following command on the offline server to generate hardware fingerprint file:

  ssclt --offline_bind_c2d --c2d ./

  A file with a suffix of ".c2d" will be generated in the current directory, for example: PC_192.168.0.54.c2d

  Copy the generated C2D file to any other computer that has internet access. Log in to https://user.lm.virbox.com/sn/login.html on the computer and enter the authorization code provided by the pre-sales.

  In the "Offline Binding" section , use the generated C2D file to get a D2C update file. The file name will be like PC_192.168.0.54.D2C.

  Copy the D2C file back to the offline server and run the following command:

  ssclt --update_d2c --d2c ./PC_192.168.0.54.D2C

  Then proceed with the "Confirm Activation Status" steps below.

3.2.2. Confirm Activation Status

You can list the license information using the following command:

ssclt -l

The LicenseId in the returned results represents the existing license ID. To use the Voiceprint Recognition service, there must be a license ID 803000 on the server.

3.3. Install Voiceprint Recognition service

3.3.1. Import Docker Image

Unzip the vpr-service_{version}.zip file provided by the pre-sales team into a proper directory:

unzip -o vpr-service_2.5.0.tar.zip
docker import vpr-service_2.5.0.tar vpr-service:2.5.0

3.3.2. Run a Docker Container

docker run -itd --name=vpr-service --shm-size=2g -p 7800:7800  \
--restart=always --privileged -v /tmp:/tmp \
vpr-service:2.5.0 /bin/bash -c "/home/start.sh"

The default server port is 7800. If you need to change it, modify the part before the colon in the -p parameter of the command, for example, -p custom_port:7800, and then execute the command.

3.3.3. Check the Status of the Container

docker logs -f vpr-service

The appearance of the following message indicates that the startup was successful:

VPR module was launched successfully, listening on http://localhost:7800
[INFO]: emb model is loaded.

4. Moving or Copying the Software to Another Device

4.2. Unbind the Old Server

On the old device, unbind the license. After unbinding, the VPR service on the old device will no longer be usable. If the old device can access the internet, use the online unbinding method; otherwise, use the offline unbinding method.

• Online Unbinding

  ssclt --online_unbind_license_key --license_key xxxx-xxxx-xxxx-xxxx (the authorization code provided by pre-sales for first activation)

• Offline Unbinding

  Step 1: Execute the following command. An offline unbinding file with a .c2d extension will be generated in the current directory.

  ssclt --offline_unbind_c2d --c2d ./ --license_key xxxx-xxxx-xxxx-xxxx (the authorization code provided by pre-sales for first activation)

  Step 2: Log in to the User License Center. Enter the authorization code and complete the image verification to access the redemption page. In the "Offline Unbind" section, click the edit box next to "Import C2D File" and select the offline unbinding C2D file generated in the previous step. Finally, click "Start unbind" button to complete the license unbinding. After unbinding, the authorization code will regain one binding slot, allowing it to be used on a new device.

4.2. Bind the Old Server

Refer to Section 3.1 to install the dongle driver on the new device, and then bind the authorization code. If the new device can access the internet, use the online binding method; otherwise, use the offline binding method.

• Online Binding: Refer to "Online Binding" in Section 3.2.1, , to complete the operation.
• Offline Binding: Refer to "Offline Binding" in Section 3.2.1, to complete the operation.

After completing the binding, please refer to Section 2.3 to install the Voiceprint Recognition service.

6. FAQ

No Response to a Request

1. Please check if the service is running properly by executing the docker ps -a|grep vpr-service command to see if there is a running container.
2. Please check the firewall settings to allow the port for the TCP protocol (default is 7800).

Failed During Activation (Binding)

If you encounter the error code 0x22001001, please execute the following command:

wget https://download.virbox.com/virboxtools/hwss/senseshield-2.5.0.60698-x86_64.sh
chmod +x senseshield-2.5.0.60698-x86_64.sh
./senseshield-2.5.0.60698-x86_64.sh install

Then retry activation (binding).

Slow Response from Voiceprint Registration Interface

The first voiceprint registration request after the Docker container starts may take around 10 seconds due to model loading. This is a normal occurrence. Subsequent registration requests should return to normal speed.