ColorControlTrait.StepColorCommand.Request

class ColorControlTrait.StepColorCommand.Request : ClusterStruct


The request payload for the StepColor command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Request(
    stepX: Short,
    stepY: Short,
    transitionTime: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap,
    optionsOverride: ColorControlTrait.OptionsBitmap
)

Creates a request payload for the StepColor 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.

Short

The change to be added to the device's currentX attribute.

Short

The change to be added to the device's currentY attribute.

UShort

The time (in 0.1 seconds) taken to move the device to the new color.

Public constructors

Request

Request(
    stepX: Short = 0,
    stepY: Short = 0,
    transitionTime: UShort,
    optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the StepColor 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.

stepX

val stepXShort

The change to be added to the device's currentX attribute.

stepY

val stepYShort

The change to be added to the device's currentY attribute.

transitionTime

val transitionTimeUShort

The time (in 0.1 seconds) taken to move the device to the new color.