EnergyEvseTrait.ChargingTargetStruct
class EnergyEvseTrait.ChargingTargetStruct : ClusterStruct
A single user-specified charging target for an electric vehicle.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
ChargingTargetStruct(Creates the ChargingTargetStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OptionalValue<Long> |
The amount of energy, in milliwatt hours, that the user would like to have added to the vehicle before the |
OptionalValue<UByte> |
The target SoC, in percentage, that the vehicle should be charged to before the |
UShort |
The desired charging completion time of the associated day, where the time is represented by a 16-bit unsigned integer to designate the minutes past midnight. |
Public constructors
ChargingTargetStruct
ChargingTargetStruct(
targetTimeMinutesPastMidnight: UShort,
targetSoC: OptionalValue<UByte> = OptionalValue.absent(),
addedEnergy: OptionalValue<Long> = OptionalValue.absent()
)
Creates the ChargingTargetStruct class.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
addedEnergy
val addedEnergy: OptionalValue<Long>
The amount of energy, in milliwatt hours, that the user would like to have added to the vehicle before the targetTimeMinutesPastMidnight is reached.
targetSoC
val targetSoC: OptionalValue<UByte>
The target SoC, in percentage, that the vehicle should be charged to before the targetTimeMinutesPastMidnight is reached.
targetTimeMinutesPastMidnight
val targetTimeMinutesPastMidnight: UShort
The desired charging completion time of the associated day, where the time is represented by a 16-bit unsigned integer to designate the minutes past midnight. For example, 6 a.m. is represented by 360 minutes past midnight.