# FanControlCommands

# FanControlCommands


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface FanControlCommands
```

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

*** ** * ** ***

Commands for the FanControl trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlCommands#step(com.google.home.matter.standard.FanControlTrait.StepDirectionEnum,kotlin.Function1)( direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` Speed up or slow down the fan, in steps, without the client having to know the fan speed. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlCommands#stepBatchable(com.google.home.matter.standard.FanControlTrait.StepDirectionEnum,kotlin.Function1)( direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlCommands#step(com.google.home.matter.standard.FanControlTrait.StepDirectionEnum,kotlin.Function1)` command. |

## Public functions

### step

```
suspend fun step(
    direction: FanControlTrait.StepDirectionEnum,
    optionalArgs: FanControlTrait.StepCommand.OptionalArgs.() -> Unit = {}
): Unit
```

Speed up or slow down the fan, in steps, without the client having to know the fan speed.

| Parameters |
|---|---|
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum` | Whether the fan speed increases or decreases to the next step value. Valid directions are defined in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum`. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

### stepBatchable

```
fun stepBatchable(
    direction: FanControlTrait.StepDirectionEnum,
    optionalArgs: FanControlTrait.StepCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlCommands#step(com.google.home.matter.standard.FanControlTrait.StepDirectionEnum,kotlin.Function1)` command.

Speed up or slow down the fan, in steps, without the client having to know the fan speed.

| Parameters |
|---|---|
| `direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum` | Whether the fan speed increases or decreases to the next step value. Valid directions are defined in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum`. |
| `optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |