FanControlTrait.FanModeSequenceEnum
enum FanControlTrait.FanModeSequenceEnum : Enum, ClusterEnum
Supported fan speed ranges.
Summary
Enum Values |
|
|---|---|
OffHigh |
Fan supports off and on speeds. |
OffHighAuto |
Fan supports off, on and auto speeds. |
OffLowHigh |
Fan supports off, low and high speeds. |
OffLowHighAuto |
Fan supports off, low, high and auto speeds. |
OffLowMedHigh |
Fan supports off, low, medium and high speeds. |
OffLowMedHighAuto |
Fan supports off, low, medium, high and auto speeds. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
FanControlTrait.FanModeSequenceEnum |
Returns the enum constant of this type with the specified name. |
Array<FanControlTrait.FanModeSequenceEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
OffHigh
val FanControlTrait.FanModeSequenceEnum.OffHigh: FanControlTrait.FanModeSequenceEnum
Fan supports off and on speeds.
OffHighAuto
val FanControlTrait.FanModeSequenceEnum.OffHighAuto: FanControlTrait.FanModeSequenceEnum
Fan supports off, on and auto speeds.
OffLowHigh
val FanControlTrait.FanModeSequenceEnum.OffLowHigh: FanControlTrait.FanModeSequenceEnum
Fan supports off, low and high speeds.
OffLowHighAuto
val FanControlTrait.FanModeSequenceEnum.OffLowHighAuto: FanControlTrait.FanModeSequenceEnum
Fan supports off, low, high and auto speeds.
OffLowMedHigh
val FanControlTrait.FanModeSequenceEnum.OffLowMedHigh: FanControlTrait.FanModeSequenceEnum
Fan supports off, low, medium and high speeds.
OffLowMedHighAuto
val FanControlTrait.FanModeSequenceEnum.OffLowMedHighAuto: FanControlTrait.FanModeSequenceEnum
Fan supports off, low, medium, high and auto speeds.
UnknownValue
val FanControlTrait.FanModeSequenceEnum.UnknownValue: FanControlTrait.FanModeSequenceEnum
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.FanModeSequenceEnum
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.FanModeSequenceEnum>
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.