diff --git a/docs/api-clients/devices/README.md b/docs/api-clients/devices/README.md index 1ee01f25..0e0169b9 100644 --- a/docs/api-clients/devices/README.md +++ b/docs/api-clients/devices/README.md @@ -22,7 +22,7 @@ Superseded by [capability flags](../../capability-guides/device-and-system-capab ### `device.properties` Properties -
Property | Type | Description |
---|---|---|
online | Boolean Required | Indicates whether the device is online. |
accessory_keypad | Object Optional | Accessory keypad state. See accessory_keypad Properties. |
appearance | Object Required | Appearance-related properties, including the read-only name of the device, as seen from the provider API and application. |
model | Object Required | Device model properties. See model Properties. |
has_direct_power | Boolean Optional | Indicates whether the device has direct power. |
battery_level | Number Required | Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. Deprecated. Use device.properties.battery.level instead. |
battery | Object Optional | Device battery properties. See Devicebattery Properties. |
manufacturer | String Optional | Manufacturer of the device. See Device Manufacturers. |
image_url | String (URL) Optional | Image URL for the device or placeholder image URL if a device-specific image is unavailable. |
image_alt_text | String Optional | Alternative text for the device image. |
serial_number | String Optional | Serial number of the device. |
online_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use online access codes for the device. Superseded by the device.properties.can_program_online_access_codes capability flag. |
offline_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use offline access codes for the device. Superseded by the device.properties.can_program_offline_access_codes capability flag. |
locked | Boolean Optional | Indicates whether the device is locked. Applicable to locks. |
keypad_battery | Object Optional | Keypad battery properties. Applicable to locks. |
door_open | Boolean Optional | Indicates whether the door is open. Applicable to locks. |
code_constraints | Array of objects Optional | Constraints on access codes that can be set on the device. Applicable to devices that support access codes. |
supported_code_lengths | Array of numbers Optional | Supported code lengths for the device. For example, |
max_active_codes_supported | Number Optional | Maximum number of codes that can exist on the device at one time. Applicable to devices that support access codes. |
supports_backup_access_code_pool | Boolean Optional | Indicates whether the device supports backup access code pools. Applicable to devices that support access codes. |
temperature_fahrenheit | Number Required | Temperature, measured in Fahrenheit. Applicable to thermostats. |
temperature_celsius | Number Required | Temperature, measured in Celsius. Applicable to thermostats. |
relative_humidity | Number Required | Relative humidity, the amount of moisture in the air compared to the maximum amount of moisture the air can hold at a given temperature. It is a percentage expressed as a number between 0 and 1 , inclusive.Applicable to thermostats. |
available_hvac_mode_settings | Array of enums (strings) | List of the available HVAC modes for the thermostat.
Applicable to thermostats. |
is_heating | Boolean Required | Indicates whether the heating system is currently heating. Applicable to thermostats. |
is_cooling | Boolean Required | Indicates whether the cooling system is currently cooling. Applicable to thermostats. |
is_fan_running | Boolean Required | Indicates whether the fan is currently running. Applicable to thermostats. |
fan_mode_setting | Enum (string) Required | Fan mode of the thermostat.
Applicable to thermostats. |
is_temporary_manual_override_active | Boolean Required | Indicates whether the current thermostat settings differ from the configured current_climate_setting .Applicable to thermostats. |
current_climate_setting | Object Required | Current climate setting for the thermostat. Can only be overridden manually if device.properties.current_climate_setting.manual_override_allowed is true .Applicable to thermostats. See Thermostat climate_setting Properties. | min_cooling_set_point_celsius | Number Required | Minimum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_cooling_set_point_fahrenheit | Number Required | Minimum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_cooling_set_point_celsius | Number Required | Maximum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_cooling_set_point_fahrenheit | Number Required | Maximum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_set_point_celsius | Number Required | Minimum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_heating_set_point_fahrenheit | Number Required | Minimum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_heating_set_point_celsius | Number Required | Maximum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_heating_set_point_fahrenheit | Number Required | Maximum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_cooling_delta_celsius | Number Required | Minimum temperature difference—that is, delta—in degrees Celsius between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
min_heating_cooling_delta_fahrenheit | Number Required | Minimum temperature difference—that is, delta—in degrees Fahrenheit between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
XXX_metadata | Object | Manufacturer-specific metadata for the device, where XXX is the manufacturer. |
Property | Type | Description |
---|---|---|
online | Boolean Required | Indicates whether the device is online. |
accessory_keypad | Object Optional | Accessory keypad state. See accessory_keypad Properties. |
appearance | Object Required | Appearance-related properties, including the read-only name of the device, as seen from the provider API and application. |
model | Object Required | Device model properties. See model Properties. |
has_direct_power | Boolean Optional | Indicates whether the device has direct power. |
battery_level | Number Required | Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. If the device is offline, Seam does not return this property. Deprecated. Use device.properties.battery.level instead. |
battery | Object Optional | Device battery properties. If the device is offline, Seam does not return this property. |
manufacturer | String Optional | Manufacturer of the device. See Device Manufacturers. |
image_url | String (URL) Optional | Image URL for the device or placeholder image URL if a device-specific image is unavailable. |
image_alt_text | String Optional | Alternative text for the device image. |
serial_number | String Optional | Serial number of the device. |
online_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use online access codes for the device. Superseded by the device.properties.can_program_online_access_codes capability flag. |
offline_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use offline access codes for the device. Superseded by the device.properties.can_program_offline_access_codes capability flag. |
locked | Boolean Optional | Indicates whether the device is locked. Applicable to locks. |
keypad_battery | Object Optional | Keypad battery properties. Applicable to locks. |
door_open | Boolean Optional | Indicates whether the door is open. Applicable to locks. |
code_constraints | Array of objects Optional | Constraints on access codes that can be set on the device. Applicable to devices that support access codes. |
supported_code_lengths | Array of numbers Optional | Supported code lengths for the device. For example, |
max_active_codes_supported | Number Optional | Maximum number of codes that can exist on the device at one time. Applicable to devices that support access codes. |
supports_backup_access_code_pool | Boolean Optional | Indicates whether the device supports backup access code pools. Applicable to devices that support access codes. |
temperature_fahrenheit | Number Required | Temperature, measured in Fahrenheit. Applicable to thermostats. |
temperature_celsius | Number Required | Temperature, measured in Celsius. Applicable to thermostats. |
relative_humidity | Number Required | Relative humidity, the amount of moisture in the air compared to the maximum amount of moisture the air can hold at a given temperature. It is a percentage expressed as a number between 0 and 1 , inclusive.Applicable to thermostats. |
available_hvac_mode_settings | Array of enums (strings) | List of the available HVAC modes for the thermostat.
Applicable to thermostats. |
is_heating | Boolean Required | Indicates whether the heating system is currently heating. Applicable to thermostats. |
is_cooling | Boolean Required | Indicates whether the cooling system is currently cooling. Applicable to thermostats. |
is_fan_running | Boolean Required | Indicates whether the fan is currently running. Applicable to thermostats. |
fan_mode_setting | Enum (string) Required | Fan mode of the thermostat.
Applicable to thermostats. |
is_temporary_manual_override_active | Boolean Required | Indicates whether the current thermostat settings differ from the configured current_climate_setting .Applicable to thermostats. |
current_climate_setting | Object Required | Current climate setting for the thermostat. Can only be overridden manually if device.properties.current_climate_setting.manual_override_allowed is true .Applicable to thermostats. See Thermostat climate_setting Properties. |
min_cooling_set_point_celsius | Number Required | Minimum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_cooling_set_point_fahrenheit | Number Required | Minimum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_cooling_set_point_celsius | Number Required | Maximum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_cooling_set_point_fahrenheit | Number Required | Maximum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_set_point_celsius | Number Required | Minimum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_heating_set_point_fahrenheit | Number Required | Minimum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_heating_set_point_celsius | Number Required | Maximum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_heating_set_point_fahrenheit | Number Required | Maximum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_cooling_delta_celsius | Number Required | Minimum temperature difference—that is, delta—in degrees Celsius between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
min_heating_cooling_delta_fahrenheit | Number Required | Minimum temperature difference—that is, delta—in degrees Fahrenheit between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
XXX_metadata | Object | Manufacturer-specific metadata for the device, where XXX is the manufacturer. |
Property | Type | Description |
---|---|---|
can_connect_accessory_keypad | Boolean Optional | Indicates whether the device can connect a accessory keypad. |
display_name | String Required | Display name of the device model. |
manufacturer_display_name | String Required | Display name that corresponds to the manufacturer-specific terminology for the device. |
has_built_in_keypad | Boolean Optional | Indicates whether the device has a built in accessory keypad. |
offline_access_codes_supported | Boolean Optional | Indicates whether the device supports offline access codes. Superseded by the device.properties.can_program_offline_access_codes capability flag. |
online_access_codes_supported | Boolean Optional | Indicates whether the device supports online access codes. Superseded by the device.properties.can_program_online_access_codes capability flag. |
accessory_keypad_supported | Boolean Optional | Indicates whether the device supports an accessory keypad. Deprecated. Use device.properties.model.can_connect_accessory_keypad instead. |
Property | Type | Description |
---|---|---|
can_connect_accessory_keypad | Boolean Optional | Indicates whether the device can connect a accessory keypad. |
display_name | String Required | Display name of the device model. |
manufacturer_display_name | String Required | Display name that corresponds to the manufacturer-specific terminology for the device. |
has_built_in_keypad | Boolean Optional | Indicates whether the device has a built in accessory keypad. |
offline_access_codes_supported | Boolean Optional | Indicates whether the device supports offline access codes. Superseded by the device.properties.can_program_offline_access_codes capability flag. |
online_access_codes_supported | Boolean Optional | Indicates whether the device supports online access codes. Superseded by the device.properties.can_program_online_access_codes capability flag. |
accessory_keypad_supported | Boolean Optional | Indicates whether the device supports an accessory keypad. Deprecated. Use device.properties.model.can_connect_accessory_keypad instead. |
Property | Type | Description |
---|---|---|
level | Number Required | Indicates the battery level of the device as a decimal value between 0 and 1 , inclusive. |
status | Enum (string) Required | Represents the current status of the battery charge level. Values are:
|
Property | Type | Description | hvac_mode_setting | Enum (string) Required | HVAC mode to which the thermostat is set. Possible values:
|
---|---|---|
cooling_set_point_celsius | Number Optional | The cooling set point, measured in Celsius, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on. |
heating_set_point_celsius | Number Optional | The heating set point, measured in Celsius, if heating is turned on. When the ambient temperature drops below this set point, heating turns on. |
cooling_set_point_fahrenheit | Number Optional | The cooling set point, measured in Fahrenheit, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on. |
heating_set_point_fahrenheit | Number Optional | The heating set point, measured in Fahrenheit, if heating is turned on. When the ambient temperature drops below this set point, heating turns on. |
manual_override_allowed | Boolean Required | Indicates whether another user can use the thermostat or API to override this climate setting. |
Property | Type | Description |
---|---|---|
hvac_mode_setting | Enum (string) Required | HVAC mode to which the thermostat is set. Possible values:
|
cooling_set_point_celsius | Number Optional | The cooling set point, measured in Celsius, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on. |
heating_set_point_celsius | Number Optional | The heating set point, measured in Celsius, if heating is turned on. When the ambient temperature drops below this set point, heating turns on. |
cooling_set_point_fahrenheit | Number Optional | The cooling set point, measured in Fahrenheit, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on. |
heating_set_point_fahrenheit | Number Optional | The heating set point, measured in Fahrenheit, if heating is turned on. When the ambient temperature drops below this set point, heating turns on. |
manual_override_allowed | Boolean Required | Indicates whether another user can use the thermostat or API to override this climate setting. |
Constraint Type | Description |
---|---|
no_zeros | 0 s cannot be used as digits in the PIN code. |
cannot_start_with_12 | The PIN code cannot start with the sequence of digits 12 . |
no_triple_consecutive_ints | No more than three digits in a row can be consecutive or the same in the PIN code. |
cannot_specify_pin_code | You cannot specify a PIN code. You must leave the code empty, and the lock provider generates a PIN code. |
pin_code_matches_existing_set | If you specify a PIN code, it must match an existing set of PIN codes used in the account. For example, the PIN code could match the code assigned to a user in the system. |
start_date_in_future | For time-bound codes, the start date must be in the future. |
no_ascending_or_descending_sequence | The PIN code cannot consist of a sequence of consecutive digits. |
at_least_three_unique_digits | The PIN must contain at least three unique digits. |
cannot_contain_089 | The PIN code cannot contain the digits For example, this restriction could apply to a cylinder lock that only includes the digits |
name_length | The name of the code has some restrictions on length. When the |
name_must_be_unique | The name of the code must be unique within the device. |
Constraint Type | Description |
---|---|
no_zeros | 0 s cannot be used as digits in the PIN code. |
cannot_start_with_12 | The PIN code cannot start with the sequence of digits 12 . |
no_triple_consecutive_ints | No more than three digits in a row can be consecutive or the same in the PIN code. |
cannot_specify_pin_code | You cannot specify a PIN code. You must leave the code empty, and the lock provider generates a PIN code. |
pin_code_matches_existing_set | If you specify a PIN code, it must match an existing set of PIN codes used in the account. For example, the PIN code could match the code assigned to a user in the system. |
start_date_in_future | For time-bound codes, the start date must be in the future. |
no_ascending_or_descending_sequence | The PIN code cannot consist of a sequence of consecutive digits. |
at_least_three_unique_digits | The PIN must contain at least three unique digits. |
cannot_contain_089 | The PIN code cannot contain the digits For example, this restriction could apply to a cylinder lock that only includes the digits |
name_length | The name of the code has some restrictions on length. When the |
name_must_be_unique | The name of the code must be unique within the device. |
Property | Type | Description |
---|---|---|
properties.has_direct_power | Boolean | Indicates whether the device has direct power, that is, whether the device is wired |
properties.battery | Object | Battery information, including level and status |
properties.battery.level | Number (0-1) | Battery level of the device as a decimal value between 0 and 1, inclusive |
properties.battery.status | Enum (string) | Current status of the battery charge level. Values are:
|
Property | Type | Description |
---|---|---|
properties.has_direct_power | Boolean | Indicates whether the device has direct power, that is, whether the device is wired |
properties.battery | Object | Battery information, including level and status If the device is offline, Seam does not return this property. |
properties.battery.level | Number (0-1) | Battery level of the device as a decimal value between 0 and 1, inclusive If the device is offline, Seam does not return this property. |
properties.battery.status | Enum (string) | Current status of the battery charge level. Values are:
|
Parameter | Type | Description |
---|---|---|
device_id | String (UUID) | ID of the device for which you want to retrieve device.connected or device.disconnected events |
event_type | String | Event type that you want to retrieve, that is, device.connected or device.disconnected |
since | String | Desired starting event generation date and time You must include since or between . |
between | Set of two strings | Desired starting and ending event generation dates and times For example: ["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"] You must include between or since . |
Parameter | Type | Description |
---|---|---|
device_id | String (UUID) | ID of the device for which you want to retrieve device.connected or device.disconnected events |
event_type | String | Event type that you want to retrieve, that is, device.connected or device.disconnected |
since | String | Desired starting event generation date and time You must include since or between . |
between | Set of two strings | Desired starting and ending event generation dates and times For example: ["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"] You must include between or since . |