FanControlTrait.Attributes

interface FanControlTrait.Attributes

Known direct subclasses

FanControl

FanControl

API for the FanControl trait.

Attributes for the FanControl cluster.

Summary

Public properties
`List<UInt>`	`acceptedCommandList` A list of client-generated commands which are supported by this cluster server instance.
`FanControlTrait.AirflowDirectionEnum?`	`airflowDirection`
`List<UInt>`	`attributeList` A list of the attribute IDs of the attributes supported by the cluster instance.
`UShort`	`clusterRevision` The revision of the server cluster specification supported by the cluster instance.
`FanControlTrait.FanModeEnum?`	`fanMode` The current speed mode of the fan.
`FanControlTrait.FanModeSequenceEnum?`	`fanModeSequence` The supported fan speed ranges.
`FanControlTrait.Feature`	`featureMap` Whether the server supports zero or more optional cluster features.
`List<UInt>`	`generatedCommandList` A list of server-generated commands (server to client) which are supported by this cluster server instance.
`UByte?`	`percentCurrent` The actual currently operating fan speed, or `0` to indicate that the fan is off.
`UByte?`	`percentSetting` The speed setting for the fan.
`FanControlTrait.RockBitmap?`	`rockSetting` A bitmap that indicates the current active fan rocking motion settings.
`FanControlTrait.RockBitmap?`	`rockSupport` A bitmap that indicates what rocking motions the server supports.
`UByte?`	`speedCurrent` The actual currently operating fan speed, or `0` to indicate that the fan is off.
`UByte?`	`speedMax` The fan speed (value of `1`) or the maximum speed, if the fan is capable of multiple speeds,
`UByte?`	`speedSetting` The speed setting for the fan.
`FanControlTrait.WindBitmap?`	`windSetting` A bitmap that indicates the current active fan wind feature settings.
`FanControlTrait.WindBitmap?`	`windSupport` A bitmap that indicates what wind modes the server supports.

Public properties

acceptedCommandList

val acceptedCommandList: List<UInt>

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

airflowDirection

val airflowDirection: FanControlTrait.AirflowDirectionEnum?

attributeList

val attributeList: List<UInt>

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

clusterRevision

val clusterRevision: UShort

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

fanMode

val fanMode: FanControlTrait.FanModeEnum?

The current speed mode of the fan. Valid modes are defined in FanModeEnum.

Access type: Write

fanModeSequence

val fanModeSequence: FanControlTrait.FanModeSequenceEnum?

The supported fan speed ranges. Valid modes are defined in FanModeSequenceEnum.

Access type: Read

featureMap

val featureMap: FanControlTrait.Feature

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 generatedCommandList: List<UInt>

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

percentCurrent

val percentCurrent: UByte?

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

Access type: Read

percentSetting

val percentSetting: UByte?

The speed setting for the fan.

Access type: Write

rockSetting

val rockSetting: FanControlTrait.RockBitmap?

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

Access type: Write

rockSupport

val rockSupport: FanControlTrait.RockBitmap?

A bitmap that indicates what rocking motions the server supports. Valid values are:

0 — RockLeftRight
1 — RockUpDown
2 — RockRound

Access type: Read

speedCurrent

val speedCurrent: UByte?

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

Access type: Read

speedMax

val speedMax: UByte?

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

Access type: Read

speedSetting

val speedSetting: UByte?

The speed setting for the fan.

Access type: Write

windSetting

val windSetting: FanControlTrait.WindBitmap?

A bitmap that indicates the current active fan wind feature settings. Valid values are:

0 — Sleep Wind
1 — Natural Wind

Access type: Write

windSupport

val windSupport: FanControlTrait.WindBitmap?

A bitmap that indicates what wind modes the server supports. Valid values are:

0 — Sleep Wind
1 — Natural Wind

Access type: Read