ThermostatFanControlTrait.FanSpeedSetting
enum ThermostatFanControlTrait.FanSpeedSetting : Enum, ClusterEnum
The fan speed setting.
Summary
Enum Values |
|
|---|---|
Auto |
Automatic speed adjustment. |
Off |
The fan speed setting is off. |
Stage1 |
Low speed. |
Stage2 |
Medium speed. |
Stage3 |
High speed. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The fan speed setting is unspecified. |
Public functions |
|
|---|---|
String |
|
ThermostatFanControlTrait.FanSpeedSetting |
Returns the enum constant of this type with the specified name. |
Array<ThermostatFanControlTrait.FanSpeedSetting> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<ThermostatFanControlTrait.FanSpeedSetting> |
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
Auto
val ThermostatFanControlTrait.FanSpeedSetting.Auto: ThermostatFanControlTrait.FanSpeedSetting
Automatic speed adjustment.
Off
val ThermostatFanControlTrait.FanSpeedSetting.Off: ThermostatFanControlTrait.FanSpeedSetting
The fan speed setting is off.
Stage1
val ThermostatFanControlTrait.FanSpeedSetting.Stage1: ThermostatFanControlTrait.FanSpeedSetting
Low speed.
Stage2
val ThermostatFanControlTrait.FanSpeedSetting.Stage2: ThermostatFanControlTrait.FanSpeedSetting
Medium speed.
Stage3
val ThermostatFanControlTrait.FanSpeedSetting.Stage3: ThermostatFanControlTrait.FanSpeedSetting
High speed.
UnknownValue
val ThermostatFanControlTrait.FanSpeedSetting.UnknownValue: ThermostatFanControlTrait.FanSpeedSetting
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.
Unspecified
val ThermostatFanControlTrait.FanSpeedSetting.Unspecified: ThermostatFanControlTrait.FanSpeedSetting
The fan speed setting is unspecified.
Public functions
valueOf
fun valueOf(value: String): ThermostatFanControlTrait.FanSpeedSetting
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<ThermostatFanControlTrait.FanSpeedSetting>
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<ThermostatFanControlTrait.FanSpeedSetting>
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.