The device Object for Thermostats
Represents a thermostat. 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. If the thermostat reports a temperature outside these thresholds, Seam automatically alerts you.
- Make immediate changes to thermostat climate settings, such as the HVAC mode and fan mode.
- Create and schedule climate presets, including a fallback climate preset.
- Create daily and weekly thermostat programs.
device resource that includes both basic device properties and thermostat-specific properties.
Properties
Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
Indicates whether the thermostat supports different climate programs for each day of the week.
Indicates whether the camera can stream live video through a camera live view session.
false while the camera is offline.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.Enum values
Enum values
access_codelocknoise_detectionthermostatbatteryphonepool
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. Keys set to
null or to an empty string are omitted.Type of the device. The
august_lock and yale_lock values are deprecated. Use yale_access_lock in place of august_lock, and yale_access_lock or yale_home_lock in place of yale_lock.Enum values
Enum values
akuvox_lockaugust_lockbrivo_access_pointbutterflymx_panelavigilon_alta_entrydoorking_lockgenie_doorigloo_locklinear_locklockly_lockkwikset_locknuki_locksalto_lockschlage_locksmartthings_lockwyze_lockyale_lockyale_access_lockyale_home_lockyale_connect_locktwo_n_intercomcontrolbyweb_devicettlock_lockigloohome_lockfour_suites_doordormakaba_oracode_doortedee_lockakiles_lockultraloq_lockyacan_lockkeyincode_lockomnitec_lockkisi_lockaqara_locktuya_lockeufy_lockkeynest_keynoiseaware_activity_zoneminut_sensorecobee_thermostatnest_thermostathoneywell_resideo_thermostattado_thermostatsensi_thermostatsensibo_thermostatsmartthings_thermostatios_phoneandroid_phonering_cameratapo_cameraarlo_camerareolink_cameraunifi_protect_camerasonos_speakeralertify_sensorhayward_pool_systemhayward_pool
Display name of the device, defaults to nickname (if it is set) or
properties.appearance.name, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.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.Indicates whether Seam manages the device. See also Managed and Unmanaged Devices.
Properties of the device. See Common Device Properties for shared fields and provider metadata, and the property group sections below for capability-specific fields.
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.Thermostats
ID of the active thermostat schedule.
Climate preset modes that the thermostat supports, such as “home”, “away”, “wake”, “sleep”, “occupied”, and “unoccupied”.
Enum values
Enum values
homeawaywakesleepoccupiedunoccupied
Available climate presets for the thermostat.
HVAC mode settings that the thermostat supports.
Enum values
Enum values
offheatcoolheat_cooleco
Key of the fallback climate preset for the thermostat.
Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.
Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.
Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur,
current_climate_setting.manual_override_allowed must also be true.Maximum cooling set point in °C.
Maximum cooling set point in °F.
Maximum heating set point in °C.
Maximum heating set point in °F.
Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.
Minimum cooling set point in °C.
Minimum cooling set point in °F.
Minimum temperature difference in °C between the cooling and heating set points when in heat-cool (auto) mode.
Minimum temperature difference in °F between the cooling and heating set points when in heat-cool (auto) mode.
Minimum heating set point in °C.
Minimum heating set point in °F.
Current temperature threshold set for the thermostat.
Precision of the thermostat’s period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.
Configured daily programs for the thermostat.
Current weekly program for the thermostat.