-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpaths.yaml
More file actions
157 lines (117 loc) · 6.17 KB
/
paths.yaml
File metadata and controls
157 lines (117 loc) · 6.17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
---
/acs:
title: Access Control Systems (ACS)
description: Systems for managing and monitoring access to physical spaces
overview: |
Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements:
- Who has access
- The entrances to which users have access
- The access schedule for each user and entrance
- The access mechanism—PIN codes, mobile keys, or plastic cards—for each access grant
To grant access using the Seam access control system API, use the following basic process:
1. Create `acs_user`s.
2. Configure access for these users.
For some access control systems, configure the allowed entrances and access schedule. For other systems, use `acs_access_group`s. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access control system.
3. Create `acs_credential`s, which are the digital means of granting access to users, such as PIN codes, mobile keys, and plastic (RFID) cards.
If you are developing a mobile app to provide access for your users, you can also use [Seam's iOS and Android SDKs](https://docs.seam.co/latest/capability-guides/mobile-access/mobile-device-sdks) that pair with the Seam API to create and manage mobile keys.
/acs/users:
title: ACS Users
/acs/encoders/simulate:
title: Encoder Simulations
/phones/simulate:
title: Phone Simulations
/thermostats:
title: Thermostats
resources:
- device
include_groups:
- thermostats
overview: |
## The device Object for Thermostats
- [Properties](./#properties)
- [device.properties](./#device.properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)
Represents a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
You can use the Seam API to perform the following management and monitoring actions for thermostats:
- Monitor current thermostat settings and readings.
- Configure [temperature thresholds](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). If the thermostat reports a temperature outside these thresholds, Seam automatically alerts you.
- Make immediate changes to [thermostat climate settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings), such as the HVAC mode and fan mode.
- [Create](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) and [schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) climate presets, including a fallback climate preset.
- Create daily and weekly [thermostat programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs).
The Seam API represents a thermostat as a `device` resource that includes both basic device properties and thermostat-specific properties.
---
/thermostats/simulate:
title: Thermostat Simulations
/thermostats/schedules:
title: Thermostat Schedules
/noise_sensors:
title: Noise Sensors
include_groups:
- noise_sensors
overview: |
## The device Object for Noise Sensors
- [Properties](./#properties)
- [Endpoints](./#endpoints)
Represents a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).
Noise sensors are devices that measure that sound level in a given area. You can use noise sensors to monitor noise levels remotely and receive notifications when the noise volume is too loud. The Seam API enables you to configure the [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) of a noise sensor and receive events when a disturbance is detected. You can also [simulate triggering a noise threshold](https://docs.seam.co/latest/api/noise_sensors/simulate/trigger_noise_threshold).
The Seam API represents a noise sensor as a `device` resource that includes both basic device properties and noise sensor-specific properties.
---
/noise_sensors/simulate:
title: Noise Sensor Simulations
/access_codes:
title: Access Codes
include_groups:
- locks
- access_codes
/access_codes/unmanaged:
title: Unmanaged Access Codes
include_groups:
- locks
- access_codes
/access_codes/simulate:
title: Access Code Simulations
/access_grants:
title: Access Grants
/access_methods:
title: Access Methods
/spaces:
title: Spaces
/customers:
title: Customers
alpha: "**Early Access Preview.** The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [support@seam.co](mailto:support@seam.co). Expect breaking changes as we refine the design."
/devices/unmanaged:
title: Unmanaged Devices
/devices/simulate:
title: Device Simulations
/action_attempts:
title: Action Attempts
resources:
- action_attempt
/events:
title: Events
resources:
- event
/locks:
title: Locks
resources:
- device
include_groups:
- locks
- access_codes
overview: |
## The device Object for Locks
- [Properties](./#properties)
- [device.properties](./#device.properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)
Represents a [lock](https://docs.seam.co/latest/capability-guides/smart-locks).
The Seam API enables you to control connected smart locks from a wide variety of manufacturers, including locks that provide online and offline [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) programming.
Depending on the smart lock brand and model, actions that you can perform include remote unlock, remote lock, and programming access codes. You can also view a lock's properties, capabilities, and status. Further, you can monitor for unlock and lock events.
See also [Webhooks](https://docs.seam.co/latest/developer-tools/webhooks).
/locks/simulate:
title: Lock Simulations