FanControlTrait.FanModeEnum
enum FanControlTrait.FanModeEnum : Enum, ClusterEnum
Specifies the current fan mode.
Summary
Enum Values |
|
|---|---|
Auto |
The fan is using an auto speed. |
High |
The fan is using a high speed. |
Low |
The fan is using a low speed. |
Medium |
The fan is using a medium speed. |
Off |
The fan is off. |
On |
The fan is on. |
Smart |
The Smart mode for the fan. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
FanControlTrait.FanModeEnum |
Returns the enum constant of this type with the specified name. |
Array<FanControlTrait.FanModeEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Auto
val FanControlTrait.FanModeEnum.Auto: FanControlTrait.FanModeEnum
The fan is using an auto speed. Selecting this mode sets the percentSetting and, if present, speedSetting attributes to null.
High
val FanControlTrait.FanModeEnum.High: FanControlTrait.FanModeEnum
The fan is using a high speed. Selecting this mode sets the attributes speedSetting, speedCurrent, percentSetting and, percentCurrent to a single value in the corresponding range.
Low
val FanControlTrait.FanModeEnum.Low: FanControlTrait.FanModeEnum
The fan is using a low speed. Selecting this mode sets the attributes speedSetting, speedCurrent, percentSetting and, percentCurrent to a single value in the corresponding range.
Medium
val FanControlTrait.FanModeEnum.Medium: FanControlTrait.FanModeEnum
The fan is using a medium speed. Selecting this mode sets the attributes speedSetting, speedCurrent, percentSetting and, percentCurrent to a single value in the corresponding range.
Off
val FanControlTrait.FanModeEnum.Off: FanControlTrait.FanModeEnum
The fan is off. Selecting this mode sets the percentSetting and percentCurrent attributes and, if present, the speedSetting and speedCurrent attributes to 0 (zero).
Smart
val FanControlTrait.FanModeEnum.Smart: FanControlTrait.FanModeEnum
The Smart mode for the fan.
UnknownValue
val FanControlTrait.FanModeEnum.UnknownValue: FanControlTrait.FanModeEnum
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): FanControlTrait.FanModeEnum
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<FanControlTrait.FanModeEnum>
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.