ADT · JSON Structure

Platform Api Device Structure

A security device (sensor, camera, lock, or smart home device).

Type: object Properties: 7
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Device is a JSON Structure definition published by ADT, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name type status zone batteryLevel lastActivity

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-structure/platform-api-device-structure.json",
  "name": "Device",
  "description": "A security device (sensor, camera, lock, or smart home device).",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the device.",
      "example": "dev-001"
    },
    "name": {
      "type": "string",
      "description": "Display name of the device.",
      "example": "Front Door Sensor"
    },
    "type": {
      "type": "string",
      "description": "Type of device.",
      "enum": [
        "sensor",
        "camera",
        "lock",
        "thermostat",
        "light",
        "doorbell",
        "smoke_detector",
        "flood_sensor"
      ],
      "example": "sensor"
    },
    "status": {
      "type": "string",
      "description": "Current status of the device.",
      "example": "closed"
    },
    "zone": {
      "type": "string",
      "description": "Security zone the device belongs to.",
      "example": "Zone 1 - Entry"
    },
    "batteryLevel": {
      "type": "int32",
      "description": "Battery level percentage (0-100) for battery-powered devices.",
      "example": 85
    },
    "lastActivity": {
      "type": "datetime",
      "description": "Timestamp of last device activity.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}