ThermostatTrait.SystemModeEnum
enum ThermostatTrait.SystemModeEnum : Enum, ClusterEnum
The current operating mode of the thermostat.
Summary
Enum Values |
|
|---|---|
Auto |
Demand is generated for either cooling or heating, as required. |
Cool |
Demand is only generated for cooling. |
Dry |
Demand is only generated for dehumidification. |
EmergencyHeat |
Second stage heating is in use to achieve desired temperature. |
FanOnly |
Demand is only generated for fan. |
Heat |
Demand is only generated for heating. |
Off |
The thermostat is not set to engage any climate control functions. |
Precooling |
The thermostat is in precooling mode. |
Sleep |
The thermostat is set to sleep mode. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
ThermostatTrait.SystemModeEnum |
Returns the enum constant of this type with the specified name. |
Array<ThermostatTrait.SystemModeEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
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 ThermostatTrait.SystemModeEnum.Auto: ThermostatTrait.SystemModeEnum
Demand is generated for either cooling or heating, as required.
Cool
val ThermostatTrait.SystemModeEnum.Cool: ThermostatTrait.SystemModeEnum
Demand is only generated for cooling.
Dry
val ThermostatTrait.SystemModeEnum.Dry: ThermostatTrait.SystemModeEnum
Demand is only generated for dehumidification.
EmergencyHeat
val ThermostatTrait.SystemModeEnum.EmergencyHeat: ThermostatTrait.SystemModeEnum
Second stage heating is in use to achieve desired temperature.
FanOnly
val ThermostatTrait.SystemModeEnum.FanOnly: ThermostatTrait.SystemModeEnum
Demand is only generated for fan.
Heat
val ThermostatTrait.SystemModeEnum.Heat: ThermostatTrait.SystemModeEnum
Demand is only generated for heating.
Off
val ThermostatTrait.SystemModeEnum.Off: ThermostatTrait.SystemModeEnum
The thermostat is not set to engage any climate control functions.
Precooling
val ThermostatTrait.SystemModeEnum.Precooling: ThermostatTrait.SystemModeEnum
The thermostat is in precooling mode.
Sleep
val ThermostatTrait.SystemModeEnum.Sleep: ThermostatTrait.SystemModeEnum
The thermostat is set to sleep mode.
UnknownValue
val ThermostatTrait.SystemModeEnum.UnknownValue: ThermostatTrait.SystemModeEnum
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): ThermostatTrait.SystemModeEnum
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<ThermostatTrait.SystemModeEnum>
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
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.