DeviceEnergyManagementTrait.PauseRequestCommand.Request
class DeviceEnergyManagementTrait.PauseRequestCommand.Request : ClusterStruct
The request payload for the PauseRequest command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the PauseRequest 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 |
|
|---|---|
DeviceEnergyManagementTrait.AdjustmentCauseEnum |
The cause of the request from the EMS. |
UInt |
The duration, in seconds, for which the ESA should pause its operation. |
Public constructors
Request
Request(
duration: UInt,
cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum = AdjustmentCauseEnum.LocalOptimization
)
Creates a request payload for the PauseRequest 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
cause
val cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum
The cause of the request from the EMS.