RvcRunModeTrait.StatusCode
enum RvcRunModeTrait.StatusCode : Enum, ClusterEnum
The status codes for RvcRunMode.
Summary
Enum Values |
|
|---|---|
BatteryLow |
The battery is low. |
DustBinFull |
The dust bin is full. |
DustBinMissing |
The dust bin is missing. |
MopCleaningPadMissing |
The mop cleaning pad is missing. |
Stuck |
The device is stuck. |
UnknownValue |
The enum value is out of range. |
WaterTankEmpty |
The water tank is empty. |
WaterTankLidOpen |
The lid to the water tank is open. |
WaterTankMissing |
The water tank is missing. |
Public functions |
|
|---|---|
RvcRunModeTrait.StatusCode |
Returns the enum constant of this type with the specified name. |
Array<RvcRunModeTrait.StatusCode> |
values()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
BatteryLow
val RvcRunModeTrait.StatusCode.BatteryLow: RvcRunModeTrait.StatusCode
The battery is low.
DustBinFull
val RvcRunModeTrait.StatusCode.DustBinFull: RvcRunModeTrait.StatusCode
The dust bin is full.
DustBinMissing
val RvcRunModeTrait.StatusCode.DustBinMissing: RvcRunModeTrait.StatusCode
The dust bin is missing.
MopCleaningPadMissing
val RvcRunModeTrait.StatusCode.MopCleaningPadMissing: RvcRunModeTrait.StatusCode
The mop cleaning pad is missing.
UnknownValue
val RvcRunModeTrait.StatusCode.UnknownValue: RvcRunModeTrait.StatusCode
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 RvcRunModeTrait.StatusCode.WaterTankEmpty: RvcRunModeTrait.StatusCode
The water tank is empty.
WaterTankLidOpen
val RvcRunModeTrait.StatusCode.WaterTankLidOpen: RvcRunModeTrait.StatusCode
The lid to the water tank is open.
WaterTankMissing
val RvcRunModeTrait.StatusCode.WaterTankMissing: RvcRunModeTrait.StatusCode
The water tank is missing.
Public functions
valueOf
fun valueOf(value: String): RvcRunModeTrait.StatusCode
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<RvcRunModeTrait.StatusCode>
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.