Skip to content

Device Management

Device Management

Set Company Code

Assigns a device to a company group.

  • Topic: <serial-number>/companycode/save
  • Message: 
    {
  "company_code": "string"
}
  • Example: 
    {
  "company_code": "sekureid"
}

Request Device State

Requests a full status report from the device. The device will publish its state to the /response topic.

  • Request Topic: <company-code>/<serial-number>/devicestate/request
  • Response Topic: <company-code>/<serial-number>/devicestate/response
  • Request Message: (Empty)
  • Response Message Example: 
    {
  "connected": true,
  "lock_state": "Locked",
  "door_state": "NoSensor",
  "message_broker_settings": {
    "message_broker_state": "Connected",
    "ip_address": "broker.example.com",
    "port": "8883",
    "use_tls": true
  },
  "wifi_settings": {
    "wifi_state": "Enabled",
    "ssid": "My-WiFi",
    "ip_configuration": {
      "ip_address": "192.168.1.100",
      "ip_mode": "Dhcp"
    }
  },
  "ethernet_settings": {
    "ethernet_state": "Enabled",
    "ip_configuration": {
      "ip_mode": "Dhcp"
    }
  }
}

Control Lock State

Remotely lock or unlock a door connected to the device.

  • Topic: <company-code>/<serial-number>/server/lockstate/save
  • Note: The device will only honor a request if the message's iso_time is within 10 seconds of the device's current time.
  • Message: 
    {
  "user_id": "string",
  "iso_time": "iso-8601-timestamp",
  "lock_state": "Locked"
}
  • lock_state values: Locked, Unlocked, Lockdown, KeepOpen, UnlockedWithSchedule, UnlockedRequestToExit.