PowerSourceTrait.BatChargeFaultEnum

enum PowerSourceTrait.BatChargeFaultEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.PowerSourceTrait.BatChargeFaultEnum

Faults that can be detected on a battery power source that is capable of charging.

Summary

Enum Values
`AmbientTooCold`	The ambient temperature is below the nominal range for this battery source.
`AmbientTooHot`	The ambient temperature is above the nominal range for this battery source.
`BatteryAbsent`	The battery source is not present.
`BatteryOverVoltage`	The voltage provided by the battery source is above the maximum supported value.
`BatteryTooCold`	The temperature of this battery source is below the nominal range.
`BatteryTooHot`	The temperature of this battery source is above the nominal range.
`BatteryUnderVoltage`	The voltage provided by the battery source is below the minimum supported value.
`ChargerOverVoltage`	The voltage of the charger for this battery source is above the maximum supported value.
`ChargerUnderVoltage`	The voltage provided by the battery source to charge the battery is below the minimum supported value.
`SafetyTimeout`	A charging safety timeout has occurred for this battery source.
`UnknownValue`	The enum value is out of range.
`Unspecified`	The fault on the battery power source is not specified.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`PowerSourceTrait.BatChargeFaultEnum`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<PowerSourceTrait.BatChargeFaultEnum>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
`EnumEntries<PowerSourceTrait.BatChargeFaultEnum>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

Enum Values

AmbientTooCold

val PowerSourceTrait.BatChargeFaultEnum.AmbientTooCold: PowerSourceTrait.BatChargeFaultEnum

The ambient temperature is below the nominal range for this battery source.

AmbientTooHot

val PowerSourceTrait.BatChargeFaultEnum.AmbientTooHot: PowerSourceTrait.BatChargeFaultEnum

The ambient temperature is above the nominal range for this battery source.

BatteryAbsent

val PowerSourceTrait.BatChargeFaultEnum.BatteryAbsent: PowerSourceTrait.BatChargeFaultEnum

The battery source is not present.

BatteryOverVoltage

val PowerSourceTrait.BatChargeFaultEnum.BatteryOverVoltage: PowerSourceTrait.BatChargeFaultEnum

The voltage provided by the battery source is above the maximum supported value.

BatteryTooCold

val PowerSourceTrait.BatChargeFaultEnum.BatteryTooCold: PowerSourceTrait.BatChargeFaultEnum

The temperature of this battery source is below the nominal range.

BatteryTooHot

val PowerSourceTrait.BatChargeFaultEnum.BatteryTooHot: PowerSourceTrait.BatChargeFaultEnum

The temperature of this battery source is above the nominal range.

BatteryUnderVoltage

val PowerSourceTrait.BatChargeFaultEnum.BatteryUnderVoltage: PowerSourceTrait.BatChargeFaultEnum

The voltage provided by the battery source is below the minimum supported value.

ChargerOverVoltage

val PowerSourceTrait.BatChargeFaultEnum.ChargerOverVoltage: PowerSourceTrait.BatChargeFaultEnum

The voltage of the charger for this battery source is above the maximum supported value.

ChargerUnderVoltage

val PowerSourceTrait.BatChargeFaultEnum.ChargerUnderVoltage: PowerSourceTrait.BatChargeFaultEnum

The voltage provided by the battery source to charge the battery is below the minimum supported value.

SafetyTimeout

val PowerSourceTrait.BatChargeFaultEnum.SafetyTimeout: PowerSourceTrait.BatChargeFaultEnum

A charging safety timeout has occurred for this battery source.

UnknownValue

val PowerSourceTrait.BatChargeFaultEnum.UnknownValue: PowerSourceTrait.BatChargeFaultEnum

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.

Unspecified

val PowerSourceTrait.BatChargeFaultEnum.Unspecified: PowerSourceTrait.BatChargeFaultEnum

The fault on the battery power source is not specified.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): PowerSourceTrait.BatChargeFaultEnum

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.BatChargeFaultEnum>

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

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