PowerSourceTrait.WiredFaultEnum

enum PowerSourceTrait.WiredFaultEnum : Enum, ClusterEnum

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

Faults that can be detected on a wired power source.

Summary

Enum Values
`OverVoltage`	The voltage provided by the wired power source is above the maximum supported value.
`UnderVoltage`	The voltage provided by the wired power source is below the minimum supported value.
`UnknownValue`	The enum value is out of range.
`Unspecified`	The fault is not specified.

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

Public properties
`EnumEntries<PowerSourceTrait.WiredFaultEnum>`	`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

OverVoltage

val PowerSourceTrait.WiredFaultEnum.OverVoltage: PowerSourceTrait.WiredFaultEnum

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

UnderVoltage

val PowerSourceTrait.WiredFaultEnum.UnderVoltage: PowerSourceTrait.WiredFaultEnum

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

UnknownValue

val PowerSourceTrait.WiredFaultEnum.UnknownValue: PowerSourceTrait.WiredFaultEnum

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.WiredFaultEnum.Unspecified: PowerSourceTrait.WiredFaultEnum

The fault is not specified.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): PowerSourceTrait.WiredFaultEnum

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

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

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.