RvcOperationalStateTrait.ErrorStateEnum

enum RvcOperationalStateTrait.ErrorStateEnum : Enum, ClusterEnum

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

The error states.

Summary

Enum Values
`BrushJammed`	The brush is jammed.
`CannotReachTargetArea`	The device cannot reach the target area.
`CommandInvalidInState`	The device cannot process the command in its current state.
`DirtyWaterTankFull`	The dirty water tank is full.
`DirtyWaterTankMissing`	The dirty water tank is missing.
`DustBinFull`	The dust bin is full.
`DustBinMissing`	The dust bin is missing.
`FailedToFindChargingDock`	The device failed to find or reach the charging dock.
`LowBattery`	The device is unable to start or continue operation due to low battery level.
`MopCleaningPadMissing`	The cleaning pad is missing.
`NavigationSensorObscured`	The navigation sensor is obscured.
`NoError`	The device is not in an error state.
`Stuck`	The device is stuck and requires manual intervention.
`UnableToCompleteOperation`	The device is unable to complete the current operation.
`UnableToStartOrResume`	The device is unable to start or resume operation.
`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.
`WheelsJammed`	The wheels are jammed.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`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
`EnumEntries<RvcOperationalStateTrait.ErrorStateEnum>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`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

BrushJammed

val RvcOperationalStateTrait.ErrorStateEnum.BrushJammed: RvcOperationalStateTrait.ErrorStateEnum

The brush is jammed.

CannotReachTargetArea

val RvcOperationalStateTrait.ErrorStateEnum.CannotReachTargetArea: RvcOperationalStateTrait.ErrorStateEnum

The device cannot reach the target area.

CommandInvalidInState

val RvcOperationalStateTrait.ErrorStateEnum.CommandInvalidInState: RvcOperationalStateTrait.ErrorStateEnum

The device cannot process the command in its current state.

DirtyWaterTankFull

val RvcOperationalStateTrait.ErrorStateEnum.DirtyWaterTankFull: RvcOperationalStateTrait.ErrorStateEnum

The dirty water tank is full.

DirtyWaterTankMissing

val RvcOperationalStateTrait.ErrorStateEnum.DirtyWaterTankMissing: RvcOperationalStateTrait.ErrorStateEnum

The dirty water tank is missing.

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.

LowBattery

val RvcOperationalStateTrait.ErrorStateEnum.LowBattery: RvcOperationalStateTrait.ErrorStateEnum

The device is unable to start or continue operation due to low battery level.

MopCleaningPadMissing

val RvcOperationalStateTrait.ErrorStateEnum.MopCleaningPadMissing: RvcOperationalStateTrait.ErrorStateEnum

The cleaning pad is missing.

NavigationSensorObscured

val RvcOperationalStateTrait.ErrorStateEnum.NavigationSensorObscured: RvcOperationalStateTrait.ErrorStateEnum

The navigation sensor is obscured.

NoError

val RvcOperationalStateTrait.ErrorStateEnum.NoError: RvcOperationalStateTrait.ErrorStateEnum

The device is not in an error state.

Stuck

val RvcOperationalStateTrait.ErrorStateEnum.Stuck: RvcOperationalStateTrait.ErrorStateEnum

The device is stuck and requires manual intervention.

UnableToCompleteOperation

val RvcOperationalStateTrait.ErrorStateEnum.UnableToCompleteOperation: RvcOperationalStateTrait.ErrorStateEnum

The device is unable to complete the current operation.

UnableToStartOrResume

val RvcOperationalStateTrait.ErrorStateEnum.UnableToStartOrResume: RvcOperationalStateTrait.ErrorStateEnum

The device is unable to start or resume operation.

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.

WheelsJammed

val RvcOperationalStateTrait.ErrorStateEnum.WheelsJammed: RvcOperationalStateTrait.ErrorStateEnum

The wheels are jammed.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

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

entries

val entries: EnumEntries<RvcOperationalStateTrait.ErrorStateEnum>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

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.