Smart Home StatusReport Trait Schema

action.devices.traits.StatusReport - This trait reports the current status of a specific device or a connected group of devices.

A specific device can report its current status as well as the status of any related devices in a group. For example, the target device could be a security system with the related devices representing individual sensors. StatusReport serves as an aggregation for reporting collective status, but does not replace individual addressing. Any device that can be accessed by Google Assistant should be reported as a separate device in the SYNC response.

Device ATTRIBUTES

None.

Device STATES

Devices with this trait may report the following states as part of the QUERY operation. To learn more about handling QUERY intents, see Intent fulfillment.

States Type Description
currentStatusReport Array

Required.

Current error or exception statuses of the device and any related device IDs.

[item, ...] Object

Current status.

blocking Boolean

True if the error or current status is blocking further commands executions.

deviceTarget String

The ID of the target device.

priority Integer

Specifies the priority of this status. The lower the value, the higher the priority, with the highest priority being 0. Google reports the error or exception status from the highest to lowest priority. Depending on the surface, Google may report only high priority errors or exceptions.

statusCode String

The current status of the device. See the full list of errors and exceptions.

Examples

Is my security system ok?

{
  "currentStatusReport": [
    {
      "blocking": false,
      "deviceTarget": "alarm_1",
      "priority": 0,
      "statusCode": "lowBattery"
    },
    {
      "blocking": false,
      "deviceTarget": "front_window_1",
      "priority": 1,
      "statusCode": "deviceOpen"
    },
    {
      "blocking": false,
      "deviceTarget": "back_window_2",
      "priority": 1,
      "statusCode": "deviceOpen"
    },
    {
      "blocking": true,
      "deviceTarget": "alarm_2",
      "priority": 0,
      "statusCode": "needsSoftwareUpdate"
    }
  ]
}

Device COMMANDS

None.

Device ERRORS

See the full list of errors and exceptions.