# FanControlTrait.Attributes


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

<br />

Known direct subclasses [FanControl](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControl)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControl` | API for the FanControl trait. |

*** ** * ** ***

Attributes for the FanControl cluster.

## Summary

| ### Public functions |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#getDescriptor()()` Returns the descriptor for the struct. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.AirflowDirectionEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#airflowDirection()` Indicates the current airflow direction of the fan. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.FanModeEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#fanMode()` The current speed mode of the fan. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.FanModeSequenceEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#fanModeSequence()` The supported fan speed ranges. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#percentCurrent()` The actual currently operating fan speed, or `0` to indicate that the fan is off. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#percentSetting()` The speed setting for the fan. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.RockBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#rockSetting()` A bitmap that indicates the current active fan rocking motion settings. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.RockBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#rockSupport()` A bitmap that indicates what rocking motions the server supports. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#speedCurrent()` The actual currently operating fan speed, or `0` to indicate that the fan is off. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#speedMax()` The fan speed (value of `1`) or the maximum speed, if the fan is capable of multiple speeds, |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#speedSetting()` The speed setting for the fan. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.WindBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#windSetting()` A bitmap that indicates the current active fan wind feature settings. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.WindBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.Attributes#windSupport()` A bitmap that indicates what wind modes the server supports. |

## 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 acceptedCommandList: List<UInt>
```

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

### airflowDirection

```
val airflowDirection: FanControlTrait.AirflowDirectionEnum?
```

Indicates the current airflow direction of the fan. May be written by a client to indicate a new airflow direction for the fan.

**Access type:** Write

### 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 `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.FanModeEnum`.

**Access type:** Write

### fanModeSequence

```
val fanModeSequence: FanControlTrait.FanModeSequenceEnum?
```

The supported fan speed ranges. Valid modes are defined in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.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

<br />

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

<br />

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

<br />

**Access type:** Read