Thermostats

Events

thermostat.climate_preset_activated

A thermostat climate preset was activated.

Properties

climate_preset_key String

Key of the climate preset that was activated.

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: thermostat.climate_preset_activated

is_fallback_climate_preset Boolean

Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.

occurred_at Datetime

Date and time at which the event occurred.

thermostat_schedule_id UUID

ID of the thermostat schedule that prompted the climate preset to be activated.

workspace_id UUID

ID of the workspace.

---

thermostat.manually_adjusted

A thermostat was adjusted manually.

Properties

connected_account_id UUID

ID of the connected account.

cooling_set_point_celsius Number

Temperature to which the thermostat should cool (in °C). See also Set Points.

cooling_set_point_fahrenheit Number

Temperature to which the thermostat should cool (in °F). See also Set Points.

created_at Datetime

Date and time at which the event was created.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: thermostat.manually_adjusted

fan_mode_setting Enum

Desired fan mode setting, such as on, auto, or circulate.

heating_set_point_celsius Number

Temperature to which the thermostat should heat (in °C). See also Set Points.

heating_set_point_fahrenheit Number

Temperature to which the thermostat should heat (in °F). See also Set Points.

hvac_mode_setting Enum

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

method Enum

Method used to adjust the thermostat manually. seam indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace.

---

thermostat.temperature_threshold_exceeded

A thermostat's temperature reading exceeded the set threshold.

Properties

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: thermostat.temperature_threshold_exceeded

lower_limit_celsius Number

Lower temperature limit, in °C, defined by the set threshold.

lower_limit_fahrenheit Number

Lower temperature limit, in °F, defined by the set threshold.

occurred_at Datetime

Date and time at which the event occurred.

temperature_celsius Number

Temperature, in °C, reported by the thermostat.

temperature_fahrenheit Number

Temperature, in °F, reported by the thermostat.

upper_limit_celsius Number

Upper temperature limit, in °C, defined by the set threshold.

upper_limit_fahrenheit Number

Upper temperature limit, in °F, defined by the set threshold.

workspace_id UUID

ID of the workspace.

---

thermostat.temperature_threshold_no_longer_exceeded

A thermostat's temperature reading no longer exceeds the set threshold.

Properties

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: thermostat.temperature_threshold_no_longer_exceeded

lower_limit_celsius Number

Lower temperature limit, in °C, defined by the set threshold.

lower_limit_fahrenheit Number

Lower temperature limit, in °F, defined by the set threshold.

occurred_at Datetime

Date and time at which the event occurred.

temperature_celsius Number

Temperature, in °C, reported by the thermostat.

temperature_fahrenheit Number

Temperature, in °F, reported by the thermostat.

upper_limit_celsius Number

Upper temperature limit, in °C, defined by the set threshold.

upper_limit_fahrenheit Number

Upper temperature limit, in °F, defined by the set threshold.

workspace_id UUID

ID of the workspace.

---

thermostat.temperature_reached_set_point

A thermostat's temperature reading is within 1 °C of the configured cooling or heating set point.

Properties

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

desired_temperature_celsius Number

Desired temperature, in °C, defined by the thermostat's cooling or heating set point.

desired_temperature_fahrenheit Number

Desired temperature, in °F, defined by the thermostat's cooling or heating set point.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: thermostat.temperature_reached_set_point

occurred_at Datetime

Date and time at which the event occurred.

temperature_celsius Number

Temperature, in °C, reported by the thermostat.

temperature_fahrenheit Number

Temperature, in °F, reported by the thermostat.

workspace_id UUID

ID of the workspace.

---

thermostat.temperature_changed

A thermostat's reported temperature changed by at least 1 °C.

Properties

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: thermostat.temperature_changed

occurred_at Datetime

Date and time at which the event occurred.

temperature_celsius Number

Temperature, in °C, reported by the thermostat.

temperature_fahrenheit Number

Temperature, in °F, reported by the thermostat.

workspace_id UUID

ID of the workspace.

---

Endpoints

/thermostats/activate_climate_preset

Activates a specified climate preset for a specified thermostat.

/thermostats/cool

Sets a specified thermostat to cool mode.

/thermostats/create_climate_preset

Creates a climate preset for a specified thermostat.

/thermostats/delete_climate_preset

Deletes a specified climate preset for a specified thermostat.

/thermostats/heat

Sets a specified thermostat to heat mode.

/thermostats/heat_cool

Sets a specified thermostat to heat-cool ("auto") mode.

/thermostats/list

Returns a list of all thermostats.

/thermostats/off

Sets a specified thermostat to "off" mode.

/thermostats/set_fallback_climate_preset

Sets a specified climate preset as the "fallback" preset for a specified thermostat.

/thermostats/set_fan_mode

Sets the fan mode setting for a specified thermostat.

/thermostats/set_hvac_mode

Sets the HVAC mode for a specified thermostat.

/thermostats/set_temperature_threshold

Sets a temperature threshold for a specified thermostat. Seam emits a thermostat.temperature_threshold_exceeded event and adds a warning on a thermostat if it reports a temperature outside the threshold range.

/thermostats/update_climate_preset

Updates a specified climate preset for a specified thermostat.

/thermostats/update_weekly_program

Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.