Set to Heat Mode
POST /thermostats/heat ⇒ { action_attempt }Sets a specified thermostat to heat mode.
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"
}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",
)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",
}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",
];Request
seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20Response
{
"action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"action_type": "SET_HEAT"
}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-workspaceheader in the request.
Request Parameters
device_id
device_idType: string
Required: Yes
ID of the desired thermostat device.
heating_set_point_celsius
heating_set_point_celsiusType: number
Required: No
Desired heating set point in °C. You must set one of the heating_set_point parameters.
heating_set_point_fahrenheit
heating_set_point_fahrenheitType: number
Required: No
Desired heating set point in °F. You must set one of the heating_set_point parameters.
Return Type
SET_HVAC_MODE
SET_HVAC_MODESetting HVAC mode.
action_attempt_id
action_attempt_idFormat: UUID
The ID of the action attempt.
action_type
action_typeFormat: String
error
errorFormat: Object
result
resultFormat: Object
This object has no properties.
status
statusFormat: Enum
Possible enum values:
successpendingerror
Last updated
Was this helpful?

