Skip to content
Merged
128 changes: 64 additions & 64 deletions docs/guides/SUMMARY.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can use [Seam Console](../../../core-concepts/seam-console/) or the [Seam AP
1. Log in to [Seam Console](https://console.seam.co/).
2. In the upper-left corner, click the workspace switcher and select or create a [workspace](../../../core-concepts/workspaces/).

To connect a real access system to Seam, use a production workspace. To use one of Seam's [virtual access systems](../../../device-guides/sandbox-and-sample-data/), use a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces).
To connect a real access system to Seam, use a production workspace. To use one of Seam's [virtual access systems](../../../developer-tools/sandbox-and-sample-data/), use a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces).

![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../.gitbook/assets/workspace-switcher.png)
3. In the top navigation pane, click **ACS Systems**.
Expand All @@ -22,7 +22,7 @@ You can use [Seam Console](../../../core-concepts/seam-console/) or the [Seam AP

<figure><img src="../../../.gitbook/assets/salto webview.webp.png" alt="Use a Connect Webview to connect your access system to Seam."><figcaption><p>Use a Connect Webview to connect your access system to Seam.</p></figcaption></figure>

If you want to connect a virtual access system to a sandbox workspace, use the corresponding [sandbox access system credentials](../../../device-guides/sandbox-and-sample-data/).
If you want to connect a virtual access system to a sandbox workspace, use the corresponding [sandbox access system credentials](../../../developer-tools/sandbox-and-sample-data/).

To connect a real access system, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS to learn any brand- or system-specific prerequisites, requirements, and restrictions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,29 +30,29 @@ Time-bound access codes are suitable for temporary access, like guest visits or

### Offline Access Codes

Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. Currently, Seam supports offline access codes for [igloohome locks](../../../device-guides/igloohome-locks.md), [dormakaba Oracode locks](../../../device-guides/dormakaba-oracode-locks.md), and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/). For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. Currently, Seam supports offline access codes for [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/), [dormakaba Oracode locks](../../../device-and-system-integration-guides/dormakaba-oracode-locks/), and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/). For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.

{% hint style="info" %}
You cannot modify a created offline access code. In addition, you cannot revoke a created offline access code before the configured expiration date for the code. To invalidate an offline access code before the expiration date, you must either perform a factory reset on the device or re-pair your smartphone with the device.
{% endhint %}

Seam supports two types of offline access codes: [time-bound](./#time-bound-offline-access-codes) and [one-time-use](./#one-time-use-offline-access-codes). Note that this support varies based on the device manufacturer. Before creating an offline access code, it is imperative to understand any manufacturer- or device-specific constraints, such as the maximum number of access codes, any time slot or activation requirements, and so on. For details, see the corresponding device guide.

* [igloohome Locks device guide](../../../device-guides/igloohome-locks.md)
* [dormakaba Oracode Locks device guide](../../../device-guides/dormakaba-oracode-locks.md)
* [igloohome Locks device guide](../../../device-and-system-integration-guides/igloohome-locks/)
* [dormakaba Oracode Locks device guide](../../../device-and-system-integration-guides/dormakaba-oracode-locks/)
* [Lockly Locks device guide](../../../device-and-system-integration-guides/lockly-locks/)

#### Time-Bound Offline Access Codes

For [igloohome locks](../../../device-guides/igloohome-locks.md) and [dormakaba Oracode locks](../../../device-guides/dormakaba-oracode-locks.md), you can create time-bound offline access codes with validity durations at either the hour level or the day level. For [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create generic time-bound offline access codes that do not differentiate between hourly-bound and daily-bound codes.
For [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/) and [dormakaba Oracode locks](../../../device-and-system-integration-guides/dormakaba-oracode-locks/), you can create time-bound offline access codes with validity durations at either the hour level or the day level. For [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create generic time-bound offline access codes that do not differentiate between hourly-bound and daily-bound codes.

Hourly-bound offline access codes are intended for shorter durations, while daily-bound offline codes are intended for longer durations. Device manufacturers set the bounds for these short- and long-term access codes, and some device manufacturers enforce a maximum duration for hourly-bound offline access codes. See the corresponding device guide for more information.

To [create a time-bound offline access code](offline-access-codes.md#creating-time-bound-offline-access-codes), specify the desired `starts_at` and `ends_at` date and time. To [create a daily-bound offline access code](offline-access-codes.md#program-a-daily-bound-offline-access-code), you must specify the same time in the `starts_at` and `ends_at` properties.

#### One-Time-Use Offline Access Codes

For [igloohome locks](../../../device-guides/igloohome-locks.md) and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create [one-time-use offline access codes](offline-access-codes.md#creating-one-time-use-offline-access-codes). igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. Lockly offline access codes are valid for the time period that you specify using the `starts_at` and `ends_at` timestamps. These codes expire after a single use.
For [igloohome locks](../../../device-and-system-integration-guides/igloohome-locks/) and [Lockly locks](../../../device-and-system-integration-guides/lockly-locks/), you can create [one-time-use offline access codes](offline-access-codes.md#creating-one-time-use-offline-access-codes). igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. Lockly offline access codes are valid for the time period that you specify using the `starts_at` and `ends_at` timestamps. These codes expire after a single use.

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,9 +285,9 @@ Once an unmanaged code is successfully converted to a managed code, all of the n

Some third-party device providers strictly limit the information available about existing access codes on a device. Thus, for devices connected using these providers, we cannot convert unmanaged codes to managed ones. The following providers currently do not support conversion:

* [igloohome](../../../device-guides/igloohome-locks.md)
* [igloohome](../../../device-and-system-integration-guides/igloohome-locks/)
* [Kwikset](../../../device-and-system-integration-guides/kwikset-locks.md)
* [SmartThings](../../../device-guides/get-started-with-smartthings-hubs-+-smart-locks.md)
* [SmartThings](../../../device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md)

For SmartThings devices, you can still see a list of all unmanaged codes on the devices using the `GET /access_codes/unmanaged/list` endpoint, but you cannot see the actual PIN code for the access codes (the `code` property is not present).

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/capability-guides/thermostats/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ For detailed information about these capabilities, see [Device and System Capabi

Seam supports integration with the following smart thermostat manufacturers:

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td><strong>ecobee Thermostats</strong></td><td></td><td></td><td><a href="../../device-guides/ecobee-thermostats.md">ecobee-thermostats.md</a></td><td><a href="../../.gitbook/assets/ecobee-logo.png">ecobee-logo.png</a></td></tr><tr><td></td><td><strong>Google Nest Thermostats</strong></td><td></td><td></td><td><a href="../../device-guides/google-nest-thermostats/">google-nest-thermostats</a></td><td><a href="../../.gitbook/assets/nest-logo.png">nest-logo.png</a></td></tr><tr><td></td><td><strong>Honeywell Resideo Thermostats</strong></td><td></td><td></td><td><a href="../../device-and-system-integration-guides/honeywell-thermostats/">honeywell-thermostats</a></td><td><a href="../../.gitbook/assets/honeywell_logo.png">honeywell_logo.png</a></td></tr><tr><td></td><td><strong>Sensi Thermostats</strong></td><td></td><td></td><td><a href="broken-reference/">broken-reference</a></td><td><a href="../../.gitbook/assets/sensi-logo.png">sensi-logo.png</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td><strong>ecobee Thermostats</strong></td><td></td><td></td><td><a href="../../device-and-system-integration-guides/ecobee-thermostats.md">ecobee-thermostats.md</a></td><td><a href="../../.gitbook/assets/ecobee-logo.png">ecobee-logo.png</a></td></tr><tr><td></td><td><strong>Google Nest Thermostats</strong></td><td></td><td></td><td><a href="../../device-and-system-integration-guides/google-nest-thermostats/">google-nest-thermostats</a></td><td><a href="../../.gitbook/assets/nest-logo.png">nest-logo.png</a></td></tr><tr><td></td><td><strong>Honeywell Resideo Thermostats</strong></td><td></td><td></td><td><a href="../../device-and-system-integration-guides/honeywell-thermostats/">honeywell-thermostats</a></td><td><a href="../../.gitbook/assets/honeywell_logo.png">honeywell_logo.png</a></td></tr><tr><td></td><td><strong>Sensi Thermostats</strong></td><td></td><td></td><td><a href="broken-reference/">broken-reference</a></td><td><a href="../../.gitbook/assets/sensi-logo.png">sensi-logo.png</a></td></tr></tbody></table>

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Seam's suite of `simulate` endpoints help you to test your thermostat app agains
* [`/thermostats/simulate/hvac_mode_adjusted`](testing-your-thermostat-app-with-simulate-endpoints.md#simulate-adjusting-the-hvac-mode)
* [`/thermostats/simulate/temperature_reached`](testing-your-thermostat-app-with-simulate-endpoints.md#simulate-reaching-a-desired-temperature)

Seam supports these endpoints for all thermostat [sandbox devices](../../device-guides/sandbox-and-sample-data/).
Seam supports these endpoints for all thermostat [sandbox devices](../../developer-tools/sandbox-and-sample-data/).

{% hint style="info" %}
Seam provides additional `simulate` endpoints to help you [test your app against device disconnection and removal](../../core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md).
Expand Down
Loading
Loading