DeviceEnergyManagementTrait.CauseEnum
enum DeviceEnergyManagementTrait.CauseEnum : Enum, ClusterEnum
The cause of the request from the EMS.
Summary
Enum Values |
|
|---|---|
Cancelled |
The adjustment was cancelled by the EMS. |
Fault |
The ESA has developed a fault and could not complete the adjustment. |
NormalCompletion |
The ESA completed the power adjustment as requested. |
Offline |
The ESA was set to |
UnknownValue |
The enum value is out of range. |
UserOptOut |
The user has disabled the ESA's flexibility capability. |
Public functions |
|
|---|---|
String |
|
DeviceEnergyManagementTrait.CauseEnum |
Returns the enum constant of this type with the specified name. |
Array<DeviceEnergyManagementTrait.CauseEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<DeviceEnergyManagementTrait.CauseEnum> |
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
Cancelled
val DeviceEnergyManagementTrait.CauseEnum.Cancelled: DeviceEnergyManagementTrait.CauseEnum
The adjustment was cancelled by the EMS.
Fault
val DeviceEnergyManagementTrait.CauseEnum.Fault: DeviceEnergyManagementTrait.CauseEnum
The ESA has developed a fault and could not complete the adjustment.
NormalCompletion
val DeviceEnergyManagementTrait.CauseEnum.NormalCompletion: DeviceEnergyManagementTrait.CauseEnum
The ESA completed the power adjustment as requested.
Offline
val DeviceEnergyManagementTrait.CauseEnum.Offline: DeviceEnergyManagementTrait.CauseEnum
The ESA was set to offline.
UnknownValue
val DeviceEnergyManagementTrait.CauseEnum.UnknownValue: DeviceEnergyManagementTrait.CauseEnum
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.
UserOptOut
val DeviceEnergyManagementTrait.CauseEnum.UserOptOut: DeviceEnergyManagementTrait.CauseEnum
The user has disabled the ESA's flexibility capability.
Public functions
valueOf
fun valueOf(value: String): DeviceEnergyManagementTrait.CauseEnum
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.CauseEnum>
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.CauseEnum>
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.