OnOffTrait.OffWithEffectCommand.Request
class OnOffTrait.OffWithEffectCommand.Request
The request payload for the OffWithEffect command.
Summary
Public constructors |
|---|
Request(Creates a request payload for the OffWithEffect command. |
Public properties |
|
|---|---|
OnOffTrait.EffectIdentifierEnum |
The fading effect to use when turning the device off. |
UByte |
Variant of the effect, indicated by the |
Public constructors
Request
Request(
effectIdentifier: OnOffTrait.EffectIdentifierEnum = EffectIdentifierEnum.DelayedAllOff,
effectVariant: UByte
)
Creates a request payload for the OffWithEffect command.
Public properties
effectIdentifier
val effectIdentifier: OnOffTrait.EffectIdentifierEnum
The fading effect to use when turning the device off. Must be a value from OnOffTrait.EffectIdentifierEnum.
effectVariant
val effectVariant: UByte
Variant of the effect, indicated by the effectIdentifier parameter, that is triggered. This must be one of the values in OnOffTrait.DelayedAllOffEffectVariantEnum or OnOffTrait.DyingLightEffectVariantEnum that correspond to the effect specified for effectIdentifier.