LevelControlTrait.OptionsBitmap

data class LevelControlTrait.OptionsBitmap

Flags for LevelControl options.

Summary

Public constructors
OptionsBitmap(executeIfOff: Boolean, coupleColorTempToLevel: Boolean)

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

Couple changes to the currentlevel attribute with the color temperature set in the ColorControl.Attributes.colorTemperatureMireds attribute of the LevelControl cluster.
Boolean

Indicates a dependency on the OnOff cluster.
String

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

Public constructors

OptionsBitmap

OptionsBitmap(
    executeIfOff: Boolean = false,
    coupleColorTempToLevel: Boolean = false
)

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

coupleColorTempToLevel

val coupleColorTempToLevel: Boolean

Couple changes to the currentlevel attribute with the color temperature set in the ColorControl.Attributes.colorTemperatureMireds attribute of the LevelControl cluster. This bit is ignored if the lighting feature is not supported.

executeIfOff

val executeIfOff: Boolean

Indicates a dependency on the OnOff cluster. A LevelControl command does not continue past options processing if all of the following are true:

  • The command is Move, MoveToLevel, Step, or Stop.
  • The OnOff cluster exists on the same endpoint as this cluster.
  • The onOff attribute of the OnOff cluster on this endpoint is false.
  • The value of this bit (executeIfOff) is 0.

traitId

val traitId: String

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