Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 3.22 KB

set-to-heat-cool-auto-mode.md

File metadata and controls

66 lines (55 loc) · 3.22 KB
layout
title description tableOfContents outline pagination
visible
true
visible
visible
true
visible
true
visible
true

Set to Heat-Cool (Auto) Mode

Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see HVAC Mode Constraints and Set Point Constraints.

{% swagger src="https://connect.getseam.com/openapi.json" path="/thermostats/heat_cool" method="post" %} https://connect.getseam.com/openapi.json {% endswagger %}

Code Example

{% tabs %} {% tab title="Curl" %}

curl --request POST 'https://connect.getseam.com/thermostats/heat_cool' \
--header 'Authorization: Bearer ${API_KEY}' \
--header 'Content-Type: application/json' \
--header 'Seam-Workspace: 00000000-0000-0000-0000-000000000000' \
--data-raw '{
  "device_id": "11111111-1111-1111-1111-111111111111",
  "cooling_set_point_celsius": 25,
  "heating_set_point_celsius": 20
 }'

{% endtab %} {% endtabs %}

Parameters

device_idtype: stringID of the Device of the thermostat
cooling_set_point_celsiustype: number
Optional
Temperature the thermostat should cool to (in °C). You must set one of the cooling_set_point parameters.
cooling_set_point_fahrenheittype: number
Optional
Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.
heating_set_point_celsiustype: number
Optional
Temperature the thermostat should heat to (in °C).
You must set one of the heating_set_point parameters.
heating_set_point_fahrenheittype: number
Optional
Temperature the thermostat should heat to (in °F).
You must set one of the heating_set_point parameters.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

{% tabs %} {% tab title="JSON" %}

{
  "action_attempt": {
    "status": "pending",
    "action_type": "SET_HEAT_COOL",
    "action_attempt_id": "22222222-2222-2222-2222-222222222222",
    "result": null,
    "error": null
  },
  "ok": true
}

{% endtab %} {% endtabs %}