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.
Attributes | Type | Description |
---|---|---|
sensorStatesSupported |
Array |
Required. Each object represents sensor state capabilities supported by this specific device. Each sensor must have at least a descriptive or numeric capability. Sensors can also report both, in which case the numeric value will be preferred. |
[item, ...] |
Object |
Supported sensor capabilities. |
name |
String |
Required. Supported sensor type. See the Supported Sensors table. |
descriptiveCapabilities |
Object |
A description of the sensor's capabilities. |
availableStates |
Array |
Required. List of the available states for the device. The "unknown" state is implicitly supported when the sensor does not return a value. |
[item, ...] |
String |
Supported descriptive state value. |
numericCapabilities |
Object |
Describes the possible numerical values that the sensor can report. |
rawValueUnit |
String |
Required. Supported numerical unit. |
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
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Supported values:
|
Carbon monoxide
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Supported values:
|
Smoke level
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Supported values:
|
Filter cleanliness
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Not supported. |
Water leak
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Not supported. |
Rain detection
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Not supported. |
Filter lifetime
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Supported values:
|
Supported values:
|
Computed filter lifetime
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Not supported. | Supported values:
|
Carbon dioxide level
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Not supported. | Supported values:
|
Particulate matter
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Not supported. | Supported values:
|
Volatile organic compounds
Name | Descriptive Capabilities | Numeric Capabilities |
---|---|---|
Supported values:
|
Not supported. | Supported values:
|
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 |
---|---|---|
currentSensorStateData |
Array |
Required. List of current sensor states. |
[item, ...] |
Object |
Current sensor state. |
name |
String |
Required. Sensor state name. Matches a value from |
currentSensorState |
String |
Current descriptive state value. Matches a value from |
rawValue |
Number |
Current numeric sensor value. |
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.