ValveConfigurationAndControlTrait.ValveFaultBitmap

data class ValveConfigurationAndControlTrait.ValveFaultBitmap

The reason for a valve fault condition.

Summary

Public constructors
ValveFaultBitmap(
    generalFault: Boolean,
    blocked: Boolean,
    leaking: Boolean,
    notConnected: Boolean,
    shortCircuit: Boolean,
    currentExceeded: Boolean
)

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

Blocked.
Boolean

Available current exceeded.
Boolean

Unspecified fault.
Boolean

Leak detected.
Boolean

No valve is connected to the controller.
Boolean

Short circuit detected.
String

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

Public constructors

ValveFaultBitmap

ValveFaultBitmap(
    generalFault: Boolean = false,
    blocked: Boolean = false,
    leaking: Boolean = false,
    notConnected: Boolean = false,
    shortCircuit: Boolean = false,
    currentExceeded: Boolean = false
)

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

blocked

val blocked: Boolean

Blocked.

currentExceeded

val currentExceeded: Boolean

Available current exceeded.

generalFault

val generalFault: Boolean

Unspecified fault.

leaking

val leaking: Boolean

Leak detected.

notConnected

val notConnected: Boolean

No valve is connected to the controller.

shortCircuit

val shortCircuit: Boolean

Short circuit detected.

traitId

val traitId: String

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