DishwasherAlarmTrait.AlarmBitmap

data class DishwasherAlarmTrait.AlarmBitmap


Bitmap indicating which alarms are supported.

Summary

Public constructors

AlarmBitmap(
    inflowError: Boolean,
    drainError: Boolean,
    doorError: Boolean,
    tempTooLow: Boolean,
    tempTooHigh: Boolean,
    waterLevelError: Boolean
)

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

Door or door lock is abnormal.

Boolean

Water draining is abnormal.

Boolean

Water inflow is abnormal.

Boolean

Temperature is too high.

Boolean

Temperature is too low.

String

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

Boolean

Water level is abnormal.

Public constructors

AlarmBitmap

AlarmBitmap(
    inflowError: Boolean = false,
    drainError: Boolean = false,
    doorError: Boolean = false,
    tempTooLow: Boolean = false,
    tempTooHigh: Boolean = false,
    waterLevelError: Boolean = false
)

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

doorError

val doorErrorBoolean

Door or door lock is abnormal.

drainError

val drainErrorBoolean

Water draining is abnormal.

inflowError

val inflowErrorBoolean

Water inflow is abnormal.

tempTooHigh

val tempTooHighBoolean

Temperature is too high.

tempTooLow

val tempTooLowBoolean

Temperature is too low.

traitId

val traitIdString

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

waterLevelError

val waterLevelErrorBoolean

Water level is abnormal.