WindowCoveringTrait.ConfigStatus

data class WindowCoveringTrait.ConfigStatus

Configuration and status information for the WindowCovering.

Summary

Public constructors
`ConfigStatus( operational: Boolean, onlineReserved: Boolean, liftMovementReversed: Boolean, liftPositionAware: Boolean, tiltPositionAware: Boolean, liftEncoderControlled: Boolean, tiltEncoderControlled: Boolean )` Creates the ConfigStatus data class.

Public functions
`open ULong`	`toRaw()` Convert this ClusterBitmap to raw (bytes) format

Public properties
`String`	`bitmapName` Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
`Boolean`	`liftEncoderControlled` When set to `true`, the window covering uses an encoder to set the height.
`Boolean`	`liftMovementReversed` When set to `true`, lift movement is reversed.
`Boolean`	`liftPositionAware` When set to `true`, the lift control is position-aware.
`Boolean`	`onlineReserved` Deprecated.
`Boolean`	`operational` When set to `true`, the window covering is operational.
`Boolean`	`tiltEncoderControlled` When set to `true`, the window covering uses an encoder to set the tilt angle.
`Boolean`	`tiltPositionAware` When set to `true`, the tilt control is position-aware.
`String`	`traitId` Trait identifier of the Matter Cluster that defines the bitmap Data Type.

Public constructors

ConfigStatus

ConfigStatus(
    operational: Boolean = false,
    onlineReserved: Boolean = false,
    liftMovementReversed: Boolean = false,
    liftPositionAware: Boolean = false,
    tiltPositionAware: Boolean = false,
    liftEncoderControlled: Boolean = false,
    tiltEncoderControlled: Boolean = false
)

Creates the ConfigStatus data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

bitmapName

val bitmapName: String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.

liftEncoderControlled

val liftEncoderControlled: Boolean

When set to true, the window covering uses an encoder to set the height. When set to false, the window covering doesn't use an encoder to set the height.

liftMovementReversed

val liftMovementReversed: Boolean

When set to true, lift movement is reversed. When set to false, the lift movement is in the normal direction.

liftPositionAware

val liftPositionAware: Boolean

When set to true, the lift control is position-aware. When set to false, the lift control isn't position-aware.

onlineReserved

val onlineReserved: Boolean

Deprecated.

operational

val operational: Boolean

When set to true, the window covering is operational. When set to false, the window covering is not operational.

tiltEncoderControlled

val tiltEncoderControlled: Boolean

When set to true, the window covering uses an encoder to set the tilt angle. When set to false, the window covering doesn't use an encoder to set the tilt angle.

tiltPositionAware

val tiltPositionAware: Boolean

When set to true, the tilt control is position-aware. When set to false, the tilt control isn't position-aware.

traitId

val traitId: String

Trait identifier of the Matter Cluster that defines the bitmap Data Type. Refer to ClusterId.traitId for the format.