# ThermostatCommands

# ThermostatCommands


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ThermostatCommands
```

<br />

Known direct subclasses [Thermostat](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Thermostat)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Thermostat` | API for the Thermostat trait. |

*** ** * ** ***

Commands for the Thermostat trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AddThermostatSuggestionCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#addThermostatSuggestion(kotlin.ByteArray,kotlin.UInt,kotlin.UShort)( presetHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, effectiveTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, expirationInMinutes: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html )` This command is provisional and is not available for use. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AddThermostatSuggestionCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#addThermostatSuggestionBatchable(kotlin.ByteArray,kotlin.UInt,kotlin.UShort)( presetHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, effectiveTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, expirationInMinutes: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#addThermostatSuggestion(kotlin.ByteArray,kotlin.UInt,kotlin.UShort)` command. |
| `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#atomicRequest(com.google.home.matter.standard.ThermostatTrait.AtomicRequestTypeEnum,kotlin.collections.List,kotlin.Function1)( requestType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestTypeEnum, attributeRequests: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Begin, commit, or cancel an atomic write. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#atomicRequestBatchable(com.google.home.matter.standard.ThermostatTrait.AtomicRequestTypeEnum,kotlin.collections.List,kotlin.Function1)( requestType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestTypeEnum, attributeRequests: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#atomicRequest(com.google.home.matter.standard.ThermostatTrait.AtomicRequestTypeEnum,kotlin.collections.List,kotlin.Function1)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#clearWeeklySchedule()()` This method is deprecated in the Matter specification and is not supported. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#clearWeeklyScheduleBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#clearWeeklySchedule()` command. |
| `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.GetWeeklyScheduleCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#getWeeklySchedule(com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap)( daysToReturn: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap, modeToReturn: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap )` This method is deprecated in the Matter specification and is not supported. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.GetWeeklyScheduleCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#getWeeklyScheduleBatchable(com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap)( daysToReturn: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap, modeToReturn: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#getWeeklySchedule(com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#removeThermostatSuggestion(kotlin.UByte)(uniqueId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` This command is provisional and is not available for use. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#removeThermostatSuggestionBatchable(kotlin.UByte)(uniqueId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#removeThermostatSuggestion(kotlin.UByte)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setActivePresetRequest(kotlin.ByteArray)(presetHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?)` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setActivePresetRequestBatchable(kotlin.ByteArray)(presetHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?)` |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setActiveScheduleRequest(kotlin.ByteArray)(scheduleHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setActiveScheduleRequestBatchable(kotlin.ByteArray)(scheduleHandle: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)` |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setWeeklySchedule(kotlin.UByte,com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap,kotlin.collections.List)( numberOfTransitionsForSequence: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, dayOfWeekForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap, modeForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap, transitions: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.WeeklyScheduleTransitionStruct> )` This method is deprecated in the Matter specification and is not supported. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setWeeklyScheduleBatchable(kotlin.UByte,com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap,kotlin.collections.List)( numberOfTransitionsForSequence: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, dayOfWeekForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap, modeForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap, transitions: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.WeeklyScheduleTransitionStruct> )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setWeeklySchedule(kotlin.UByte,com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap,kotlin.collections.List)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setpointRaiseLower(com.google.home.matter.standard.ThermostatTrait.SetpointRaiseLowerModeEnum,kotlin.Byte)( mode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.SetpointRaiseLowerModeEnum, amount: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html )` Change the setpoint for the current thermostat mode. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setpointRaiseLowerBatchable(com.google.home.matter.standard.ThermostatTrait.SetpointRaiseLowerModeEnum,kotlin.Byte)( mode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.SetpointRaiseLowerModeEnum, amount: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setpointRaiseLower(com.google.home.matter.standard.ThermostatTrait.SetpointRaiseLowerModeEnum,kotlin.Byte)` command. |

## Public functions

### addThermostatSuggestion

```
suspend fun addThermostatSuggestion(
    presetHandle: ByteArray,
    effectiveTime: UInt?,
    expirationInMinutes: UShort
): ThermostatTrait.AddThermostatSuggestionCommand.Response
```

This command is provisional and is not available for use.

### addThermostatSuggestionBatchable

```
fun addThermostatSuggestionBatchable(
    presetHandle: ByteArray,
    effectiveTime: UInt?,
    expirationInMinutes: UShort
): BatchableCommand<ThermostatTrait.AddThermostatSuggestionCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#addThermostatSuggestion(kotlin.ByteArray,kotlin.UInt,kotlin.UShort)` command.

This command is provisional and is not available for use.

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AddThermostatSuggestionCommand.Response>` | BatchableCommand |

### atomicRequest

```
suspend fun atomicRequest(
    requestType: ThermostatTrait.AtomicRequestTypeEnum,
    attributeRequests: List<UInt>,
    optionalArgs: ThermostatTrait.AtomicRequestCommand.OptionalArgs.() -> Unit = {}
): ThermostatTrait.AtomicRequestCommand.Response
```

Begin, commit, or cancel an atomic write.

| Parameters |
|---|---|
| `requestType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestTypeEnum` | The type of atomic request being made by the client. |
| `attributeRequests: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | A list of attribute IDs the client wishes to write to during an atomic request. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.Response` | The result of the atomic request. |

### atomicRequestBatchable

```
fun atomicRequestBatchable(
    requestType: ThermostatTrait.AtomicRequestTypeEnum,
    attributeRequests: List<UInt>,
    optionalArgs: ThermostatTrait.AtomicRequestCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<ThermostatTrait.AtomicRequestCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#atomicRequest(com.google.home.matter.standard.ThermostatTrait.AtomicRequestTypeEnum,kotlin.collections.List,kotlin.Function1)` command.

Begin, commit, or cancel an atomic write.

| Parameters |
|---|---|
| `requestType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestTypeEnum` | The type of atomic request being made by the client. |
| `attributeRequests: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | A list of attribute IDs the client wishes to write to during an atomic request. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.AtomicRequestCommand.Response>` | BatchableCommand |

### clearWeeklySchedule

```
suspend fun clearWeeklySchedule(): Unit
```

This method is deprecated in the Matter specification and is not supported.

### clearWeeklyScheduleBatchable

```
fun clearWeeklyScheduleBatchable(): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#clearWeeklySchedule()` command.

This method is deprecated in the Matter specification and is not supported.

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### getWeeklySchedule

```
suspend fun getWeeklySchedule(
    daysToReturn: ThermostatTrait.ScheduleDayOfWeekBitmap,
    modeToReturn: ThermostatTrait.ScheduleModeBitmap
): ThermostatTrait.GetWeeklyScheduleCommand.Response
```

This method is deprecated in the Matter specification and is not supported.

| Parameters |
|---|---|
| `daysToReturn: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap` | 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: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap` | Indicates the mode the client would like to return the set point values for. It can be any combination of modes. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.GetWeeklyScheduleCommand.Response` | The weekly schedule, with the same payload as `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Thermostat#setWeeklySchedule(kotlin.UByte,com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap,kotlin.collections.List)`. |

### getWeeklyScheduleBatchable

```
fun getWeeklyScheduleBatchable(
    daysToReturn: ThermostatTrait.ScheduleDayOfWeekBitmap,
    modeToReturn: ThermostatTrait.ScheduleModeBitmap
): BatchableCommand<ThermostatTrait.GetWeeklyScheduleCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#getWeeklySchedule(com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap)` command.

This method is deprecated in the Matter specification and is not supported.

| Parameters |
|---|---|
| `daysToReturn: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap` | 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: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap` | Indicates the mode the client would like to return the set point values for. It can be any combination of modes. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.GetWeeklyScheduleCommand.Response>` | BatchableCommand |

### removeThermostatSuggestion

```
suspend fun removeThermostatSuggestion(uniqueId: UByte): Unit
```

This command is provisional and is not available for use.

### removeThermostatSuggestionBatchable

```
fun removeThermostatSuggestionBatchable(uniqueId: UByte): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#removeThermostatSuggestion(kotlin.UByte)` command.

This command is provisional and is not available for use.

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### setActivePresetRequest

```
suspend fun setActivePresetRequest(presetHandle: ByteArray?): Unit
```

### setActivePresetRequestBatchable

```
fun setActivePresetRequestBatchable(presetHandle: ByteArray?): BatchableCommand<Unit>
```

### setActiveScheduleRequest

```
suspend fun setActiveScheduleRequest(scheduleHandle: ByteArray): Unit
```

### setActiveScheduleRequestBatchable

```
fun setActiveScheduleRequestBatchable(scheduleHandle: ByteArray): BatchableCommand<Unit>
```

### setWeeklySchedule

```
suspend fun setWeeklySchedule(
    numberOfTransitionsForSequence: UByte,
    dayOfWeekForSequence: ThermostatTrait.ScheduleDayOfWeekBitmap,
    modeForSequence: ThermostatTrait.ScheduleModeBitmap,
    transitions: List<ThermostatTrait.WeeklyScheduleTransitionStruct>
): Unit
```

This method is deprecated in the Matter specification and is not supported.

| Parameters |
|---|---|
| `numberOfTransitionsForSequence: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The number of individual transitions to expect for this sequence of commands. |
| `dayOfWeekForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap` | 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/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap`. |
| `modeForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap` | 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/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap`. |
| `transitions: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.WeeklyScheduleTransitionStruct>` | 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/kotlin/com/google/home/matter/standard/ThermostatTrait.WeeklyScheduleTransitionStruct`. |

### setWeeklyScheduleBatchable

```
fun setWeeklyScheduleBatchable(
    numberOfTransitionsForSequence: UByte,
    dayOfWeekForSequence: ThermostatTrait.ScheduleDayOfWeekBitmap,
    modeForSequence: ThermostatTrait.ScheduleModeBitmap,
    transitions: List<ThermostatTrait.WeeklyScheduleTransitionStruct>
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setWeeklySchedule(kotlin.UByte,com.google.home.matter.standard.ThermostatTrait.ScheduleDayOfWeekBitmap,com.google.home.matter.standard.ThermostatTrait.ScheduleModeBitmap,kotlin.collections.List)` command.

This method is deprecated in the Matter specification and is not supported.

| Parameters |
|---|---|
| `numberOfTransitionsForSequence: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The number of individual transitions to expect for this sequence of commands. |
| `dayOfWeekForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap` | 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/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleDayOfWeekBitmap`. |
| `modeForSequence: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap` | 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/kotlin/com/google/home/matter/standard/ThermostatTrait.ScheduleModeBitmap`. |
| `transitions: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.WeeklyScheduleTransitionStruct>` | 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/kotlin/com/google/home/matter/standard/ThermostatTrait.WeeklyScheduleTransitionStruct`. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### setpointRaiseLower

```
suspend fun setpointRaiseLower(
    mode: ThermostatTrait.SetpointRaiseLowerModeEnum,
    amount: Byte
): Unit
```

Change the setpoint for the current thermostat mode.

| Parameters |
|---|---|
| `mode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.SetpointRaiseLowerModeEnum` | The setpoint(s) to be adjusted. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.SetpointRaiseLowerModeEnum`. |
| `amount: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html` | The amount (possibly negative) that should be added to the setpoint(s), in steps of 0.1°C. |

### setpointRaiseLowerBatchable

```
fun setpointRaiseLowerBatchable(
    mode: ThermostatTrait.SetpointRaiseLowerModeEnum,
    amount: Byte
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatCommands#setpointRaiseLower(com.google.home.matter.standard.ThermostatTrait.SetpointRaiseLowerModeEnum,kotlin.Byte)` command.

Change the setpoint for the current thermostat mode.

| Parameters |
|---|---|
| `mode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.SetpointRaiseLowerModeEnum` | The setpoint(s) to be adjusted. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatTrait.SetpointRaiseLowerModeEnum`. |
| `amount: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html` | The amount (possibly negative) that should be added to the setpoint(s), in steps of 0.1°C. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |