OvenMode

interface OvenMode : OvenModeTrait.Attributes, MatterTrait, Updatable, OvenModeCommands


API for the OvenMode trait. Defines additional mode tags and namespaced enumerated values for oven devices.

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<OvenMode>

Inherited functions

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

Change device modes.

From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend OvenMode
update(optimisticReturn: (OvenMode) -> Unit, init: OvenModeTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties

From com.google.home.matter.standard.OvenModeTrait.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 of the oven device.

OvenModeTrait.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.

UByte?

The value of the currentMode that depends on the state of an OnOff cluster on the same oven endpoint.

UByte?

The desired startup mode for the oven device when it is supplied with power.

List<OvenModeTrait.ModeOptionStruct>?

The modes supported by the oven device.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: OvenMode.Attribute): Boolean

supports

fun supports(command: OvenMode.Command): Boolean

Public properties

factory

open val factoryTraitFactory<OvenMode>