# ModeSelectCommands

# ModeSelectCommands


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

<br />

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

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

*** ** * ** ***

Commands for the ModeSelect trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectCommands#changeToMode(kotlin.UByte)(newMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` Change the mode of the device's cluster instance, and set the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#currentMode()` attribute of the device's cluster instance. |
| `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/ModeSelectCommands#changeToModeBatchable(kotlin.UByte)(newMode: 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/ModeSelectCommands#changeToMode(kotlin.UByte)` command. |

## Public functions

### changeToMode

```
suspend fun changeToMode(newMode: UByte): Unit
```

Change the mode of the device's cluster instance, and set the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#currentMode()` attribute of the device's cluster instance.

| Parameters |
|---|---|
| `newMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The mode to set the cluster instance to. This must be one of the values in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.ModeOptionStruct`. |

### changeToModeBatchable

```
fun changeToModeBatchable(newMode: UByte): BatchableCommand<Unit>
```

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

Change the mode of the device's cluster instance, and set the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#currentMode()` attribute of the device's cluster instance.

| Parameters |
|---|---|
| `newMode: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The mode to set the cluster instance to. This must be one of the values in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.ModeOptionStruct`. |

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