KeypadInputTrait.Feature

data class KeypadInputTrait.Feature


KeypadInput cluster FeatureMap.

Summary

Public constructors

Feature(
    navigationKeyCodes: Boolean,
    locationKeys: Boolean,
    numberKeys: Boolean
)

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

Supports CEC keys 0x0A (Settings) and 0x09 (Home).

Boolean

Supports UP, DOWN, LEFT, RIGHT, SELECT, BACK, EXIT, and MENU keys.

Boolean

Supports numeric input keys from 0 through 9.

String

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

Public constructors

Feature

Feature(
    navigationKeyCodes: Boolean = false,
    locationKeys: Boolean = false,
    numberKeys: Boolean = false
)

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

locationKeys

val locationKeysBoolean

Supports CEC keys 0x0A (Settings) and 0x09 (Home).

val navigationKeyCodesBoolean

Supports UP, DOWN, LEFT, RIGHT, SELECT, BACK, EXIT, and MENU keys.

numberKeys

val numberKeysBoolean

Supports numeric input keys from 0 through 9.

traitId

val traitIdString

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