You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: trash/brand-guides/smartthings-hubs-+-smart-locks.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,30 +8,30 @@ description: Guide for using SmartThings hubs + smart locks with Seam
8
8
9
9
[SmartThings Hubs](https://www.samsung.com/fr/smartthings/) are connected to your local network using either Wi-Fi or Ethernet. You pair smart locks to SmartThings hubs using Zigbee or Z-Wave. Them, you can unlock and lock these smart locks remotely, and you can program access codes on them for keyless entry.
10
10
11
-
***
11
+
---
12
12
13
13
## Supported Devices
14
14
15
15
This integration supports the SmartThings hub and door locks paired with it.
16
16
17
17
For detailed information about the SmartThings hubs that Seam supports, see our [SmartThings Supported Devices page](https://www.seam.co/manufacturers/smartthings).
18
18
19
-
***
19
+
---
20
20
21
21
## Supported Features
22
22
23
23
We support the following features:
24
24
25
-
*[Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) on paired smart locks that support this feature
26
-
*[Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on paired smart locks that support this feature
25
+
-[Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) on paired smart locks that support this feature
26
+
-[Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on paired smart locks that support this feature
27
27
28
-
***
28
+
---
29
29
30
30
### Device Provider Key
31
31
32
32
To create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) that enables your users to connect their August devices to Seam, include the `smartthings` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
33
33
34
-
***
34
+
---
35
35
36
36
## Setup Instructions
37
37
@@ -41,7 +41,7 @@ To control SmartThings-connected devices using Seam, you must prompt owners of t
41
41
2. Follow [these instructions](https://www.samsung.com/ca/support/mobile-devices/smartthings-how-to-set-up-your-hub/) to pair your devices to the SmartThings hub.
42
42
3. Note your login credentials for the SmartThings app, and use these credentials to log in to the [Seam Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to add your devices to Seam.
43
43
44
-
***
44
+
---
45
45
46
46
## Brand-Specific Features
47
47
@@ -51,12 +51,12 @@ Note the following SmartThings-specific features:
51
51
52
52
For SmartThings-connected devices, you can report the set of supported access code lengths or the minimum and maximum supported code lengths. For details, see [Report Device Access Code Constraints](https://docs.seam.co/latest/api/access_codes/report_device_constraints).
53
53
54
-
***
54
+
---
55
55
56
56
## Where to Order
57
57
58
58
To order SmartThings hubs, see the Aeotec **Where to buy** page.
59
59
60
60
<tabledata-view="cards"><thead><tr><th></th><th></th><th></th><thdata-hiddendata-card-targetdata-type="content-ref"></th><thdata-hiddendata-card-coverdata-type="files"></th></tr></thead><tbody><tr><td></td><td><strong>Aeotec Where to buy page</strong></td><td></td><td><ahref="https://aeotec.com/where-to-buy/">https://aeotec.com/where-to-buy/</a></td><td><ahref=".gitbook/assets/smartthings-logo.png">smartthings-logo.png</a></td></tr></tbody></table>
Copy file name to clipboardExpand all lines: trash/guides/core-concepts/device-capabilities.md
+6-13Lines changed: 6 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,23 +8,21 @@ For example, a battery-powered door lock with a pin-pad such as Yale Assure woul
8
8
9
9
Seam exposes each capability as a set of APIs. Furthermore, those APIs are standardized across brands for ease of integration.
10
10
11
-
12
-
13
11
.png>)
14
12
15
13
### Capabilities -> Actions, Properties, and Events
16
14
17
15
Each device capability decomposes into 3 sets of affordances: 
18
16
19
-
***Actions** — things you can do to it. 
20
-
***Properties** — the current state of the device.
21
-
***Events** — reports from the device describing state transitions. 
17
+
-**Actions** — things you can do to it. 
18
+
-**Properties** — the current state of the device.
19
+
-**Events** — reports from the device describing state transitions. 
22
20
23
21
For example, the `lock` capability decomposes in the following manner:
24
22
25
-
***Actions:**`UNLOCK` and `LOCK`
26
-
***Properties:** a `locked` status to determine the lock's current status
27
-
***Events:** a list of lock/unlock events logging all of the lock's transitions.
23
+
-**Actions:**`UNLOCK` and `LOCK`
24
+
-**Properties:** a `locked` status to determine the lock's current status
25
+
-**Events:** a list of lock/unlock events logging all of the lock's transitions.
28
26
29
27
### Standardizing Capabilities Across Device Brands
30
28
@@ -36,9 +34,4 @@ For example, some door locks with the `access_codes` capability require differen
36
34
37
35
In those instances, we attempt to handle these differences for you. For example, we will generate and set a pin code of the appropriate length. However, you may wish to set your own code. We let you do so, but it must meet the constraints set by the device.
38
36
39
-
40
-
41
-
42
-
43
37
\[1] This device interaction model leans heavily on the wonderful work done by the [W3C WoT](https://www.w3.org/TR/wot-architecture/#sec-interaction-model).
Copy file name to clipboardExpand all lines: trash/guides/device-guides/hubitat-elevation-hub.md
+34-34Lines changed: 34 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: Guide for using Hubitat Elevation Hubs with Seam
6
6
7
7
This integration uses [Hubitat’s Maker API](https://docs2.hubitat.com/en/apps/maker-api) to make devices connected to a Hubitat Hub available for use with Seam.
8
8
9
-
***
9
+
---
10
10
11
11
## Supported Devices
12
12
@@ -16,73 +16,73 @@ For detailed information about the Hubitat-connected devices that Seam supports,
16
16
17
17
We support the following features:
18
18
19
-
*[Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) for devices with this capability
20
-
*[Programming access codes](../capability-guides/smart-locks/access-codes/) on devices with this capability
19
+
-[Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) for devices with this capability
20
+
-[Programming access codes](../capability-guides/smart-locks/access-codes/) on devices with this capability
21
21
22
-
***
22
+
---
23
23
24
24
### Device Provider Key
25
25
26
26
To create a [Connect Webview](../core-concepts/connect-webviews/) that enables you to connect your Hubitat Hub and devices to Seam, include the `hubitat` device provider key as the `selected_provider` or in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webview](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).
27
27
28
-
***
28
+
---
29
29
30
30
## Setup Instructions
31
31
32
32
To control Hubitat Hub-connected devices using Seam, you must prompt owners of these devices to perform the following steps:
33
33
34
34
### 1. Access the Hubitat Hub Dashboard
35
35
36
-
*[Follow these instructions to get access to the Hubitat Hub's Dashboard.](https://docs2.hubitat.com/getting-started/registration-and-setup)
36
+
-[Follow these instructions to get access to the Hubitat Hub's Dashboard.](https://docs2.hubitat.com/getting-started/registration-and-setup)
37
37
38
38
### 2. Configure the "Type" of the Device
39
39
40
-
* From the Hubitat Hub dashboard, click on "Devices" in the left navigation.
41
-
* In the "Device Information" section, click on "Type", and select the correct device type of the device.
40
+
- From the Hubitat Hub dashboard, click on "Devices" in the left navigation.
41
+
- In the "Device Information" section, click on "Type", and select the correct device type of the device.
42
42
43
43
### 3. Turn on Hub Login Security (IMPORTANT)
44
44
45
45
This prevents other people on the same network as that of the hub from being able to log in to the dashboard and modify your settings.
46
46
47
-
* From the Hubitat Hub dashboard, click on "Settings" in the left navigation
48
-
* In the "Admin Settings" section, click on "Hub Login Security".
49
-
* Click on "Add User"
50
-
* Fill in the form with a username, email, and password, and make sure to save this information somewhere. You'll be using these credentials to log in to your dashboard in the future.
47
+
- From the Hubitat Hub dashboard, click on "Settings" in the left navigation
48
+
- In the "Admin Settings" section, click on "Hub Login Security".
49
+
- Click on "Add User"
50
+
- Fill in the form with a username, email, and password, and make sure to save this information somewhere. You'll be using these credentials to log in to your dashboard in the future.
51
51
52
-
### 4. Adding the Maker API App for Seam access
52
+
### 4. Adding the Maker API App for Seam access
53
53
54
-
* From the Hubitat Hub dashboard, click on "Apps" in the left navigation
55
-
* Click on "Add Built-In App" on the top right corner
56
-
* Click on the "Maker API" app to install it
57
-
* Under the "Security" section:
58
-
* Enable "Allow Access via Remote / Cloud"
59
-
* Disable "Allow Access via Local IP / Address"
60
-
* Under "Select Devices", check the checkboxes of all the devices you want to connect with Seam
61
-
* Under the "Cloud URLS:" section, copy the "Get Device Info" Cloud URL, and save it. You'll be using this URL to connect the hub to Seam.
54
+
- From the Hubitat Hub dashboard, click on "Apps" in the left navigation
55
+
- Click on "Add Built-In App" on the top right corner
56
+
- Click on the "Maker API" app to install it
57
+
- Under the "Security" section:
58
+
- Enable "Allow Access via Remote / Cloud"
59
+
- Disable "Allow Access via Local IP / Address"
60
+
- Under "Select Devices", check the checkboxes of all the devices you want to connect with Seam
61
+
- Under the "Cloud URLS:" section, copy the "Get Device Info" Cloud URL, and save it. You'll be using this URL to connect the hub to Seam.
62
62
63
63
### 5. Adding your account via Seam Connect Webview
64
64
65
65
Use the Cloud URL you collected in the previous step to connect your account.
66
66
67
67
<figure><imgsrc="../.gitbook/assets/Screen Shot 2023-07-06 at 5.19.49 PM (2).png"alt=""width="338"><figcaption></figcaption></figure>
68
68
69
-
***
69
+
---
70
70
71
71
## Where to Order
72
72
73
73
You can purchase Hubitat Hubs from [their website](https://hubitat.com/products). They offer Zigbee and Z-Wave hubs that work in the following regions (with the associated Z-Wave frequencies):
Copy file name to clipboardExpand all lines: trash/guides/reference/help-center/handling-recurring-access-codes.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,16 +20,15 @@ There are three main steps to implementing recurring access codes:
20
20
21
21
1. Create an access code at it's first scheduled "active period"
22
22
2. Set up a webhook for `access_code.removed_from_device`
23
-
3. Whenever an access\_code is deleted, set the access code's starts\_at and ends\_at to the next active period
23
+
3. Whenever an access_code is deleted, set the access code's starts_at and ends_at to the next active period
24
24
25
25
## 1. Create an Access Code at it's First Scheduled "Active Period"
26
26
27
27
First, create an access code at the first "active period". Let's say that the first active period is tomorrow from 9am to 5pm. We'll create an access code the appropriate `starts_at` and `ends_at` time, then we'll save that access code to a user's `recurring_access_code_id` property, as shown below:
## 2. Set up a webhook for `access_code.removed_from_device` 
54
54
55
-
From the [Seam Console](https://console.seam.co/), set up a webhook to handle the `access_code.removed_from_device` event. This event is triggered whenever an access code is fully removed from a device, or at it's ends\_at time. By setting up a webhook, you'll receive an event every time the access code is removed.
55
+
From the [Seam Console](https://console.seam.co/), set up a webhook to handle the `access_code.removed_from_device` event. This event is triggered whenever an access code is fully removed from a device, or at it's ends_at time. By setting up a webhook, you'll receive an event every time the access code is removed.
56
56
57
57
<figure><imgsrc="../../.gitbook/assets/image (2) (1).png"alt=""><figcaption><p>Creating a webhook for access_code.removed_from_device from console.seam.co</p></figcaption></figure>
58
58
59
-
## 3. Whenever an access\_code is deleted, create a new access code with the starts\_at and ends\_at to the next active period
59
+
## 3. Whenever an access_code is deleted, create a new access code with the starts_at and ends_at to the next active period
60
60
61
61
Whenever your webhook endpoint is called to indicate that the access code has been removed, you should create a new access code at the next active period and replace the access code attached to the user.
62
62
63
63
{% tabs %}
64
64
{% tab title="Python" %}
65
+
65
66
```python
66
67
@app.route('/handle_event', methods=['POST'])
67
68
defhandle_event():
68
69
event = request.json["event"]
69
-
70
+
70
71
if event["event_type"] =="access_code.removed_from_device":
71
72
user = get_db_user(recurring_access_code_id=event["access_code_id"])
72
-
73
+
73
74
if user.has_recurring_daily_code:
74
75
# Create a new access code for the next active period
0 commit comments