ThermostatFanControlTrait.FanState

class ThermostatFanControlTrait.FanState : ClusterStruct


The state of the fan.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

FanState(
    speed: ThermostatFanControlTrait.FanSpeedSetting,
    user_requested_fan_running: Boolean,
    fan_speed_state: ThermostatFanControlTrait.FanSpeedState
)

Creates the FanState class.

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

ThermostatFanControlTrait.FanSpeedState

The active state of the fan speed.

ThermostatFanControlTrait.FanSpeedSetting

The speed of the fan.

Boolean

Whether the fan is running from a manual user request or a duty-cycle schedule.

Public constructors

FanState

FanState(
    speed: ThermostatFanControlTrait.FanSpeedSetting = FanSpeedSetting.Unspecified,
    user_requested_fan_running: Boolean = false,
    fan_speed_state: ThermostatFanControlTrait.FanSpeedState = FanSpeedState.Unspecified
)

Creates the FanState class.

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

fan_speed_state

val fan_speed_stateThermostatFanControlTrait.FanSpeedState

The active state of the fan speed.

speed

val speedThermostatFanControlTrait.FanSpeedSetting

The speed of the fan.

user_requested_fan_running

val user_requested_fan_runningBoolean

Whether the fan is running from a manual user request or a duty-cycle schedule.