DeviceEnergyManagementTrait.PowerAdjustReasonEnum

enum DeviceEnergyManagementTrait.PowerAdjustReasonEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.DeviceEnergyManagementTrait.PowerAdjustReasonEnum

The reason for the power adjustment.

Summary

Enum Values
`GridOptimizationAdjustment`	There is a Power Adjustment active due to grid optimization.
`LocalOptimizationAdjustment`	There is a Power Adjustment active due to local EMS optimization.
`NoAdjustment`	There is no Power Adjustment active.
`UnknownValue`	The enum value is out of range.

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

Public properties
`EnumEntries<DeviceEnergyManagementTrait.PowerAdjustReasonEnum>`	`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

GridOptimizationAdjustment

val DeviceEnergyManagementTrait.PowerAdjustReasonEnum.GridOptimizationAdjustment: DeviceEnergyManagementTrait.PowerAdjustReasonEnum

There is a Power Adjustment active due to grid optimization.

LocalOptimizationAdjustment

val DeviceEnergyManagementTrait.PowerAdjustReasonEnum.LocalOptimizationAdjustment: DeviceEnergyManagementTrait.PowerAdjustReasonEnum

There is a Power Adjustment active due to local EMS optimization.

NoAdjustment

val DeviceEnergyManagementTrait.PowerAdjustReasonEnum.NoAdjustment: DeviceEnergyManagementTrait.PowerAdjustReasonEnum

There is no Power Adjustment active.

UnknownValue

val DeviceEnergyManagementTrait.PowerAdjustReasonEnum.UnknownValue: DeviceEnergyManagementTrait.PowerAdjustReasonEnum

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

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): DeviceEnergyManagementTrait.PowerAdjustReasonEnum

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

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

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.