Skip to main content

The unmanaged_device Object

Represents an unmanaged device. An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any access codes on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.

Properties

can_configure_auto_lock
Boolean
Indicates whether the lock supports configuring automatic locking.
can_hvac_cool
Boolean
Indicates whether the thermostat supports cooling.
can_hvac_heat
Boolean
Indicates whether the thermostat supports heating.
can_hvac_heat_cool
Boolean
Indicates whether the thermostat supports simultaneous heating and cooling.
can_program_offline_access_codes
Boolean
Indicates whether the device supports programming offline access codes.
can_program_online_access_codes
Boolean
Indicates whether the device supports programming online access codes.
can_program_thermostat_programs_as_different_each_day
Boolean
Indicates whether the thermostat supports different climate programs for each day of the week.
can_program_thermostat_programs_as_same_each_day
Boolean
Indicates whether the thermostat supports a single climate program applied to every day.
can_program_thermostat_programs_as_weekday_weekend
Boolean
Indicates whether the thermostat supports weekday/weekend climate programs.
can_remotely_lock
Boolean
Indicates whether the device supports remote locking.
can_remotely_unlock
Boolean
Indicates whether the device supports remote unlocking.
can_run_thermostat_programs
Boolean
Indicates whether the thermostat supports running climate programs.
can_simulate_connection
Boolean
Indicates whether the device supports simulating connection in a sandbox.
can_simulate_disconnection
Boolean
Indicates whether the device supports simulating disconnection in a sandbox.
can_simulate_hub_connection
Boolean
Indicates whether the hub supports simulating connection in a sandbox.
can_simulate_hub_disconnection
Boolean
Indicates whether the hub supports simulating disconnection in a sandbox.
can_simulate_paid_subscription
Boolean
Indicates whether the device supports simulating a paid subscription in a sandbox.
can_simulate_removal
Boolean
Indicates whether the device supports simulating removal in a sandbox.
can_turn_off_hvac
Boolean
Indicates whether the thermostat can be turned off.
can_unlock_with_code
Boolean
Indicates whether the lock supports unlocking with an access code.
capabilities_supported
Array
Collection of capabilities that the device supports when connected to Seam. Values are access_code, which indicates that the device can manage and utilize digital PIN codes for secure access; lock, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; noise_detection, which indicates that the device supports monitoring and responding to ambient noise levels; thermostat, which indicates that the device can regulate and adjust indoor temperatures; battery, which indicates that the device can manage battery life and health; and phone, which indicates that the device is a mobile device, such as a smartphone. Important: Superseded by capability flags.
connected_account_id
String (UUID)
Unique identifier for the account associated with the device.
created_at
String (ISO 8601)
Date and time at which the device object was created.
custom_metadata
Object
Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.
device_id
String (UUID)
ID of the device.
device_type
Enum (String)
Type of the device.
errors
Array
Array of errors associated with the device. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
is_managed
Boolean
Indicates that Seam does not manage the device.
properties
Object
properties of the device.
warnings
Array
Array of warnings associated with the device. Each warning object within the array contains two fields: warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
workspace_id
String (UUID)
Unique identifier for the Seam workspace associated with the device.
location
Object
Location information for the device.

access codes

offline_access_codes_enabled
Boolean
deprecated
Deprecated. use device.can_program_offline_access_codesIndicates whether it is currently possible to use offline access codes for the device.
online_access_codes_enabled
Boolean
deprecated
Deprecated. use device.can_program_online_access_codesIndicates whether it is currently possible to use online access codes for the device.

hardware

accessory_keypad
Object
Accessory keypad properties and state.
battery
Object
Represents the current status of the battery charge level.
battery_level
number
Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
image_alt_text
String
Alt text for the device image.
image_url
String
Image URL for the device.
manufacturer
String
Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.