Skip to content

Commit

Permalink
Merge branch 'main' into thermostat-code-samples
Browse files Browse the repository at this point in the history
  • Loading branch information
razor-x authored Oct 30, 2024
2 parents 1d41c56 + b74b5c0 commit 1739326
Show file tree
Hide file tree
Showing 57 changed files with 4,446 additions and 1,741 deletions.
Binary file modified docs/.gitbook/assets/acs-access-group_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-access-group_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-credential_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.gitbook/assets/acs-credential_latch_dark.png
Binary file not shown.
Binary file removed docs/.gitbook/assets/acs-credential_latch_light.png
Binary file not shown.
Binary file modified docs/.gitbook/assets/acs-credential_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-entrance_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-entrance_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-schedule_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-system_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-system_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-user_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.gitbook/assets/acs-user_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.gitbook/assets/image (26).png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/thermostats-cover-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/thermostats-cover-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 8 additions & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,16 @@
* [Handling System Permissions](capability-guides/mobile-access-in-development/mobile-device-sdks/handling-system-permissions.md)
* [Using Unlock With Tap](capability-guides/mobile-access-in-development/mobile-device-sdks/using-unlock-with-tap.md)
* [🌡️ Thermostats](products/thermostats/README.md)
* [HVAC Mode](products/thermostats/hvac-mode.md)
* [Set Points](products/thermostats/set-points.md)
* [Understanding Thermostat Concepts](capability-guides/thermostats/understanding-thermostat-concepts/README.md)
* [HVAC Mode](capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md)
* [Set Points](capability-guides/thermostats/understanding-thermostat-concepts/set-points.md)
* [Retrieving Thermostats](products/thermostats/retrieving-thermostats.md)
* [Setting and Monitoring Temperature Thresholds](capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md)
* [Setting the Current HVAC and Fan Mode Settings](products/thermostats/configure-current-climate-settings.md)
* [Creating and Managing Climate Presets](capability-guides/thermostats/creating-and-managing-climate-presets/README.md)
* [Setting the Fallback Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md)
* [Activating a Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md)
* [Creating and Managing Climate Schedules](capability-guides/thermostats/creating-and-managing-climate-schedules.md)
* [👂 Noise Sensors](products/noise-sensors/README.md)
* [Configuring Noise Threshold Settings](products/noise-sensors/configure-noise-threshold-settings.md)
* [📡 Seam Bridge](capability-guides/seam-bridge.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/api-clients/devices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `device` object represents a [device](../../core-concepts/devices/) that has

The `device` object has the following properties:

<table><thead><tr><th width="181">Property</th><th width="166.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>device_id</code></td><td>String (UUID)<br><em>Required</em></td><td>Unique identifier for the device.</td></tr><tr><td><code>device_type</code></td><td>String<br><em>Required</em></td><td>Type of the device.</td></tr><tr><td><code>display_name</code></td><td>String<br><em>Required</em></td><td>Display name for the device.</td></tr><tr><td><code>capabilities_supported</code></td><td>Array of strings<br><em>Required</em></td><td>Collection of capabilities that the device supports when connected to Seam.<br>See <a href="./#capabilities_supported-values"><code>capabilities_supported</code> Values</a>.<br><strong>Important:</strong> Superseded by <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">capability flags</a>.</td></tr><tr><td><code>properties</code></td><td><p>Object</p><p><em>Required</em></p></td><td>Properties of the device.<br>See <a href="./#device.properties-properties"><code>device.properties</code> Properties</a>.</td></tr><tr><td><code>location</code></td><td>Object<br><em>Optional</em></td><td>Read-only location information for the device.<br>See <a href="./#location-properties"><code>location</code> Properties</a>.</td></tr><tr><td><code>connected_account_id</code></td><td>String (UUID)<br><em>Required</em></td><td>ID of the <a href="../connected_accounts/">connected account</a> associated with the device.</td></tr><tr><td><code>workspace_id</code></td><td>String (UUID)<br><em>Required</em></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> that contains the device.</td></tr><tr><td><code>errors</code></td><td>Array of objects<br><em>Required</em></td><td><p>Array of errors associated with the device.</p><p>Each error object within the array contains two fields: <code>error_code</code> and <code>message</code>.</p><p><code>error_code</code> is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue.</p><p><code>message</code> provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.<br>See <a href="./#device-error-types">Device Error Types</a>.</p></td></tr><tr><td><code>warnings</code></td><td>Array of objects<br><em>Required</em></td><td><p>Array of warnings associated with the device.</p><p>Each warning object within the array contains two fields: <code>warning_code</code> and <code>message</code>.</p><p><code>warning_code</code> is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue.</p><p><code>message</code> provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.<br>See <a href="./#device-warning-types">Device Warning Types</a>.</p></td></tr><tr><td><code>created_at</code></td><td>String (datetime)<br><em>Required</em></td><td>Date and time at which the device object was created.</td></tr><tr><td><code>is_managed</code></td><td>Boolean<br><em>Required</em></td><td>Indicates whether Seam manages the device.</td></tr><tr><td><code>custom_metadata</code></td><td>JSON object<br><em>Optional</em></td><td><p>Set of <code>custom_metadata</code> for the device.</p><p>Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.</p></td></tr><tr><td><code>can_remotely_unlock</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can perform a <a href="../../products/smart-locks/lock-and-unlock.md">remote unlock operation</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_remotely_lock</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can perform a <a href="../../products/smart-locks/lock-and-unlock.md">remote lock operation</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_program_online_access_codes</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can <a href="../../products/smart-locks/access-codes/">program online access codes</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_program_offline_access_codes</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can <a href="../../products/smart-locks/access-codes/offline-access-codes.md">program offline access codes</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_hvac_heat</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../products/thermostats/hvac-mode.md">heat mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_hvac_cool</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../products/thermostats/hvac-mode.md">cool mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_hvac_heat_cool</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../products/thermostats/hvac-mode.md">heat-cool (auto) mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_turn_off_hvac</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../products/thermostats/hvac-mode.md">off mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr></tbody></table>
<table><thead><tr><th width="181">Property</th><th width="166.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>device_id</code></td><td>String (UUID)<br><em>Required</em></td><td>Unique identifier for the device.</td></tr><tr><td><code>device_type</code></td><td>String<br><em>Required</em></td><td>Type of the device.</td></tr><tr><td><code>display_name</code></td><td>String<br><em>Required</em></td><td>Display name for the device.</td></tr><tr><td><code>capabilities_supported</code></td><td>Array of strings<br><em>Required</em></td><td>Collection of capabilities that the device supports when connected to Seam.<br>See <a href="./#capabilities_supported-values"><code>capabilities_supported</code> Values</a>.<br><strong>Important:</strong> Superseded by <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">capability flags</a>.</td></tr><tr><td><code>properties</code></td><td><p>Object</p><p><em>Required</em></p></td><td>Properties of the device.<br>See <a href="./#device.properties-properties"><code>device.properties</code> Properties</a>.</td></tr><tr><td><code>location</code></td><td>Object<br><em>Optional</em></td><td>Read-only location information for the device.<br>See <a href="./#location-properties"><code>location</code> Properties</a>.</td></tr><tr><td><code>connected_account_id</code></td><td>String (UUID)<br><em>Required</em></td><td>ID of the <a href="../connected_accounts/">connected account</a> associated with the device.</td></tr><tr><td><code>workspace_id</code></td><td>String (UUID)<br><em>Required</em></td><td>ID of the <a href="../../core-concepts/workspaces/">workspace</a> that contains the device.</td></tr><tr><td><code>errors</code></td><td>Array of objects<br><em>Required</em></td><td><p>Array of errors associated with the device.</p><p>Each error object within the array contains two fields: <code>error_code</code> and <code>message</code>.</p><p><code>error_code</code> is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue.</p><p><code>message</code> provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.<br>See <a href="./#device-error-types">Device Error Types</a>.</p></td></tr><tr><td><code>warnings</code></td><td>Array of objects<br><em>Required</em></td><td><p>Array of warnings associated with the device.</p><p>Each warning object within the array contains two fields: <code>warning_code</code> and <code>message</code>.</p><p><code>warning_code</code> is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue.</p><p><code>message</code> provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.<br>See <a href="./#device-warning-types">Device Warning Types</a>.</p></td></tr><tr><td><code>created_at</code></td><td>String (datetime)<br><em>Required</em></td><td>Date and time at which the device object was created.</td></tr><tr><td><code>is_managed</code></td><td>Boolean<br><em>Required</em></td><td>Indicates whether Seam manages the device.</td></tr><tr><td><code>custom_metadata</code></td><td>JSON object<br><em>Optional</em></td><td><p>Set of <code>custom_metadata</code> for the device.</p><p>Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.</p></td></tr><tr><td><code>can_remotely_unlock</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can perform a <a href="../../products/smart-locks/lock-and-unlock.md">remote unlock operation</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_remotely_lock</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can perform a <a href="../../products/smart-locks/lock-and-unlock.md">remote lock operation</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_program_online_access_codes</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can <a href="../../products/smart-locks/access-codes/">program online access codes</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_program_offline_access_codes</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the device can <a href="../../products/smart-locks/access-codes/offline-access-codes.md">program offline access codes</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_hvac_heat</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md">heat mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_hvac_cool</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md">cool mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_hvac_heat_cool</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md">heat-cool (auto) mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr><tr><td><code>can_turn_off_hvac</code></td><td>Boolean<br><em>Optional</em></td><td>Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports <a href="../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md">off mode</a>. See <a href="../../capability-guides/device-and-system-capabilities.md#capability-flags">Capability Flags</a>.</td></tr></tbody></table>

### `capabilities_supported` Values

Expand Down
Loading

0 comments on commit 1739326

Please sign in to comment.