ThermostatTrait.Attributes

val absMaxCoolSetpointLimit: Short?

The absolute maximum level that the cooling setpoint may be set to. This is a limitation imposed by the manufacturer.

Access type: Read

val absMaxHeatSetpointLimit: Short?

The absolute maximum level that the heating setpoint may be set to. This is a limitation imposed by the manufacturer.

Access type: Read

val absMinCoolSetpointLimit: Short?

The absolute minimum level that the cooling setpoint may be set to. This is a limitation imposed by the manufacturer.

Access type: Read

val absMinHeatSetpointLimit: Short?

The absolute minimum level that the heating setpoint may be set to. This is a limitation imposed by the manufacturer.

Access type: Read

val acCapacity: UShort?

The capacity of the mini split AC as expressed by ThermostatTrait.Attributes.ACCapacityformat.

Access type: Write

val acCapacityformat: ThermostatTrait.AcCapacityFormatEnum?

The format for ThermostatTrait.Attributes.ACCapacity. Set to 0, which represents British Thermal Units per Hour (BTUh).

Access type: Write

val acCoilTemperature: Short?

The temperature of the AC coil, as measured locally or remotely (over the network).

Access type: Read

val acCompressorType: ThermostatTrait.AcCompressorTypeEnum?

The type of compressor used within the mini split AC. Valid values are:

• Unknown — The mini split AC uses an unknown compressor type.
• T1 — The mini split AC uses a compressor with a maximum working ambient temperature of 43 °C.
• T2 — The mini split AC uses a compressor with a maximum working ambient temperature of 35 °C.
• T3 — The mini split AC uses a compressor with a maximum working ambient temperature of 52 °C.

Access type: Write

val acErrorCode: ThermostatTrait.AcErrorCodeBitmap?

This bitmap indicates the type of errors encountered within the mini split AC. Error codes are reported with four-byte values. Each bit within the four bytes indicates a unique error code. For more details, see the Matter Specification.

Access type: Write

val acLouverPosition: ThermostatTrait.AcLouverPositionEnum?

The position of the louver on the AC. Valid values:

• Closed — The louver is fully closed.
• Open — The louver is fully open.
• Quarter — The louver is quarter open.
• Half — The louver is half open.
• ThreeQuarters — The louver is three quarters open.

Access type: Write

val acRefrigerantType: ThermostatTrait.AcRefrigerantTypeEnum?

Type of refrigerant used within the mini split AC. Valid values:

• Unknown — The mini split AC uses an unknown refrigerant type.
• R22 — The mini split AC uses R22 Refrigerant.
• R410a — The mini split AC uses R410a Refrigerant.
• R407c — The mini split AC uses R407c Refrigerant.

Access type: Write

val acType: ThermostatTrait.AcTypeEnum?

The type of mini split AC in terms of how cooling and heating is accomplished by the device. Valid values:

• 0: Unknown — The AC is of an Unknown type.
• 1: CoolingFixed — The AC incorporates cooling and fixed speed.
• 2: HeatPumpFixed — The AC incorporates a heat pump and fixed speed.
• 3: CoolingInverter — The AC incorporates cooling and an inverter.
• 4: HeatPumpInverter — The AC incorporates a heat pump and inverter.

Access type: Write

val acceptedCommandList: List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

val attributeList: List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

val clusterRevision: UShort

The revision of the server cluster specification supported by the cluster instance.

val controlSequenceOfOperation: ThermostatTrait.ControlSequenceOfOperationEnum?

The possible system modes that the thermostat can operate in. Valid modes are defined by ThermostatTrait.Attributes.ControlSequenceOfOperationEnum.

Access type: Write

val emergencyHeatDelta: UByte?

The delta between the localTemperature attribute and occupiedHeatingSetpoint or unoccupiedHeatingSetpoint at which the thermostat server will operate in emergency heat mode. 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.

Access type: Write

val featureMap: ThermostatTrait.Feature

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

val generatedCommandList: List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

val hvacSystemTypeConfiguration: UByte?

The HVAC system type controlled by the thermostat. Each bit represents a type of system configuration. Bits 0-1: Cooling Stage

• 00: Cool Stage 1
• 01: Cool Stage 2
• 10: Cool Stage 3
• 11: Reserved

• 00: Heat Stage 1
• 01: Heat Stage 2
• 10: Heat Stage 3
• 11: Reserved

Access type: Write

val localTemperature: Short?

The current temperature. The value may be local or remote, depending on the value of RemoteSensing.

Access type: Read

val localTemperatureCalibration: Byte?

The offset the thermostat server makes to the measured temperature (locally or remotely) to adjust the localTemperature attribute prior to using, displaying or reporting it. The purpose of this attribute is to adjust the calibration of the thermostat server according to the user's preferences (for example, to match if there are multiple servers displaying different values for the same HVAC area) or compensate for variability amongst temperature sensors.

Access type: Write

val maxCoolSetpointLimit: Short?

The maximum level that the cooling setpoint may be set to. This allows the user to define setpoint limits more constrictive than the manufacturer imposed ones. Limiting users (for example, in a commercial building) to such setpoint limits can help conserve power.

Access type: Write

val maxHeatSetpointLimit: Short?

The maximum level that the heating setpoint may be set to. This allows the user to define setpoint limits more constrictive than the manufacturer imposed ones. Limiting users (for example, in a commercial building) to such setpoint limits can help conserve power.

Access type: Write

val minCoolSetpointLimit: Short?

The minimum level that the cooling setpoint may be set to. This allows the user to define setpoint limits more constrictive than the manufacturer imposed ones. Limiting users (for example, in a commercial building) to such setpoint limits can help conserve power.

Access type: Write

val minHeatSetpointLimit: Short?

The minimum level that the heating setpoint may be set to. This allows the user to define setpoint limits more constrictive than the manufacturer imposed ones. Limiting users (for example, in a commercial building) to such setpoint limits can help conserve power.

Access type: Write

val minSetpointDeadBand: Byte?

On devices which support the auto feature, this specifies the minimum difference between the heat setpoint and the cool setpoint.

Access type: Write

val numberOfDailyTransitions: UByte?

The number of daily schedule transitions the thermostat can handle.

Access type: Read

val numberOfWeeklyTransitions: UByte?

The number of weekly schedule transitions the thermostat can handle.

Access type: Read

val occupancy: UByte?

This specifies whether the heated or cooled space is occupied or not, as measured locally or remotely (over the network). If bit 0 = 1, the space is occupied, else it is unoccupied. All other bits are reserved.

Access type: Read

val occupiedCoolingSetpoint: Short?

The cooling mode setpoint when the room is occupied.

Access type: Write

val occupiedHeatingSetpoint: Short?

The heating mode setpoint when the room is occupied.

Access type: Write

val occupiedSetback: UByte?

The amount that the thermostat will allow the localTemperature attribute to float above the occupiedCoolingSetpoint (in other words, occupiedCoolingSetpoint + occupiedSetback ) or below the occupiedHeatingSetpoint (in other words, occupiedHeatingSetpoint - occupiedSetback ) before initiating a state change to bring the temperature back to the user's desired setpoint. This is sometimes also referred to as the 'span'. The purpose of this is to allow remote configuration of the span between the desired setpoint and the measured temperature to help prevent over-cycling and reduce energy bills, though this may result in lower comfort on the part of some users. A null value indicates the attribute is unused.

Access type: Write

val occupiedSetbackMax: UByte?

The maximum value that the user can set the occupiedSetback to. A null value indicates the attribute is unused.

Access type: Read

val occupiedSetbackMin: UByte?

The minimum value that the user can set the occupiedSetback to. A null value indicates the attribute is unused.

Access type: Read

val piCoolingDemand: UByte?

The level of cooling demanded by the PI (proportional integral) control loop in use by the thermostat (if any), in percent. This value is 0 when the thermostat is in 'off' or 'heating' mode.

Access type: Read

val piHeatingDemand: UByte?

The level of heating demanded by the PI (proportional integral) control loop in use by the thermostat (if any), in percent. This value is 0 when the thermostat is in 'off' or 'cooling' mode.

Access type: Read

val remoteSensing: ThermostatTrait.RemoteSensingBitmap?

This bitmap indicates when the local temperature, outdoor temperature and occupancy are being sensed by remote networked sensors, rather than internal sensors. A bit set to 1 indicates remote sensing of the relevant value. For more details, see the Matter Specification.

Access type: Write

val setpointChangeAmount: Short?

The delta between the current active occupiedCoolingSetpoint or occupiedHeatingSetpoint and the previous active setpoint. A null value indicates that the previous setpoint was unknown.

Access type: Read

val setpointChangeSource: ThermostatTrait.SetpointChangeSourceEnum?

The source of the current active occupiedCoolingSetpoint or occupiedHeatingSetpoint (in other words, who or what determined the current setpoint). This enables service providers to determine whether changes to setpoints were initiated due to occupant comfort, scheduled programming, or some other source, such as an electric utility or service provider. Because automation services may initiate frequent setpoint changes, this attribute clearly differentiates the source of setpoint changes made at the thermostat. May be one of the following:

• 0 — Manual - The setpoint was set manually, by a user-initiated setpoint change via the thermostat.
• 1 — Schedule - The setpoint was set through a schedule or internal programming-initiated change.
• 2 — External - The setpoint was set externally (for example through a DRLC cluster command).

Access type: Read

val setpointChangeSourceTimestamp: UInt?

The time in UTC at which the ThermostatTrait.Attributes.setpointChangeSourceAmount change was recorded.

Access type: Read

val startOfWeek: ThermostatTrait.StartOfWeekEnum?

The day of the week that this thermostat considers to be the start of week for weekly setpoint scheduling.

• 0 — Sunday
• 1 — Monday
• 2 — Tuesday
• 3 — Wednesday
• 4 — Thursday
• 5 — Friday
• 6 — Saturday

Access type: Read

val systemMode: ThermostatTrait.SystemModeEnum?

The current operating mode of the thermostat. Valid values are defined by ThermostatTrait.Attributes.SystemModeEnum.

Access type: Write

val temperatureSetpointHold: ThermostatTrait.TemperatureSetpointHoldEnum?

The temperature hold status on the thermostat. Valid values:

• 0 — SetpointHoldOff - Follow the scheduling program.
• 1 — SetpointHoldOn - Maintain the current setpoint, regardless of schedule transitions.

Access type: Write

val temperatureSetpointHoldDuration: UShort?

This sets the period in minutes for which a setpoint hold is active. A null value indicates the field is unused. All other values are reserved.

Access type: Write

val thermostatProgrammingOperationMode: ThermostatTrait.ProgrammingOperationModeBitmap?

This bitmap determines the operational state of the thermostat's programming. For complete details, see the Matter Specification.

Access type: Write

val thermostatRunningMode: ThermostatTrait.ThermostatRunningModeEnum?

The running mode of the thermostat. This attribute uses the ThermostatTrait.Attributes.ThermostatRunningModeEnum values. This attribute is intended to provide additional information when the thermostat is in auto mode.

Access type: Read

val thermostatRunningState: ThermostatTrait.RelayStateBitmap?

The current relay state of the heat, cool, and fan relays.

Access type: Read

val unoccupiedCoolingSetpoint: Short?

The cooling mode setpoint when the room is unoccupied.

Access type: Write

val unoccupiedHeatingSetpoint: Short?

The heating mode setpoint when the room is unoccupied.

Access type: Write

val unoccupiedSetback: UByte?

The amount that the thermostat server will allow the localTemperature attribute to float above the ThermostatTrait.Attributes.unoccupiedCoolingSetback setpoint (in other words, ThermostatTrait.Attributes.unoccupiedCoolingSetback + unoccupiedSetback ) or below the ThermostatTrait.Attributes.unoccupiedHeatingSetback setpoint (in other words, ThermostatTrait.Attributes.unoccupiedHeatingSetback - unoccupiedSetback ) before initiating a state change to bring the temperature back to the user's desired setpoint. This attribute is sometimes also referred to as the 'span'. The purpose of this attribute is to allow remote configuration of the span between the desired setpoint and the measured temperature to help prevent over-cycling and reduce energy bills, though this may result in lower comfort on the part of some users. A null value indicates the attribute is unused.

Access type: Write

val unoccupiedSetbackMax: UByte?

The maximum value that the user can set the unoccupiedSetback to. A null value indicates the attribute is unused.

Access type: Read

val unoccupiedSetbackMin: UByte?

The minimum value that the user can set the unoccupiedSetback to. A null value indicates the attribute is unused.

Access type: Read