When integrating with a provider, Seam adds any information that doesn’t fit nicely into a cross-provider standard field into the provider metadata for a device or system. Provider metadata is an object named as follows on a device or system:
[device or acs_system].properties.[provider]_metadata
Examples of provider metadata include august_metadata, schlage_metadata, and visionline_metadata.
Sometimes provider metadata contains fields where Seam is still coming up with a standard representation, so you can use these fields to “get ahead” of Seam’s standardized implementation.
Do not use [provider]_metadata.model because it is being deprecated and is
likely to be changed or removed in the future.
/devices/get or /devices/list.
Provider metadata is also available in sandbox
workspaces, so if you want to see typical
examples of provider metadata, you can just create a webview and connect
devices in a sandbox workspace to read the properties. const devices = await seam.devices.list()
console.log(devices[0].properties.smartthings_metadata)
/*
{
"model": "0129-8002-0600",
"device_id": "750ed15f-93f2-4ff1-8944-47e93b10f7d6",
"device_name": "Yale Door Lock"
}
*/
curl \
-H 'Authorization: Bearer MY_API_KEY' \
https://connect.getseam.com/devices/list
#{
# "devices": [
# {
# "device_id": "3c196474-d2eb-4e07-b1d0-e2996eeb40d0",
# "device_type": "smartthings_lock",
# "properties": {
# "smartthings_metadata": {
# "model": "0129-8002-0600",
# "device_id": "750ed15f-93f2-4ff1-8944-47e93b10f7d6",
# "device_name": "Yale Door Lock"
# },
# ...
device.properties.august_metadata.
| Property | Description | Typical Value |
|---|
| lock_id | Identifier for lock as stored by August | ”348350520F06446Q940E2F67E21D351A” |
| lock_name | Name for lock, typically named by host | ”Front Door” |
| house_name | House name that the host placed the lock in from the August App or Yale
Access App | ”123 Amy Lane” |
| has_keypad | Boolean indicating whether or not a keypad is paired to the lock, or the
lock has a keypad on it | true |
Schlage metadata is stored on device.properties.schlage_metadata.
| Property | Description | Typical Value |
|---|
| device_id | Id for device as stored by Schlage | ”c7dd9f62-2b3f-4135-b092-160fc1b4179b” |
| device_name | Name given to Schlage device, usually via the host’s app | ”My Door” |
| access_code_length | Length of access codes supported on device. | 4 |
device.properties.smartthings_metadata.
| Property | Description | Typical Value |
|---|
| device_id | Id for device as stored by Smartthings | ”750ed15f-93f2-4ff1-8944-47e93b10f7d6” |
| device_name | Name for device, set in the Smartthings app or from a Smartthings dashboard | ”Front Door” |
device.properties.lockly_metadata.
| Property | Description | Typical Value |
|---|
| device_id | Device Id as stored by Lockly | ”750ed15f93f24ff1894447e93” |
| device_name | Device name as given by Lockly | ”Front Door” |
device.properties.salto_metadata.
| Property | Description | Typical Value |
|---|
| lock_id | Identifier for lock as stored by Salto | |
| customer_reference | Name of the device as given by Installer or User in Salto | ”BACK DOOR” |
| lock_type | Lock type as given by Salto | ”wall_reader” |
| battery_level | Battery level enums as provided by Salto. | ”fresh” |
| locked_state | Locked state as given Salto | ”locked” |
device.properties.genie_metadata.
| Property | Description | Typical Value |
|---|
| device_name | | ”Model 3155D” |
| door_name | | ”Front Door” |
device.properties.brivo_metadata.
| Property | Description | Typical Value |
|---|
| device_name | Name as set by user in Brivo | ”Front Door” |
device.properties.igloo_metadata.
| Property | Description | Typical Value |
|---|
| device_id | Device Id as stored by Igloo | |
| bridge_id | Id of Bridge device stored by Igloo | |
