ThermostatFanControl

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ThermostatFanControl : ThermostatFanControlTrait.Attributes, MatterTrait, Updatable


API for the ThermostatFanControl trait. This trait provides fan control capabilities for thermostats.

Summary

Public functions

Boolean

Public properties

open TraitFactory<ThermostatFanControl>

Inherited functions

From com.google.home.google.ThermostatFanControlTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend ThermostatFanControl

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.google.ThermostatFanControlTrait.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.

ThermostatFanControlTrait.FanSpeedSetting?

The currently selected fan speed.

ThermostatFanControlTrait.FanSpeedState?

The active state indicating why the current fan speed is selected.

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.

ThermostatFanControlTrait.FanSpeedSetting?

The user-specified override for the automatically selected speed.

ThermostatFanControlTrait.FanTotalStages?

The maximum number of physical fan speeds supported by the physical installation.

UInt?

The maximum finite timer duration supported by the thermostat.

ThermostatFanControlTrait.FanMode?

The active fan control mode.

UInt?

The duty cycle of the schedule in seconds per hour.

Boolean?

Whether scheduling is active while system mode is off.

UInt?

Schedule end time in seconds relative to local midnight.

ThermostatFanControlTrait.FanSpeedSetting?

The fan speed used by the schedule.

UInt?

Schedule start time in seconds relative to local midnight.

Boolean?

Whether smart ventilation, such as managing outdoor and indoor air quality interactions, is active.

Boolean?

Whether gas furnace specific fan settings extend to all non-electric forced-air systems.

Boolean?

Whether the circulating fan supports starting a timer that runs indefinitely.

Boolean?

Whether the circulating fan supports running the fan schedule and/or the ventilation schedule while the system mode is off.

Boolean?

Whether the circulating fan supports starting a timer while the system mode is off.

UInt?

The requested duration in seconds.

UInt?

The end epoch time in seconds of the active finite timer.

ThermostatFanControlTrait.FanEquipment?

If the HVAC system has both a circulating fan and a ventilator, the thermostat activates this set of equipment when the fan timer is active.

Boolean?

Whether the active timer runs indefinitely, ignoring duration and end time.

ThermostatFanControlTrait.FanSpeedSetting?

The speed used by the fan timer.

Boolean?

Whether the fan is running due to the active schedule or because of a manual user request.

ThermostatFanControlTrait.VentilationAlert?

The alert status indicating poor indoor or outdoor air quality constraint interactions.

Boolean?

Whether automatic ventilation is active.

Boolean?

Whether ventilation remains active while system mode is off.

Boolean?

Whether free heating and cooling by means of ventilation is active.

UInt?

The requested total daily ventilation duration in seconds.

ThermostatFanControlTrait.VentilationState?

The active state of ventilation equipment.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: ThermostatFanControl.Attribute): Boolean

Public properties

factory

open val factoryTraitFactory<ThermostatFanControl>