Set to Cool Mode

POST /thermostats/cool ⇒ { action_attempt }

Sets a specified thermostat to cool mode.

JavaScript

Request

await seam.thermostats.cool({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  cooling_set_point_celsius: 25,
});

Response

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

Python

Request

seam.thermostats.cool(
    device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25
)

Response

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

Ruby

Request

seam.thermostats.cool(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  cooling_set_point_celsius: 25,
)

Response

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

PHP

Request

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

Response

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

Seam CLI

Request

seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25

Response

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

Go

Request

package main

import api "github.com/seamapi/go"

func main() {
	client.Thermostats.Cool(
		context.Background(),
		api.ThermostatsCoolRequest{
			DeviceId:               api.String("123e4567-e89b-12d3-a456-426614174000"),
			CoolingSetPointCelsius: api.Float64(25),
		},
	)
}

Response

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

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.

---

cooling_set_point_celsius

Format: Number Required: No

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

---

cooling_set_point_fahrenheit

Format: Number Required: No

Desired cooling set point in °F. You must set one of the cooling_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

---