ActionsTrait.CommandBits

data class ActionsTrait.CommandBits


Bitmap indicating which commands are supported.

Summary

Public constructors

CommandBits(
    instantAction: Boolean,
    instantActionWithTransition: Boolean,
    startAction: Boolean,
    startActionWithDuration: Boolean,
    stopAction: Boolean,
    pauseAction: Boolean,
    pauseActionWithDuration: Boolean,
    resumeAction: Boolean,
    enableAction: Boolean,
    enableActionWithDuration: Boolean,
    disableAction: Boolean,
    disableActionWithDuration: Boolean
)

Creates the CommandBits data class.

Public functions

open ULong

Convert this ClusterBitmap to raw (bytes) format

Public constructors

CommandBits

CommandBits(
    instantAction: Boolean = false,
    instantActionWithTransition: Boolean = false,
    startAction: Boolean = false,
    startActionWithDuration: Boolean = false,
    stopAction: Boolean = false,
    pauseAction: Boolean = false,
    pauseActionWithDuration: Boolean = false,
    resumeAction: Boolean = false,
    enableAction: Boolean = false,
    enableActionWithDuration: Boolean = false,
    disableAction: Boolean = false,
    disableActionWithDuration: Boolean = false
)

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

disableAction

val disableActionBoolean

Supports the DisableActionCommand.

disableActionWithDuration

val disableActionWithDurationBoolean

Supports the DisableActionWithDurationCommand.

enableAction

val enableActionBoolean

Supports the EnableActionCommand.

enableActionWithDuration

val enableActionWithDurationBoolean

Supports the EnableActionWithDurationCommand.

instantAction

val instantActionBoolean

Supports the InstantActionCommand.

instantActionWithTransition

val instantActionWithTransitionBoolean

Supports the InstantActionWithTransitionCommand.

pauseAction

val pauseActionBoolean

Supports the PauseActionCommand.

pauseActionWithDuration

val pauseActionWithDurationBoolean

Supports the PauseActionWithDurationCommand.

resumeAction

val resumeActionBoolean

Supports the ResumeActionCommand.

startAction

val startActionBoolean

Supports the StartActionCommand.

startActionWithDuration

val startActionWithDurationBoolean

Supports the StartActionWithDurationCommand.

stopAction

val stopActionBoolean

Supports the StopActionCommand.

traitId

val traitIdString

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