FanControlTrait.StepCommand.Request
class FanControlTrait.StepCommand.Request : ClusterStruct
The request payload for the Step command.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the Step command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
FanControlTrait.StepDirectionEnum |
Whether the fan speed increases or decreases to the next step value. |
OptionalValue<Boolean> |
Whether the fan being off (speed value |
OptionalValue<Boolean> |
Fan speed wraps between highest and lowest step value. |
Public constructors
Request
Request(
direction: FanControlTrait.StepDirectionEnum = StepDirectionEnum.Increase,
wrap: OptionalValue<Boolean> = OptionalValue.absent(),
lowestOff: OptionalValue<Boolean> = OptionalValue.absent()
)
Creates a request payload for the Step 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
direction
val direction: FanControlTrait.StepDirectionEnum
Whether the fan speed increases or decreases to the next step value. Valid directions are defined in StepDirectionEnum.
lowestOff
val lowestOff: OptionalValue<Boolean>
Whether the fan being off (speed value 0) is included as a step value.