LevelControlTrait.MoveWithOnOffCommand.Request

class LevelControlTrait.MoveWithOnOffCommand.Request


The request payload for the MoveWithOnOff command.

Summary

Public constructors

Request(
    moveMode: LevelControlTrait.MoveModeEnum,
    rate: UByte?,
    optionsMask: LevelControlTrait.OptionsBitmap,
    optionsOverride: LevelControlTrait.OptionsBitmap
)

Creates a request payload for the MoveWithOnOff command.

Public properties

LevelControlTrait.MoveModeEnum

The direction in which to move the level.

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.

UByte?

The rate (in units per seconds) used to move the device's currentLevel to the minLevel or maxLevel.

Public constructors

Request

Request(
    moveMode: LevelControlTrait.MoveModeEnum = MoveModeEnum.Up,
    rate: UByte? = null,
    optionsMask: LevelControlTrait.OptionsBitmap = OptionsBitmap(),
    optionsOverride: LevelControlTrait.OptionsBitmap = OptionsBitmap()
)

Creates a request payload for the MoveWithOnOff command.

Public properties

moveMode

val moveModeLevelControlTrait.MoveModeEnum

The direction in which to move the level. This must be one of the values in LevelControlTrait.MoveModeEnum.

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.

rate

val rateUByte?

The rate (in units per seconds) used to move the device's currentLevel to the minLevel or maxLevel.