ThermostatHvac Schema

Nest Thermostat 

sdm.devices.traits.ThermostatHvac

This trait belongs to device types of THERMOSTAT that can report HVAC details.

Fields

Field Description Data Type
status Current HVAC status of the thermostat. string
Values: "OFF", "HEATING", "COOLING"

Timing of events

Note that an event for a change in HVAC status may not be delivered at the same time as events for a thermostat mode change.

For example, sometimes there is a delay in starting a thermostat's heating or cooling mode in order to protect the HVAC system. In this scenario, changing the thermostat mode may only initially send events for ThermostatMode and ThermostatTemperatureSetpoint trait changes, with the ThermostatHvac trait change sent later as a separate event once the system actually turns on. If there was no delay in turning on the HVAC system, all three events would be sent at the same time.

Sample GET request and response

Request

GET /enterprises/project-id/devices/device-id

Response

{
  "name" : "enterprises/project-id/devices/device-id",
  "traits" : {
    "sdm.devices.traits.ThermostatHvac" : {
      "status" : "HEATING"
    }
  }
}

Commands

There are no commands available for this trait.

Errors

See the API Error Code Reference for the full list of API error codes.