ThermostatFanControlTrait.VentilationAlert
enum ThermostatFanControlTrait.VentilationAlert : Enum, ClusterEnum
The ventilation alert.
Summary
Enum Values |
|
|---|---|
IndoorAirQuality |
The ventilation is active due to poor indoor air quality. |
IndoorOutdoorAirQuality |
The indoor air quality is poor, but ventilation is blocked due to poor outdoor air quality. |
Ok |
The ventilation alert is normal. |
OutdoorAirQuality |
The ventilation stopped due to poor outdoor air quality (excludes timers). |
UnknownValue |
The enum value is out of range. |
Unspecified |
The ventilation alert is unspecified. |
Public functions |
|
|---|---|
String |
|
ThermostatFanControlTrait.VentilationAlert |
Returns the enum constant of this type with the specified name. |
Array<ThermostatFanControlTrait.VentilationAlert> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<ThermostatFanControlTrait.VentilationAlert> |
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
IndoorAirQuality
val ThermostatFanControlTrait.VentilationAlert.IndoorAirQuality: ThermostatFanControlTrait.VentilationAlert
The ventilation is active due to poor indoor air quality.
IndoorOutdoorAirQuality
val ThermostatFanControlTrait.VentilationAlert.IndoorOutdoorAirQuality: ThermostatFanControlTrait.VentilationAlert
The indoor air quality is poor, but ventilation is blocked due to poor outdoor air quality.
Ok
val ThermostatFanControlTrait.VentilationAlert.Ok: ThermostatFanControlTrait.VentilationAlert
The ventilation alert is normal.
OutdoorAirQuality
val ThermostatFanControlTrait.VentilationAlert.OutdoorAirQuality: ThermostatFanControlTrait.VentilationAlert
The ventilation stopped due to poor outdoor air quality (excludes timers).
UnknownValue
val ThermostatFanControlTrait.VentilationAlert.UnknownValue: ThermostatFanControlTrait.VentilationAlert
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.VentilationAlert.Unspecified: ThermostatFanControlTrait.VentilationAlert
The ventilation alert is unspecified.
Public functions
valueOf
fun valueOf(value: String): ThermostatFanControlTrait.VentilationAlert
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.VentilationAlert>
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.VentilationAlert>
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.