ExtendedThermostatTrait.ExtendedThermostatMode
enum ExtendedThermostatTrait.ExtendedThermostatMode : Enum, ClusterEnum
Represents a mode in which a thermostat can operate.
Summary
Enum Values |
|
|---|---|
Eco |
Energy-saving mode. |
On |
Restores the previous mode of the device. |
Purifier |
Purifying mode. |
SmarthomeAuto |
|
Standard |
The thermostat is running in one of the standard modes, not in any of the defined extended modes for this trait. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
ExtendedThermostatTrait.ExtendedThermostatMode |
Returns the enum constant of this type with the specified name. |
Array<ExtendedThermostatTrait.ExtendedThermostatMode> |
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
Eco
val ExtendedThermostatTrait.ExtendedThermostatMode.Eco: ExtendedThermostatTrait.ExtendedThermostatMode
Energy-saving mode.
On
val ExtendedThermostatTrait.ExtendedThermostatMode.On: ExtendedThermostatTrait.ExtendedThermostatMode
Restores the previous mode of the device.
Purifier
val ExtendedThermostatTrait.ExtendedThermostatMode.Purifier: ExtendedThermostatTrait.ExtendedThermostatMode
Purifying mode.
SmarthomeAuto
val ExtendedThermostatTrait.ExtendedThermostatMode.SmarthomeAuto: ExtendedThermostatTrait.ExtendedThermostatMode
Standard
val ExtendedThermostatTrait.ExtendedThermostatMode.Standard: ExtendedThermostatTrait.ExtendedThermostatMode
The thermostat is running in one of the standard modes, not in any of the defined extended modes for this trait. For more information, refer to the systemMode attribute of the Thermostat cluster.
UnknownValue
val ExtendedThermostatTrait.ExtendedThermostatMode.UnknownValue: ExtendedThermostatTrait.ExtendedThermostatMode
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): ExtendedThermostatTrait.ExtendedThermostatMode
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<ExtendedThermostatTrait.ExtendedThermostatMode>
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.