DoorLockTrait.DlKeypadOperationEventMask

data class DoorLockTrait.DlKeypadOperationEventMask

Event mask used to enable and disable the transmission of keypad operation events.

Summary

Public constructors
`DlKeypadOperationEventMask( unknown: Boolean, lock: Boolean, unlock: Boolean, lockInvalidPin: Boolean, lockInvalidSchedule: Boolean, unlockInvalidCode: Boolean, unlockInvalidSchedule: Boolean, nonAccessUserOpEvent: Boolean )` Creates the DlKeypadOperationEventMask data class.

Public functions
`open ULong`	`toRaw()` Convert this ClusterBitmap to raw (bytes) format

Public properties
`String`	`bitmapName` Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
`Boolean`	`lock` Lock event sent by the keypad.
`Boolean`	`lockInvalidPin` Lock event sent by the keypad with the error message 'invalid PIN'.
`Boolean`	`lockInvalidSchedule` Lock event sent by the keypad with the error message 'invalid schedule'.
`Boolean`	`nonAccessUserOpEvent` Non-access user operation event sent by the keypad.
`String`	`traitId` Trait identifier of the Matter Cluster that defines the bitmap Data Type.
`Boolean`	`unknown` Unknown or manufacturer-specific keypad operation event.
`Boolean`	`unlock` Unlock event sent by the keypad.
`Boolean`	`unlockInvalidCode` Unlock event sent by the keypad with the error message 'invalid code'.
`Boolean`	`unlockInvalidSchedule` Unlock event sent by the keypad with the error message 'invalid schedule'.

Public constructors

DlKeypadOperationEventMask

DlKeypadOperationEventMask(
    unknown: Boolean = false,
    lock: Boolean = false,
    unlock: Boolean = false,
    lockInvalidPin: Boolean = false,
    lockInvalidSchedule: Boolean = false,
    unlockInvalidCode: Boolean = false,
    unlockInvalidSchedule: Boolean = false,
    nonAccessUserOpEvent: Boolean = false
)

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

lock

val lock: Boolean

Lock event sent by the keypad.

lockInvalidPin

val lockInvalidPin: Boolean

Lock event sent by the keypad with the error message 'invalid PIN'.

lockInvalidSchedule

val lockInvalidSchedule: Boolean

Lock event sent by the keypad with the error message 'invalid schedule'.

nonAccessUserOpEvent

val nonAccessUserOpEvent: Boolean

Non-access user operation event sent by the keypad.

traitId

val traitId: String

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

unknown

val unknown: Boolean

Unknown or manufacturer-specific keypad operation event.

unlock

val unlock: Boolean

Unlock event sent by the keypad.

unlockInvalidCode

val unlockInvalidCode: Boolean

Unlock event sent by the keypad with the error message 'invalid code'.

unlockInvalidSchedule

val unlockInvalidSchedule: Boolean

Unlock event sent by the keypad with the error message 'invalid schedule'.