ThermostatFanControlTrait.Attributes

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ThermostatFanControlTrait.Attributes : ClusterStruct

Known direct subclasses
ThermostatFanControl

API for the ThermostatFanControl trait.


Attributes for the ThermostatFanControl cluster.

Summary

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

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

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

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.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

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

Public properties

acceptedCommandList

val acceptedCommandListList<UInt>

A list of client-generated commands which are supported by this cluster server instance.

attributeList

val attributeListList<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

clusterRevision

val clusterRevisionUShort

The revision of the server cluster specification supported by the cluster instance.

current_speed

val current_speedThermostatFanControlTrait.FanSpeedSetting?

The currently selected fan speed. This value cannot be 'Auto'.

Access type: Read

fan_speed_state

val fan_speed_stateThermostatFanControlTrait.FanSpeedState?

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

Access type: Read

featureMap

val featureMapUInt

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

generatedCommandList

val generatedCommandListList<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

hvac_override_speed

val hvac_override_speedThermostatFanControlTrait.FanSpeedSetting?

The user-specified override for the automatically selected speed. This speed cannot be off.

Access type: Write

max_available_speed

val max_available_speedThermostatFanControlTrait.FanTotalStages?

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

Access type: Read

max_timer_duration

val max_timer_durationUInt?

The maximum finite timer duration supported by the thermostat. Null should be interpreted as 12 hours.

Access type: Read

mode

val modeThermostatFanControlTrait.FanMode?

The active fan control mode.

Access type: Write

schedule_duty_cycle

val schedule_duty_cycleUInt?

The duty cycle of the schedule in seconds per hour. Supported range: 300 to 3600.

Access type: Write

schedule_enabled_in_off_mode

val schedule_enabled_in_off_modeBoolean?

Whether scheduling is active while system mode is off. Fan schedule does not run during CO or smoke safety shutoff.

Access type: Write

schedule_end_time

val schedule_end_timeUInt?

Schedule end time in seconds relative to local midnight.

Access type: Write

schedule_speed

val schedule_speedThermostatFanControlTrait.FanSpeedSetting?

The fan speed used by the schedule. The speed cannot be off or auto.

Access type: Write

schedule_start_time

val schedule_start_timeUInt?

Schedule start time in seconds relative to local midnight. If schedule_start_time equals schedule_end_time, the fan schedule runs continuously.

Access type: Write

smart_ventilation_enabled

val smart_ventilation_enabledBoolean?

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

Access type: Write

supports_fan_activation_for_non_electric_furnaces

val supports_fan_activation_for_non_electric_furnacesBoolean?

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

Access type: Read

supports_indefinite_timer

val supports_indefinite_timerBoolean?

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

Access type: Read

supports_schedule_in_off_mode

val supports_schedule_in_off_modeBoolean?

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

Access type: Read

supports_timer_in_off_mode

val supports_timer_in_off_modeBoolean?

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

Access type: Read

timer_duration

val timer_durationUInt?

The requested duration in seconds.

Access type: Write

timer_end

val timer_endUInt?

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

Access type: Write

timer_equipment

val timer_equipmentThermostatFanControlTrait.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. If the system has only a fan or only a vent, the thermostat ignores this field.

Access type: Write

timer_is_indefinite

val timer_is_indefiniteBoolean?

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

Access type: Write

timer_speed

val timer_speedThermostatFanControlTrait.FanSpeedSetting?

The speed used by the fan timer. The speed cannot be off or auto.

Access type: Write

user_requested_fan_running

val user_requested_fan_runningBoolean?

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

Access type: Write

ventilation_alert

val ventilation_alertThermostatFanControlTrait.VentilationAlert?

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

Access type: Read

ventilation_enabled

val ventilation_enabledBoolean?

Whether automatic ventilation is active. Does not apply to timer.

Access type: Write

ventilation_enabled_in_off_mode

val ventilation_enabled_in_off_modeBoolean?

Whether ventilation remains active while system mode is off. Ventilation does not run during CO or smoke safety shutoff.

Access type: Write

ventilation_for_heating_and_cooling_enabled

val ventilation_for_heating_and_cooling_enabledBoolean?

Whether free heating and cooling by means of ventilation is active. Requires the ventilator type to be configured as supply-only or exhaust-only.

Access type: Write

ventilation_on_time_per_day

val ventilation_on_time_per_dayUInt?

The requested total daily ventilation duration in seconds.

Access type: Write

ventilation_state

val ventilation_stateThermostatFanControlTrait.VentilationState?

The active state of ventilation equipment.

Access type: Read