# FanControlTrait.StepCommand.Request

# FanControlTrait.StepCommand.Request


```
class FanControlTrait.StepCommand.Request : ClusterStruct
```

<br />

*** ** * ** ***

The request payload for the Step command.

## Summary

| ### Nested types |
|---|
| `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.Request.CommandFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this command's request fields. |

| ### Public constructors |
|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.Request#Request(com.google.home.matter.standard.FanControlTrait.StepDirectionEnum,com.google.home.matter.serialization.OptionalValue,com.google.home.matter.serialization.OptionalValue)( direction: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum, wrap: https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html>, lowestOff: https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html> )` Creates a request payload for the Step command. |

| ### 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.StepCommand.Request#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.StepCommand.Request#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://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepDirectionEnum` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.Request#direction()` Whether the fan speed increases or decreases to the next step value. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.Request#lowestOff()` Whether the fan being off (speed value `0`) is included as a step value. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/FanControlTrait.StepCommand.Request#wrap()` Fan speed wraps between highest and lowest step value. |

## Public constructors

### Request

```
Request(
    direction: FanControlTrait.StepDirectionEnum = StepDirectionEnum.Increase,
    wrap: OptionalValue<Boolean> = OptionalValue.absent(),
    lowestOff: OptionalValue<Boolean> = OptionalValue.absent()
)
```

Creates a request payload for the Step command.

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

### direction

```
val direction: 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`.

### lowestOff

```
val lowestOff: OptionalValue<Boolean>
```

Whether the fan being off (speed value `0`) is included as a step value.

### wrap

```
val wrap: OptionalValue<Boolean>
```

Fan speed wraps between highest and lowest step value.