From 7d40377060c89efa20a2faad9f11994310b1a266 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Thu, 17 Apr 2025 14:17:24 -0700 Subject: [PATCH 1/3] Document max_override_period_minutes null not 0 --- .../thermostats/creating-and-managing-thermostat-schedules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md b/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md index ba25d468a..61a2e8fd8 100644 --- a/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md +++ b/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md @@ -30,7 +30,7 @@ When creating a schedule for a thermostat, you can specify `is_override_allowed` Through these override period settings, the Seam API provides you with the flexibility to customize the thermostat behavior to suit your needs. For example, a multifamily property manager may want to give complete control of the thermostat to a unit's residents as soon as they move into the unit. However, a short-term rental host may want to enforce stricter rules to ensure that their guests are using the associated HVAC system in a reasonable manner. -To allow complete control at the thermostat, set `is_override_allowed` to `true` and `max_override_period_minutes` to `0`. To disable manual overrides entirely, set `is_override_allowed` to `false`. +To allow complete control at the thermostat, set `is_override_allowed` to `true` and `max_override_period_minutes` to `null`. To disable manual overrides entirely, set `is_override_allowed` to `false`. *** From 5135f0f5d2db3a920eaaddf93d139f181a90abe7 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 17 Apr 2025 17:22:24 -0400 Subject: [PATCH 2/3] Update creating-and-managing-thermostat-schedules.md --- .../thermostats/creating-and-managing-thermostat-schedules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md b/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md index 61a2e8fd8..9468d7899 100644 --- a/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md +++ b/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md @@ -10,7 +10,7 @@ Once you have created a set of [climate presets](creating-and-managing-climate-p Each thermostat schedule can contain the following properties: -
PropertyDescription
name(Optional) User-friendly name to identify the thermostat schedule.
climate_preset_key(Required) Key of the climate preset to use for the thermostat schedule.
is_override_allowed(Optional) Indicates whether a person at the thermostat or using the API can change (that is, override) the thermostat's settings from an active scheduled climate preset.
max_override_period_minutesNumber of minutes for which a person at the thermostat or using the API can change (that is, override) the thermostat's settings after the activation of the scheduled climate preset.
Note: If you set this value to 0, the override applies until another climate preset becomes active, that is, the override timeout is disabled.
Default: 0
See also Specifying Manual Override Permissions.
starts_at(Required) Date and time at which the thermostat schedule starts, in ISO 8601 format.
ends_at(Required) Date and time at which the thermostat schedule ends, in ISO 8601 format.
+
PropertyDescription
name(Optional) User-friendly name to identify the thermostat schedule.
climate_preset_key(Required) Key of the climate preset to use for the thermostat schedule.
is_override_allowed(Optional) Indicates whether a person at the thermostat or using the API can change (that is, override) the thermostat's settings from an active scheduled climate preset.
max_override_period_minutesNumber of minutes for which a person at the thermostat or using the API can change (that is, override) the thermostat's settings after the activation of the scheduled climate preset.
Note: If you set this value to null, the override applies until another climate preset becomes active, that is, the override timeout is disabled.
Default: 0
See also Specifying Manual Override Permissions.
starts_at(Required) Date and time at which the thermostat schedule starts, in ISO 8601 format.
ends_at(Required) Date and time at which the thermostat schedule ends, in ISO 8601 format.
*** From b8424f630a0bc8807c0db94f107e544b8709a612 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 23 Apr 2025 15:28:25 -0400 Subject: [PATCH 3/3] Update docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md --- .../thermostats/creating-and-managing-thermostat-schedules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md b/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md index 9468d7899..a3f206934 100644 --- a/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md +++ b/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md @@ -10,7 +10,7 @@ Once you have created a set of [climate presets](creating-and-managing-climate-p Each thermostat schedule can contain the following properties: -
PropertyDescription
name(Optional) User-friendly name to identify the thermostat schedule.
climate_preset_key(Required) Key of the climate preset to use for the thermostat schedule.
is_override_allowed(Optional) Indicates whether a person at the thermostat or using the API can change (that is, override) the thermostat's settings from an active scheduled climate preset.
max_override_period_minutesNumber of minutes for which a person at the thermostat or using the API can change (that is, override) the thermostat's settings after the activation of the scheduled climate preset.
Note: If you set this value to null, the override applies until another climate preset becomes active, that is, the override timeout is disabled.
Default: 0
See also Specifying Manual Override Permissions.
starts_at(Required) Date and time at which the thermostat schedule starts, in ISO 8601 format.
ends_at(Required) Date and time at which the thermostat schedule ends, in ISO 8601 format.
+
PropertyDescription
name(Optional) User-friendly name to identify the thermostat schedule.
climate_preset_key(Required) Key of the climate preset to use for the thermostat schedule.
is_override_allowed(Optional) Indicates whether a person at the thermostat or using the API can change (that is, override) the thermostat's settings from an active scheduled climate preset.
max_override_period_minutesNumber of minutes for which a person at the thermostat or using the API can change (that is, override) the thermostat's settings after the activation of the scheduled climate preset.
Note: If you set this value to null, there is no enforced maximum override period. That is, the override applies until another climate preset becomes active.
Default: null
See also Specifying Manual Override Permissions.
starts_at(Required) Date and time at which the thermostat schedule starts, in ISO 8601 format.
ends_at(Required) Date and time at which the thermostat schedule ends, in ISO 8601 format.
***