DeviceEnergyManagementTrait.EsaStateEnum
enum DeviceEnergyManagementTrait.EsaStateEnum : Enum, ClusterEnum
The state of the ESA.
Summary
Enum Values |
|
|---|---|
Fault |
The ESA is in a fault state and cannot provide service. |
Offline |
The ESA is not available. |
Online |
The ESA is working normally and can be controlled by the EMS. |
Paused |
The ESA is currently paused as the result of a client running the |
PowerAdjustActive |
The ESA is actively adjusting its power consumption. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
String |
|
DeviceEnergyManagementTrait.EsaStateEnum |
Returns the enum constant of this type with the specified name. |
Array<DeviceEnergyManagementTrait.EsaStateEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<DeviceEnergyManagementTrait.EsaStateEnum> |
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
Fault
val DeviceEnergyManagementTrait.EsaStateEnum.Fault: DeviceEnergyManagementTrait.EsaStateEnum
The ESA is in a fault state and cannot provide service.
Offline
val DeviceEnergyManagementTrait.EsaStateEnum.Offline: DeviceEnergyManagementTrait.EsaStateEnum
The ESA is not available.
Online
val DeviceEnergyManagementTrait.EsaStateEnum.Online: DeviceEnergyManagementTrait.EsaStateEnum
The ESA is working normally and can be controlled by the EMS.
Paused
val DeviceEnergyManagementTrait.EsaStateEnum.Paused: DeviceEnergyManagementTrait.EsaStateEnum
The ESA is currently paused as the result of a client running the PauseRequest command.
PowerAdjustActive
val DeviceEnergyManagementTrait.EsaStateEnum.PowerAdjustActive: DeviceEnergyManagementTrait.EsaStateEnum
The ESA is actively adjusting its power consumption.
UnknownValue
val DeviceEnergyManagementTrait.EsaStateEnum.UnknownValue: DeviceEnergyManagementTrait.EsaStateEnum
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): DeviceEnergyManagementTrait.EsaStateEnum
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.EsaStateEnum>
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.EsaStateEnum>
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.