DishwasherMode

interface DishwasherMode : DishwasherModeTrait.Attributes, MatterTrait, Updatable, DishwasherModeCommands


API for the DishwasherMode trait. This trait provides an interface for dishwasher devices.

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public properties

open TraitFactory<DishwasherMode>

Inherited functions

suspend DishwasherModeTrait.ChangeToModeCommand.Response
changeToMode(newMode: UByte)

Change dishwasher mode.

suspend Unit
suspend DishwasherMode
update(optimisticReturn: (DishwasherMode) -> Unit, init: DishwasherModeTrait.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

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

DishwasherModeTrait.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 endpoint.

UByte?
List<DishwasherModeTrait.ModeOptionStruct>?

The list of supported modes for the dishwasher.

Public functions

supports

fun supports(attribute: DishwasherMode.Attribute): Boolean

supports

fun supports(command: DishwasherMode.Command): Boolean

Public properties

factory

open val factoryTraitFactory<DishwasherMode>