ThermostatTrait.PresetScenarioEnum

enum ThermostatTrait.PresetScenarioEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.ThermostatTrait.PresetScenarioEnum

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`	`valueOf(value: String)` 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.

Public properties
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

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.

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.

typeName

open val typeName: String

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

value

open val value: ULong

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.