# LowPower


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface LowPower : LowPowerTrait.Attributes, MatterTrait, LowPowerCommands
```

<br />

*** ** * ** ***

API for the LowPower trait. This trait provides an interface for managing low power mode on a device.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPower.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/LowPower.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/LowPower#supports(com.google.home.matter.standard.LowPower.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPower.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPower#supports(com.google.home.matter.standard.LowPower.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPower.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/LowPower>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPower#factory()` |

### Inherited functions

From [com.google.home.matter.standard.LowPowerCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPowerCommands) `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPowerCommands#sleep()()`

Put the device into low power 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/LowPowerCommands#sleepBatchable()()`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPowerCommands#sleep()` command.
From [com.google.home.matter.standard.LowPowerTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPowerTrait.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/LowPowerTrait.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/LowPowerTrait.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()()`

### Inherited properties

From [com.google.home.matter.standard.LowPowerTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPowerTrait.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/LowPowerTrait.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/LowPowerTrait.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/LowPowerTrait.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/LowPowerTrait.Feature` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/LowPowerTrait.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/LowPowerTrait.Attributes#generatedCommandList()`

A list of server-generated commands (server to client) which are supported by this cluster server 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: LowPower.Attribute): Boolean
```

### supports

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

## Public properties

### factory

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