# WindowCovering


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface WindowCovering : WindowCoveringTrait.Attributes, MatterTrait, Updatable, WindowCoveringCommands
```

<br />

*** ** * ** ***

API for the WindowCovering trait. This trait provides an interface to an automatic window covering that can be raised or tilted.

## Summary

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

| ### Inherited functions |
|---|
| 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/WindowCovering` | `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/WindowCovering) -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html, init: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.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. | |
| From [com.google.home.matter.standard.WindowCoveringCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringCommands) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringCommands#downOrClose()()` Adjust the window covering position so the physical lift or slide and tilt is at the maximum closed or down position. | | `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/WindowCoveringCommands#downOrCloseBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringCommands#downOrClose()` 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/WindowCoveringCommands#goToLiftPercentage(kotlin.UShort)(liftPercent100thsValue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Adjust the window covering to the specified lift position. | | `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/WindowCoveringCommands#goToLiftPercentageBatchable(kotlin.UShort)(liftPercent100thsValue: 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/WindowCoveringCommands#goToLiftPercentage(kotlin.UShort)` 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/WindowCoveringCommands#goToLiftValue(kotlin.UShort)(liftValue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Adjust the window covering to the specified lift position. | | `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/WindowCoveringCommands#goToLiftValueBatchable(kotlin.UShort)(liftValue: 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/WindowCoveringCommands#goToLiftValue(kotlin.UShort)` 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/WindowCoveringCommands#goToTiltPercentage(kotlin.UShort)(tiltPercent100thsValue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Adjust the window covering to the specified tilt position. | | `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/WindowCoveringCommands#goToTiltPercentageBatchable(kotlin.UShort)(tiltPercent100thsValue: 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/WindowCoveringCommands#goToTiltPercentage(kotlin.UShort)` 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/WindowCoveringCommands#goToTiltValue(kotlin.UShort)(tiltValue: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Adjust the window covering to the specified tilt position. | | `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/WindowCoveringCommands#goToTiltValueBatchable(kotlin.UShort)(tiltValue: 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/WindowCoveringCommands#goToTiltValue(kotlin.UShort)` 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/WindowCoveringCommands#stopMotion()()` Stop any adjustments to physical tilt and lift or slide that is currently underway. | | `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/WindowCoveringCommands#stopMotionBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringCommands#stopMotion()` 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/WindowCoveringCommands#upOrOpen()()` Adjust the window covering position so the physical lift or slide and tilt is at the maximum open or up position. | | `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/WindowCoveringCommands#upOrOpenBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringCommands#upOrOpen()` command. | |
| From [com.google.home.matter.standard.WindowCoveringTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.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/WindowCoveringTrait.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/WindowCoveringTrait.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. | |

| ### Inherited properties |
|---|
| 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()` | |
| From [com.google.home.matter.standard.WindowCoveringTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.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/WindowCoveringTrait.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/WindowCoveringTrait.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/WindowCoveringTrait.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/WindowCoveringTrait.ConfigStatus?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#configStatus()` Configuration and status information for the window covering. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#currentPositionLift()` The distance of the window covering from the fully-open position, in centimeters. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#currentPositionLiftPercent100ths()` The position of the window covering as a percentage with a minimum step of 0.01%. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#currentPositionLiftPercentage()` The position of the window covering as a percentage with a 1% default step. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#currentPositionTilt()` The current tilt position of the window covering, in degrees. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#currentPositionTiltPercent100ths()` The position of the window covering as a percentage with a minimal step of 0.01%. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#currentPositionTiltPercentage()` The position of the window covering as a percentage with a 1% default step. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.EndProductType?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#endProductType()` With the WindowCovering.Type, this specifies the subtype of window covering. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.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/WindowCoveringTrait.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-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#installedClosedLimitLift()` The closed limit when tilting the window covering, in tenths of a degree. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#installedClosedLimitTilt()` The closed limit when lifting the window covering, in tenths of a degree. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#installedOpenLimitLift()` The open limit for lifting the window covering, in centimeters. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#installedOpenLimitTilt()` The open limit for tilting the window covering, in tenths of a degree. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Mode?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#mode()` Allows configuration of the window covering, such as: reversing the motor direction, or placing the motor into maintenance mode. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#numberOfActuationsLift()` The total number of lift or slide actuations applied to the window covering since it was installed. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#numberOfActuationsTilt()` The total number of tilt actuations applied to the window covering since it was installed. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.OperationalStatus?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#operationalStatus()` Indicates currently ongoing operations and applies to all types of devices. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#physicalClosedLimitLift()` The maximum possible encoder position for setting the height of the window covering, in centimeters. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#physicalClosedLimitTilt()` The maximum possible encoder position for setting the angle of the window covering. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.SafetyStatus?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#safetyStatus()` Reflects the state of the safety sensors and the common issues preventing movements. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#targetPositionLiftPercent100ths()` The lift position which the window covering is moving to, as a percentage. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#targetPositionTiltPercent100ths()` The tilt position which the window covering is moving to, as a percentage. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Type?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/WindowCoveringTrait.Attributes#type()` The type of window covering. | |

## Public functions

### supports

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

### supports

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

## Public properties

### factory

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