EnergyEvseCommands

interface EnergyEvseCommands

Known direct subclasses
EnergyEvse

API for the EnergyEvse trait.


Summary

Public functions

suspend Unit

Allows a client to clear all stored charging targets.

suspend Unit

Disables the EVSE from charging and discharging.

suspend Unit
enableCharging(
    chargingEnabledUntil: UInt?,
    minimumChargeCurrent: Long,
    maximumChargeCurrent: Long
)

Enables the EVSE to charge an electric vehicle.

suspend Unit
enableDischarging(
    dischargingEnabledUntil: UInt?,
    maximumDischargeCurrent: Long
)

Enables the EVSE to discharge an electric vehicle.

suspend EnergyEvseTrait.GetTargetsCommand.Response

Allows a client to retrieve the current set of charging targets.

suspend Unit

Allows a client to set user-specified charging targets.

suspend Unit

Puts the EVSE into self-diagnostics mode as long as the supplyState attribute is in the Disabled state when the command is sent.

Public functions

clearTargets

suspend fun clearTargets(): Unit

Allows a client to clear all stored charging targets.

disable

suspend fun disable(): Unit

Disables the EVSE from charging and discharging.

enableCharging

suspend fun enableCharging(
    chargingEnabledUntil: UInt?,
    minimumChargeCurrent: Long,
    maximumChargeCurrent: Long
): Unit

Enables the EVSE to charge an electric vehicle.

Parameters
chargingEnabledUntil: UInt?

The time, in UTC, when charging becomes disabled. If the value is in the past, charging is disabled. If the value is null, charging is permanently enabled.

minimumChargeCurrent: Long

The minimum current, in milliamps, that the EVSE can deliver to the electric vehicle.

maximumChargeCurrent: Long

The maximum current, in milliamps, that the EVSE can deliver to the electric vehicle.

enableDischarging

suspend fun enableDischarging(
    dischargingEnabledUntil: UInt?,
    maximumDischargeCurrent: Long
): Unit

Enables the EVSE to discharge an electric vehicle.

Parameters
dischargingEnabledUntil: UInt?

The time, in UTC, when discharging becomes disabled. If the value is in the past, discharging is disabled. If the value is null, discharging is permanently enabled.

maximumDischargeCurrent: Long

The maximum current, in milliamps, that the EVSE can receive from the electric vehicle.

getTargets

suspend fun getTargets(): EnergyEvseTrait.GetTargetsCommand.Response

Allows a client to retrieve the current set of charging targets.

Returns
EnergyEvseTrait.GetTargetsCommand.Response

The result of the GetTargets command.

setTargets

suspend fun setTargets(
    chargingTargetSchedules: List<EnergyEvseTrait.ChargingTargetScheduleStruct>
): Unit

Allows a client to set user-specified charging targets.

Parameters
chargingTargetSchedules: List<EnergyEvseTrait.ChargingTargetScheduleStruct>

A list of up to seven sets of daily charging targets and their associated days of the week. Each day of the week can be included in only a single chargingTargetSchedule in this field.

startDiagnostics

suspend fun startDiagnostics(): Unit

Puts the EVSE into self-diagnostics mode as long as the supplyState attribute is in the Disabled state when the command is sent.