SetbackComponent: {
    attributes: {
        occupiedSetback: WritableAttribute<number | null, any>;
        occupiedSetbackMax: FixedAttribute<number | null, any>;
        occupiedSetbackMin: FixedAttribute<number | null, any>;
    };
}

A ThermostatCluster supports these elements if it supports feature Setback.

Type declaration

  • Readonlyattributes: {
        occupiedSetback: WritableAttribute<number | null, any>;
        occupiedSetbackMax: FixedAttribute<number | null, any>;
        occupiedSetbackMin: FixedAttribute<number | null, any>;
    }
    • ReadonlyoccupiedSetback: WritableAttribute<number | null, any>

      Indicates the amount that the Thermostat server will allow the Calculated Local Temperature to float above the OccupiedCoolingSetpoint (i.e., OccupiedCoolingSetpoint + OccupiedSetback) or below the OccupiedHeatingSetpoint setpoint (i.e., OccupiedHeatingSetpoint – OccupiedSetback) 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.

      The null value indicates the attribute is unused.

      If the Thermostat client attempts to write OccupiedSetback to a value greater than OccupiedSetbackMax, the Thermostat server shall set its OccupiedSetback value to OccupiedSetbackMax and shall send a Write Attribute Response command with a Status Code field enumeration of SUCCESS response.

      If the Thermostat client attempts to write OccupiedSetback to a value less than OccupiedSetbackMin, the Thermostat server shall set its OccupiedSetback value to OccupiedSetbackMin and shall send a Write Attribute Response command with a Status Code field enumeration of SUCCESS response.

      MatterSpecification.v13.Cluster § 4.3.9.38

    • ReadonlyoccupiedSetbackMax: FixedAttribute<number | null, any>

      Indicates the maximum value that the Thermostat server will allow the OccupiedSetback attribute to be configured by a user.

      The null value indicates the attribute is unused.

      MatterSpecification.v13.Cluster § 4.3.9.40

    • ReadonlyoccupiedSetbackMin: FixedAttribute<number | null, any>

      Indicates the minimum value that the Thermostat server will allow the OccupiedSetback attribute to be configured by a user.

      The null value indicates the attribute is unused.

      MatterSpecification.v13.Cluster § 4.3.9.39