Device Status API

You can configure what signals should be emitted on the LEDs and the buzzer for the predefined device status.

Config

There are 15 predefined status. You can configure LEDStatus and BuzzerStatus per each status.

message StatusConfig {
  repeated LEDStatus LEDState;
  repeated BuzzerStatus BuzzerState;
}
LEDState
The LED signals for a status.
BuzzerState
The buzzer signals for a status.
message LEDStatus {
  DeviceStatus deviceStatus;
  uint32 count;
  repeated action.LEDSignal signals;
}
deviceStatus
The status for which the LED signals will be displayed.
count
The repeat count of the signals. If 0, repeat the signals indefinitely.
signals
Up to 3 LED signals can be defined.
message BuzzerStatus {
  DeviceStatus deviceStatus;
  uint32 count;
  repeated action.BuzzerSignal signals;
}
deviceStatus
The status for which the buzzer signals will be emitted.
count
The repeat count of the signals. If 0, repeat the signals indefinitely.
signals
Up to 3 buzzer patterns can be defined.
enum DeviceStatus {
  DEVICE_STATUS_NORMAL = 0;
  DEVICE_STATUS_LOCKED = 1;
  DEVICE_STATUS_RTC_ERROR = 2;
  DEVICE_STATUS_WAITING_INPUT = 3;
  DEVICE_STATUS_WAITING_DHCP = 4;
  DEVICE_STATUS_SCAN_FINGER = 5;
  DEVICE_STATUS_SCAN_CARD = 6;
  DEVICE_STATUS_SUCCESS = 7;
  DEVICE_STATUS_FAIL = 8;
  DEVICE_STATUS_DURESS = 9;
  DEVICE_STATUS_PROCESS_CONFIG_CARD = 10;
  DEVICE_STATUS_SUCCESS_CONFIG_CARD = 11;
  DEVICE_STATUS_RESERVED2 = 12;
  DEVICE_STATUS_RESERVED3 = 13;
  DEVICE_STATUS_RESERVED4 = 14;
}

GetConfig

Get the status configuration of a device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
Response
Parameter Type Description
config StatusConfig The status configuration of the device

SetConfig

Change the status configuration of a device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
config StatusConfig The status configuration to be written to the device

SetConfigMulti

Change the status configurations of multiple devices.

Request
Parameter Type Description
deviceIDs uint32[] The IDs of the devices
config StatusConfig The status configuration to be written to the devices