ValveConfigurationAndControlTrait.OpenCommand.Request
class ValveConfigurationAndControlTrait.OpenCommand.Request : ClusterStruct
The request payload for the Open command.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the Open 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 |
|
|---|---|
OptionalValue<UInt?> |
How long the valve should remain open for the current |
OptionalValue<UByte> |
The target level used for the current |
Public constructors
Request
Request(
openDuration: OptionalValue<UInt?> = OptionalValue.absent(),
targetLevel: OptionalValue<UByte> = OptionalValue.absent()
)
Creates a request payload for the Open 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
openDuration
val openDuration: OptionalValue<UInt?>
How long the valve should remain open for the current Open operation.
targetLevel
val targetLevel: OptionalValue<UByte>
The target level used for the current Open operation.