DeviceEnergyManagementTrait.RequestConstraintBasedForecastCommand.Request
class DeviceEnergyManagementTrait.RequestConstraintBasedForecastCommand.Request : ClusterStruct
The request payload for the RequestConstraintBasedForecast command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the RequestConstraintBasedForecast 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. |
List<DeviceEnergyManagementTrait.ConstraintsStruct> |
A series of turn-up or turn-down power constraints that the EMS is asking the ESA to adhere to in its forecast. |
Public constructors
Request
Request(
constraints: List<DeviceEnergyManagementTrait.ConstraintsStruct> = emptyList(),
cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum = AdjustmentCauseEnum.LocalOptimization
)
Creates a request payload for the RequestConstraintBasedForecast 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.
constraints
val constraints: List<DeviceEnergyManagementTrait.ConstraintsStruct>
A series of turn-up or turn-down power constraints that the EMS is asking the ESA to adhere to in its forecast. For example, if a grid event requires devices to reduce power (turn down) between 4 p.m. and 6 p.m., and there is excess power on the grid overnight, this may cause an EMS to request that an ESA increase its power demand (turn up) between midnight and 6 a.m.