ColorControlTrait.StopMoveStepCommand.Request

class ColorControlTrait.StopMoveStepCommand.Request : ClusterStruct


The request payload for the StopMoveStep command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(
    optionsMask: ColorControlTrait.OptionsBitmap,
    optionsOverride: ColorControlTrait.OptionsBitmap
)

Creates a request payload for the StopMoveStep command.

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

ColorControlTrait.OptionsBitmap

Determines which bits in the options attribute should be overridden by optionsOverride.

ColorControlTrait.OptionsBitmap

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

Public constructors

Request

Request(
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the StopMoveStep command.

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

optionsMask

val optionsMaskColorControlTrait.OptionsBitmap

Determines which bits in the options attribute should be overridden by optionsOverride.

optionsOverride

val optionsOverrideColorControlTrait.OptionsBitmap

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.