PowerSourceTrait.BatCommonDesignationEnum

enum PowerSourceTrait.BatCommonDesignationEnum : Enum, ClusterEnum


The ID of the common or colloquial designation of the battery.

Summary

Enum Values

A

A battery.

A10

A10 battery.

A13

A13 battery.

A23

A23 battery.

A27

A27 battery.

A312

A312 battery.

A5

A5 battery.

A675

A675 battery.

AA

AA battery.

AAA

AAA battery.

AAAA

AAAA battery.

AC41E

AC41E battery.

B

B battery.

BA5800

BA5800 battery.

C

C battery.

CR123A

CR123A battery.

CR2

CR2 battery.

CRP2

CRP2 battery.

CRV3

CRV3 battery.

D

D battery.

Duplex

Duplex battery.

F

F battery.

J

J battery.

LR932

LR932 battery.

N

N battery.

No6

No6 battery.

Num10180

10180 battery.

Num10280

10280 battery.

Num10440

10440 battery.

Num12AA

12AA battery.

Num14250

14250 battery.

Num14430

14430 battery.

Num14500

14500 battery.

Num14650

14650 battery.

Num15270

15270 battery.

Num15v0

15v0 battery.

Num16340

16340 battery.

Num17500

17500 battery.

Num17670

17670 battery.

Num18350

18350 battery.

Num18500

18500 battery.

Num18650

18650 battery.

Num19670

19670 battery.

Num22v5

22v5 battery.

Num25500

25500 battery.

Num26650

26650 battery.

Num2CR5

2CR5 battery.

Num30v0

30v0 battery.

Num32600

32600 battery.

Num45v0

45v0 battery.

Num4SR44

4SR44 battery.

Num4v5

4v5 battery.

Num523

523 battery.

Num531

531 battery.

Num67v5

67v5 battery.

Num6v0

6v0 battery.

Num9v0

9v0 battery.

RCR123A

RCR123A battery.

SR41

SR41 battery.

SR43

SR43 battery.

SR44

SR44 battery.

SR45

SR45 battery.

SR48

SR48 battery.

SR516

SR516 battery.

SR54

SR54 battery.

SR55

SR55 battery.

SR57

SR57 battery.

SR58

SR58 battery.

SR59

SR59 battery.

SR60

SR60 battery.

SR63

SR63 battery.

SR64

SR64 battery.

SR65

SR65 battery.

SR66

SR66 battery.

SR67

SR67 battery.

SR68

SR68 battery.

SR69

SR69 battery.

SR712

SR712 battery.

SR731

SR731 battery.

SubC

SubC battery.

UnknownValue

The enum value is out of range.

Unspecified

Unspecified battery.

Public functions

String
PowerSourceTrait.BatCommonDesignationEnum
valueOf(value: String)

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

Array<PowerSourceTrait.BatCommonDesignationEnum>

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

Public properties

EnumEntries<PowerSourceTrait.BatCommonDesignationEnum>

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

UnknownValue

val PowerSourceTrait.BatCommonDesignationEnum.UnknownValuePowerSourceTrait.BatCommonDesignationEnum

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): PowerSourceTrait.BatCommonDesignationEnum

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<PowerSourceTrait.BatCommonDesignationEnum>

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<PowerSourceTrait.BatCommonDesignationEnum>

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.