LevelControlTrait.MoveToLevelCommand.Request

class LevelControlTrait.MoveToLevelCommand.Request


The request payload for the MoveToLevel command.

Summary

Public constructors

Request(
    level: UByte,
    transitionTime: UShort?,
    optionsMask: LevelControlTrait.OptionsBitmap,
    optionsOverride: LevelControlTrait.OptionsBitmap
)

Creates a request payload for the MoveToLevel command.

Public properties

UByte

The level to move the device to.

LevelControlTrait.OptionsBitmap

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

LevelControlTrait.OptionsBitmap

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

UShort?

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

Public constructors

Request

Request(
    level: UByte,
    transitionTime: UShort? = null,
    optionsMask: LevelControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: LevelControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the MoveToLevel command.

Public properties

level

val levelUByte

The level to move the device to.

optionsMask

val optionsMaskLevelControlTrait.OptionsBitmap

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

optionsOverride

val optionsOverrideLevelControlTrait.OptionsBitmap

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

transitionTime

val transitionTimeUShort?

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