ThermostatTrait.PresetScenarioEnum
enum ThermostatTrait.PresetScenarioEnum : Enum, ClusterEnum
Preset Scenarios.
Summary
Enum Values |
|
|---|---|
GoingToSleep |
Users are likely to be going to sleep. |
Occupied |
The thermostat-controlled area is occupied. |
Sleep |
Users are likely to be sleeping. |
UnknownValue |
The enum value is out of range. |
Unoccupied |
The thermostat-controlled area is unoccupied. |
UserDefined |
Custom presets. |
Vacation |
Users are on vacation. |
Wake |
Users are likely to be waking up. |
Public functions |
|
|---|---|
ThermostatTrait.PresetScenarioEnum |
Returns the enum constant of this type with the specified name. |
Array<ThermostatTrait.PresetScenarioEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
GoingToSleep
val ThermostatTrait.PresetScenarioEnum.GoingToSleep: ThermostatTrait.PresetScenarioEnum
Users are likely to be going to sleep.
Occupied
val ThermostatTrait.PresetScenarioEnum.Occupied: ThermostatTrait.PresetScenarioEnum
The thermostat-controlled area is occupied.
Sleep
val ThermostatTrait.PresetScenarioEnum.Sleep: ThermostatTrait.PresetScenarioEnum
Users are likely to be sleeping.
UnknownValue
val ThermostatTrait.PresetScenarioEnum.UnknownValue: ThermostatTrait.PresetScenarioEnum
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.
Unoccupied
val ThermostatTrait.PresetScenarioEnum.Unoccupied: ThermostatTrait.PresetScenarioEnum
The thermostat-controlled area is unoccupied.
UserDefined
val ThermostatTrait.PresetScenarioEnum.UserDefined: ThermostatTrait.PresetScenarioEnum
Custom presets.
Vacation
val ThermostatTrait.PresetScenarioEnum.Vacation: ThermostatTrait.PresetScenarioEnum
Users are on vacation.
Wake
val ThermostatTrait.PresetScenarioEnum.Wake: ThermostatTrait.PresetScenarioEnum
Users are likely to be waking up.
Public functions
valueOf
fun valueOf(value: String): ThermostatTrait.PresetScenarioEnum
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.PresetScenarioEnum>
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.