Overview

[+ 1.9.0] Device License provides a way to activate specific features on a device.

Device Type Supported Version Visual QR Wireless lock
XS2 V1.2.0 or later O  
BS3 V1.1.0 or later O  
CS40 V1.7.1 or later   O

Config

Retrieves device license related settings for the device.

message DeviceLicenseConfig {
    uint32 version = 1;
    repeated DeviceLicenseInfo licenseInfo = 2;
}
version
Version of device license settings information.
licenseInfo
Device license information. Up to 16 can be configured.
message DeviceLicenseInfo {
    uint32 index = 1;
    uint32 hasCapability = 2;
    bool enabled = 3;
    uint32 enableCount = 4;
    DeviceLicenseType type = 5;
    DeviceLicenseSubType subType = 6;
    uint32 enableTime = 7;
    uint32 expiredTime = 8;
    uint32 issueNumber = 9;
    string name = 10;
}
index
License index.
hasCapability
Whether the device supports that license. It usually has a value of 1.
enabled
Whether the license is active.
enableCount
This is the number that can be supported. For wireless locks, this indicates the number of slaves that can be connected.
type
The type of license.
subType
Detailed form of license type.
enableTime
License activation start time, expressed in POSIX time.
expiredTime
License activation end time, 0 means unlimited.
issueNumber
Issuing unique number.
name
License name.
enum DeviceLicenseType {
    TYPE_NONE                = 0x0000;
    TYPE_VISUAL_QR           = 0x0001;
    TYPE_UZ_WIRELESS_LOCK    = 0x0002;
}

enum DeviceLicenseSubType {
    SUBTYPE_NONE                = 0;
    SUBTYPE_VISUAL_QR_CODE_CORP = 1;
}

GetConfig

Get the display configuration of a device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
Response
Parameter Type Description
config DeviceLicenseConfig The device license configuration of the device

Enable/Disable/Query

Activate/deactivate/check device license on the device.

message DeviceLicenseBlob {
    DeviceLicenseType type = 1;
    repeated uint32 deviceIDs = 2;
    bytes data = 3;
}
type
The type of license.
deviceIDs
Slave devices for which license information will be issued.
data
License activation data block.
message DeviceLicenseResult {
    uint32 deviceID = 1;
    DeviceLicenseStatus status = 2;
}
deviceID
Device identifier.
status
License status information.
enum DeviceLicenseStatus {
    NOT_SUPPORTED   = 0;
    DISABLE         = 1;
    ENABLE          = 2;
    EXPIRED         = 3;
    NOT_EXIST       = 4;
    ALREADY_ADD     = 5;
}

Enable

Activate device license on the device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
licenseBlob DeviceLicenseBlob Device license information to be activated.
Response
Parameter Type Description
results DeviceLicenseResult Activation results.

Disable

Deactivate device license on the device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
licenseBlob DeviceLicenseBlob Device license information to be deactivated.
Response
Parameter Type Description
results DeviceLicenseResult Deactivation results.

Query

Check activation status on the device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
type DeviceLicenseType Device license type information to check.
Response
Parameter Type Description
results DeviceLicenseResult Activation status on the device.

Updated: