FanControlTrait.RockBitmap

data class FanControlTrait.RockBitmap


The current active fan rocking motion setting.

Summary

Public constructors

RockBitmap(rockLeftRight: Boolean, rockUpDown: Boolean, rockRound: Boolean)

Creates the RockBitmap 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

The fan is using a rock left to right setting.

Boolean

The fan is using a rock around setting.

Boolean

The fan is using a rock up and down setting.

String

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

Public constructors

RockBitmap

RockBitmap(
    rockLeftRight: Boolean = false,
    rockUpDown: Boolean = false,
    rockRound: Boolean = false
)

Creates the RockBitmap data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

bitmapName

val bitmapNameString

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

rockLeftRight

val rockLeftRightBoolean

The fan is using a rock left to right setting.

rockRound

val rockRoundBoolean

The fan is using a rock around setting.

rockUpDown

val rockUpDownBoolean

The fan is using a rock up and down setting.

traitId

val traitIdString

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