Set to Heat Mode

POST /thermostats/heat ⇒ { action_attempt }

Sets a specified thermostat to heat mode.

JavaScript

Request

await seam.thermostats.heat({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  heating_set_point_celsius: 20,
});

Response

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

Python

Request

seam.thermostats.heat(
    device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20
)

Response

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

Ruby

Request

seam.thermostats.heat(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  heating_set_point_celsius: 20,
)

Response

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

PHP

Request

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

Response

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

Seam CLI

Request

seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20

Response

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

Go

Request

package main

import api "github.com/seamapi/go"

func main() {
	client.Thermostats.Heat(
		context.Background(),
		api.ThermostatsHeatRequest{
			DeviceId:               api.String("123e4567-e89b-12d3-a456-426614174000"),
			HeatingSetPointCelsius: api.Float64(20),
		},
	)
}

Response

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

Authentication Methods

• API key

• Client session token

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

Request Parameters

device_id

Format: UUID Required: Yes

ID of the desired thermostat device.

---

heating_set_point_celsius

Format: Number Required: No

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

---

heating_set_point_fahrenheit

Format: 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

ID of the action attempt.

---

action_type

Format: Enum

Value: SET_HVAC_MODE

---

status

Format: Enum

Possible enum values:

• success

• pending

• error

---