OpenCloseTrait.StepCommand.Request
class OpenCloseTrait.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? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OpenCloseTrait.Direction |
The direction in which to open. |
Double |
The exact percentage to change open-close state. |
Public constructors
Request
Request(
openRelativePercent: Double = 0.0,
openDirection: OpenCloseTrait.Direction = Direction.Unspecified
)
Creates a request payload for the Step command.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
openDirection
val openDirection: OpenCloseTrait.Direction
The direction in which to open. Only present if the device supports multiple directions, as indicated by the OpenCloseTrait.Attributes.openDirection attribute, and a direction is specified by the user.
openRelativePercent
val openRelativePercent: Double
The exact percentage to change open-close state.