FanControlTrait.FanModeSequenceEnum

enum FanControlTrait.FanModeSequenceEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.FanControlTrait.FanModeSequenceEnum

Supported fan speed ranges.

Summary

Enum Values
`OffHigh`	Fan supports off and on speeds.
`OffHighAuto`	Fan supports off, on and auto speeds.
`OffLowHigh`	Fan supports off, low and high speeds.
`OffLowHighAuto`	Fan supports off, low, high and auto speeds.
`OffLowMedHigh`	Fan supports off, low, medium and high speeds.
`OffLowMedHighAuto`	Fan supports off, low, medium, high and auto speeds.
`UnknownValue`	The enum value is out of range.

Public functions
`FanControlTrait.FanModeSequenceEnum`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<FanControlTrait.FanModeSequenceEnum>`	`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

OffHigh

val FanControlTrait.FanModeSequenceEnum.OffHigh: FanControlTrait.FanModeSequenceEnum

Fan supports off and on speeds.

OffHighAuto

val FanControlTrait.FanModeSequenceEnum.OffHighAuto: FanControlTrait.FanModeSequenceEnum

Fan supports off, on and auto speeds.

OffLowHigh

val FanControlTrait.FanModeSequenceEnum.OffLowHigh: FanControlTrait.FanModeSequenceEnum

Fan supports off, low and high speeds.

OffLowHighAuto

val FanControlTrait.FanModeSequenceEnum.OffLowHighAuto: FanControlTrait.FanModeSequenceEnum

Fan supports off, low, high and auto speeds.

OffLowMedHigh

val FanControlTrait.FanModeSequenceEnum.OffLowMedHigh: FanControlTrait.FanModeSequenceEnum

Fan supports off, low, medium and high speeds.

OffLowMedHighAuto

val FanControlTrait.FanModeSequenceEnum.OffLowMedHighAuto: FanControlTrait.FanModeSequenceEnum

Fan supports off, low, medium, high and auto speeds.

UnknownValue

val FanControlTrait.FanModeSequenceEnum.UnknownValue: FanControlTrait.FanModeSequenceEnum

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): FanControlTrait.FanModeSequenceEnum

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<FanControlTrait.FanModeSequenceEnum>

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.