ExtendedThermostatTrait.PresetScenario

enum ExtendedThermostatTrait.PresetScenario : Enum, ClusterEnum


The type of preset.

Summary

Enum Values

Away

Away, also known as Leave.

Comfort

Temperature is optimized for comfort.

Eco

Energy-saving mode.

Home

Home, also known as Return.

Occupied

For use when the space is occupied.

Sleep

Temperature is optimized for sleeping.

UnknownValue

The enum value is out of range.

Unoccupied

For use when the space is vacant.

Unspecified

Unspecified.

UserDefined

User-defined preset.

Vacation

Temperature is optimized for vacation.

Wake

Temperature is optimized for when the user is awake.

Public functions

ExtendedThermostatTrait.PresetScenario
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<ExtendedThermostatTrait.PresetScenario>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

open String
open String
open ULong

Enum Values

Comfort

val ExtendedThermostatTrait.PresetScenario.ComfortExtendedThermostatTrait.PresetScenario

Temperature is optimized for comfort.

Sleep

val ExtendedThermostatTrait.PresetScenario.SleepExtendedThermostatTrait.PresetScenario

Temperature is optimized for sleeping.

UnknownValue

val ExtendedThermostatTrait.PresetScenario.UnknownValueExtendedThermostatTrait.PresetScenario

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.

Vacation

val ExtendedThermostatTrait.PresetScenario.VacationExtendedThermostatTrait.PresetScenario

Temperature is optimized for vacation.

Wake

val ExtendedThermostatTrait.PresetScenario.WakeExtendedThermostatTrait.PresetScenario

Temperature is optimized for when the user is awake.

Public functions

valueOf

fun valueOf(value: String): ExtendedThermostatTrait.PresetScenario

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.PresetScenario>

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 traitIdString

typeName

open val typeNameString

value

open val valueULong