ExtendedFanControlTrait.ExtendedStepCommand.Request
class ExtendedFanControlTrait.ExtendedStepCommand.Request : ClusterStruct
The request payload for the ExtendedStep command.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the ExtendedStep 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 |
|
|---|---|
ExtendedFanControlTrait.StepDirection |
The direction in which the speed should change. |
Long |
The relative amount of the speed change. |
Public constructors
Request
Request(
fanSpeedRelativeWeight: Long = 0,
direction: ExtendedFanControlTrait.StepDirection = StepDirection.Unspecified
)
Creates a request payload for the ExtendedStep 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: ExtendedFanControlTrait.StepDirection
The direction in which the speed should change.
fanSpeedRelativeWeight
val fanSpeedRelativeWeight: Long
The relative amount of the speed change. The absolute value indicates the scaled amount while the numerical sign indicates the direction of the change.