LevelControlTrait.StepWithOnOffCommand.Request
class LevelControlTrait.StepWithOnOffCommand.Request
The request payload for the StepWithOnOff command.
Summary
Public constructors |
|---|
Request(Creates a request payload for the StepWithOnOff command. |
Public properties |
|
|---|---|
LevelControlTrait.OptionsBitmap |
Determines which bits in the |
LevelControlTrait.OptionsBitmap |
If the corresponding bit in |
LevelControlTrait.StepModeEnum |
The direction in which to move the level. |
UByte |
The amount of units to move the device's |
UShort? |
The time (in 0.1 seconds) taken to move the device to the new level. |
Public constructors
Request
Request(
stepMode: LevelControlTrait.StepModeEnum = StepModeEnum.Up,
stepSize: UByte,
transitionTime: UShort? = null,
optionsMask: LevelControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: LevelControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the StepWithOnOff command.
Public properties
optionsMask
val optionsMask: LevelControlTrait.OptionsBitmap
Determines which bits in the options attribute should be overridden by optionsOverride.
optionsOverride
val optionsOverride: LevelControlTrait.OptionsBitmap
If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.
stepMode
val stepMode: LevelControlTrait.StepModeEnum
The direction in which to move the level. This must be one of the values in LevelControlTrait.StepModeEnum.
transitionTime
val transitionTime: UShort?
The time (in 0.1 seconds) taken to move the device to the new level.