SwitchTrait.MultiPressOngoing

interface SwitchTrait.MultiPressOngoing : ClusterStruct

Indicates how many times the momentary switch has been pressed in a multi-press sequence.

Summary

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
UByte?

Valid values are:

  • 2 when the second press of a multi-press sequence has been detected,
  • 3 when the third press of a multi-press sequence has been detected,
  • n when the nth press of a multi-press sequence has been detected.
UByte?

The value of the currentPosition attribute after the press.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

currentNumberOfPressesCounted

val currentNumberOfPressesCounted: UByte?

Valid values are:

  • 2 when the second press of a multi-press sequence has been detected,
  • 3 when the third press of a multi-press sequence has been detected,
  • n when the nth press of a multi-press sequence has been detected.

newPosition

val newPosition: UByte?

The value of the currentPosition attribute after the press.