Set the HVAC Mode

POST /thermostats/set_hvac_mode ⇒ { action_attempt }

Sets the HVAC mode for a specified thermostat.

JavaScript

Request

await seam.thermostats.setHvacMode({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  hvac_mode_setting: "heat_cool",
  heating_set_point_celsius: 20,
  cooling_set_point_celsius: 25,
});

Response

{
  "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "success",
  "action_type": "SET_HVAC_MODE"
}

Python

Request

seam.thermostats.set_hvac_mode(
    device_id="123e4567-e89b-12d3-a456-426614174000",
    hvac_mode_setting="heat_cool",
    heating_set_point_celsius=20,
    cooling_set_point_celsius=25,
)

Response

ActionAttempt(
    action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
    status="success",
    action_type="SET_HVAC_MODE",
)

Ruby

Request

seam.thermostats.set_hvac_mode(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  hvac_mode_setting: "heat_cool",
  heating_set_point_celsius: 20,
  cooling_set_point_celsius: 25,
)

Response

{
  "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
  "status" => "success",
  "action_type" => "SET_HVAC_MODE",
}

PHP

Request

<?php
$seam->thermostats->set_hvac_mode(
    device_id: "123e4567-e89b-12d3-a456-426614174000",
    hvac_mode_setting: "heat_cool",
    heating_set_point_celsius: 20,
    cooling_set_point_celsius: 25
);

Response

<?php
[
    "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
    "status" => "success",
    "action_type" => "SET_HVAC_MODE",
];

Seam CLI

Request

seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25

Response

{
  "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "success",
  "action_type": "SET_HVAC_MODE"
}

Go

Request

package main

import api "github.com/seamapi/go"

func main() {
	client.Thermostats.SetHvacMode(
		context.Background(),
		api.ThermostatsSetHvacModeRequest{
			DeviceId:               api.String("123e4567-e89b-12d3-a456-426614174000"),
			HvacModeSetting:        api.String("heat_cool"),
			HeatingSetPointCelsius: api.Float64(20),
			CoolingSetPointCelsius: api.Float64(25),
		},
	)
}

Response

api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"}

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

Request Parameters

device_id

Type: string Required: Yes

ID of the desired thermostat device.

---

hvac_mode_setting

Type: string Required: Yes

---

cooling_set_point_celsius

Type: number Required: No

Desired cooling set point in °C. You must set one of the cooling_set_point parameters.

---

cooling_set_point_fahrenheit

Type: number Required: No

Desired cooling set point in °F. You must set one of the cooling_set_point parameters.

---

heating_set_point_celsius

Type: number Required: No

Desired heating set point in °C. You must set one of the heating_set_point parameters.

---

heating_set_point_fahrenheit

Type: number Required: No

Desired heating set point in °F. You must set one of the heating_set_point parameters.

---

Return Type

action_attempt

SET_HVAC_MODE

Setting HVAC mode.

action_attempt_id

Format: UUID

The ID of the action attempt.

---

action_type

Format: String

---

error

Format: Object

message Format: String

type Format: String

---

result

Format: Object

This object has no properties.

---

status

Format: Enum

Possible enum values:

• success

• pending

• error

---