OperationalState

interface OperationalState : OperationalStateTrait.Attributes, MatterTrait, OperationalStateCommands


API for the OperationalState trait. This trait supports remote monitoring and allows the operational state of any device to be changed provided that a state machine is part of the operation.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public properties

open TraitFactory<OperationalState>

Inherited functions

From com.google.home.matter.standard.OperationalStateCommands
suspend OperationalStateTrait.PauseCommand.Response

Pause the device if possible, based on the current operation underway.

suspend OperationalStateTrait.ResumeCommand.Response

Resume operation if the device is in a state where it can be resumed.

suspend OperationalStateTrait.StartCommand.Response

Start the device if the device is in a state where it can be started.

suspend OperationalStateTrait.StopCommand.Response

Stop the device if possible, based on the current operation underway.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.OperationalStateTrait.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, in seconds, before the operation completes.

UByte?

The current phase of operation being performed by the server.

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.

OperationalStateTrait.ErrorStateStruct?

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

OperationalStateTrait.OperationalStateEnum?

The current operational state of the device.

List<OperationalStateTrait.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

Public functions

supports

fun supports(attribute: OperationalState.Attribute): Boolean

supports

fun supports(command: OperationalState.Command): Boolean

Public properties

factory

open val factoryTraitFactory<OperationalState>