struct ThermostatTrait This trait provides an interface to the functionality of a thermostat. - ` ### [supportedEventTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV014supportedEventC0Say0aB3SDK0H0_pXpGvpZ) ` List of the event types that are supported by `ThermostatTrait`. #### Declaration Swift static let supportedEventTypes: [any Event.Type] - ` ### [supportedCommandTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV016supportedCommandC0Say0aB3SDK0H0_pXpGvpZ) ` List of the commands that are supported by `ThermostatTrait`. #### Declaration Swift static let supportedCommandTypes: [any Command.Type] - ` ### [identifier](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV10identifierSSvpZ) ` The trait identifier. #### Declaration Swift static let identifier: String - ` ### [metadata](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV8metadata0aB3SDK0F8MetadataVvp) ` Metadata about this `Trait`. #### Declaration Swift let metadata: TraitMetadata - ` ### [attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV10attributesAE10AttributesVvp) ` List of attributes for the `ThermostatTrait`. #### Declaration Swift let attributes: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/Attributes.html - ` ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV7decoder16interactionProxy8metadataAE0aB3SDK0F7DecoderV_AI011InteractionI0_pSgAI0F8MetadataVtKcfc) ` Creates a new Trait instance using data read from the given `TraitDecoder`. Throws `HomeError.parseError` when parsing fails. #### Declaration Swift init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws #### Parameters |---|---| | ` decoder ` | The raw data representing this Trait. | | ` interactionProxy ` | Proxy to the Interaction Client. | | ` metadata ` | Metadata about this Trait. | - ` ### [encode(with:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV6encode4withy0aB3SDK0F7EncoderC_tKF) ` Writes this object to the given `TraitEncoder`. Throws `HomeError.encodingFailed` if the data could not be encoded. #### Declaration Swift func encode(with encoder: TraitEncoder) throws - ` ### [forceRead()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV9forceReadyyYaKF) ` This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the "C" quality) or unintentionally due to poor implementations. When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active. This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with `HomeError`s thrown by this call. #### Declaration Swift func forceRead() async throws - ` ### [Attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/Attributes.html) ` Attributes for the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait.html`. #### Declaration Swift struct Attributes - ` ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV2eeoiySbAE_AEtFZ) ` Returns a Boolean value indicating whether two values are equal. Equality is the inverse of inequality. For any values `a` and `b`, `a == b` implies that `a != b` is `false`. #### Declaration Swift static func == (lhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait) -> Bool #### Parameters |---|---| | ` lhs ` | A value to compare. | | ` rhs ` | Another value to compare. | - ` ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV4hash4intoys6HasherVz_tF) ` Hashes the essential components of this value by feeding them into the given hasher. Implement this method to conform to the `Hashable` protocol. The components used for hashing must be the same as the components compared in your type's `==` operator implementation. Call `hasher.combine(_:)` with each of these components. Important In your implementation of `hash(into:)`, don't call `finalize()` on the `hasher` instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future. #### Declaration Swift func hash(into hasher: inout Hasher) - ` ### [AtomicAttributeStatusStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/AtomicAttributeStatusStruct.html) ` The status of an attribute during an atomic write. #### Declaration Swift struct AtomicAttributeStatusStruct - ` ### [PresetStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/PresetStruct.html) ` A preset. #### Declaration Swift struct PresetStruct - ` ### [PresetTypeStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/PresetTypeStruct.html) ` A preset type. #### Declaration Swift struct PresetTypeStruct - ` ### [ScheduleStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleStruct.html) ` A schedule. #### Declaration Swift struct ScheduleStruct - ` ### [ScheduleTransitionStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleTransitionStruct.html) ` A schedule transition. #### Declaration Swift struct ScheduleTransitionStruct - ` ### [ScheduleTypeStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleTypeStruct.html) ` A schedule type. #### Declaration Swift struct ScheduleTypeStruct - ` ### [ThermostatSuggestionStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ThermostatSuggestionStruct.html) ` This struct is provisional and is not available for use. #### Declaration Swift struct ThermostatSuggestionStruct - ` ### [WeeklyScheduleTransitionStruct](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/WeeklyScheduleTransitionStruct.html) ` A single transition in a thermostat schedule. #### Declaration Swift struct WeeklyScheduleTransitionStruct - ` ### [supportsSetpointRaiseLowerCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV33supportsSetpointRaiseLowerCommandSbvp) ` Whether the device supports the `setpointRaiseLower` command for this trait. #### Declaration Swift var supportsSetpointRaiseLowerCommand: Bool { get } - ` ### [setpointRaiseLower(mode:amount:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV18setpointRaiseLower4mode6amountyAE08SetpointhI8ModeEnumO_s4Int8VtYaKF) ` Change the setpoint for the current thermostat mode. #### Declaration Swift func setpointRaiseLower(mode: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/SetpointRaiseLowerModeEnum.html, amount: Int8) async throws #### Parameters |---|---| | ` mode ` | The setpoint(s) to be adjusted. Valid values are defined by `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/SetpointRaiseLowerModeEnum.html`. | | ` amount ` | The amount (possibly negative) that should be added to the setpoint(s), in steps of 0.1°C. | - ` ### [setpointRaiseLowerBatchable(mode:amount:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV27setpointRaiseLowerBatchable4mode6amount0aB3SDK0J7CommandVyytGAE08SetpointhI8ModeEnumO_s4Int8VtKF) ` The batchable version of setpointRaiseLower command above. See also setpointRaiseLower #### Declaration Swift func setpointRaiseLowerBatchable(mode: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/SetpointRaiseLowerModeEnum.html, amount: Int8) throws -> BatchableCommand - ` ### [supportsSetWeeklyScheduleCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV32supportsSetWeeklyScheduleCommandSbvp) ` Whether the device supports the `setWeeklySchedule` command for this trait. #### Declaration Swift var supportsSetWeeklyScheduleCommand: Bool { get } - ` ### [setWeeklySchedule(numberOfTransitionsForSequence:dayOfWeekForSequence:modeForSequence:transitions:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV17setWeeklySchedule30numberOfTransitionsForSequence03dayk4WeekmN004modemN011transitionsys5UInt8V_AE0i3DaykP6BitmapVAE0i4ModeU0VSayAE0hI16TransitionStructVGtYaKF) ` This method is deprecated in the Matter specification and is not supported. #### Declaration Swift func setWeeklySchedule(numberOfTransitionsForSequence: UInt8, dayOfWeekForSequence: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleDayOfWeekBitmap.html, modeForSequence: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleModeBitmap.html, transitions: [https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/WeeklyScheduleTransitionStruct.html]) async throws #### Parameters |---|---| | ` numberOfTransitionsForSequence ` | The number of individual transitions to expect for this sequence of commands. | | ` dayOfWeekForSequence ` | The day(s) of the week to which all the transitions within the payload of the command should be associated. The bitmap values conform to those defined in `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleDayOfWeekBitmap.html`. | | ` modeForSequence ` | How the app decodes the `coolSetpoint` and `heatSetpoint` fields of each transition. The bitmap values confirm to those defined in `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleModeBitmap.html`. | | ` transitions ` | The list of setpoint transitions used to update the specified daily schedules. Each setpoint transition is represented by a `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/WeeklyScheduleTransitionStruct.html`. | - ` ### [setWeeklyScheduleBatchable(numberOfTransitionsForSequence:dayOfWeekForSequence:modeForSequence:transitions:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV26setWeeklyScheduleBatchable30numberOfTransitionsForSequence03dayl4WeeknO004modenO011transitions0aB3SDK0J7CommandVyytGs5UInt8V_AE0i3DaylQ6BitmapVAE0i4ModeX0VSayAE0hI16TransitionStructVGtKF) ` The batchable version of setWeeklySchedule command above. See also setWeeklySchedule #### Declaration Swift func setWeeklyScheduleBatchable(numberOfTransitionsForSequence: UInt8, dayOfWeekForSequence: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleDayOfWeekBitmap.html, modeForSequence: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleModeBitmap.html, transitions: [https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/WeeklyScheduleTransitionStruct.html]) throws -> BatchableCommand - ` ### [supportsGetWeeklyScheduleCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV32supportsGetWeeklyScheduleCommandSbvp) ` Whether the device supports the `getWeeklySchedule` command for this trait. #### Declaration Swift var supportsGetWeeklyScheduleCommand: Bool { get } - ` ### [getWeeklySchedule(daysToReturn:modeToReturn:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV17getWeeklySchedule12daysToReturn04modekL0AE03GethI7CommandV8ResponseVAE0I15DayOfWeekBitmapV_AE0i4ModeT0VtYaKF) ` This method is deprecated in the Matter specification and is not supported. #### Declaration Swift func getWeeklySchedule(daysToReturn: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleDayOfWeekBitmap.html, modeToReturn: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleModeBitmap.html) async throws -> https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.GetWeeklyScheduleCommandResponse #### Parameters |---|---| | ` daysToReturn ` | The number of days the client would like to return the set point values for. It can be any combination of single days or the entire week. | | ` modeToReturn ` | Indicates the mode the client would like to return the set point values for. It can be any combination of modes. | #### Return Value The weekly schedule, with the same payload as `setWeeklySchedule`. - ` ### [getWeeklyScheduleBatchable(daysToReturn:modeToReturn:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV26getWeeklyScheduleBatchable12daysToReturn04modelM00aB3SDK0J7CommandVyAE03GethiP0V8ResponseVGAE0I15DayOfWeekBitmapV_AE0i4ModeV0VtKF) ` The batchable version of getWeeklySchedule command above. See also getWeeklySchedule #### Declaration Swift func getWeeklyScheduleBatchable(daysToReturn: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleDayOfWeekBitmap.html, modeToReturn: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleModeBitmap.html) throws -> BatchableCommand - ` ### [supportsClearWeeklyScheduleCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV34supportsClearWeeklyScheduleCommandSbvp) ` Whether the device supports the `clearWeeklySchedule` command for this trait. #### Declaration Swift var supportsClearWeeklyScheduleCommand: Bool { get } - ` ### [clearWeeklySchedule()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV19clearWeeklyScheduleyyYaKF) ` This method is deprecated in the Matter specification and is not supported. #### Declaration Swift func clearWeeklySchedule() async throws - ` ### [clearWeeklyScheduleBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV28clearWeeklyScheduleBatchable0aB3SDK0J7CommandVyytGyKF) ` The batchable version of clearWeeklySchedule command above. See also clearWeeklySchedule #### Declaration Swift func clearWeeklyScheduleBatchable() throws -> BatchableCommand - ` ### [supportsSetActiveScheduleRequestCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV39supportsSetActiveScheduleRequestCommandSbvp) ` Whether the device supports the `setActiveScheduleRequest` command for this trait. #### Declaration Swift var supportsSetActiveScheduleRequestCommand: Bool { get } - ` ### [setActiveScheduleRequestBatchable(scheduleHandle:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV33setActiveScheduleRequestBatchable14scheduleHandle0aB3SDK0K7CommandVyytG10Foundation4DataV_tKF) ` The batchable version of setActiveScheduleRequest command above. See also setActiveScheduleRequest #### Declaration Swift func setActiveScheduleRequestBatchable(scheduleHandle: Data) throws -> BatchableCommand - ` ### [supportsSetActivePresetRequestCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV37supportsSetActivePresetRequestCommandSbvp) ` Whether the device supports the `setActivePresetRequest` command for this trait. #### Declaration Swift var supportsSetActivePresetRequestCommand: Bool { get } - ` ### [setActivePresetRequestBatchable(presetHandle:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV31setActivePresetRequestBatchable12presetHandle0aB3SDK0K7CommandVyytG10Foundation4DataVSg_tKF) ` The batchable version of setActivePresetRequest command above. See also setActivePresetRequest #### Declaration Swift func setActivePresetRequestBatchable(presetHandle: Data?) throws -> BatchableCommand - ` ### [supportsAddThermostatSuggestionCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV011supportsAddE17SuggestionCommandSbvp) ` Whether the device supports the `addThermostatSuggestion` command for this trait. #### Declaration Swift var supportsAddThermostatSuggestionCommand: Bool { get } - ` ### [addThermostatSuggestion(presetHandle:effectiveTime:expirationInMinutes:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV03addE10Suggestion12presetHandle13effectiveTime19expirationInMinutesAE03AddeH7CommandV8ResponseV10Foundation4DataV_s6UInt32VSgs6UInt16VtYaKF) ` This command is provisional and is not available for use. #### Declaration Swift func addThermostatSuggestion(presetHandle: Data, effectiveTime: UInt32?, expirationInMinutes: UInt16) async throws -> https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.AddThermostatSuggestionCommandResponse - ` ### [addThermostatSuggestionBatchable(presetHandle:effectiveTime:expirationInMinutes:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV03addE19SuggestionBatchable12presetHandle13effectiveTime19expirationInMinutes0aB3SDK0I7CommandVyAE03AddehR0V8ResponseVG10Foundation4DataV_s6UInt32VSgs6UInt16VtKF) ` The batchable version of addThermostatSuggestion command above. See also addThermostatSuggestion #### Declaration Swift func addThermostatSuggestionBatchable(presetHandle: Data, effectiveTime: UInt32?, expirationInMinutes: UInt16) throws -> BatchableCommand - ` ### [supportsRemoveThermostatSuggestionCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV014supportsRemoveE17SuggestionCommandSbvp) ` Whether the device supports the `removeThermostatSuggestion` command for this trait. #### Declaration Swift var supportsRemoveThermostatSuggestionCommand: Bool { get } - ` ### [removeThermostatSuggestion(uniqueID:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV06removeE10Suggestion8uniqueIDys5UInt8V_tYaKF) ` This command is provisional and is not available for use. #### Declaration Swift func removeThermostatSuggestion(uniqueID: UInt8) async throws - ` ### [removeThermostatSuggestionBatchable(uniqueID:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV06removeE19SuggestionBatchable8uniqueID0aB3SDK0I7CommandVyytGs5UInt8V_tKF) ` The batchable version of removeThermostatSuggestion command above. See also removeThermostatSuggestion #### Declaration Swift func removeThermostatSuggestionBatchable(uniqueID: UInt8) throws -> BatchableCommand - ` ### [supportsAtomicRequestCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV28supportsAtomicRequestCommandSbvp) ` Whether the device supports the `atomicRequest` command for this trait. #### Declaration Swift var supportsAtomicRequestCommand: Bool { get } - ` ### [atomicRequest(requestType:attributeRequests:optionalArgsProvider:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV13atomicRequest11requestType17attributeRequests20optionalArgsProviderAE06AtomicH7CommandV8ResponseVAE0phJ4EnumO_Says6UInt32VGyAK08OptionalN0CYbcSgtYaKF) ` Begin, commit, or cancel an atomic write. #### Declaration Swift func atomicRequest(requestType: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/AtomicRequestTypeEnum.html, attributeRequests: [UInt32], optionalArgsProvider: (@Sendable (https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.AtomicRequestCommand.OptionalArgs) -> Void)? = nil) async throws -> https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.AtomicRequestCommandResponse #### Parameters |---|---| | ` requestType ` | The type of atomic request being made by the client. | | ` attributeRequests ` | A list of attribute IDs the client wishes to write to during an atomic request. | #### Return Value The result of the atomic request. - ` ### [atomicRequestBatchable(requestType:attributeRequests:optionalArgsProvider:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait#/s:15GoogleHomeTypes6MatterO15ThermostatTraitV22atomicRequestBatchable11requestType17attributeRequests20optionalArgsProvider0aB3SDK0I7CommandVyAE06AtomichR0V8ResponseVGAE0shK4EnumO_Says6UInt32VGyAN08OptionalO0CcSgtKF) ` The batchable version of atomicRequest command above. See also atomicRequest #### Declaration Swift func atomicRequestBatchable(requestType: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/AtomicRequestTypeEnum.html, attributeRequests: [UInt32], optionalArgsProvider: ((https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter.html.ThermostatTrait.AtomicRequestCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand - ` ### [AtomicRequestTypeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/AtomicRequestTypeEnum.html) ` Types of atomic requests. #### Declaration Swift enum AtomicRequestTypeEnum - ` ### [ACCapacityFormatEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ACCapacityFormatEnum.html) ` Unit of measurement used for the AC capacity. #### Declaration Swift enum ACCapacityFormatEnum - ` ### [ACCompressorTypeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ACCompressorTypeEnum.html) ` Types of compressor. #### Declaration Swift enum ACCompressorTypeEnum - ` ### [ACLouverPositionEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ACLouverPositionEnum.html) ` The positions a louver may be in. #### Declaration Swift enum ACLouverPositionEnum - ` ### [ACRefrigerantTypeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ACRefrigerantTypeEnum.html) ` Types of refrigerant. #### Declaration Swift enum ACRefrigerantTypeEnum - ` ### [ACTypeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ACTypeEnum.html) ` Types of Air Conditioner features. #### Declaration Swift enum ACTypeEnum - ` ### [ControlSequenceOfOperationEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ControlSequenceOfOperationEnum.html) ` The system modes that the thermostat can operate in. #### Declaration Swift enum ControlSequenceOfOperationEnum - ` ### [PresetScenarioEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/PresetScenarioEnum.html) ` Preset Scenarios. #### Declaration Swift enum PresetScenarioEnum - ` ### [SetpointChangeSourceEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/SetpointChangeSourceEnum.html) ` Possible sources of a given setpoint. #### Declaration Swift enum SetpointChangeSourceEnum - ` ### [SetpointRaiseLowerModeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/SetpointRaiseLowerModeEnum.html) ` Specifies which setpoint is to be adjusted. #### Declaration Swift enum SetpointRaiseLowerModeEnum - ` ### [StartOfWeekEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/StartOfWeekEnum.html) ` Days of the week that may be designated the first day of the week. #### Declaration Swift enum StartOfWeekEnum - ` ### [SystemModeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/SystemModeEnum.html) ` The current operating mode of the thermostat. #### Declaration Swift enum SystemModeEnum - ` ### [TemperatureSetpointHoldEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/TemperatureSetpointHoldEnum.html) ` Temperature setpoint hold statuses. #### Declaration Swift enum TemperatureSetpointHoldEnum - ` ### [ThermostatRunningModeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ThermostatRunningModeEnum.html) ` The running mode of the thermostat. Intended to provide additional information when the thermostat is in auto mode. #### Declaration Swift enum ThermostatRunningModeEnum - ` ### [ACErrorCodeBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ACErrorCodeBitmap.html) ` Error codes. #### Declaration Swift struct ACErrorCodeBitmap - ` ### [Feature](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/Feature.html) ` Thermostat cluster FeatureMap. #### Declaration Swift struct Feature - ` ### [HvacSystemTypeBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/HvacSystemTypeBitmap.html) ` Describes the characteristics of the HVAC system. #### Declaration Swift struct HvacSystemTypeBitmap - ` ### [OccupancyBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/OccupancyBitmap.html) ` Indicates the sensed occupancy state. #### Declaration Swift struct OccupancyBitmap - ` ### [PresetTypeFeaturesBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/PresetTypeFeaturesBitmap.html) ` Preset type features. #### Declaration Swift struct PresetTypeFeaturesBitmap - ` ### [ProgrammingOperationModeBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ProgrammingOperationModeBitmap.html) ` Thermostat programming operational states. #### Declaration Swift struct ProgrammingOperationModeBitmap - ` ### [RelayStateBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/RelayStateBitmap.html) ` Thermostate running states. #### Declaration Swift struct RelayStateBitmap - ` ### [RemoteSensingBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/RemoteSensingBitmap.html) ` Remote sensing configurations. #### Declaration Swift struct RemoteSensingBitmap - ` ### [ScheduleDayOfWeekBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleDayOfWeekBitmap.html) ` Days of the week for scheduling. #### Declaration Swift struct ScheduleDayOfWeekBitmap - ` ### [ScheduleModeBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleModeBitmap.html) ` How the app decodes the setpoint fields of each transition. #### Declaration Swift struct ScheduleModeBitmap - ` ### [ScheduleTypeFeaturesBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ScheduleTypeFeaturesBitmap.html) ` Features that may be supported by a Thermostat schedule. #### Declaration Swift struct ScheduleTypeFeaturesBitmap - ` ### [ThermostatSuggestionNotFollowingReasonBitmap](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Matter/ThermostatTrait/ThermostatSuggestionNotFollowingReasonBitmap.html) ` This bitmap is provisional and is not available for use. #### Declaration Swift struct ThermostatSuggestionNotFollowingReasonBitmap