RvcRunMode

interface RvcRunMode : RvcRunModeTrait.Attributes, MatterTrait, RvcRunModeCommands


API for the RvcRunMode trait. This trait provides an interface to the running modes of robotic vacuum cleaners.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions

Boolean
Boolean

Public properties

open TraitFactory<RvcRunMode>

Inherited functions

From com.google.home.matter.standard.RvcRunModeCommands
suspend RvcRunModeTrait.ChangeToModeCommand.Response
changeToMode(newMode: UByte)

Change the mode of the device's cluster instance, and set the currentMode attribute of the device's cluster instance.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.RvcRunModeTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

UByte?

The current mode.

RvcRunModeTrait.Feature

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

List<RvcRunModeTrait.ModeOptionStruct>?

The list of supported modes for the cluster instance.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: RvcRunMode.Attribute): Boolean

supports

fun supports(command: RvcRunMode.Command): Boolean

Public properties

factory

open val factoryTraitFactory<RvcRunMode>