RvcOperationalState

interface RvcOperationalState : RvcOperationalStateTrait.Attributes, MatterTrait, RvcOperationalStateCommands

API for the RvcOperationalState trait. This trait provides an interface to the cleaning 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<RvcOperationalState>

Inherited functions
From com.google.home.matter.standard.RvcOperationalStateCommands
suspend RvcOperationalStateTrait.GoHomeCommand.Response

Send the device to its home base.
suspend RvcOperationalStateTrait.PauseCommand.Response

Pause the device if possible, based on the current operation underway.
suspend RvcOperationalStateTrait.ResumeCommand.Response

Resume operation if the device is in a state where it can be resumed.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.matter.standard.RvcOperationalStateTrait.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.
UInt?

The estimated time left in seconds before the operation is completed.
UByte?

The current phase of operation being performed by the device.
UInt

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.
RvcOperationalStateTrait.ErrorStateStruct?

The details of any current error condition being experienced by the device when the operationalState attribute is Error.
UByte?

The current operational state of the device.
List<RvcOperationalStateTrait.OperationalStateStruct>?

The set of possible operational states that the device exposes.
List<String>?

The set of phases that the device can go through for the selected function or mode.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: RvcOperationalState.Attribute): Boolean

supports

fun supports(command: RvcOperationalState.Command): Boolean

Public properties

factory

open val factory: TraitFactory<RvcOperationalState>