RvcRunModeTrait.ModeTag
enum RvcRunModeTrait.ModeTag : Enum, ClusterEnum
The ModeTags for RvcRunMode.
Summary
Enum Values |
|
|---|---|
Auto |
Decides which options, features, and setting values to use. |
Cleaning |
The device is cleaning or paused while in the middle of cleaning. |
Day |
Provides a mode suitable for use during day time. |
Idle |
The device is doing something other than cleaning or mapping. |
LowEnergy |
Optimizes for lower energy usage. |
LowNoise |
Optimizes for low noise operation. |
Mapping |
The device is mapping. |
Max |
Uses the highest available setting value. |
Min |
Uses the lowest available setting value. |
Night |
Provides a mode suitable for use during night time. |
Quick |
Optimizes for faster completion. |
Quiet |
Operates silently or barely audibly. |
UnknownValue |
The enum value is out of range. |
Vacation |
Provides a mode suitable for use during vacations or other extended absences. |
Public functions |
|
|---|---|
String |
|
RvcRunModeTrait.ModeTag |
Returns the enum constant of this type with the specified name. |
Array<RvcRunModeTrait.ModeTag> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<RvcRunModeTrait.ModeTag> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
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
Auto
val RvcRunModeTrait.ModeTag.Auto: RvcRunModeTrait.ModeTag
Decides which options, features, and setting values to use.
Cleaning
val RvcRunModeTrait.ModeTag.Cleaning: RvcRunModeTrait.ModeTag
The device is cleaning or paused while in the middle of cleaning.
Day
val RvcRunModeTrait.ModeTag.Day: RvcRunModeTrait.ModeTag
Provides a mode suitable for use during day time.
Idle
val RvcRunModeTrait.ModeTag.Idle: RvcRunModeTrait.ModeTag
The device is doing something other than cleaning or mapping.
LowEnergy
val RvcRunModeTrait.ModeTag.LowEnergy: RvcRunModeTrait.ModeTag
Optimizes for lower energy usage.
LowNoise
val RvcRunModeTrait.ModeTag.LowNoise: RvcRunModeTrait.ModeTag
Optimizes for low noise operation.
Max
val RvcRunModeTrait.ModeTag.Max: RvcRunModeTrait.ModeTag
Uses the highest available setting value.
Min
val RvcRunModeTrait.ModeTag.Min: RvcRunModeTrait.ModeTag
Uses the lowest available setting value.
Night
val RvcRunModeTrait.ModeTag.Night: RvcRunModeTrait.ModeTag
Provides a mode suitable for use during night time.
Quiet
val RvcRunModeTrait.ModeTag.Quiet: RvcRunModeTrait.ModeTag
Operates silently or barely audibly.
UnknownValue
val RvcRunModeTrait.ModeTag.UnknownValue: RvcRunModeTrait.ModeTag
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.
Vacation
val RvcRunModeTrait.ModeTag.Vacation: RvcRunModeTrait.ModeTag
Provides a mode suitable for use during vacations or other extended absences.
Public functions
valueOf
fun valueOf(value: String): RvcRunModeTrait.ModeTag
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.ModeTag>
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<RvcRunModeTrait.ModeTag>
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.