Smart Home SensorState Trait Schema

action.devices.traits.SensorState - This trait covers both quantitative measurement and qualitative state.

Device ATTRIBUTES

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

See Supported Sensors for more details on the different capabilities and sensor types this trait supports.

Examples

Sensor device that reports descriptive state value.

{
  "sensorStatesSupported": [
    {
      "name": "AirQuality",
      "descriptiveCapabilities": {
        "availableStates": [
          "healthy",
          "moderate",
          "unhealthy",
          "very unhealthy"
        ]
      }
    }
  ]
}

Sensor device that reports numeric state value.

{
  "sensorStatesSupported": [
    {
      "name": "CarbonMonoxideLevel",
      "numericCapabilities": {
        "rawValueUnit": "PARTS_PER_MILLION"
      }
    }
  ]
}

Sensor device that reports descriptive and numeric state value.

{
  "sensorStatesSupported": [
    {
      "name": "SmokeLevel",
      "numericCapabilities": {
        "rawValueUnit": "PARTS_PER_MILLION"
      },
      "descriptiveCapabilities": {
        "availableStates": [
          "smoke detected",
          "high",
          "no smoke detected"
        ]
      }
    }
  ]
}

Supported Sensors

The following tables list the supported sensor types and their associated capabilities.

Air quality

Carbon monoxide

Smoke level

Filter cleanliness

Water leak

Rain detection

Filter lifetime

Computed filter lifetime

Carbon dioxide level

Particulate matter

Volatile organic compounds

Device STATES

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

See Supported Sensors for more details on the different capabilities and sensor types this trait supports.

Examples

Sensor device that reports descriptive state value.

{
  "currentSensorStateData": [
    {
      "name": "AirQuality",
      "currentSensorState": "healthy"
    }
  ]
}

Sensor device that reports numeric state value.

{
  "currentSensorStateData": [
    {
      "name": "CarbonMonoxideLevel",
      "rawValue": 200
    }
  ]
}

Sensor device that reports descriptive and numeric state value.

{
  "currentSensorStateData": [
    {
      "name": "SmokeLevel",
      "currentSensorState": "smoke detected",
      "rawValue": 200
    }
  ]
}

Device COMMANDS

None.

Device NOTIFICATIONS

Devices with this trait may return the following notification payload as part of a device state change. To learn more about implementing notifications, see Notifications for smart home Actions.

The notification payload can contain the following sensor types:

• AirQuality
• CarbonMonoxideLevel
• SmokeLevel
• FilterCleanliness
• WaterLeak
• RainDetection
• FilterLifeTime

See Supported Sensors for more details on the different capabilities supported by each sensor type.

Examples

The detects smoke.

{
  "SensorState": {
    "priority": 0,
    "name": "SmokeLevel",
    "currentSensorState": "high"
  }
}

Device ERRORS