DeviceEnergyManagementTrait.SlotStruct
class DeviceEnergyManagementTrait.SlotStruct : ClusterStruct
Indicates a specific stage of an ESA's operation.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
SlotStruct(Creates the SlotStruct 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 |
|
|---|---|
OptionalValue<List<DeviceEnergyManagementTrait.CostStruct>> |
The current estimated cost of operating the appliance. |
UInt |
The time, in seconds, that the appliance is expected to be in its slot. |
UInt |
The time, in seconds, that has already elapsed with the appliance in its slot. |
OptionalValue<UShort> |
Provides a manufacturer-defined value that indicates the state of the ESA. |
UInt |
The maximum time, in seconds, that the appliance is expected to be in its slot. |
OptionalValue<UInt> |
The maximum duration, in seconds, to which the slot's usage can be extended. |
OptionalValue<UInt> |
The maximum amount of time, in seconds, that the slot can be paused. |
OptionalValue<Long> |
The highest power, in milliwatts, that the appliance is expected to use in its current slot. |
OptionalValue<Long> |
The maximum power adjustment, in milliwatts, that the ESA can be requested to use. |
UInt |
The minimum time, in seconds, that the appliance is expected to be in its slot. |
OptionalValue<UInt> |
The minimum time, in seconds, to which the slot's usage can be shortened. |
OptionalValue<UInt> |
The shortest amount of time, in seconds, that the slot can be paused. |
OptionalValue<Long> |
The lowest power, in milliwatts, that the appliance is expected to use in its current slot. |
OptionalValue<Long> |
The minimum power adjustment, in milliwatts, that the ESA can be requested to use. |
OptionalValue<Long> |
The amount of energy that the appliance is expected to use or produce in its current slot. |
OptionalValue<Long> |
The expected power that the appliance will use in its current slot. |
UInt |
The remaining time, in seconds, that the appliance is expected to be in its slot. |
OptionalValue<Boolean> |
Indicates whether this slot can be paused. |
Public constructors
SlotStruct
SlotStruct(
minDuration: UInt,
maxDuration: UInt,
defaultDuration: UInt,
elapsedSlotTime: UInt,
remainingSlotTime: UInt,
slotIsPausable: OptionalValue<Boolean> = OptionalValue.absent(),
minPauseDuration: OptionalValue<UInt> = OptionalValue.absent(),
maxPauseDuration: OptionalValue<UInt> = OptionalValue.absent(),
manufacturerEsaState: OptionalValue<UShort> = OptionalValue.absent(),
nominalPower: OptionalValue<Long> = OptionalValue.absent(),
minPower: OptionalValue<Long> = OptionalValue.absent(),
maxPower: OptionalValue<Long> = OptionalValue.absent(),
nominalEnergy: OptionalValue<Long> = OptionalValue.absent(),
costs: OptionalValue<List<DeviceEnergyManagementTrait.CostStruct>> = OptionalValue.absent(),
minPowerAdjustment: OptionalValue<Long> = OptionalValue.absent(),
maxPowerAdjustment: OptionalValue<Long> = OptionalValue.absent(),
minDurationAdjustment: OptionalValue<UInt> = OptionalValue.absent(),
maxDurationAdjustment: OptionalValue<UInt> = OptionalValue.absent()
)
Creates the SlotStruct 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
costs
val costs: OptionalValue<List<DeviceEnergyManagementTrait.CostStruct>>
The current estimated cost of operating the appliance.
defaultDuration
val defaultDuration: UInt
The time, in seconds, that the appliance is expected to be in its slot.
elapsedSlotTime
val elapsedSlotTime: UInt
The time, in seconds, that has already elapsed with the appliance in its slot.
manufacturerEsaState
val manufacturerEsaState: OptionalValue<UShort>
Provides a manufacturer-defined value that indicates the state of the ESA.
maxDuration
val maxDuration: UInt
The maximum time, in seconds, that the appliance is expected to be in its slot.
maxDurationAdjustment
val maxDurationAdjustment: OptionalValue<UInt>
The maximum duration, in seconds, to which the slot's usage can be extended.
maxPauseDuration
val maxPauseDuration: OptionalValue<UInt>
The maximum amount of time, in seconds, that the slot can be paused.
maxPower
val maxPower: OptionalValue<Long>
The highest power, in milliwatts, that the appliance is expected to use in its current slot. Some appliances, such as battery inverters that can charge and discharge, might have a negative value for this field.
maxPowerAdjustment
val maxPowerAdjustment: OptionalValue<Long>
The maximum power adjustment, in milliwatts, that the ESA can be requested to use.
minDuration
val minDuration: UInt
The minimum time, in seconds, that the appliance is expected to be in its slot.
minDurationAdjustment
val minDurationAdjustment: OptionalValue<UInt>
The minimum time, in seconds, to which the slot's usage can be shortened.
minPauseDuration
val minPauseDuration: OptionalValue<UInt>
The shortest amount of time, in seconds, that the slot can be paused.
minPower
val minPower: OptionalValue<Long>
The lowest power, in milliwatts, that the appliance is expected to use in its current slot. Some appliances, such as battery inverters that can charge and discharge, might have a negative value for this field.
minPowerAdjustment
val minPowerAdjustment: OptionalValue<Long>
The minimum power adjustment, in milliwatts, that the ESA can be requested to use.
nominalEnergy
val nominalEnergy: OptionalValue<Long>
The amount of energy that the appliance is expected to use or produce in its current slot.
nominalPower
val nominalPower: OptionalValue<Long>
The expected power that the appliance will use in its current slot.
remainingSlotTime
val remainingSlotTime: UInt
The remaining time, in seconds, that the appliance is expected to be in its slot.
slotIsPausable
val slotIsPausable: OptionalValue<Boolean>
Indicates whether this slot can be paused.