DeviceEnergyManagementTrait.StartTimeAdjustRequestCommand.Request

class DeviceEnergyManagementTrait.StartTimeAdjustRequestCommand.Request : ClusterStruct

The request payload for the StartTimeAdjustRequest command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(
    requestedStartTime: UInt,
    cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum
)

Creates a request payload for the StartTimeAdjustRequest 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 start time, in UTC, that the EMS requests the ESA to change its forecast sequence to.

Public constructors

Request

Request(
    requestedStartTime: UInt,
    cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum = AdjustmentCauseEnum.LocalOptimization
)

Creates a request payload for the StartTimeAdjustRequest 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.

requestedStartTime

val requestedStartTime: UInt

The start time, in UTC, that the EMS requests the ESA to change its forecast sequence to. This value must be in the future.