DeviceEnergyManagementTrait.EsaTypeEnum

enum DeviceEnergyManagementTrait.EsaTypeEnum : Enum, ClusterEnum


The type of the ESA.

Summary

Enum Values

BatteryStorage

Battery electric storage system.

Cooking

Cooking appliance.

Dishwasher

Dishwasher

EVSE

EV supply equipment.

FridgeFreezer

Refrigerator or freezer.

HomeWaterPump

Home water pump.

IrrigationWaterPump

Irrigation water pump.

Other

Other appliance type.

PoolPump

Pool pump.

SolarPV

Solar PV inverter.

SpaceCooling

Space cooling appliance

SpaceHeating

Space heating appliance.

SpaceHeatingCooling

Space heating and cooling appliance.

UnknownValue

The enum value is out of range.

WashingMachine

Washing machine.

WaterHeating

Water heating appliance.

Public functions

String
DeviceEnergyManagementTrait.EsaTypeEnum
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<DeviceEnergyManagementTrait.EsaTypeEnum>

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

Public properties

EnumEntries<DeviceEnergyManagementTrait.EsaTypeEnum>

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

open String

Trait identifier of the Matter Cluster that defines the enum Data Type.

open String

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

open ULong

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

Enum Values

SpaceHeatingCooling

val DeviceEnergyManagementTrait.EsaTypeEnum.SpaceHeatingCoolingDeviceEnergyManagementTrait.EsaTypeEnum

Space heating and cooling appliance.

UnknownValue

val DeviceEnergyManagementTrait.EsaTypeEnum.UnknownValueDeviceEnergyManagementTrait.EsaTypeEnum

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

valueOf

fun valueOf(value: String): DeviceEnergyManagementTrait.EsaTypeEnum

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
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

fun values(): Array<DeviceEnergyManagementTrait.EsaTypeEnum>

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 entriesEnumEntries<DeviceEnergyManagementTrait.EsaTypeEnum>

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 traitIdString

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.

typeName

open val typeNameString

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

value

open val valueULong

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