OpenCloseTrait.GoToOpenPercentageCommand.Request
class OpenCloseTrait.GoToOpenPercentageCommand.Request : ClusterStruct
The request payload for the GoToOpenPercentage command.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(openPercent: Double, openDirection: OpenCloseTrait.Direction)Creates a request payload for the GoToOpenPercentage 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 |
|
|---|---|
OpenCloseTrait.Direction |
The direction in which to open. |
Double |
Indicates the percentage that a device should be opened, where 0 is closed and 100 is fully open. |
Public constructors
Request
Request(
openPercent: Double = 0.0,
openDirection: OpenCloseTrait.Direction = Direction.Unspecified
)
Creates a request payload for the GoToOpenPercentage 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
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.
openPercent
val openPercent: Double
Indicates the percentage that a device should be opened, where 0 is closed and 100 is fully open.