/** * @license * Copyright 2022-2026 Matter.js Authors * SPDX-License-Identifier: Apache-2.0 */ /*** THIS FILE IS GENERATED, DO NOT EDIT ***/ import { Resource } from "#models/Resource.js"; Resource.add( { tag: "cluster", name: "Thermostat", pics: "TSTAT", xref: "cluster§4.3", details: "This cluster provides an interface to the functionality of a thermostat.", children: [ { tag: "attribute", name: "FeatureMap", xref: "cluster§4.3.4", children: [ { tag: "field", name: "HEAT", details: "Thermostat is capable of managing a heating device" }, { tag: "field", name: "COOL", details: "Thermostat is capable of managing a cooling device" }, { tag: "field", name: "OCC", details: "Supports Occupied and Unoccupied setpoints" }, { tag: "field", name: "AUTO", details: "Supports a System Mode of Auto" }, { tag: "field", name: "LTNE", xref: "cluster§4.3.4.1", details: "This feature indicates that the Calculated Local Temperature used internally is unavailable to " + "report externally, for example due to the temperature control being done by a separate subsystem " + "which does not offer a view into the currently measured temperature, but allows setpoints to be " + "provided." }, { tag: "field", name: "MSCH", xref: "cluster§4.3.4.2", details: "This feature indicates that the thermostat is capable of schedules. If this feature is supported, " + "the thermostat shall support a mechanism to do time synchronization." }, { tag: "field", name: "PRES", details: "Thermostat supports setpoint presets" }, { tag: "field", name: "TEVT", details: "Thermostat supports events" }, { tag: "field", name: "TSUGGEST", xref: "cluster§4.3.4.3", details: "This feature indicates that the thermostat can process suggestions. If this feature is supported, " + "the thermostat shall support a mechanism to do time synchronization." } ] }, { tag: "attribute", name: "LocalTemperature", xref: "cluster§4.3.11.2", details: "Indicates the current Calculated Local Temperature, when available." + "\n" + " - If the LTNE feature is not supported:" + "\n" + " - If the LocalTemperatureCalibration is invalid or currently unavailable, the attribute shall " + "report null." + "\n" + " - If the LocalTemperatureCalibration is valid, the attribute shall report that value." + "\n" + " - Otherwise, if the LTNE feature is supported, there is no feedback externally available for the " + "LocalTemperatureCalibration. In that case, the LocalTemperature attribute shall always report " + "null." }, { tag: "attribute", name: "OutdoorTemperature", xref: "cluster§4.3.11.3", details: "Indicates the outdoor temperature, as measured locally or remotely (over the network)." }, { tag: "attribute", name: "Occupancy", xref: "cluster§4.3.11.4", details: "Indicates whether the heated/cooled space is occupied or not, as measured locally or remotely (over " + "the network)." }, { tag: "attribute", name: "AbsMinHeatSetpointLimit", xref: "cluster§4.3.11.5", details: "Indicates the absolute minimum level that the heating setpoint may be set to. This is a limitation " + "imposed by the manufacturer." + "\n" + "Refer to Setpoint Limits for constraints" }, { tag: "attribute", name: "AbsMaxHeatSetpointLimit", xref: "cluster§4.3.11.6", details: "Indicates the absolute maximum level that the heating setpoint may be set to. This is a limitation " + "imposed by the manufacturer." + "\n" + "Refer to Setpoint Limits for constraints" }, { tag: "attribute", name: "AbsMinCoolSetpointLimit", xref: "cluster§4.3.11.7", details: "Indicates the absolute minimum level that the cooling setpoint may be set to. This is a limitation " + "imposed by the manufacturer." + "\n" + "Refer to Setpoint Limits for constraints" }, { tag: "attribute", name: "AbsMaxCoolSetpointLimit", xref: "cluster§4.3.11.8", details: "Indicates the absolute maximum level that the cooling setpoint may be set to. This is a limitation " + "imposed by the manufacturer." + "\n" + "Refer to Setpoint Limits for constraints" }, { tag: "attribute", name: "PiCoolingDemand", xref: "cluster§4.3.11" }, { tag: "attribute", name: "PiHeatingDemand", xref: "cluster§4.3.11" }, { tag: "attribute", name: "HvacSystemTypeConfiguration", xref: "cluster§4.3.11.9", details: "Indicates the HVAC system type controlled by the thermostat. If the thermostat uses physical DIP " + "switches to set these parameters, this information shall be available read-only from the DIP " + "switches. If these parameters are set via software, there shall be read/write access in order to " + "provide remote programming capability." }, { tag: "attribute", name: "LocalTemperatureCalibration", xref: "cluster§4.3.11.10", details: "Indicates the offset the Thermostat server shall make to the measured temperature (locally or " + "remotely) to adjust the Calculated Local Temperature prior to using, displaying or reporting it." + "\n" + "The purpose of this attribute is to adjust the calibration of the Thermostat server per the user's " + "preferences (e.g., to match if there are multiple servers displaying different values for the same " + "HVAC area) or compensate for variability amongst temperature sensors." + "\n" + "If a Thermostat client attempts to write LocalTemperatureCalibration attribute to an unsupported " + "value (e.g., out of the range supported by the Thermostat server), the Thermostat server shall " + "respond with a status of SUCCESS and set the value of LocalTemperatureCalibration to the upper or " + "lower limit reached." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: Prior to revision 8 of this cluster specification the value of this attribute was " + "constrained to a range of -2.5°C to 2.5°C." }, { tag: "attribute", name: "OccupiedCoolingSetpoint", xref: "cluster§4.3.11.11", details: "Indicates the cooling mode setpoint when the room is occupied." + "\n" + "Refer to Setpoint Limits for constraints." + "\n" + "If an attempt is made to set this attribute to a value greater than MaxCoolSetpointLimit or less " + "than MinCoolSetpointLimit, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + "If this attribute is set to a value that is less than (OccupiedHeatingSetpoint + " + "MinSetpointDeadBand), the value of OccupiedHeatingSetpoint shall be adjusted to " + "(OccupiedCoolingSetpoint - MinSetpointDeadBand)." + "\n" + "If the occupancy status of the room is unknown, this attribute shall be used as the cooling mode " + "setpoint." + "\n" + "If a client changes the value of this attribute, the server supports the PRES feature, and the " + "server either does not support the OCC feature or the Occupied bit is set on the Occupancy " + "attribute, the value of the ActivePresetHandle attribute shall be set to null." }, { tag: "attribute", name: "OccupiedHeatingSetpoint", xref: "cluster§4.3.11.12", details: "Indicates the heating mode setpoint when the room is occupied." + "\n" + "Refer to Setpoint Limits for constraints." + "\n" + "If an attempt is made to set this attribute to a value greater than MaxHeatSetpointLimit or less " + "than MinHeatSetpointLimit, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + "If this attribute is set to a value that is greater than (OccupiedCoolingSetpoint - " + "MinSetpointDeadBand), the value of OccupiedCoolingSetpoint shall be adjusted to " + "(OccupiedHeatingSetpoint + MinSetpointDeadBand)." + "\n" + "If the occupancy status of the room is unknown, this attribute shall be used as the heating mode " + "setpoint." + "\n" + "If a client changes the value of this attribute, the server supports the PRES feature, and the " + "server either does not support the OCC feature or the Occupied bit is set on the Occupancy " + "attribute, the value of the ActivePresetHandle attribute shall be set to null." }, { tag: "attribute", name: "UnoccupiedCoolingSetpoint", xref: "cluster§4.3.11.13", details: "Indicates the cooling mode setpoint when the room is unoccupied." + "\n" + "Refer to Setpoint Limits for constraints." + "\n" + "If an attempt is made to set this attribute to a value greater than MaxCoolSetpointLimit or less " + "than MinCoolSetpointLimit, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + "If this attribute is set to a value that is less than (UnoccupiedHeatingSetpoint + " + "MinSetpointDeadBand), the value of UnoccupiedHeatingSetpoint shall be adjusted to " + "(UnoccupiedCoolingSetpoint - MinSetpointDeadBand)." + "\n" + "If the occupancy status of the room is unknown, this attribute shall NOT be used." + "\n" + "If a client changes the value of this attribute, the server supports the PRES and OCC features, and " + "the Occupied bit is not set on the Occupancy attribute, the value of the ActivePresetHandle " + "attribute shall be set to null." }, { tag: "attribute", name: "UnoccupiedHeatingSetpoint", xref: "cluster§4.3.11.14", details: "Indicates the heating mode setpoint when the room is unoccupied." + "\n" + "Refer to Setpoint Limits for constraints." + "\n" + "If an attempt is made to set this attribute to a value greater than MaxHeatSetpointLimit or less " + "than MinHeatSetpointLimit, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + "If this attribute is set to a value that is greater than (UnoccupiedCoolingSetpoint - " + "MinSetpointDeadBand), the value of UnoccupiedCoolingSetpoint shall be adjusted to " + "(UnoccupiedHeatingSetpoint + MinSetpointDeadBand)." + "\n" + "If the occupancy status of the room is unknown, this attribute shall NOT be used." + "\n" + "If a client changes the value of this attribute, the server supports the PRES and OCC features, and " + "the Occupied bit is not set on the Occupancy attribute, the value of the ActivePresetHandle " + "attribute shall be set to null." }, { tag: "attribute", name: "MinHeatSetpointLimit", xref: "cluster§4.3.11.15", details: "Indicates the minimum level that the heating setpoint may be set to." + "\n" + "This attribute, and the following three attributes, allow the user to define setpoint limits more " + "constrictive than the manufacturer imposed ones. Limiting users (e.g., in a commercial building) to " + "such setpoint limits can help conserve power." + "\n" + "Refer to Setpoint Limits for constraints. If an attempt is made to set this attribute to a value " + "which conflicts with setpoint values then those setpoints shall be adjusted by the minimum amount to " + "permit this attribute to be set to the desired value. If an attempt is made to set this attribute to " + "a value which is not consistent with the constraints and cannot be resolved by modifying setpoints " + "then a response with the status code CONSTRAINT_ERROR shall be returned." }, { tag: "attribute", name: "MaxHeatSetpointLimit", xref: "cluster§4.3.11.16", details: "Indicates the maximum level that the heating setpoint may be set to." + "\n" + "Refer to Setpoint Limits for constraints. If an attempt is made to set this attribute to a value " + "which conflicts with setpoint values then those setpoints shall be adjusted by the minimum amount to " + "permit this attribute to be set to the desired value. If an attempt is made to set this attribute to " + "a value which is not consistent with the constraints and cannot be resolved by modifying setpoints " + "then a response with the status code CONSTRAINT_ERROR shall be returned." }, { tag: "attribute", name: "MinCoolSetpointLimit", xref: "cluster§4.3.11.17", details: "Indicates the minimum level that the cooling setpoint may be set to." + "\n" + "Refer to Setpoint Limits for constraints. If an attempt is made to set this attribute to a value " + "which conflicts with setpoint values then those setpoints shall be adjusted by the minimum amount to " + "permit this attribute to be set to the desired value. If an attempt is made to set this attribute to " + "a value which is not consistent with the constraints and cannot be resolved by modifying setpoints " + "then a response with the status code CONSTRAINT_ERROR shall be returned." }, { tag: "attribute", name: "MaxCoolSetpointLimit", xref: "cluster§4.3.11.18", details: "Indicates the maximum level that the cooling setpoint may be set to." + "\n" + "Refer to Setpoint Limits for constraints. If an attempt is made to set this attribute to a value " + "which conflicts with setpoint values then those setpoints shall be adjusted by the minimum amount to " + "permit this attribute to be set to the desired value. If an attempt is made to set this attribute to " + "a value which is not consistent with the constraints and cannot be resolved by modifying setpoints " + "then a response with the status code CONSTRAINT_ERROR shall be returned." }, { tag: "attribute", name: "MinSetpointDeadBand", xref: "cluster§4.3.11.19", details: "On devices which support the AUTO feature, this attribute shall indicate the minimum difference " + "between the Heat Setpoint and the Cool Setpoint." + "\n" + "Refer to Setpoint Limits for constraints." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: Prior to revision 8 of this cluster specification the value of this attribute was " + "constrained to a range of 0°C to 2.5°C." + "\n" + "> [!NOTE]" + "\n" + "> NOTE: For backwards compatibility, this attribute is optionally writeable. However any writes to " + "this attribute shall be silently ignored." }, { tag: "attribute", name: "RemoteSensing", xref: "cluster§4.3.11.20", details: "Indicates when the local temperature, outdoor temperature and occupancy are being sensed by remote " + "networked sensors, rather than internal sensors." + "\n" + "If the LTNE feature is present in the server, the LocalTemperature RemoteSensing bit value shall " + "always report a value of 0." + "\n" + "If the LocalTemperature RemoteSensing bit is written with a value of 1 when the LTNE feature is " + "present, the write shall fail and the server shall report a CONSTRAINT_ERROR." }, { tag: "attribute", name: "ControlSequenceOfOperation", xref: "cluster§4.3.11.21", details: "Indicates the overall operating environment of the thermostat, and thus the possible system modes " + "that the thermostat can operate in." + "\n" + "If an attempt is made to write to this attribute, the server shall silently ignore the write and the " + "value of this attribute shall remain unchanged. This behavior is in place for backwards " + "compatibility with existing thermostats." }, { tag: "attribute", name: "SystemMode", xref: "cluster§4.3.11.22", details: "Indicates the current operating mode of the thermostat. Its value shall be limited by the " + "ControlSequenceOfOperation attribute." }, { tag: "attribute", name: "ThermostatRunningMode", xref: "cluster§4.3.11.23", details: "Indicates the running mode of the thermostat. This attribute uses the same values as SystemModeEnum " + "but can only be Off, Cool or Heat. This attribute is intended to provide additional information when " + "the thermostat's system mode is in auto mode." }, { tag: "attribute", name: "TemperatureSetpointHold", xref: "cluster§4.3.11.27", details: "Indicates the temperature hold status on the thermostat. If hold status is on, the thermostat SHOULD " + "maintain the temperature setpoint for the current mode until a system mode change. If hold status is " + "off, the thermostat SHOULD follow the setpoint transitions specified by its internal scheduling " + "program. If the thermostat supports setpoint hold for a specific duration, it SHOULD also implement " + "the TemperatureSetpointHoldDuration attribute." + "\n" + "If the server supports a setpoint hold for a specific duration, it SHOULD also implement the " + "SetpointHoldExpiryTimestamp attribute." + "\n" + "If this attribute is updated to SetpointHoldOn and the TemperatureSetpointHoldDuration has a " + "non-null value and the SetpointHoldExpiryTimestamp is supported, the server shall update the " + "SetpointHoldExpiryTimestamp with a value of current UTC timestamp, in seconds, plus the value in " + "TemperatureSetpointHoldDuration multiplied by 60." + "\n" + "If this attribute is updated to SetpointHoldOff and the SetpointHoldExpiryTimestamp is supported, " + "the server shall set the SetpointHoldExpiryTimestamp to null." }, { tag: "attribute", name: "TemperatureSetpointHoldDuration", xref: "cluster§4.3.11.28", details: "Indicates the period in minutes for which a setpoint hold is active. Thermostats that support hold " + "for a specified duration SHOULD implement this attribute. The null value indicates the field is " + "unused. All other values are reserved." + "\n" + "If this attribute is updated to a non-null value and the TemperatureSetpointHold is set to " + "SetpointHoldOn and the SetpointHoldExpiryTimestamp is supported, the server shall update " + "SetpointHoldExpiryTimestamp with a value of current UTC timestamp, in seconds, plus the new value of " + "this attribute multiplied by 60." + "\n" + "If this attribute is set to null and the SetpointHoldExpiryTimestamp is supported, the server shall " + "set the SetpointHoldExpiryTimestamp to null." }, { tag: "attribute", name: "ThermostatProgrammingOperationMode", xref: "cluster§4.3.11" }, { tag: "attribute", name: "ThermostatRunningState", xref: "cluster§4.3.11.29", details: "Indicates the current relay state of the heat, cool, and fan relays." + "\n" + "Unimplemented outputs shall be treated as if they were Off." }, { tag: "attribute", name: "SetpointChangeSource", xref: "cluster§4.3.11.30", details: "Indicates the source of the current active OccupiedCoolingSetpoint or OccupiedHeatingSetpoint (i.e., " + "who or what determined the current setpoint)." + "\n" + "This attribute enables service providers to determine whether changes to setpoints were initiated " + "due to occupant comfort, scheduled programming or some other source (e.g., electric utility or other " + "service provider). Because automation services may initiate frequent setpoint changes, this " + "attribute clearly differentiates the source of setpoint changes made at the thermostat." }, { tag: "attribute", name: "SetpointChangeAmount", xref: "cluster§4.3.11.31", details: "Indicates the delta between the current active OccupiedCoolingSetpoint or OccupiedHeatingSetpoint " + "and the previous active setpoint. This attribute is meant to accompany the SetpointChangeSource " + "attribute; devices implementing SetpointChangeAmount SHOULD also implement SetpointChangeSource." + "\n" + "The null value indicates that the previous setpoint was unknown." }, { tag: "attribute", name: "SetpointChangeSourceTimestamp", xref: "cluster§4.3.11.32", details: "Indicates the time in UTC at which the SetpointChangeAmount attribute change was recorded." }, { tag: "attribute", name: "OccupiedSetback", xref: "cluster§4.3.11" }, { tag: "attribute", name: "OccupiedSetbackMin", xref: "cluster§4.3.11" }, { tag: "attribute", name: "OccupiedSetbackMax", xref: "cluster§4.3.11" }, { tag: "attribute", name: "UnoccupiedSetback", xref: "cluster§4.3.11" }, { tag: "attribute", name: "UnoccupiedSetbackMin", xref: "cluster§4.3.11" }, { tag: "attribute", name: "UnoccupiedSetbackMax", xref: "cluster§4.3.11" }, { tag: "attribute", name: "EmergencyHeatDelta", xref: "cluster§4.3.11.33", details: "Indicates the delta between the Calculated Local Temperature and the OccupiedHeatingSetpoint or " + "UnoccupiedHeatingSetpoint attributes at which the Thermostat server will operate in emergency heat " + "mode." + "\n" + "If the difference between the Calculated Local Temperature and OccupiedCoolingSetpoint or " + "UnoccupiedCoolingSetpoint is greater than or equal to the EmergencyHeatDelta and the Thermostat " + "server's SystemMode attribute is in a heating-related mode, then the Thermostat server shall " + "immediately switch to the SystemMode attribute value that provides the highest stage of heating " + "(e.g., emergency heat) and continue operating in that running state until the " + "OccupiedHeatingSetpoint value is reached. For example:" + "\n" + " - Calculated Local Temperature = 10.0°C" + "\n" + " - OccupiedHeatingSetpoint = 16.0°C" + "\n" + " - EmergencyHeatDelta = 2.0°C" + "\n" + "=> OccupiedHeatingSetpoint - Calculated Local Temperature ≥? EmergencyHeatDelta" + "\n" + " - => 16°C - 10°C ≥? 2°C" + "\n" + "=> TRUE >>> Thermostat server changes its SystemMode to operate in 2^nd stage or emergency heat mode" + "\n" + "The purpose of this attribute is to provide Thermostat clients the ability to configure rapid " + "heating when a setpoint is of a specified amount greater than the measured temperature. This allows " + "the heated space to be quickly heated to the desired level set by the user." }, { tag: "attribute", name: "AcType", xref: "cluster§4.3.11.34", details: "Indicates the type of Mini Split ACTypeEnum of Mini Split AC is defined depending on how Cooling and " + "Heating condition is achieved by Mini Split AC." }, { tag: "attribute", name: "AcCapacity", xref: "cluster§4.3.11.35", details: "Indicates capacity of Mini Split AC in terms of the format defined by the ACCapacityFormat attribute" }, { tag: "attribute", name: "AcRefrigerantType", xref: "cluster§4.3.11.36", details: "Indicates type of refrigerant used within the Mini Split AC." }, { tag: "attribute", name: "AcCompressorType", xref: "cluster§4.3.11.37", details: "Indicates the type of compressor used within the Mini Split AC." }, { tag: "attribute", name: "AcErrorCode", xref: "cluster§4.3.11.38", details: "Indicates the type of errors encountered within the Mini Split AC." }, { tag: "attribute", name: "AcLouverPosition", xref: "cluster§4.3.11.39", details: "Indicates the position of Louver on the AC." }, { tag: "attribute", name: "AcCoilTemperature", xref: "cluster§4.3.11.40", details: "Indicates the temperature of the AC coil, as measured locally or remotely (over the network)." }, { tag: "attribute", name: "AcCapacityFormat", xref: "cluster§4.3.11.41", details: "Indicates the format for the ACCapacity attribute." }, { tag: "attribute", name: "PresetTypes", xref: "cluster§4.3.11.42", details: "Indicates the supported PresetScenarioEnum values, limits on how many presets can be created for " + "each PresetScenarioEnum, and whether or not a thermostat can transition automatically to a given " + "scenario." + "\n" + "The list shall contain at least one entry. The list shall NOT be larger than the number of supported " + "PresetScenarioEnum values (maximum 7). The list shall NOT contain any PresetTypeStruct entries with " + "duplicate PresetScenarioEnum values." }, { tag: "attribute", name: "ScheduleTypes", xref: "cluster§4.3.11.43", details: "Indicates the supported SystemMode values for Schedules, limits on how many schedules can be created " + "for each SystemMode value, and whether or not a given SystemMode value supports transitions to " + "Presets, target setpoints, or both." + "\n" + "The list shall contain at least one entry. The list shall NOT be larger than the number of supported " + "schedule SystemMode values (maximum 3, since the data type only allows Auto, Heat and Cool). The " + "list shall NOT contain any ScheduleTypeStruct entries with duplicate SystemModeEnum values." }, { tag: "attribute", name: "NumberOfPresets", xref: "cluster§4.3.11.44", details: "Indicates the maximum number of entries supported by the Presets attribute." }, { tag: "attribute", name: "NumberOfSchedules", xref: "cluster§4.3.11.45", details: "Indicates the maximum number of entries supported by the Schedules attribute." }, { tag: "attribute", name: "NumberOfScheduleTransitions", xref: "cluster§4.3.11.46", details: "Indicates the maximum number of transitions per Schedules attribute entry." }, { tag: "attribute", name: "NumberOfScheduleTransitionPerDay", xref: "cluster§4.3.11.47", details: "Indicates the maximum number of transitions per day of the week supported by each Schedules " + "attribute entry. If this value is null, there is no limit on the number of transitions per day." }, { tag: "attribute", name: "ActivePresetHandle", xref: "cluster§4.3.11.48", details: "Indicates the PresetHandle of the active preset. If this attribute is null, then there is no active " + "preset." }, { tag: "attribute", name: "ActiveScheduleHandle", xref: "cluster§4.3.11.49", details: "Indicates the ScheduleHandle of the active schedule. A null value in this attribute indicates that " + "there is no active schedule." }, { tag: "attribute", name: "Presets", xref: "cluster§4.3.11.50", details: "This attribute shall contain the current list of configured presets." + "\n" + "On receipt of a write request:" + "\n" + " 1. If the PresetHandle field is null, the PresetStruct shall be treated as an added preset, and " + "the device shall create a new unique value for the PresetHandle field." + "\n" + " 1. If the BuiltIn field is true, a response with the status code CONSTRAINT_ERROR shall be " + "returned." + "\n" + " 2. If the PresetHandle field is not null, the PresetStruct shall be treated as a modification of " + "an existing preset." + "\n" + " 1. If the value of the PresetHandle field does not match any of the existing presets, a response " + "with the status code NOT_FOUND shall be returned." + "\n" + " 2. If the value of the PresetHandle field is duplicated on multiple presets in the updated list, " + "a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 3. If the BuiltIn field is true, and the PresetStruct in the current value with a matching " + "PresetHandle field has a BuiltIn field set to false, a response with the status code " + "CONSTRAINT_ERROR shall be returned." + "\n" + " 4. If the BuiltIn field is false, and the PresetStruct in the current value with a matching " + "PresetHandle field has a BuiltIn field set to true, a response with the status code " + "CONSTRAINT_ERROR shall be returned." + "\n" + " 3. If the specified PresetScenarioEnum value does not exist in PresetTypes, a response with the " + "status code CONSTRAINT_ERROR shall be returned." + "\n" + " 4. If the Name is set, but the associated PresetTypeStruct does not have the SupportsNames bit " + "set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 5. If appending the received PresetStruct to the pending list of Presets would cause the total " + "number of pending presets to exceed the value of the NumberOfPresets attribute, a response with " + "the status code RESOURCE_EXHAUSTED shall be returned." + "\n" + " 6. If appending the received PresetStruct to the pending list of Presets would cause the total " + "number of pending presets whose PresetScenario field matches the appended preset's " + "PresetScenario field to exceed the value of the NumberOfPresets field on the PresetTypeStruct " + "whose PresetScenario matches the appended preset's PresetScenario field, a response with the " + "status code RESOURCE_EXHAUSTED shall be returned." + "\n" + " 7. Otherwise, the write shall be pended until receipt of a commit request, and the status code " + "SUCCESS shall be returned." + "\n" + " 1. If the BuiltIn field is null:" + "\n" + " 1. If there is a PresetStruct in the current value with a matching PresetHandle field, the " + "BuiltIn field on the pending PresetStruct shall be set to the value of the BuiltIn on the " + "matching PresetStruct." + "\n" + " 2. Otherwise, the BuiltIn field on the pending PresetStruct shall be set to false." + "\n" + "On an attempt to commit, the status of this attribute shall be determined as follows:" + "\n" + " 1. For all existing presets:" + "\n" + " 1. If, after applying all pending changes, the updated value of the Presets attribute would not " + "contain a PresetStruct with a matching PresetHandle field, indicating the removal of the " + "PresetStruct, the server shall check for invalid removal of the PresetStruct:" + "\n" + " 1. If the BuiltIn field is true on the removed PresetStruct, the attribute status shall be " + "CONSTRAINT_ERROR." + "\n" + " 2. If the MSCH feature is supported and the removed PresetHandle would be referenced by any " + "PresetHandle on any ScheduleTransitionStruct on any ScheduleStruct in the updated value of " + "the Schedules attribute, the attribute status shall be INVALID_IN_STATE." + "\n" + " 3. If the removed PresetHandle is equal to the value of the ActivePresetHandle attribute, the " + "attribute status shall be INVALID_IN_STATE." + "\n" + " 2. If the attribute status has not yet been determined:" + "\n" + " 1. The attribute status shall be SUCCESS." + "\n" + " 2. For all existing presets:" + "\n" + " 1. If, after applying all pending changes, the updated value of the Presets attribute would " + "not contain a PresetStruct with a matching PresetHandle field, indicating the removal of " + "the PresetStruct, the server shall ensure that the preset being removed is unused, as " + "follows:" + "\n" + " 1. If the PresetHandle field of the removed preset is equal to the value of the PresetHandle " + "field of the CurrentThermostatSuggestion attribute's value, the " + "CurrentThermostatSuggestion attribute shall be set to null." + "\n" + " 2. If the PresetHandle field of the removed preset is equal to the value of the PresetHandle " + "field of one or more of the entries in the ThermostatSuggestions attribute, the server " + "shall delete any such entries from the ThermostatSuggestions attribute." }, { tag: "attribute", name: "Schedules", xref: "cluster§4.3.11.51", details: "This attribute shall contain a list of ScheduleStructs." + "\n" + "On receipt of a write request:" + "\n" + " 1. For all schedules in the write request:" + "\n" + " 1. If the ScheduleHandle field is null, the ScheduleStruct shall be treated as an added " + "schedule, and the device shall create a new unique value for the ScheduleHandle field." + "\n" + " 1. If the BuiltIn field is true, a response with the status code CONSTRAINT_ERROR shall be " + "returned." + "\n" + " 2. Otherwise, if the ScheduleHandle field is not null, the ScheduleStruct shall be treated as a " + "modification of an existing schedule." + "\n" + " 1. If the value of the ScheduleHandle field does not match any of the existing schedules, a " + "response with the status code NOT_FOUND shall be returned." + "\n" + " 2. If the BuiltIn field is true, and the ScheduleStruct in the current value with a matching " + "ScheduleHandle field has a BuiltIn field set to false, a response with the status code " + "CONSTRAINT_ERROR shall be returned." + "\n" + " 3. If the BuiltIn field is false, and the ScheduleStruct in the current value with a matching " + "ScheduleHandle field has a BuiltIn field set to true, a response with the status code " + "CONSTRAINT_ERROR shall be returned." + "\n" + " 3. If the specified SystemMode does not exist in ScheduleTypes, a response with the status code " + "CONSTRAINT_ERROR shall be returned." + "\n" + " 4. If the number of transitions exceeds the NumberOfScheduleTransitions value, a response with " + "the status code RESOURCE_EXHAUSTED shall be returned." + "\n" + " 5. If the value of the NumberOfScheduleTransitionPerDay attribute is not null, and the number of " + "transitions on any single day of the week exceeds the NumberOfScheduleTransitionPerDay value, " + "a response with the status code RESOURCE_EXHAUSTED shall be returned." + "\n" + " 6. If the PresetHandle field is present, but the associated ScheduleTypeStruct does not have the " + "SupportsPresets bit set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 7. If the PresetHandle field is present, but after applying all pending changes, the Presets " + "attribute would not contain a PresetStruct whose PresetHandle field matches the value of the " + "PresetHandle field, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 8. If the Name is set, but the associated ScheduleTypeStruct does not have the SupportsNames bit " + "set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 9. For all transitions in all schedules in the write request:" + "\n" + " 1. If the PresetHandle field is present, but the ScheduleTypeStruct matching the value of the " + "SystemMode field on the encompassing ScheduleStruct does not have the SupportsPresets bit " + "set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 10. If the PresetHandle field is present, but after applying all pending changes, the Presets " + "attribute would not contain a PresetStruct whose PresetHandle field matches the value of the " + "PresetHandle field, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 1. If the SystemMode field is present, but the ScheduleTypeStruct matching the value of the " + "SystemMode field on the encompassing ScheduleStruct does not have the SupportsSetpoints bit " + "set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 2. If the SystemMode field is has a value of SystemModeOff, but the ScheduleTypeStruct " + "matching the value of the SystemMode field on the encompassing ScheduleStruct does not have " + "the SupportsOff bit set, a response with the status code CONSTRAINT_ERROR shall be " + "returned." + "\n" + " 11. If the HeatingSetpoint field is present, but the ScheduleTypeStruct matching the value of " + "the SystemMode field on the encompassing ScheduleStruct does not have the SupportsSetpoints " + "bit set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 12. If the CoolingSetpoint field is present, but the ScheduleTypeStruct matching the value of " + "the SystemMode field on the encompassing ScheduleStruct does not have the SupportsSetpoints " + "bit set, a response with the status code CONSTRAINT_ERROR shall be returned." + "\n" + " 2. If appending the received ScheduleStruct to the pending list of Schedules would cause the total " + "number of pending schedules to exceed the value of the NumberOfSchedules attribute, a response " + "with the status code RESOURCE_EXHAUSTED shall be returned." + "\n" + " 3. If appending the received ScheduleStruct to the pending list of Schedules would cause the total " + "number of pending schedules whose SystemMode field matches the appended schedule's SystemMode " + "field to exceed the value of the NumberOfSchedules field on the ScheduleTypeStruct whose " + "SystemMode field matches the appended schedule's SystemMode field, a response with the status " + "code RESOURCE_EXHAUSTED shall be returned." + "\n" + " 4. Otherwise, the write shall be pended until receipt of a commit request, and the attribute " + "status shall be SUCCESS." + "\n" + " 1. If the BuiltIn field is null:" + "\n" + " 1. If there is a ScheduleStruct in the current value with a matching ScheduleHandle field, the " + "BuiltIn field on the pending ScheduleStruct shall be set to the value of the BuiltIn on the " + "matching ScheduleStruct." + "\n" + " 2. Otherwise, the BuiltIn field on the pending ScheduleStruct shall be set to false." + "\n" + "On an attempt to commit, the status of this attribute shall be determined as follows:" + "\n" + " 1. For all existing schedules:" + "\n" + " 1. If, after applying all pending changes, the updated value of the Schedules attribute would " + "not contain a ScheduleStruct with a matching ScheduleHandle field, indicating the removal of " + "the ScheduleStruct, the server shall check for invalid removal of the ScheduleStruct:" + "\n" + " 1. If the BuiltIn field is true on the removed ScheduleStruct, the attribute status shall be " + "CONSTRAINT_ERROR." + "\n" + " 2. If the removed ScheduleHandle is equal to the value of the ActiveScheduleHandle attribute, " + "the attribute status shall be INVALID_IN_STATE." + "\n" + " 2. Otherwise, the attribute status shall be SUCCESS." }, { tag: "attribute", name: "SetpointHoldExpiryTimestamp", xref: "cluster§4.3.11.52", details: "If there is a known time when the TemperatureSetpointHold shall be cleared, this attribute shall " + "contain the timestamp in UTC indicating when that will happen. If there is no such known time, this " + "attribute shall be null." + "\n" + "If the TemperatureSetpointHold is set to SetpointHoldOn and the TemperatureSetpointHoldDuration is " + "set to null, this attribute shall be set to null indicating there is a hold on the Thermostat " + "without a duration." + "\n" + "If the TemperatureSetpointHold is set to SetpointHoldOff, this attribute shall be set to null " + "indicating there is no hold on the Thermostat." }, { tag: "attribute", name: "MaxThermostatSuggestions", xref: "cluster§4.3.11.53", details: "Indicates the maximum number of entries supported by the ThermostatSuggestions attribute." }, { tag: "attribute", name: "ThermostatSuggestions", xref: "cluster§4.3.11.54", details: "Indicates an unordered set of thermostat suggestions." + "\n" + "The suggested value shall be a PresetHandle that shall match the PresetHandle of one of the entries " + "in the Presets attribute." + "\n" + "The Thermostat may use this information to ensure user comfort while also prioritizing other factors " + "(e.g. energy savings, cost, and so on). Entries with effective times in the future may be used for " + "pre-cool or pre-heat decisions." + "\n" + "See Section 4.3.7, \"Re-evaluation of Current Thermostat Suggestion\" for what to do if this " + "attribute's value changes." }, { tag: "attribute", name: "CurrentThermostatSuggestion", xref: "cluster§4.3.11.55", details: "Indicates an entry in the entries, which identifies the current thermostat suggestion." + "\n" + "A value of null shall indicate that there is no current thermostat suggestion. When this attribute's " + "value changes to a null value, the server may decide to set the ActivePresetHandle attribute to a " + "value of its choice, based on schedules, occupancy sensors, etc." + "\n" + "When the server is \"following the suggestion\" that means that the server shall ensure that the value " + "of the ActivePresetHandle attribute matches the value of this attribute." + "\n" + "When there is a current thermostat suggestion and the server is unable to follow the suggestion or " + "the server is unable to choose a current thermostat suggestion due to conflicting suggestions, it " + "shall set the ThermostatSuggestionNotFollowingReason attribute to a non-null value as described in " + "the definition of the ThermostatSuggestionNotFollowingReason attribute. Otherwise, the server shall " + "follow the suggestion and set the ThermostatSuggestionNotFollowingReason attribute to null." + "\n" + "Whenever the state of the server changes such that it might need to start or stop following the " + "suggestion, the server shall re-evaluate whether it is doing so and update the ActivePresetHandle " + "and ThermostatSuggestionNotFollowingReason attributes as needed." }, { tag: "attribute", name: "ThermostatSuggestionNotFollowingReason", xref: "cluster§4.3.11.56", details: "Indicates the reasons the Thermostat is unable to follow suggestions." + "\n" + "When the server is unable to follow the suggestion, it shall set the appropriate bits in the value " + "of the ThermostatSuggestionNotFollowingReason attribute to indicate the reasons due to which the " + "suggestion is not being followed. The value of the ThermostatSuggestionNotFollowingReason attribute " + "shall be 0 (all bits cleared) if there are no bits defined in " + "ThermostatSuggestionNotFollowingReasonBitmap that represent the reasons the suggestion is not being " + "followed." + "\n" + "If the CurrentThermostatSuggestion attribute is null, this attribute shall be set to null." }, { tag: "event", name: "SystemModeChange", xref: "cluster§4.3.13.1", details: "This event shall be generated when the SystemMode attribute changes.", children: [ { tag: "field", name: "PreviousSystemMode", xref: "cluster§4.3.13.1.1", details: "This field shall indicate the previous value of the SystemMode attribute. If the previous value is " + "unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentSystemMode", xref: "cluster§4.3.13.1.2", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the SystemMode attribute." } ] }, { tag: "event", name: "LocalTemperatureChange", xref: "cluster§4.3.13.2", details: "This event shall be generated when the LocalTemperature attribute changes significantly." + "\n" + "Significant changes are:" + "\n" + " - Changes from null to not null, or from not null to null." + "\n" + " - Changes from one not-null value to another not-null value that are sufficiently large, as " + "determined by the server." + "\n" + "LocalTemperatureChange events shall NOT be generated more often than once every 60 seconds.", children: [{ tag: "field", name: "CurrentLocalTemperature", xref: "cluster§4.3.13.2.1", details: "This field shall indicate the current value of the LocalTemperature attribute." }] }, { tag: "event", name: "OccupancyChange", xref: "cluster§4.3.13.3", details: "This event shall be generated when the Occupancy attribute changes.", children: [ { tag: "field", name: "PreviousOccupancy", xref: "cluster§4.3.13.3.1", details: "This field shall indicate the previous value of the Occupancy attribute. If the previous value is " + "unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentOccupancy", xref: "cluster§4.3.13.3.2", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the Occupancy attribute." } ] }, { tag: "event", name: "SetpointChange", xref: "cluster§4.3.13.4", details: "This event shall be generated when the value of any of the OccupiedHeatingSetpoint, " + "UnoccupiedHeatingSetpoint, OccupiedCoolingSetpoint, or UnoccupiedCoolingSetpoint attributes is " + "changed.", children: [ { tag: "field", name: "SystemMode", xref: "cluster§4.3.13.4.1", details: "This field shall indicate the system mode associated with the changed attribute. If the changed " + "attribute is OccupiedHeatingSetpoint or UnoccupiedHeatingSetpoint, the value of this field shall be " + "Heat. If the changed attribute is OccupiedCoolingSetpoint or UnoccupiedCoolingSetpoint, the value of " + "this field shall be Cool." }, { tag: "field", name: "Occupancy", xref: "cluster§4.3.13.4.2", details: "This field shall indicate the occupancy associated with the changed attribute. If the changed " + "attribute is OccupiedHeatingSetpoint or OccupiedCoolingSetpoint, the value of this field shall be 1. " + "If the changed attribute is UnoccupiedHeatingSetpoint or UnoccupiedCoolingSetpoint, the value of " + "this field shall be 0." }, { tag: "field", name: "PreviousSetpoint", xref: "cluster§4.3.13.4.3", details: "This field shall indicate the previous value of the changed attribute. If the previous value is " + "unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentSetpoint", xref: "cluster§4.3.13.4.4", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the changed attribute." } ] }, { tag: "event", name: "RunningStateChange", xref: "cluster§4.3.13.6", details: "This event shall be generated when the ThermostatRunningState attribute changes.", children: [ { tag: "field", name: "PreviousRunningState", xref: "cluster§4.3.13.6.1", details: "This field shall indicate the previous value of the ThermostatRunningState attribute. If the " + "previous value is unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentRunningState", xref: "cluster§4.3.13.6.2", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the ThermostatRunningState attribute." } ] }, { tag: "event", name: "RunningModeChange", xref: "cluster§4.3.13.5", details: "This event shall be generated when the ThermostatRunningMode attribute changes.", children: [ { tag: "field", name: "PreviousRunningMode", xref: "cluster§4.3.13.5.1", details: "This field shall indicate the previous value of the ThermostatRunningMode attribute. If the previous " + "value is unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentRunningMode", xref: "cluster§4.3.13.5.2", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the ThermostatRunningMode attribute." } ] }, { tag: "event", name: "ActiveScheduleChange", xref: "cluster§4.3.13.8", details: "This event shall be generated when the ActiveScheduleHandle attribute changes.", children: [ { tag: "field", name: "PreviousScheduleHandle", xref: "cluster§4.3.13.8.1", details: "This field shall indicate the previous value of the ActiveScheduleHandle attribute. If the previous " + "value is unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentScheduleHandle", xref: "cluster§4.3.13.8.2", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the ActiveScheduleHandle attribute." } ] }, { tag: "event", name: "ActivePresetChange", xref: "cluster§4.3.13.7", details: "This event shall be generated when the ActivePresetHandle attribute changes.", children: [ { tag: "field", name: "PreviousPresetHandle", xref: "cluster§4.3.13.7.1", details: "This field shall indicate the previous value of the ActivePresetHandle attribute. If the previous " + "value is unavailable, this field shall be omitted." }, { tag: "field", name: "CurrentPresetHandle", xref: "cluster§4.3.13.7.2", details: "This field shall indicate the current (after the change that caused the event to be generated) value " + "of the ActivePresetHandle attribute." } ] }, { tag: "command", name: "SetpointRaiseLower", xref: "cluster§4.3.12.1", details: "This command will raise or lower the setpoint based on the provided values.", children: [ { tag: "field", name: "Mode", xref: "cluster§4.3.12.1.1", details: "The field shall specify which setpoints are to be adjusted." }, { tag: "field", name: "Amount", xref: "cluster§4.3.12.1.2", details: "This field shall indicate the amount (possibly negative) that should be added to the setpoint(s), in " + "steps of 0.1°C." } ] }, { tag: "command", name: "SetActiveScheduleRequest", xref: "cluster§4.3.12.2", details: "This command will set the active schedule to the provided schedule handle.", children: [{ tag: "field", name: "ScheduleHandle", xref: "cluster§4.3.12.2.1", details: "This field shall specify the value of the ScheduleHandle field on the ScheduleStruct to be made " + "active." }] }, { tag: "command", name: "SetActivePresetRequest", xref: "cluster§4.3.12.3", details: "This command will set the active preset to the provided preset handle.", children: [{ tag: "field", name: "PresetHandle", xref: "cluster§4.3.12.3.1", details: "This field shall specify the value of the PresetHandle field on the PresetStruct to be made active. " + "If the field is set to null, that indicates there should be no active preset." }] }, { tag: "command", name: "AddThermostatSuggestion", xref: "cluster§4.3.12.4", details: "This command will add a new suggestion based on the specified values.", children: [ { tag: "field", name: "PresetHandle", xref: "cluster§4.3.12.4.1", details: "This field shall specify the value of the thermostat suggestion." }, { tag: "field", name: "EffectiveTime", xref: "cluster§4.3.12.4.2", details: "This field shall indicate the timestamp in UTC at which the thermostat suggestion shall become " + "available. If this field is set to null, that means the thermostat suggestion shall become available " + "immediately." }, { tag: "field", name: "ExpirationInMinutes", xref: "cluster§4.3.12.4.3", details: "This field shall indicate the duration in minutes after which the thermostat suggestion provided by " + "this command shall expire." } ] }, { tag: "command", name: "AddThermostatSuggestionResponse", xref: "cluster§4.3.12.5", details: "This command is sent in response to the AddThermostatSuggestion command.", children: [{ tag: "field", name: "UniqueId", xref: "cluster§4.3.12.5.1", details: "This field shall contain the value in the UniqueID field of the entry that was added to the " + "ThermostatSuggestions attribute via the AddThermostatSuggestion command for which this response " + "shall be sent." }] }, { tag: "command", name: "RemoveThermostatSuggestion", xref: "cluster§4.3.12.6", details: "This command will remove the specified suggestion.", children: [{ tag: "field", name: "UniqueId", xref: "cluster§4.3.12.6.1", details: "This field shall contain a unique identifier for an entry in the ThermostatSuggestions attribute " + "that shall be removed." }] }, { tag: "datatype", name: "ACErrorCodeBitmap", xref: "cluster§4.3.10.1", children: [ { tag: "field", name: "CompressorFail", description: "Compressor Failure or Refrigerant Leakage" }, { tag: "field", name: "RoomSensorFail", description: "Room Temperature Sensor Failure" }, { tag: "field", name: "OutdoorSensorFail", description: "Outdoor Temperature Sensor Failure" }, { tag: "field", name: "CoilSensorFail", description: "Indoor Coil Temperature Sensor Failure" }, { tag: "field", name: "FanFail", description: "Fan Failure" } ] }, { tag: "datatype", name: "OccupancyBitmap", xref: "cluster§4.3.10.2", children: [{ tag: "field", name: "Occupied", description: "Indicates the occupancy state", xref: "cluster§4.3.10.2.1", details: "If this bit is set, it shall indicate the occupied state else if the bit if not set, it shall " + "indicate the unoccupied state." }] }, { tag: "datatype", name: "PresetTypeFeaturesBitmap", xref: "cluster§4.3.10.3", children: [ { tag: "field", name: "Automatic", description: "Preset may be automatically activated by the thermostat" }, { tag: "field", name: "SupportsNames", description: "Preset supports user-provided names" } ] }, { tag: "datatype", name: "RelayStateBitmap", xref: "cluster§4.3.10.4", children: [ { tag: "field", name: "Heat", description: "Heat Stage On" }, { tag: "field", name: "Cool", description: "Cool Stage On" }, { tag: "field", name: "Fan", description: "Fan Stage On" }, { tag: "field", name: "HeatStage2", description: "Heat 2^nd Stage On" }, { tag: "field", name: "CoolStage2", description: "Cool 2^nd Stage On" }, { tag: "field", name: "FanStage2", description: "Fan 2^nd Stage On" }, { tag: "field", name: "FanStage3", description: "Fan 3^rd Stage On" } ] }, { tag: "datatype", name: "RemoteSensingBitmap", xref: "cluster§4.3.10.5", children: [ { tag: "field", name: "LocalTemperature", description: "Calculated Local Temperature is derived from a remote node" }, { tag: "field", name: "OutdoorTemperature", description: "OutdoorTemperature is derived from a remote node" }, { tag: "field", name: "Occupancy", description: "Occupancy is derived from a remote node" } ] }, { tag: "datatype", name: "ScheduleTypeFeaturesBitmap", xref: "cluster§4.3.10.6", children: [ { tag: "field", name: "SupportsPresets", description: "Supports presets", xref: "cluster§4.3.10.6.1", details: "This bit shall indicate that any ScheduleStruct with a SystemMode field whose value matches the " + "SystemMode field on the encompassing ScheduleTypeStruct supports specifying presets on " + "ScheduleTransitionStructs contained in its Transitions field." }, { tag: "field", name: "SupportsSetpoints", description: "Supports setpoints", xref: "cluster§4.3.10.6.2", details: "This bit shall indicate that any ScheduleStruct with a SystemMode field whose value matches the " + "SystemMode field on the encompassing ScheduleTypeStruct supports specifying setpoints on " + "ScheduleTransitionStructs contained in its Transitions field." }, { tag: "field", name: "SupportsNames", description: "Supports user-provided names", xref: "cluster§4.3.10.6.3", details: "This bit shall indicate that any ScheduleStruct with a SystemMode field whose value matches the " + "SystemMode field on the encompassing ScheduleTypeStruct supports setting the value of the Name " + "field." }, { tag: "field", name: "SupportsOff", description: "Supports transitioning to SystemModeOff", xref: "cluster§4.3.10.6.4", details: "This bit shall indicate that any ScheduleStruct with a SystemMode field whose value matches the " + "SystemMode field on the encompassing ScheduleTypeStruct supports setting its SystemMode field to " + "Off." } ] }, { tag: "datatype", name: "ScheduleDayOfWeekBitmap", xref: "cluster§4.3.10.7", children: [ { tag: "field", name: "Sunday", description: "Sunday" }, { tag: "field", name: "Monday", description: "Monday" }, { tag: "field", name: "Tuesday", description: "Tuesday" }, { tag: "field", name: "Wednesday", description: "Wednesday" }, { tag: "field", name: "Thursday", description: "Thursday" }, { tag: "field", name: "Friday", description: "Friday" }, { tag: "field", name: "Saturday", description: "Saturday" }, { tag: "field", name: "Away", description: "Away or Vacation" } ] }, { tag: "datatype", name: "ScheduleModeBitmap", xref: "cluster§4.3.10.8", children: [ { tag: "field", name: "HeatSetpointPresent", description: "Adjust Heat Setpoint" }, { tag: "field", name: "CoolSetpointPresent", description: "Adjust Cool Setpoint" } ] }, { tag: "datatype", name: "ThermostatSuggestionNotFollowingReasonBitmap", xref: "cluster§4.3.10.9", children: [ { tag: "field", name: "DemandResponseEvent", description: "Thermostat is responding to a Demand Response event" }, { tag: "field", name: "OngoingHold", description: "Thermostat has an ongoing setpoint hold" }, { tag: "field", name: "Schedule", description: "Thermostat is following a schedule" }, { tag: "field", name: "Occupancy", description: "Thermostat is following the occupancy signal" }, { tag: "field", name: "VacationMode", description: "Thermostat is set to Vacation mode" }, { tag: "field", name: "TimeOfUseCostSavings", description: "Thermostat is following a Time Of Use based cost savings plan" }, { tag: "field", name: "PreCoolingOrPreHeating", description: "Thermostat is precooling or preheating based on an energy forecast signal" }, { tag: "field", name: "ConflictingSuggestions", description: "Thermostat has conflicting suggestions and is unable to choose one" } ] }, { tag: "datatype", name: "ACCapacityFormatEnum", xref: "cluster§4.3.10.10", children: [{ tag: "field", name: "BtUh", description: "British Thermal Unit per Hour" }] }, { tag: "datatype", name: "ACCompressorTypeEnum", xref: "cluster§4.3.10.11", children: [ { tag: "field", name: "Unknown", description: "Unknown compressor type" }, { tag: "field", name: "T1", description: "Max working ambient 43 °C" }, { tag: "field", name: "T2", description: "Max working ambient 35 °C" }, { tag: "field", name: "T3", description: "Max working ambient 52 °C" } ] }, { tag: "datatype", name: "ACLouverPositionEnum", xref: "cluster§4.3.10.12", children: [ { tag: "field", name: "Closed", description: "Fully Closed" }, { tag: "field", name: "Open", description: "Fully Open" }, { tag: "field", name: "Quarter", description: "Quarter Open" }, { tag: "field", name: "Half", description: "Half Open" }, { tag: "field", name: "ThreeQuarters", description: "Three Quarters Open" } ] }, { tag: "datatype", name: "ACRefrigerantTypeEnum", xref: "cluster§4.3.10.13", children: [ { tag: "field", name: "Unknown", description: "Unknown Refrigerant Type" }, { tag: "field", name: "R22", description: "R22 Refrigerant" }, { tag: "field", name: "R410A", description: "R410a Refrigerant" }, { tag: "field", name: "R407C", description: "R407c Refrigerant" } ] }, { tag: "datatype", name: "ACTypeEnum", xref: "cluster§4.3.10.14", children: [ { tag: "field", name: "Unknown", description: "Unknown AC Type" }, { tag: "field", name: "CoolingFixed", description: "Cooling and Fixed Speed" }, { tag: "field", name: "HeatPumpFixed", description: "Heat Pump and Fixed Speed" }, { tag: "field", name: "CoolingInverter", description: "Cooling and Inverter" }, { tag: "field", name: "HeatPumpInverter", description: "Heat Pump and Inverter" } ] }, { tag: "datatype", name: "SetpointRaiseLowerModeEnum", xref: "cluster§4.3.10.15", children: [ { tag: "field", name: "Heat", description: "Adjust Heat Setpoint" }, { tag: "field", name: "Cool", description: "Adjust Cool Setpoint" }, { tag: "field", name: "Both", description: "Adjust Heat Setpoint and Cool Setpoint" } ] }, { tag: "datatype", name: "ControlSequenceOfOperationEnum", xref: "cluster§4.3.10.16", details: "> [!NOTE]" + "\n" + "> NOTE: A thermostat indicating it supports CoolingAndHeating (or CoolingAndHeatingWithReheat) " + "SHOULD be able to request heating or cooling on demand and will usually support the Auto " + "SystemMode." + "\n" + "Systems which support cooling or heating, requiring external intervention to change modes or where " + "the whole building must be in the same mode, SHOULD report CoolingOnly or HeatingOnly based on the " + "current capability.", children: [ { tag: "field", name: "CoolingOnly", description: "Heat and Emergency are not possible" }, { tag: "field", name: "CoolingWithReheat", description: "Heat and Emergency are not possible" }, { tag: "field", name: "HeatingOnly", description: "Cool and precooling (see Terms) are not possible" }, { tag: "field", name: "HeatingWithReheat", description: "Cool and precooling are not possible" }, { tag: "field", name: "CoolingAndHeating", description: "All modes are possible" }, { tag: "field", name: "CoolingAndHeatingWithReheat", description: "All modes are possible" } ] }, { tag: "datatype", name: "PresetScenarioEnum", xref: "cluster§4.3.10.17", children: [ { tag: "field", name: "Occupied", description: "The thermostat-controlled area is occupied", xref: "cluster§4.3.10.17.2", details: "This value shall indicate the preset for periods when the thermostat's temperature-controlled area " + "is occupied. It is intended for thermostats that can automatically determine occupancy." }, { tag: "field", name: "Unoccupied", description: "The thermostat-controlled area is unoccupied", xref: "cluster§4.3.10.17.3", details: "This value shall indicate the preset for periods when the thermostat's temperature-controlled area " + "is unoccupied. It is intended for thermostats that can automatically determine occupancy." }, { tag: "field", name: "Sleep", description: "Users are likely to be sleeping", xref: "cluster§4.3.10.17.4", details: "This value shall indicate the preset for periods when users are likely to be asleep." }, { tag: "field", name: "Wake", description: "Users are likely to be waking up", xref: "cluster§4.3.10.17.5", details: "This value shall indicate the preset for periods when users are likely to be waking up." }, { tag: "field", name: "Vacation", description: "Users are on vacation", xref: "cluster§4.3.10.17.6", details: "This value shall indicate the preset for periods when users are on vacation, or otherwise " + "out-of-home for extended periods of time." }, { tag: "field", name: "GoingToSleep", description: "Users are likely to be going to sleep", xref: "cluster§4.3.10.17.7", details: "This value shall indicate the preset for periods when users are likely to be going to sleep." }, { tag: "field", name: "UserDefined", description: "Custom presets", xref: "cluster§4.3.10.17.8", details: "This value shall indicate a free-form preset; when set, the Name field on PresetStruct shall NOT be " + "null." } ] }, { tag: "datatype", name: "SetpointChangeSourceEnum", xref: "cluster§4.3.10.18", children: [ { tag: "field", name: "Manual", description: "Manual, user-initiated setpoint change via the thermostat" }, { tag: "field", name: "Schedule", description: "Schedule/internal programming-initiated setpoint change" }, { tag: "field", name: "External", description: "Externally-initiated setpoint change (e.g., DRLC cluster command, attribute write)" } ] }, { tag: "datatype", name: "StartOfWeekEnum", xref: "cluster§4.3.10.19" }, { tag: "datatype", name: "SystemModeEnum", xref: "cluster§4.3.10.20", children: [ { tag: "field", name: "Off", description: "The Thermostat does not generate demand for Cooling or Heating" }, { tag: "field", name: "Auto", description: "Demand is generated for either Cooling or Heating, as required" }, { tag: "field", name: "Cool", description: "Demand is only generated for Cooling" }, { tag: "field", name: "Heat", description: "Demand is only generated for Heating" }, { tag: "field", name: "EmergencyHeat", description: "2^nd stage heating is in use to achieve desired temperature" }, { tag: "field", name: "Precooling", description: "(see Terms)" } ] }, { tag: "datatype", name: "ThermostatRunningModeEnum", xref: "cluster§4.3.10.21", children: [ { tag: "field", name: "Off", description: "The Thermostat does not generate demand for Cooling or Heating" }, { tag: "field", name: "Cool", description: "Demand is only generated for Cooling" }, { tag: "field", name: "Heat", description: "Demand is only generated for Heating" } ] }, { tag: "datatype", name: "TemperatureSetpointHoldEnum", xref: "cluster§4.3.10.22", children: [ { tag: "field", name: "SetpointHoldOff", description: "Follow scheduling program" }, { tag: "field", name: "SetpointHoldOn", description: "Maintain current setpoint, regardless of schedule transitions" } ] }, { tag: "datatype", name: "PresetStruct", xref: "cluster§4.3.10.23", children: [ { tag: "field", name: "PresetHandle", xref: "cluster§4.3.10.23.1", details: "This field shall indicate a device generated identifier for this preset. It shall be unique on the " + "device, and shall NOT be reused after the associated preset has been deleted." + "\n" + "This field shall only be null when the encompassing PresetStruct is appended to the Presets " + "attribute for the purpose of creating a new Preset. Refer to Presets for the creation of Preset " + "handles." }, { tag: "field", name: "PresetScenario", xref: "cluster§4.3.10.23.2", details: "This field shall indicate the associated PresetScenarioEnum value for this preset." }, { tag: "field", name: "Name", xref: "cluster§4.3.10.23.3", details: "This field shall indicate a name provided by a user. The null value shall indicate no name." + "\n" + "Within each subset of presets sharing the same PresetScenario field value, there shall NOT be any " + "presets with the same value, including null as a value, in the Name field." }, { tag: "field", name: "CoolingSetpoint", xref: "cluster§4.3.10.23.4", details: "This field shall indicate the cooling setpoint for the preset. Refer to Setpoint Limits for value " + "constraints." }, { tag: "field", name: "HeatingSetpoint", xref: "cluster§4.3.10.23.5", details: "This field shall indicate the heating setpoint for the preset. Refer to Setpoint Limits for value " + "constraints." }, { tag: "field", name: "BuiltIn", xref: "cluster§4.3.10.23.6", details: "This field shall indicate whether the preset is marked as \"built-in\", meaning that it can be " + "modified, but it cannot be deleted." } ] }, { tag: "datatype", name: "PresetTypeStruct", xref: "cluster§4.3.10.24", children: [ { tag: "field", name: "PresetScenario", xref: "cluster§4.3.10.24.1", details: "This field shall specify a PresetScenarioEnum value supported by this thermostat." }, { tag: "field", name: "NumberOfPresets", xref: "cluster§4.3.10.24.2", details: "This field shall specify a limit for the number of presets for this PresetScenarioEnum." }, { tag: "field", name: "PresetTypeFeatures", xref: "cluster§4.3.10.24.3", details: "This field shall specify a bitmap of features for this PresetTypeStruct." } ] }, { tag: "datatype", name: "WeeklyScheduleTransitionStruct", xref: "cluster§4.3.10.25", details: "This represents a single transition in a Thermostat schedule", children: [ { tag: "field", name: "TransitionTime", xref: "cluster§4.3.10.25.1", details: "This field shall represent the start time of the schedule transition during the associated day. The " + "time will be represented by a 16 bits unsigned integer to designate the minutes since midnight. For " + "example, 6am will be represented by 360 minutes since midnight and 11:30pm will be represented by " + "1410 minutes since midnight." }, { tag: "field", name: "HeatSetpoint", xref: "cluster§4.3.10.25.2", details: "This field shall represent the heat setpoint to be applied at this associated transition start time." }, { tag: "field", name: "CoolSetpoint", xref: "cluster§4.3.10.25.3", details: "This field shall represent the cool setpoint to be applied at this associated transition start time." } ] }, { tag: "datatype", name: "ScheduleStruct", xref: "cluster§4.3.10.26", children: [ { tag: "field", name: "ScheduleHandle", xref: "cluster§4.3.10.26.1", details: "This field shall indicate a device generated identifier for this schedule. It shall be unique on the " + "device, and shall NOT be reused after the associated schedule has been deleted." + "\n" + "This field shall only be null when the encompassing ScheduleStruct is appended to the Schedules " + "attribute for the purpose of creating a new Schedule. Refer to Schedules for the creation of " + "Schedule handles." }, { tag: "field", name: "SystemMode", xref: "cluster§4.3.10.26.2", details: "This field shall specify the default thermostat system mode for transitions in this schedule. The " + "only valid values for this field shall be Auto, Heat, and Cool." }, { tag: "field", name: "Name", xref: "cluster§4.3.10.26.3", details: "This field shall specify a name for the ScheduleStruct." }, { tag: "field", name: "PresetHandle", xref: "cluster§4.3.10.26.4", details: "This field shall indicate the default PresetHandle value for transitions in this schedule." }, { tag: "field", name: "Transitions", xref: "cluster§4.3.10.26.5", details: "This field shall specify a list of transitions for the schedule." + "\n" + "This field shall NOT contain more than one ScheduleStruct with the same TransitionTime field and " + "overlapping DayOfWeek fields; i.e. there shall be no duplicate transitions." + "\n" + "If the NumberOfScheduleTransitionPerDay attribute is not null, then for each bit in " + "ScheduleDayOfWeekBitmap, the number of transitions with that bit set in DayOfWeek shall NOT be " + "greater than the value of the NumberOfScheduleTransitionPerDay attribute." + "\n" + "For the purposes of determining which ScheduleStruct in this list is currently active, the current " + "time shall be the number of minutes past midnight in the display value of the current time, not the " + "actual number of minutes that have elapsed since midnight. On days which transition into or out of " + "daylight saving time, certain values may repeat or not occur during the transition period." + "\n" + "A ScheduleTransitionStruct in this list shall be active if the current day of the week matches its " + "DayOfWeek field and the current time is greater than or equal to the TransitionTime, but less than " + "the TransitionTime on any other ScheduleTransitionStruct in the Transitions field whose DayOfWeek " + "field also matches the current day of the week." + "\n" + "If the current time is less than every ScheduleTransitionStruct whose DayOfWeek field also matches " + "the current day of the week, the server shall attempt the same process to identify the active " + "ScheduleTransitionStruct for the day preceding the previously attempted day of the week, repeating " + "until an active ScheduleTransitionStruct is found or the attempted day is the current day of the " + "week again. If no active ScheduleTransitionStruct is found, then the active ScheduleTransitionStruct " + "shall be the ScheduleTransitionStruct with the largest TransitionTime field from the set of " + "ScheduleTransitionStructs whose DayOfWeek field matches the current day of the week." }, { tag: "field", name: "BuiltIn", xref: "cluster§4.3.10.26.6", details: "This field shall indicate whether the schedule is marked as \"built-in\", meaning that it can be " + "modified, but it cannot be deleted." } ] }, { tag: "datatype", name: "ScheduleTransitionStruct", xref: "cluster§4.3.10.27", details: "This struct provides a time of day and a set of days of the week for a state transition within a " + "schedule. The thermostat shall use the following order of precedence for determining a new setpoint " + "at the time of transition:" + "\n" + " 1. If the PresetHandle field is provided, then the setpoint for the PresetStruct in the Presets " + "attribute with that identifier shall be used" + "\n" + " 2. If either the HeatingSetpoint or CoolingSetpoint is provided, then it shall be used" + "\n" + " 1. If the SystemMode field is provided, the HeatingSetpoint and CoolingSetpoint fields shall be " + "interpreted using the SystemMode field" + "\n" + " 2. If the SystemMode field is not provided, the HeatingSetpoint and CoolingSetpoint fields shall " + "be interpreted using the SystemMode field on the parent ScheduleStruct" + "\n" + " 3. If neither the PresetHandle field or any Setpoint field is provided, then the PresetHandle " + "field on the parent ScheduleStruct shall be used to determine the active PresetStruct" + "\n" + " 4. If the PresetHandle is not indicated and no setpoint is provided for the current SystemMode, " + "the server shall use a default value for the current SystemMode." + "\n" + "If the setpoint was derived from a preset, then the ActivePresetHandle shall be set to the " + "PresetHandle of that preset." + "\n" + "If a CoolingSetpoint was used to determine the cooling setpoint:" + "\n" + " - If the server supports the OCC feature, and the Occupied bit is not set on the Occupancy " + "attribute, then the UnoccupiedCoolingSetpoint attribute shall be set to the CoolingSetpoint" + "\n" + " - Otherwise, the OccupiedCoolingSetpoint attribute shall be set to the CoolingSetpoint" + "\n" + "If a HeatingSetpoint was used to determine the heating setpoint:" + "\n" + " - If the server supports the OCC feature, and the Occupied bit is not set on the Occupancy " + "attribute, then the UnoccupiedHeatingSetpoint attribute shall be set to the HeatingSetpoint" + "\n" + " - Otherwise, the OccupiedHeatingSetpoint attribute shall be set to the HeatingSetpoint" + "\n" + "The ScheduleTransitionStruct shall be invalid if all the following are true:" + "\n" + " - The HeatingSetpoint field is not provided" + "\n" + " - The PresetHandle field is not provided" + "\n" + " - The PresetHandle field on the encompassing ScheduleStruct is not provided" + "\n" + " - The SystemMode field is provided and has the value Heat or Auto, or the SystemMode field on the " + "parent ScheduleStruct has the value Heat or Auto" + "\n" + "The ScheduleTransitionStruct shall be invalid if all the following are true:" + "\n" + " - The CoolingSetpoint field is not provided" + "\n" + " - The PresetHandle field is not provided" + "\n" + " - The PresetHandle field on the encompassing ScheduleStruct is not provided" + "\n" + " - The SystemMode field is provided and has the value Cool or Auto, or the SystemMode field on the " + "parent ScheduleStruct has the value Cool or Auto", children: [ { tag: "field", name: "DayOfWeek", xref: "cluster§4.3.10.27.1", details: "This field shall specify a bitmask of days of the week that the transition applies to. The Vacation " + "bit shall NOT be set; vacation schedules shall be set via the vacation preset." }, { tag: "field", name: "TransitionTime", xref: "cluster§4.3.10.27.2", details: "This shall specify the time of day at which the transition becomes active, in terms of minutes " + "within the day representing the wall clock, where 0 is 00:00:00, 1 is 00:01:00 and 1439 is 23:59:00." + "\n" + "Handling of transitions during the changeover of Daylight Saving Time is implementation-dependent." }, { tag: "field", name: "PresetHandle", xref: "cluster§4.3.10.27.3", details: "This field shall specify the preset used at the TransitionTime. If this field is provided, then the " + "SystemMode, CoolingSetpoint and HeatingSetpoint fields shall NOT be provided." }, { tag: "field", name: "SystemMode", xref: "cluster§4.3.10.27.4", details: "This shall specify the default mode to which the thermostat will switch for this transition, " + "overriding the default for the schedule. The only valid values for this field shall be Auto, Heat, " + "Cool and Off. This field shall only be included when the required system mode differs from the " + "schedule's default SystemMode." }, { tag: "field", name: "CoolingSetpoint", xref: "cluster§4.3.10.27.5", details: "This field shall specify the cooling setpoint for the transition. If PresetHandle is set, this field " + "shall NOT be included. Refer to Setpoint Limits for value constraints." }, { tag: "field", name: "HeatingSetpoint", xref: "cluster§4.3.10.27.6", details: "This field shall specify the cooling setpoint for the transition. If PresetHandle is set, this field " + "shall NOT be included. Refer to Setpoint Limits for value constraints." } ] }, { tag: "datatype", name: "ScheduleTypeStruct", xref: "cluster§4.3.10.28", children: [ { tag: "field", name: "SystemMode", xref: "cluster§4.3.10.28.1", details: "This field shall specify a SystemModeEnum supported by this thermostat for Schedules. The only valid " + "values for this field shall be Auto, Heat, and Cool." }, { tag: "field", name: "NumberOfSchedules", xref: "cluster§4.3.10.28.2", details: "This field shall specify a limit for the number of Schedules for this SystemMode." }, { tag: "field", name: "ScheduleTypeFeatures", xref: "cluster§4.3.10.28.3", details: "This field shall specify a bitmap of features for this schedule entry. At least one of " + "SupportsPresets and SupportsSetpoints shall be set." } ] }, { tag: "datatype", name: "ThermostatSuggestionStruct", xref: "cluster§4.3.10.29", children: [ { tag: "field", name: "UniqueId", xref: "cluster§4.3.10.29.1", details: "This field shall have a generated identifier that identifies a distinct entry of type " + "ThermostatSuggestionStruct." }, { tag: "field", name: "PresetHandle", xref: "cluster§4.3.10.29.2", details: "This field shall indicate the PresetHandle of the PresetStruct that represents the thermostat " + "suggestion value." }, { tag: "field", name: "EffectiveTime", xref: "cluster§4.3.10.29.3", details: "This field shall indicate the UTC timestamp at which the suggestion shall take effect." }, { tag: "field", name: "ExpirationTime", xref: "cluster§4.3.10.29.4", details: "This field shall indicate the UTC timestamp at which the suggestion shall expire." } ] }, { tag: "datatype", name: "TemperatureDifference", xref: "cluster§4.3.10.30", details: "This data type is derived from int16 and represents a temperature difference with a resolution of " + "0.01°C." + "\n" + " - value = (temperature in °C) x 100" + "\n" + " - -4°C => -400" + "\n" + " - 123.45°C => 12345" + "\n" + "The full (non-null) range of -327.67°C to 327.67°C may be used." }, { tag: "datatype", name: "SignedTemperature", xref: "cluster§4.3.10.31", details: "This data type is derived from int8 and represents a temperature from -12.7°C to 12.7°C with a " + "resolution of 0.1°C." + "\n" + " - value = (temperature in °C) x 10" + "\n" + " - -4°C => -40" + "\n" + " - 12.3°C => 123" + "\n" + "This type is employed where compactness of representation is important and where the resolution and " + "range are still satisfactory." }, { tag: "datatype", name: "UnsignedTemperature", xref: "cluster§4.3.10.32", details: "This data type is derived from uint8 and represents a temperature from 0°C to 25.5°C with a " + "resolution of 0.1°C." + "\n" + " - value = (temperature in °C) x 10" + "\n" + " - 4°C => 40" + "\n" + " - 12.3°C => 123" + "\n" + "This type is employed where compactness of representation is important and where the resolution and " + "range are still satisfactory." } ] } );