EnergyEvseCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface EnergyEvseCommands

Known direct subclasses

EnergyEvse

EnergyEvse

API for the EnergyEvse trait.

Summary

Public functions
`suspend Unit`	`clearTargets()` Allows a client to clear all stored charging targets.
`BatchableCommand<Unit>`	`clearTargetsBatchable()` The batchable version of `clearTargets` command.
`suspend Unit`	`disable()` Disables the EVSE from charging and discharging.
`BatchableCommand<Unit>`	`disableBatchable()` The batchable version of `disable` command.
`suspend Unit`	`enableCharging( chargingEnabledUntil: UInt?, minimumChargeCurrent: Long, maximumChargeCurrent: Long )` Enables the EVSE to charge an electric vehicle.
`BatchableCommand<Unit>`	`enableChargingBatchable( chargingEnabledUntil: UInt?, minimumChargeCurrent: Long, maximumChargeCurrent: Long )` The batchable version of `enableCharging` command.
`suspend Unit`	`enableDischarging( dischargingEnabledUntil: UInt?, maximumDischargeCurrent: Long )` Enables the EVSE to discharge an electric vehicle.
`BatchableCommand<Unit>`	`enableDischargingBatchable( dischargingEnabledUntil: UInt?, maximumDischargeCurrent: Long )` The batchable version of `enableDischarging` command.
`suspend EnergyEvseTrait.GetTargetsCommand.Response`	`getTargets()` Allows a client to retrieve the current set of charging targets.
`BatchableCommand<EnergyEvseTrait.GetTargetsCommand.Response>`	`getTargetsBatchable()` The batchable version of `getTargets` command.
`suspend Unit`	`setTargets( chargingTargetSchedules: List<EnergyEvseTrait.ChargingTargetScheduleStruct> )` Allows a client to set user-specified charging targets.
`BatchableCommand<Unit>`	`setTargetsBatchable( chargingTargetSchedules: List<EnergyEvseTrait.ChargingTargetScheduleStruct> )` The batchable version of `setTargets` command.
`suspend Unit`	`startDiagnostics()` Puts the EVSE into self-diagnostics mode as long as the `supplyState` attribute is in the `Disabled` state when the command is sent.
`BatchableCommand<Unit>`	`startDiagnosticsBatchable()` The batchable version of `startDiagnostics` command.

Public functions

clearTargets

suspend fun clearTargets(): Unit

Allows a client to clear all stored charging targets.

clearTargetsBatchable

fun clearTargetsBatchable(): BatchableCommand<Unit>

The batchable version of clearTargets command.

Allows a client to clear all stored charging targets.

Returns
`BatchableCommand<Unit>`	BatchableCommand

disable

suspend fun disable(): Unit

Disables the EVSE from charging and discharging.

disableBatchable

fun disableBatchable(): BatchableCommand<Unit>

The batchable version of disable command.

Disables the EVSE from charging and discharging.

Returns
`BatchableCommand<Unit>`	BatchableCommand

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.

enableChargingBatchable

fun enableChargingBatchable(
    chargingEnabledUntil: UInt?,
    minimumChargeCurrent: Long,
    maximumChargeCurrent: Long
): BatchableCommand<Unit>

The batchable version of enableCharging command.

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.

Returns
`BatchableCommand<Unit>`	BatchableCommand

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.

enableDischargingBatchable

fun enableDischargingBatchable(
    dischargingEnabledUntil: UInt?,
    maximumDischargeCurrent: Long
): BatchableCommand<Unit>

The batchable version of enableDischarging command.

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.

Returns
`BatchableCommand<Unit>`	BatchableCommand

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.

getTargetsBatchable

fun getTargetsBatchable(): BatchableCommand<EnergyEvseTrait.GetTargetsCommand.Response>

The batchable version of getTargets command.

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

Returns
`BatchableCommand<EnergyEvseTrait.GetTargetsCommand.Response>`	BatchableCommand

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.

setTargetsBatchable

fun setTargetsBatchable(
    chargingTargetSchedules: List<EnergyEvseTrait.ChargingTargetScheduleStruct>
): BatchableCommand<Unit>

The batchable version of setTargets command.

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.

Returns
`BatchableCommand<Unit>`	BatchableCommand

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.

startDiagnosticsBatchable

fun startDiagnosticsBatchable(): BatchableCommand<Unit>

The batchable version of startDiagnostics command.

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

Returns
`BatchableCommand<Unit>`	BatchableCommand