LevelControlTrait.StepModeEnum

enum LevelControlTrait.StepModeEnum : Enum, ClusterEnum

kotlin.Any
   ↳ kotlin.Enum
     ↳ com.google.home.matter.standard.LevelControlTrait.StepModeEnum

The direction in which to step a device's level.

Summary

Enum Values
Down

Decrease the device's level.
UnknownValue

The enum value is out of range.
Up

Increase the device's level.

Public functions
LevelControlTrait.StepModeEnum
valueOf(value: String)

Returns the enum constant of this type with the specified name.
Array<LevelControlTrait.StepModeEnum>

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

Down

val LevelControlTrait.StepModeEnum.Down: LevelControlTrait.StepModeEnum

Decrease the device's level.

UnknownValue

val LevelControlTrait.StepModeEnum.UnknownValue: LevelControlTrait.StepModeEnum

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.

Up

val LevelControlTrait.StepModeEnum.Up: LevelControlTrait.StepModeEnum

Increase the device's level.

Public functions

valueOf

fun valueOf(value: String): LevelControlTrait.StepModeEnum

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<LevelControlTrait.StepModeEnum>

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.