SwitchTrait.MultiPressComplete

interface SwitchTrait.MultiPressComplete : 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?

The value of the currentPosition attribute just prior to the release.
UByte?

Valid values are:

  • 1 when there was one press, and the sequence has ended - in other words, it was not a multiple-press,
  • 2 when there were exactly two presses in a multi-press sequence, and the the sequence has ended,
  • 3 when there were exactly three presses in a multi-press sequence, and the the sequence has ended,
  • n when there were exactly n presses in a multi-press sequence, and the sequence has ended.

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

previousPosition

val previousPosition: UByte?

The value of the currentPosition attribute just prior to the release.

totalNumberOfPressesCounted

val totalNumberOfPressesCounted: UByte?

Valid values are:

  • 1 when there was one press, and the sequence has ended - in other words, it was not a multiple-press,
  • 2 when there were exactly two presses in a multi-press sequence, and the the sequence has ended,
  • 3 when there were exactly three presses in a multi-press sequence, and the the sequence has ended,
  • n when there were exactly n presses in a multi-press sequence, and the sequence has ended.