# EnergyEvseTrait.StateEnum

# EnergyEvseTrait.StateEnum


```
enum EnergyEvseTrait.StateEnum : Enum, ClusterEnum
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html) ||
|   | ↳ | [com.google.home.matter.standard.EnergyEvseTrait.StateEnum](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum) |

*** ** * ** ***

The state of the electric vehicle.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#Fault` | The EVSE has detected a fault. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#NotPluggedIn` | The electric vehicle is not plugged in. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#PluggedInCharging` | The electric vehicle is plugged in, charging is in progress, and current is flowing. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#PluggedInDemand` | The electric vehicle is plugged in and is demanding current, but the EVSE is not allowing current to flow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#PluggedInDischarging` | The electric vehicle is plugged in, discharging is in progress, and current is flowing. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#PluggedInNoDemand` | The electric vehicle is plugged in and is not demanding current. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#SessionEnding` | The electric vehicle is transitioning from any plugged-in state to `NotPluggedIn`. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#UnknownValue` | The enum value is out of range. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#toDescription()()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#valueOf(kotlin.String)(value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/kotlin/enums/EnumEntries<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#entries()` Returns a representation of an immutable list of all enum entries, in the order they're declared. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#traitId()` Trait identifier of the Matter Cluster that defines the enum Data Type. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#typeName()` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.StateEnum#value()` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |

## Enum Values

### Fault

```
val EnergyEvseTrait.StateEnum.Fault: EnergyEvseTrait.StateEnum
```

The EVSE has detected a fault. See the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/EnergyEvseTrait.Attributes#faultState()` attribute for more information.

### NotPluggedIn

```
val EnergyEvseTrait.StateEnum.NotPluggedIn: EnergyEvseTrait.StateEnum
```

The electric vehicle is not plugged in.

### PluggedInCharging

```
val EnergyEvseTrait.StateEnum.PluggedInCharging: EnergyEvseTrait.StateEnum
```

The electric vehicle is plugged in, charging is in progress, and current is flowing.

### PluggedInDemand

```
val EnergyEvseTrait.StateEnum.PluggedInDemand: EnergyEvseTrait.StateEnum
```

The electric vehicle is plugged in and is demanding current, but the EVSE is not allowing current to flow.

### PluggedInDischarging

```
val EnergyEvseTrait.StateEnum.PluggedInDischarging: EnergyEvseTrait.StateEnum
```

The electric vehicle is plugged in, discharging is in progress, and current is flowing.

### PluggedInNoDemand

```
val EnergyEvseTrait.StateEnum.PluggedInNoDemand: EnergyEvseTrait.StateEnum
```

The electric vehicle is plugged in and is not demanding current.

### SessionEnding

```
val EnergyEvseTrait.StateEnum.SessionEnding: EnergyEvseTrait.StateEnum
```

The electric vehicle is transitioning from any plugged-in state to `NotPluggedIn`.

### UnknownValue

```
val EnergyEvseTrait.StateEnum.UnknownValue: EnergyEvseTrait.StateEnum
```

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

## Public functions

### toDescription

```
@HomeExperimentalGenericApi
fun toDescription(): String
```

### valueOf

```
fun valueOf(value: String): EnergyEvseTrait.StateEnum
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

```
fun values(): Array<EnergyEvseTrait.StateEnum>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

## Public properties

### entries

```
val entries: EnumEntries<EnergyEvseTrait.StateEnum>
```

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

### traitId

```
open val traitId: String
```

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/ClusterId#traitId()` for the format.

### typeName

```
open val typeName: String
```

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

### value

```
open val value: ULong
```

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.