githubEdit

Create a Climate Preset

Creates a climate preset for a specified thermostatarrow-up-right.

Creates a climate preset for a specified thermostat.

Code:

await seam.thermostats.createClimatePreset({
  device_id: "ba9b816d-c255-46b9-a16d-971e6f535dd3",
  manual_override_allowed: true,
  climate_preset_key: "Occupied",
  name: "Occupied",
  fan_mode_setting: "auto",
  hvac_mode_setting: "heat_cool",
  cooling_set_point_celsius: 25,
  heating_set_point_celsius: 20,
});

Output:

// void
chevron-rightAuthentication Methodshashtag
  • API key

  • Client session token

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

To learn more, see Authenticationarrow-up-right.

Request Parameters

climate_preset_key String (Required)

Unique key to identify the climate preset.


device_id String (Required)

ID of the thermostat device for which you want create a climate preset.


climate_preset_mode String

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.


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.


ecobee_metadata Object

Metadata specific to the Ecobee climate, if applicable.

chevron-rightclimate_ref Stringhashtag

Reference to the Ecobee climate, if applicable.


chevron-rightis_optimized Booleanhashtag

Indicates if the climate preset is optimized by Ecobee.


chevron-rightowner Enumhashtag

Indicates whether the climate preset is owned by the user or the system.

Enum values:

  • user

  • system


fan_mode_setting String

Desired fan mode settingarrow-up-right, 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 String

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


manual_override_allowed Boolean

Indicates whether a person at the thermostat or using the API can change the thermostat's settings.

circle-exclamation

name String

User-friendly name to identify the climate preset.


Response

circle-check

Last updated

Was this helpful?