EnergyPreferenceTrait.EnergyPriorityEnum
enum EnergyPreferenceTrait.EnergyPriorityEnum : Enum, ClusterEnum
Categories to prioritize for energy consumption.
Summary
Enum Values |
|
|---|---|
Comfort |
Emphasizes user comfort, such as the local temperature for a thermostat. |
Efficiency |
Emphasizes how much energy a device uses, such as electricity usage for a pump. |
Speed |
Emphasizes how quickly a device accomplishes its targeted use, such as the time it takes for a robot vacuum to complete its cleaning cycle. |
UnknownValue |
The enum value is out of range. |
WaterConsumption |
Emphasizes how much water is consumed during device usage, such as the amount of water a dishwasher uses during a cleaning cycle. |
Public functions |
|
|---|---|
EnergyPreferenceTrait.EnergyPriorityEnum |
Returns the enum constant of this type with the specified name. |
Array<EnergyPreferenceTrait.EnergyPriorityEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Comfort
val EnergyPreferenceTrait.EnergyPriorityEnum.Comfort: EnergyPreferenceTrait.EnergyPriorityEnum
Emphasizes user comfort, such as the local temperature for a thermostat.
Efficiency
val EnergyPreferenceTrait.EnergyPriorityEnum.Efficiency: EnergyPreferenceTrait.EnergyPriorityEnum
Emphasizes how much energy a device uses, such as electricity usage for a pump.
Speed
val EnergyPreferenceTrait.EnergyPriorityEnum.Speed: EnergyPreferenceTrait.EnergyPriorityEnum
Emphasizes how quickly a device accomplishes its targeted use, such as the time it takes for a robot vacuum to complete its cleaning cycle.
UnknownValue
val EnergyPreferenceTrait.EnergyPriorityEnum.UnknownValue: EnergyPreferenceTrait.EnergyPriorityEnum
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.
WaterConsumption
val EnergyPreferenceTrait.EnergyPriorityEnum.WaterConsumption: EnergyPreferenceTrait.EnergyPriorityEnum
Emphasizes how much water is consumed during device usage, such as the amount of water a dishwasher uses during a cleaning cycle.
Public functions
valueOf
fun valueOf(value: String): EnergyPreferenceTrait.EnergyPriorityEnum
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<EnergyPreferenceTrait.EnergyPriorityEnum>
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.