# EnergyEvseCommands

# EnergyEvseCommands


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

<br />

Known direct subclasses [EnergyEvse](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvse)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvse` | API for the EnergyEvse trait. |

*** ** * ** ***

Commands for the EnergyEvse trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#clearTargets()()` Allows a client to clear all stored charging targets. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#clearTargetsBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#clearTargets()` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#disable()()` Disables the EVSE from charging and discharging. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#disableBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#disable()` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableCharging(kotlin.UInt,kotlin.Long,kotlin.Long)( chargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, minimumChargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html, maximumChargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html )` Enables the EVSE to charge an electric vehicle. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableChargingBatchable(kotlin.UInt,kotlin.Long,kotlin.Long)( chargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, minimumChargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html, maximumChargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableCharging(kotlin.UInt,kotlin.Long,kotlin.Long)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableDischarging(kotlin.UInt,kotlin.Long)( dischargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, maximumDischargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html )` Enables the EVSE to discharge an electric vehicle. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableDischargingBatchable(kotlin.UInt,kotlin.Long)( dischargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, maximumDischargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableDischarging(kotlin.UInt,kotlin.Long)` command. |
| `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.GetTargetsCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#getTargets()()` Allows a client to retrieve the current set of charging targets. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.GetTargetsCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#getTargetsBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#getTargets()` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#setTargets(kotlin.collections.List)( chargingTargetSchedules: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.ChargingTargetScheduleStruct> )` Allows a client to set user-specified charging targets. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#setTargetsBatchable(kotlin.collections.List)( chargingTargetSchedules: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.ChargingTargetScheduleStruct> )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#setTargets(kotlin.collections.List)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#startDiagnostics()()` Puts the EVSE into self-diagnostics mode as long as the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.Attributes#supplyState()` attribute is in the `Disabled` state when the command is sent. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#startDiagnosticsBatchable()()` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#clearTargets()` command.

Allows a client to clear all stored charging targets.

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### disable

```
suspend fun disable(): Unit
```

Disables the EVSE from charging and discharging.

### disableBatchable

```
fun disableBatchable(): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#disable()` command.

Disables the EVSE from charging and discharging.

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### enableCharging

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

Enables the EVSE to charge an electric vehicle.

| Parameters |
|---|---|
| `chargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | 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: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | The minimum current, in milliamps, that the EVSE can deliver to the electric vehicle. |
| `maximumChargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | 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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableCharging(kotlin.UInt,kotlin.Long,kotlin.Long)` command.

Enables the EVSE to charge an electric vehicle.

| Parameters |
|---|---|
| `chargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | 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: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | The minimum current, in milliamps, that the EVSE can deliver to the electric vehicle. |
| `maximumChargeCurrent: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | The maximum current, in milliamps, that the EVSE can deliver to the electric vehicle. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### enableDischarging

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

Enables the EVSE to discharge an electric vehicle.

| Parameters |
|---|---|
| `dischargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | 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: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | 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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#enableDischarging(kotlin.UInt,kotlin.Long)` command.

Enables the EVSE to discharge an electric vehicle.

| Parameters |
|---|---|
| `dischargingEnabledUntil: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | 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: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html` | The maximum current, in milliamps, that the EVSE can receive from the electric vehicle. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### getTargets

```
suspend fun getTargets(): EnergyEvseTrait.GetTargetsCommand.Response
```

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

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.GetTargetsCommand.Response` | The result of the `GetTargets` command. |

### getTargetsBatchable

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

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#getTargets()` command.

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

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.GetTargetsCommand.Response>` | BatchableCommand |

### setTargets

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

Allows a client to set user-specified charging targets.

| Parameters |
|---|---|
| `chargingTargetSchedules: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#setTargets(kotlin.collections.List)` command.

Allows a client to set user-specified charging targets.

| Parameters |
|---|---|
| `chargingTargetSchedules: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/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 |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### startDiagnostics

```
suspend fun startDiagnostics(): Unit
```

Puts the EVSE into self-diagnostics mode as long as the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.Attributes#supplyState()` attribute is in the `Disabled` state when the command is sent.

### startDiagnosticsBatchable

```
fun startDiagnosticsBatchable(): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseCommands#startDiagnostics()` command.

Puts the EVSE into self-diagnostics mode as long as the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.Attributes#supplyState()` attribute is in the `Disabled` state when the command is sent.

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |