# ModeSelect

# ModeSelect


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ModeSelect : ModeSelectTrait.Attributes, MatterTrait, Updatable, ModeSelectCommands
```

<br />

*** ** * ** ***

API for the ModeSelect trait. This trait provides an interface for controlling a characteristic of a device that can be set to one of several predefined values.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect.Attribute : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this trait's attributes. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect#supports(com.google.home.matter.standard.ModeSelect.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect#supports(com.google.home.matter.standard.ModeSelect.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<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#factory()` |

| ### Inherited functions |
|---|
| From [com.google.home.matter.standard.ModeSelectCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectCommands) |---|---| | `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. | |
| From [com.google.home.matter.standard.ModeSelectTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes) |---|---| | `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#getDescriptor()()` Returns the descriptor for the struct. | | `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. | |
| From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()` | |
| From [com.google.home.Updatable](https://developers.home.google.com/reference/kotlin/com/google/home/Updatable) |---|---| | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect` | `https://developers.home.google.com/reference/kotlin/com/google/home/Updatable#update(kotlin.Function1,kotlin.Function1)(optimisticReturn: (https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelect) -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html, init: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.MutableAttributes.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state. | |

| ### Inherited properties |
|---|
| From [com.google.home.matter.standard.ModeSelectTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes) |---|---| | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#currentMode()` The current mode of a cluster instance on a device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#description()` Describes the purpose of the mode in this cluster instance. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#onMode()` The value of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#currentMode()` that depends on the state of an `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/OnOff` cluster on the same endpoint. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#standardNamespace()` The single standard namespace for any standard semantic tag value supported in this or any other cluster instance with the same namespace. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#startUpMode()` The desired startup mode for the device when it is supplied with power. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.ModeOptionStruct>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ModeSelectTrait.Attributes#supportedModes()` The list of supported modes for the cluster instance. | |
| From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) |---|---| | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()` | |

## Public functions

### supports

```
fun supports(attribute: ModeSelect.Attribute): Boolean
```

### supports

```
fun supports(command: ModeSelect.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<ModeSelect>
```