OnOffTrait.OnWithTimedOffCommand.Request
class OnOffTrait.OnWithTimedOffCommand.Request : ClusterStruct
The request payload for the OnWithTimedOff command.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the OnWithTimedOff 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 |
|
|---|---|
UShort |
The guarded off duration to set for the device. |
OnOffTrait.OnOffControlBitmap |
When set to |
UShort |
The duration for which device is turned on. |
Public constructors
Request
Request(
onOffControl: OnOffTrait.OnOffControlBitmap = OnOffControlBitmap(),
onTime: UShort,
offWaitTime: UShort
)
Creates a request payload for the OnWithTimedOff 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
offWaitTime
val offWaitTime: UShort
The guarded off duration to set for the device. Sets the value of the offWaitTime attribute.
onOffControl
val onOffControl: OnOffTrait.OnOffControlBitmap
When set to 1, the onWithTimedOff command will only be processed if the onOff attribute is true. When set to 0, the onWithTimedOff command is always processed.