ZeroKey

Device Information

Operations in the Device Information group will provide the last known properties of a given device, even if that device is not currently connected to the network.

Get information about all devices present on the system

Warning: Do not use this for time sensitive retrieval.

The device information is currently snapshotted on an interval

SecurityOAuth2 or ApiKey
Responses
200

Response success

Response Schema: application/json
Array
DeviceID
string

A 6-byte MAC address associated to the device. This is usually the MAC address associated with the radio or Ethernet interface, depending on the particular device.

Position
Array of numbers >= 3 items

A vector representing the last known X, Y, and Z coordinates of the device, respectively. Coordinates are in metres, and may be negative.

Orientation
Array of numbers >= 4 items

A vector representing the W, X, Y, and Z values (respectively) of a normalized quaternion representing the device's orientation.

DeviceFlags
integer

A bitfield integer representing device-specific state information.

AlertState
string

The alert state of a device indicates whether it is currently alarming by flashing it's alarm LED, and exciting its buzzer and vibration motor.

Enum: "off" "active"
FirmwareHash
string

A unique hash identifier that indicates the exact firmware build on an device.

FirmwareVersion
string

The version of the firmware on a device.

DeviceType
string

Indicates whether the device is a gateway device, anchor node, or mobile node. This value is derived from the DeviceFlags bitfield.

Enum: "gateway" "anchor" "mobile"
LastUpdateTime
string <date-time>

The date and time of the last communication from the device.

BatteryLevel
number [ 0 .. 1 ]

The last indicated battery-level as a decimal value between 0..1. This field will be null if the device have not reported its battery level.

LastGatewaySource
string

A URI that specifies the last known network route to a device of the form ZK://{SiteID}::{GatewayID}::{ExternalSource}). ExternalSource may be a UDP end-point for Power-over-Ethernet devices of the form UDP::{Host}:{Port}, or may be a USB connected gateway of the form USB::{DeviceID}.

401

Unauthorized access, invalid credentials were used.

get/devices
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get detailed information about a specific device


Warning: Do not use this for time sensitive retrieval.


The device information is currently snapshotted on an interval




SecurityOAuth2 or ApiKey 
Request 
path Parameters
address
required
string
Address of the device (usually it's MAC address)


 
Responses 
200
Response success


Response Schema: application/json
DeviceID
string
A 6-byte MAC address associated to the device. This is usually the MAC address associated with the radio or Ethernet interface, depending on the particular device.


 
Position
Array of numbers  >= 3 items 
A vector representing the last known X, Y, and Z coordinates of the device, respectively. Coordinates are in metres, and may be negative.


 
Orientation
Array of numbers  >= 4 items 
A vector representing the W, X, Y, and Z values (respectively) of a normalized quaternion representing the device's orientation.


 
DeviceFlags
integer
A bitfield integer representing device-specific state information.


 
AlertState
string
The alert state of a device indicates whether it is currently alarming by flashing it's alarm LED, and exciting its buzzer and vibration motor.


 Enum: "off" "active"  
FirmwareHash
string
A unique hash identifier that indicates the exact firmware build on an device.


 
FirmwareVersion
string
The version of the firmware on a device.


 
DeviceType
string
Indicates whether the device is a gateway device, anchor node, or mobile node. This value is derived from the DeviceFlags bitfield.


 Enum: "gateway" "anchor" "mobile"  
LastUpdateTime
string <date-time> 
The date and time of the last communication from the device.


 
BatteryLevel
number  [ 0 .. 1 ] 
The last indicated battery-level as a decimal value between 0..1. This field will be null if the device have not reported its battery level.


 
LastGatewaySource
string
A URI that specifies the last known network route to a device of the form ZK://{SiteID}::{GatewayID}::{ExternalSource}). ExternalSource may be a UDP end-point for Power-over-Ethernet devices of the form UDP::{Host}:{Port}, or may be a USB connected gateway of the form USB::{DeviceID}.


 
401
Unauthorized access, invalid credentials were used.


404
Resource was not found.


get/devices/{address}
Request samples 
Response samples 
application/json
{
  • "DeviceID": "00:AA:BB:CC:DD:EE",
  • "Position": [
    ],
  • "Orientation": [
    ],
  • "DeviceFlags": 3,
  • "AlertState": "active",
  • "FirmwareHash": "ec95199c",
  • "FirmwareVersion": "0.10.0",
  • "DeviceType": "anchor",
  • "LastUpdateTime": "2019-08-24T14:15:22Z",
  • "BatteryLevel": 0.85,
  • "LastGatewaySource": "ZK://501::3F2504E0-4F89-11D3-9A0C-0305E82C3301::UDP::10.0.0.220:10000"
}
➔ Next to Device Control