ThermostatTemperatureSetpoint Schema

sdm.devices.traits.ThermostatTemperatureSetpoint

This trait belongs to device types of THERMOSTAT that support setting target temperature and temperature range.

Fields

Field Description Data Type
heatCelsius Target temperature in Celsius for thermostat HEAT and HEATCOOL modes. number
Example: 20.0
coolCelsius Target temperature in Celsius for thermostat COOL and HEATCOOL modes. number
Example: 22.0

Sample GET request and response - HEAT

Request

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

Response

{
  "name" : "enterprises/project-id/devices/device-id",
  "traits" : {
    "sdm.devices.traits.ThermostatTemperatureSetpoint" : {
      "heatCelsius" : 20.0,
    }
  }
}

Sample GET request and response - COOL

Request

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

Response

{
  "name" : "enterprises/project-id/devices/device-id",
  "traits" : {
    "sdm.devices.traits.ThermostatTemperatureSetpoint" : {
      "coolCelsius" : 22.0
    }
  }
}

Sample GET request and response - HEATCOOL

Request

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

Response

{
  "name" : "enterprises/project-id/devices/device-id",
  "traits" : {
    "sdm.devices.traits.ThermostatTemperatureSetpoint" : {
      "heatCelsius" : 20.0,
      "coolCelsius" : 22.0
    }
  }
}

Commands

The thermostat must be in the mode that corresponds to the command being called prior to changing the temperature setpoints. The command and field(s) to change the setpoint(s) varies by thermostat mode.

For example, to issue the SetHeat command, the thermostat must be in HEAT mode first:

Mode Command Field(s)
HEAT SetHeat heatCelsius
COOL SetCool coolCelsius
HEATCOOL SetRange heatCelsius, coolCelsius

Note that the setpoint commands only take degrees in Celsius as a parameter, though the Google Nest Thermostat can display temperature in either degrees Celsius or Fahrenheit.

SetHeat

Sets the target temperature when the thermostat is in HEAT mode.

SetHeat request and response

Request

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.ThermostatTemperatureSetpoint.SetHeat",
  "params" : {
    "heatCelsius" : 22.0
  }
}

Response

{}

SetHeat request fields

Field Description Data Type
heatCelsius The target temperature to set when the thermostat is in HEAT mode. number
Example: 22.0

SetCool

Sets the target temperature when the thermostat is in COOL mode.

SetCool request and response

Request

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.ThermostatTemperatureSetpoint.SetCool",
  "params" : {
    "coolCelsius" : 20.0
  }
}

Response

{}

SetCool request fields

Field Description Data Type
coolCelsius The target temperature to set when the thermostat is in COOL mode. number
Example: 20.0

SetRange

Sets the minimum and maximum temperatures when the thermostat is in HEATCOOL mode.

SetRange request and response

Request

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.ThermostatTemperatureSetpoint.SetRange",
  "params" : {
    "heatCelsius" : 20.0,
    "coolCelsius" : 22.0
  }
}

Response

{}

SetRange request fields

Field Description Data Type
heatCelsius The minimum target temperature to set when the thermostat is in HEATCOOL mode. number
Example: 20.0
coolCelsius The maximum target temperature to set when the thermostat is in HEATCOOL mode. number
Example: 22.0

Errors

The following error code(s) may be returned in relation to this trait:

Error Message RPC Troubleshooting
Command not allowed in current thermostat mode. FAILED_PRECONDITION Certain commands are not applicable in certain thermostat modes.
Cool value must be greater than heat value. INVALID_ARGUMENT Make sure that the heatCelsius field is less than the coolCelsius field in your command.
Command not allowed when thermostat in MANUAL_ECO mode. FAILED_PRECONDITION The temperature setpoint cannot be set when the thermostat is in manual Eco mode.

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