Set the HVAC Mode

• Request Parameters

• Response

Sets the HVAC mode for a specified thermostat.

JavaScript

Sets the HVAC mode for a specified thermostat.

Code:

await seam.thermostats.setHvacMode({
  device_id: "5d5c3b30-5fed-47a3-9df1-ed32f32589e5",
  hvac_mode_setting: "heat_cool",
  heating_set_point_celsius: 20,
  cooling_set_point_celsius: 25,
});

Output:

{
  "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type": "SET_HVAC_MODE",
  "error": null,
  "result": {},
  "status": "success"
}

cURL

Sets the HVAC mode for a specified thermostat.

Code:

curl --include --request POST "https://connect.getseam.com/thermostats/set_hvac_mode" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "5d5c3b30-5fed-47a3-9df1-ed32f32589e5",
  "hvac_mode_setting": "heat_cool",
  "heating_set_point_celsius": 20,
  "cooling_set_point_celsius": 25
}
EOF

Output:

{
  "action_attempt": {
    "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
    "action_type": "SET_HVAC_MODE",
    "error": null,
    "result": {},
    "status": "success"
  }
}

Python

Sets the HVAC mode for a specified thermostat.

Code:

seam.thermostats.set_hvac_mode(
    device_id="5d5c3b30-5fed-47a3-9df1-ed32f32589e5",
    hvac_mode_setting="heat_cool",
    heating_set_point_celsius=20,
    cooling_set_point_celsius=25,
)

Output:

ActionAttempt(
    action_attempt_id="b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
    action_type="SET_HVAC_MODE",
    error=None,
    result={},
    status="success",
)

Ruby

Sets the HVAC mode for a specified thermostat.

Code:

seam.thermostats.set_hvac_mode(
  device_id: "5d5c3b30-5fed-47a3-9df1-ed32f32589e5",
  hvac_mode_setting: "heat_cool",
  heating_set_point_celsius: 20,
  cooling_set_point_celsius: 25,
)

Output:

{
  "action_attempt_id" => "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type" => "SET_HVAC_MODE",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}

PHP

Sets the HVAC mode for a specified thermostat.

Code:

$seam->thermostats->set_hvac_mode(
    device_id: "5d5c3b30-5fed-47a3-9df1-ed32f32589e5",
    hvac_mode_setting: "heat_cool",
    heating_set_point_celsius: 20,
    cooling_set_point_celsius: 25
);

Output:

[
    "action_attempt_id" => "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
    "action_type" => "SET_HVAC_MODE",
    "error" => null,
    "result" => [],
    "status" => "success",
];

Seam CLI

Sets the HVAC mode for a specified thermostat.

Code:

seam thermostats set-hvac-mode --device_id "5d5c3b30-5fed-47a3-9df1-ed32f32589e5" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25

Output:

{
  "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type": "SET_HVAC_MODE",
  "error": null,
  "result": {},
  "status": "success"
}

Authentication Methods

• API key

• Client session token

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

To learn more, see Authentication.

Request Parameters

device_id String (Required)

ID of the thermostat device for which you want to set the HVAC mode.

---

hvac_mode_setting String (Required)

---

cooling_set_point_celsius Number

Cooling set point in °C that you want to set for the thermostat. You must set one of the cooling_set_point parameters.

---

cooling_set_point_fahrenheit Number

Cooling set point in °F that you want to set for the thermostat. You must set one of the cooling_set_point parameters.

---

heating_set_point_celsius Number

Heating set point in °C that you want to set for the thermostat. You must set one of the heating_set_point parameters.

---

heating_set_point_fahrenheit Number

Heating set point in °F that you want to set for the thermostat. You must set one of the heating_set_point parameters.

---

Response

action_attempt

JSON

{
  "action_attempt_id": "b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d",
  "action_type": "SET_HVAC_MODE",
  "error": null,
  "result": {},
  "status": "success"
}