RvcOperationalStateTrait.ErrorStateEnum

enum RvcOperationalStateTrait.ErrorStateEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.RvcOperationalStateTrait.ErrorStateEnum

The error states.

Summary

Enum Values
`CommandInvalidInState`
`DustBinFull`	The dust bin is full.
`DustBinMissing`	The dust bin is missing.
`FailedToFindChargingDock`	The device failed to find or reach the charging dock.
`MopCleaningPadMissing`	The cleaning pad is missing.
`NoError`
`Stuck`	The device is stuck and requires manual intervention.
`UnableToCompleteOperation`
`UnableToStartOrResume`
`UnknownValue`	The enum value is out of range.
`WaterTankEmpty`	The water tank is empty.
`WaterTankLidOpen`	The water tank lid is open.
`WaterTankMissing`	The water tank is missing.

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

CommandInvalidInState

val RvcOperationalStateTrait.ErrorStateEnum.CommandInvalidInState: RvcOperationalStateTrait.ErrorStateEnum

DustBinFull

val RvcOperationalStateTrait.ErrorStateEnum.DustBinFull: RvcOperationalStateTrait.ErrorStateEnum

The dust bin is full.

DustBinMissing

val RvcOperationalStateTrait.ErrorStateEnum.DustBinMissing: RvcOperationalStateTrait.ErrorStateEnum

The dust bin is missing.

FailedToFindChargingDock

val RvcOperationalStateTrait.ErrorStateEnum.FailedToFindChargingDock: RvcOperationalStateTrait.ErrorStateEnum

The device failed to find or reach the charging dock.

MopCleaningPadMissing

val RvcOperationalStateTrait.ErrorStateEnum.MopCleaningPadMissing: RvcOperationalStateTrait.ErrorStateEnum

The cleaning pad is missing.

NoError

val RvcOperationalStateTrait.ErrorStateEnum.NoError: RvcOperationalStateTrait.ErrorStateEnum

Stuck

val RvcOperationalStateTrait.ErrorStateEnum.Stuck: RvcOperationalStateTrait.ErrorStateEnum

The device is stuck and requires manual intervention.

UnableToCompleteOperation

val RvcOperationalStateTrait.ErrorStateEnum.UnableToCompleteOperation: RvcOperationalStateTrait.ErrorStateEnum

UnableToStartOrResume

val RvcOperationalStateTrait.ErrorStateEnum.UnableToStartOrResume: RvcOperationalStateTrait.ErrorStateEnum

UnknownValue

val RvcOperationalStateTrait.ErrorStateEnum.UnknownValue: RvcOperationalStateTrait.ErrorStateEnum

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.

WaterTankEmpty

val RvcOperationalStateTrait.ErrorStateEnum.WaterTankEmpty: RvcOperationalStateTrait.ErrorStateEnum

The water tank is empty.

WaterTankLidOpen

val RvcOperationalStateTrait.ErrorStateEnum.WaterTankLidOpen: RvcOperationalStateTrait.ErrorStateEnum

The water tank lid is open.

WaterTankMissing

val RvcOperationalStateTrait.ErrorStateEnum.WaterTankMissing: RvcOperationalStateTrait.ErrorStateEnum

The water tank is missing.

Public functions

valueOf

fun valueOf(value: String): RvcOperationalStateTrait.ErrorStateEnum

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<RvcOperationalStateTrait.ErrorStateEnum>

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.