Skip to content

Commit 77e011b

Browse files
Document max_override_period_minutes null not 0 (#564)
* Document max_override_period_minutes null not 0 * Update creating-and-managing-thermostat-schedules.md * Update docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md --------- Co-authored-by: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com>
1 parent b620107 commit 77e011b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Once you have created a set of [climate presets](creating-and-managing-climate-p
1010

1111
Each thermostat schedule can contain the following properties:
1212

13-
<table><thead><tr><th width="339">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code></td><td>(Optional) User-friendly name to identify the thermostat schedule.</td></tr><tr><td><code>climate_preset_key</code></td><td>(Required) Key of the climate preset to use for the thermostat schedule.</td></tr><tr><td><code>is_override_allowed</code></td><td>(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.</td></tr><tr><td><code>max_override_period_minutes</code></td><td>Number 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.<br><strong>Note:</strong> If you set this value to <code>0</code>, the override applies until another climate preset becomes active, that is, the override timeout is disabled.<br>Default: <code>0</code><br>See also <a href="creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions">Specifying Manual Override Permissions</a>.</td></tr><tr><td><code>starts_at</code></td><td>(Required) Date and time at which the thermostat schedule starts, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format.</td></tr><tr><td><code>ends_at</code></td><td>(Required) Date and time at which the thermostat schedule ends, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format.</td></tr></tbody></table>
13+
<table><thead><tr><th width="339">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code></td><td>(Optional) User-friendly name to identify the thermostat schedule.</td></tr><tr><td><code>climate_preset_key</code></td><td>(Required) Key of the climate preset to use for the thermostat schedule.</td></tr><tr><td><code>is_override_allowed</code></td><td>(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.</td></tr><tr><td><code>max_override_period_minutes</code></td><td>Number 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.<br><strong>Note:</strong> If you set this value to <code>null</code>, there is no enforced maximum override period. That is, the override applies until another climate preset becomes active.<br>Default: <code>null</code><br>See also <a href="creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions">Specifying Manual Override Permissions</a>.</td></tr><tr><td><code>starts_at</code></td><td>(Required) Date and time at which the thermostat schedule starts, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format.</td></tr><tr><td><code>ends_at</code></td><td>(Required) Date and time at which the thermostat schedule ends, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format.</td></tr></tbody></table>
1414

1515
***
1616

@@ -30,7 +30,7 @@ When creating a schedule for a thermostat, you can specify `is_override_allowed`
3030

3131
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.
3232

33-
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`.
33+
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`.
3434

3535
***
3636

0 commit comments

Comments
 (0)