ThermostatTrait.RelayStateBitmap

data class ThermostatTrait.RelayStateBitmap


Thermostate running states.

Summary

Public constructors

RelayStateBitmap(
    heat: Boolean,
    cool: Boolean,
    fan: Boolean,
    heatStage2: Boolean,
    coolStage2: Boolean,
    fanStage2: Boolean,
    fanStage3: Boolean
)

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

Cool Stage On

Boolean

Cool 2nd Stage On

Boolean

Fan Stage On

Boolean

Fan 2nd Stage On

Boolean

Fan 3rd Stage On

Boolean

Heat Stage On

Boolean

Heat 2nd Stage On

String

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

Public constructors

RelayStateBitmap

RelayStateBitmap(
    heat: Boolean = false,
    cool: Boolean = false,
    fan: Boolean = false,
    heatStage2: Boolean = false,
    coolStage2: Boolean = false,
    fanStage2: Boolean = false,
    fanStage3: Boolean = false
)

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

cool

val coolBoolean

Cool Stage On

coolStage2

val coolStage2Boolean

Cool 2nd Stage On

fan

val fanBoolean

Fan Stage On

fanStage2

val fanStage2Boolean

Fan 2nd Stage On

fanStage3

val fanStage3Boolean

Fan 3rd Stage On

heat

val heatBoolean

Heat Stage On

heatStage2

val heatStage2Boolean

Heat 2nd Stage On

traitId

val traitIdString

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