DeviceEnergyManagementTrait.SlotAdjustmentStruct

class DeviceEnergyManagementTrait.SlotAdjustmentStruct : ClusterStruct


Indicates requested power and duration adjustments for a specific slot.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

SlotAdjustmentStruct(
    slotIndex: UByte,
    nominalPower: OptionalValue<Long>,
    duration: UInt
)

Creates the SlotAdjustmentStruct class.

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

UInt

The new amount of time, in seconds, to which the ESA is extending or shortening its duration.

OptionalValue<Long>

The power, in milliwatts, at which the ESA is being requested to operate.

UByte

The index into the slots list within the forecast to be modified.

Public constructors

SlotAdjustmentStruct

SlotAdjustmentStruct(
    slotIndex: UByte,
    nominalPower: OptionalValue<Long> = OptionalValue.absent(),
    duration: UInt
)

Creates the SlotAdjustmentStruct class.

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

duration

val durationUInt

The new amount of time, in seconds, to which the ESA is extending or shortening its duration.

nominalPower

val nominalPowerOptionalValue<Long>

The power, in milliwatts, at which the ESA is being requested to operate.

slotIndex

val slotIndexUByte

The index into the slots list within the forecast to be modified.