WindowCovering

interface WindowCovering : WindowCoveringTrait.Attributes, MatterTrait, Updatable, WindowCoveringCommands

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

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<WindowCovering>

Inherited functions
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend WindowCovering
update(optimisticReturn: (WindowCovering) -> Unit, init: WindowCoveringTrait.MutableAttributes.() -> Unit)

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
suspend Unit

Adjust the window covering position so the physical lift or slide and tilt is at the maximum closed or down position.
suspend Unit
goToLiftPercentage(liftPercent100thsValue: UShort)

Adjust the window covering to the specified lift position.
suspend Unit
goToLiftValue(liftValue: UShort)

Adjust the window covering to the specified lift position.
suspend Unit
goToTiltPercentage(tiltPercent100thsValue: UShort)

Adjust the window covering to the specified tilt position.
suspend Unit
goToTiltValue(tiltValue: UShort)

Adjust the window covering to the specified tilt position.
suspend Unit

Stop any adjustments to physical tilt and lift or slide that is currently underway.
suspend Unit

Adjust the window covering position so the physical lift or slide and tilt is at the maximum open or up position.

Inherited properties
From com.google.home.Trait
Trait.TraitMetadata
From com.google.home.matter.standard.WindowCoveringTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
WindowCoveringTrait.ConfigStatus?
UShort?

The distance of the window covering from the fully-open position, in centimeters.
UShort?

The position of the window covering as a percentage with a minimum step of 0.01%.
UByte?

The position of the window covering as a percentage with a 1% default step.
UShort?

The current tilt position of the window covering, in degrees.
UShort?

The position of the window covering as a percentage with a minimal step of 0.01%.
UByte?

The position of the window covering as a percentage with a 1% default step.
WindowCoveringTrait.EndProductType?
WindowCoveringTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
UShort?

The closed limit when tilting the window covering, in tenths of a degree.
UShort?

The closed limit when lifting the window covering, in tenths of a degree.
UShort?

The open limit for lifting the window covering, in centimeters.
UShort?

The open limit for tilting the window covering, in tenths of a degree.
WindowCoveringTrait.Mode?
UShort?

The total number of lift or slide actuations applied to the window covering since it was installed.
UShort?

The total number of tilt actuations applied to the window covering since it was installed.
WindowCoveringTrait.OperationalStatus?
UShort?

The maximum possible encoder position for setting the height of the window covering, in centimeters.
UShort?

The maximum possible encoder position for setting the angle of the window covering.
WindowCoveringTrait.SafetyStatus?
UShort?

The lift position which the window covering is moving to, as a percentage.
UShort?

The tilt position which the window covering is moving to, as a percentage.
WindowCoveringTrait.Type?

Public functions

supports

fun supports(attribute: WindowCovering.Attribute): Boolean

supports

fun supports(command: WindowCovering.Command): Boolean

Public properties

factory

open val factory: TraitFactory<WindowCovering>