Set Fan Mode

POST /thermostats/set_fan_mode ⇒ { action_attempt }

Sets the fan mode setting for a specified thermostat.

JavaScript

Request

await seam.thermostats.setFanMode({
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  fan_mode_setting: "auto",
});

Response

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

Python

Request

seam.thermostats.set_fan_mode(
    device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto"
)

Response

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

Ruby

Request

seam.thermostats.set_fan_mode(
  device_id: "123e4567-e89b-12d3-a456-426614174000",
  fan_mode_setting: "auto",
)

Response

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

PHP

Request

<?php
$seam->thermostats->set_fan_mode(
    device_id: "123e4567-e89b-12d3-a456-426614174000",
    fan_mode_setting: "auto"
);

Response

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

Seam CLI

Request

seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto"

Response

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

Go

Request

package main

import api "github.com/seamapi/go"

func main() {
	client.Thermostats.SetFanMode(
		context.Background(),
		api.ThermostatsSetFanModeRequest{
			DeviceId:       api.String("123e4567-e89b-12d3-a456-426614174000"),
			FanModeSetting: api.String("auto"),
		},
	)
}

Response

api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_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

Format: UUID Required: Yes

---

fan_mode

Format: Enum Required: No

Possible enum values:

• auto

• on

• circulate

Deprecated. Use fan_mode_setting instead.

---

fan_mode_setting

Format: Enum Required: No

Desired fan mode setting for the thermostat.

Possible enum values:

• auto

• on

• circulate

---

Return Type

action_attempt

SET_FAN_MODE

Setting fan mode.

action_attempt_id

Format: UUID

ID of the action attempt.

---

action_type

Format: Enum

Value: SET_FAN_MODE

---

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

---