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 20
Response
{
"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
Personal access token
Must also include the seam-workspace header in the request.
Request Parameters
device_id
Type: string
Required: Yes
ID of the desired thermostat device.
heating_set_point_celsius
Type: number
Required: No
Desired heating set point in °C. You must set one of the heating_set_point parameters.
heating_set_point_fahrenheit
Type: 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
The ID of the action attempt.
action_type
Format: String
error
Format: Object
message Format: String
type Format: String
result
Format: Object
This object has no properties.
status
Format: Enum
Possible enum values:
