FanControl

interface FanControl : FanControlTrait.Attributes, MatterTrait, Updatable, FanControlCommands

API for the FanControl trait. This trait provides an interface for controlling the speed of a fan.

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

Inherited functions
From com.google.home.matter.standard.FanControlCommands
suspend Unit

Speed up or slow down the fan, in steps, without the client having to know the fan speed.
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend FanControl
update(optimisticReturn: (FanControl) -> Unit, init: FanControlTrait.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.FanControlTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
FanControlTrait.AirflowDirectionEnum?
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.
FanControlTrait.FanModeEnum?

The current speed mode of the fan.
FanControlTrait.FanModeSequenceEnum?

The supported fan speed ranges.
FanControlTrait.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 actual currently operating fan speed, or 0 to indicate that the fan is off.
UByte?

The speed setting for the fan.
FanControlTrait.RockBitmap?

A bitmap that indicates the current active fan rocking motion settings.
FanControlTrait.RockBitmap?

A bitmap that indicates what rocking motions the server supports.
UByte?

The actual currently operating fan speed, or 0 to indicate that the fan is off.
UByte?

The fan speed (value of 1) or the maximum speed, if the fan is capable of multiple speeds,
UByte?

The speed setting for the fan.
FanControlTrait.WindBitmap?

A bitmap that indicates the current active fan wind feature settings.
FanControlTrait.WindBitmap?

A bitmap that indicates what wind modes the server supports.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: FanControl.Attribute): Boolean

supports

fun supports(command: FanControl.Command): Boolean

Public properties

factory

open val factory: TraitFactory<FanControl>