# ThermostatUserInterfaceConfiguration


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ThermostatUserInterfaceConfiguration : ThermostatUserInterfaceConfigurationTrait.Attributes, MatterTrait, Updatable
```

<br />

*** ** * ** ***

API for the ThermostatUserInterfaceConfiguration trait. This trait provides an interface to allow configuration of the user interface for a thermostat, or a thermostat controller device, that supports a keypad and LCD screen.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfiguration.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. |

| ### 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/ThermostatUserInterfaceConfiguration#supports(com.google.home.matter.standard.ThermostatUserInterfaceConfiguration.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfiguration.Attribute)` |

| ### 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/ThermostatUserInterfaceConfiguration>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfiguration#factory()` |

### Inherited functions

From [com.google.home.matter.standard.ThermostatUserInterfaceConfigurationTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfiguration` `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/ThermostatUserInterfaceConfiguration) -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html,
init: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.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.ThermostatUserInterfaceConfigurationTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfigurationTrait.Attributes#clusterRevision()`

The revision of the server cluster specification supported by the cluster instance.
`https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.Feature` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.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/ThermostatUserInterfaceConfigurationTrait.Attributes#generatedCommandList()`

A list of server-generated commands (server to client) which are supported by this cluster server instance.
`https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.KeypadLockoutEnum?` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.Attributes#keypadLockout()`

Indicates the level of functionality available to the user through the thermostat's keypad.
`https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.ScheduleProgrammingVisibilityEnum?` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.Attributes#scheduleProgrammingVisibility()`

Hides the weekly schedule programming functionality or menu on a thermostat from the user, preventing local user programming of the weekly schedule.
`https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.TemperatureDisplayModeEnum?` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ThermostatUserInterfaceConfigurationTrait.Attributes#temperatureDisplayMode()`

Indicates the units of temperature (Celsius or Fahrenheit) displayed on the thermostat screen.
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: ThermostatUserInterfaceConfiguration.Attribute): Boolean
```

## Public properties

### factory

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