SwitchTrait.Feature

data class SwitchTrait.Feature

Switch cluster FeatureMap.

Summary

Public constructors
`Feature( latchingSwitch: Boolean, momentarySwitch: Boolean, momentarySwitchRelease: Boolean, momentarySwitchLongPress: Boolean, momentarySwitchMultiPress: Boolean, actionSwitch: Boolean )` Creates the Feature data class.

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

Public properties
`Boolean`	`actionSwitch`
`String`	`bitmapName` Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
`Boolean`	`latchingSwitch` The latching switch (such as a rocker) maintains its position after being pressed or turned.
`Boolean`	`momentarySwitch` The momentary switch (such as a push button) does not maintain its position after being pressed or turned.
`Boolean`	`momentarySwitchLongPress` The momentary switch (such as a push button) can distinguish and report long pressed from short presses.
`Boolean`	`momentarySwitchMultiPress` The momentary switch (such as a push button) can distinguish and report double press and potentially multiple presses with more events, such as a triple press.
`Boolean`	`momentarySwitchRelease` The momentary switch (such as a push button) can distinguish and report release events.
`String`	`traitId` Trait identifier of the Matter Cluster that defines the bitmap Data Type.

Public constructors

Feature

Feature(
    latchingSwitch: Boolean = false,
    momentarySwitch: Boolean = false,
    momentarySwitchRelease: Boolean = false,
    momentarySwitchLongPress: Boolean = false,
    momentarySwitchMultiPress: Boolean = false,
    actionSwitch: Boolean = false
)

Creates the Feature data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

actionSwitch

val actionSwitch: Boolean

bitmapName

val bitmapName: String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.

latchingSwitch

val latchingSwitch: Boolean

The latching switch (such as a rocker) maintains its position after being pressed or turned.

momentarySwitch

val momentarySwitch: Boolean

The momentary switch (such as a push button) does not maintain its position after being pressed or turned. After releasing, it goes back to its idle position.

momentarySwitchLongPress

val momentarySwitchLongPress: Boolean

The momentary switch (such as a push button) can distinguish and report long pressed from short presses.

momentarySwitchMultiPress

val momentarySwitchMultiPress: Boolean

The momentary switch (such as a push button) can distinguish and report double press and potentially multiple presses with more events, such as a triple press.

momentarySwitchRelease

val momentarySwitchRelease: Boolean

The momentary switch (such as a push button) can distinguish and report release events.

traitId

val traitId: String

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