EnergyEvse

interface EnergyEvse : EnergyEvseTrait.Attributes, MatterTrait, Updatable, EnergyEvseCommands

API for the EnergyEvse trait. This trait is for devices that provide electric vehicle supply equipment (EVSE) functionality.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<EnergyEvse>

Inherited functions
From com.google.home.matter.standard.EnergyEvseCommands
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.
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend EnergyEvse
update(optimisticReturn: (EnergyEvse) -> Unit, init: EnergyEvseTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties
From com.google.home.matter.standard.EnergyEvseTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
UShort?

The vehicle efficiency rating for a connected vehicle.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
Long?

The capacity of the electric vehicle battery in milliwatt hours.
UInt?

The time, in UTC, when the EVSE automatically stops current flow to the electric vehicle.
Long?

The capacity that the EVSE circuit can provide.
UShort

The revision of the server cluster specification supported by the cluster instance.
UInt?

The time, in UTC, when the EVSE automatically stops current flow from the electric vehicle.
EnergyEvseTrait.FaultStateEnum?

The type of fault detected by the EVSE.
EnergyEvseTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
Long?

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

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

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

The amount of energy, in megawatt hours, that the EVSE will attempt to add to the vehicle in the next charging target.
UInt?

The time, in UTC, when the EVSE is scheduled to start the next charge based on the charging preferences.
UByte?

The target state of charge (SoC), in percent, that the EVSE will attempt to reach when the vehicle is next charged.
UInt?

The time, in UTC, when the EVSE should complete the next scheduled charge based on the charging preferences.
UInt?

The time of a random window, in seconds, over which the EVSE randomizes the start of a charging session.
UInt?

The duration, in seconds, for the current or most recent charging session.
Long?

The energy, in milliwatt hours, delivered by the EVSE to the electric vehicle for the current or most recent charging session.
Long?

The energy, in milliwatt hours, received by the EVSE from the electric vehicle for the current or most recent charging session.
UInt?

A unique identifier for the current or most recent session.
EnergyEvseTrait.StateEnum?

The current status of the EVSE.
UByte?

The state of charge (SOC) of the electric vehicle battery in one-percent increments.
EnergyEvseTrait.SupplyStateEnum?

Indicates whether the electric vehicle is currently allowed to charge from the EVSE or discharge to the EVSE.
Long?

The maximum current, in milliamps, that the consumer can set as a preference to further reduce the charging rate.
String?

The vehicle ID read by the EVSE via ISO-15118 using the Plug & Charge (PnC) feature, if the EVSE supports this capability.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: EnergyEvse.Attribute): Boolean

supports

fun supports(command: EnergyEvse.Command): Boolean

Public properties

factory

open val factory: TraitFactory<EnergyEvse>