WindowCoveringTrait.Mode

data class WindowCoveringTrait.Mode

Can be used to configure the window covering by enabling or disabling various modes and capabilities.

Summary

Public constructors
Mode(
    motorDirectionReversed: Boolean,
    calibrationMode: Boolean,
    maintenanceMode: Boolean,
    ledFeedback: Boolean
)

Creates the Mode data class.

Public functions
open ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties
String

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

When set to true, the window covering is in calibration mode.
Boolean

When set to true, the LEDs display feedback.
Boolean

When set to true, the window covering is in maintenance mode.
Boolean

When set to true, the lift movement is reversed.
String

Trait identifier of the Matter Cluster that defines the bitmap Data Type.

Public constructors

Mode

Mode(
    motorDirectionReversed: Boolean = false,
    calibrationMode: Boolean = false,
    maintenanceMode: Boolean = false,
    ledFeedback: Boolean = false
)

Creates the Mode 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.

calibrationMode

val calibrationMode: Boolean

When set to true, the window covering is in calibration mode. When set to false, the window covering is in normal mode.

ledFeedback

val ledFeedback: Boolean

When set to true, the LEDs display feedback. When set to false, the LEDs are off.

maintenanceMode

val maintenanceMode: Boolean

When set to true, the window covering is in maintenance mode. When set to false, the window covering is in normal mode.

motorDirectionReversed

val motorDirectionReversed: Boolean

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

traitId

val traitId: String

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