diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ffc57a8c..23f81bed 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -70,7 +70,6 @@ * [Set Points](products/thermostats/set-points.md) * [Retrieving Thermostats](products/thermostats/retrieving-thermostats.md) * [Setting the Current HVAC and Fan Mode Settings](products/thermostats/configure-current-climate-settings.md) - * [Setting the Default Climate Setting](capability-guides/thermostats/configure-current-climate-settings/setting-the-default-climate-setting.md) * [👂 Noise Sensors](products/noise-sensors/README.md) * [Configuring Noise Threshold Settings](products/noise-sensors/configure-noise-threshold-settings.md) * [📡 Seam Bridge](capability-guides/seam-bridge.md) diff --git a/docs/api-clients/devices/README.md b/docs/api-clients/devices/README.md index 37d23199..f1779c8c 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. |
default_climate_setting | Object Optional | Default climate setting for the thermostat. 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. 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. |
Device ID
status | "success" | "error" | "pending" | success determines a completed action performed on the device.error determines an unsuccessful action performed on the device.pending determines Seam is still trying to perform the action on the device |
action_type | "UPDATE_THERMOSTAT" | Determines the type of action performed on the device |
action_attempt_id | String | ID of the action attempt |
result | String | result only exists for the success status describing the event |
error | Object | error only exists for the error status describing the event. It is an object with type and message . Where type determines type of error and message describes the error |
Command Stub | Description |
---|---|
seam | Access all Seam Online CLI commands in an interactive manner. |
seam access-codes | Manage access codes. |
seam acs | Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials. |
seam action-attempts | List and get action attempts to poll the status of attempted actions, such as unlock and create access code. |
seam client-sessions | Manage client sessions that enable you to restrict users' interactions to include only the devices that they own. |
seam connect-webviews | Manage Connect Webviews that enable users to connect their devices to Seam. |
seam connected-accounts | Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access. |
seam devices | Manage devices, including both "managed" and "unmanaged" devices. |
seam events | Retrieve events. |
seam locks | Retrieve, lock, and unlock smart locks. |
seam login | Log back in to the Seam Online CLI or change your authorization to use a different API key or Personal Access Token. |
seam logout | Log out of the Seam Online CLI. |
seam noise-sensors | Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts. |
seam select | Select the desired workspace or server. |
seam thermostats | Manage thermostats, including current climate settings, default climate settings. |
seam user-identities | Manage user identities that enable you to issue and manage mobile credentials and access permissions for users. |
seam webhooks | Manage webhook endpoints that enable you to receive notifications of Seam-related events. |
seam workspaces | Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces. |
Command Stub | Description |
---|---|
seam | Access all Seam Online CLI commands in an interactive manner. |
seam access-codes | Manage access codes. |
seam acs | Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials. |
seam action-attempts | List and get action attempts to poll the status of attempted actions, such as unlock and create access code. |
seam client-sessions | Manage client sessions that enable you to restrict users' interactions to include only the devices that they own. |
seam connect-webviews | Manage Connect Webviews that enable users to connect their devices to Seam. |
seam connected-accounts | Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access. |
seam devices | Manage devices, including both "managed" and "unmanaged" devices. |
seam events | Retrieve events. |
seam locks | Retrieve, lock, and unlock smart locks. |
seam login | Log back in to the Seam Online CLI or change your authorization to use a different API key or Personal Access Token. |
seam logout | Log out of the Seam Online CLI. |
seam noise-sensors | Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts. |
seam select | Select the desired workspace or server. |
seam thermostats | Manage thermostats, including current climate settings. |
seam user-identities | Manage user identities that enable you to issue and manage mobile credentials and access permissions for users. |
seam webhooks | Manage webhook endpoints that enable you to receive notifications of Seam-related events. |
seam workspaces | Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces. |