# IdentifyCommands

# IdentifyCommands


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

<br />

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

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

*** ** * ** ***

Commands for the Identify 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/IdentifyCommands#identify(kotlin.UShort)(identifyTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Start or stop the identification state for the receiving device. |
| `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/IdentifyCommands#identifyBatchable(kotlin.UShort)(identifyTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#identify(kotlin.UShort)` command. |
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#triggerEffect(com.google.home.matter.standard.IdentifyTrait.EffectIdentifierEnum,com.google.home.matter.standard.IdentifyTrait.EffectVariantEnum)( effectIdentifier: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectIdentifierEnum, effectVariant: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectVariantEnum )` Start an effect that provides visual feedback to the user. |
| `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/IdentifyCommands#triggerEffectBatchable(com.google.home.matter.standard.IdentifyTrait.EffectIdentifierEnum,com.google.home.matter.standard.IdentifyTrait.EffectVariantEnum)( effectIdentifier: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectIdentifierEnum, effectVariant: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectVariantEnum )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#triggerEffect(com.google.home.matter.standard.IdentifyTrait.EffectIdentifierEnum,com.google.home.matter.standard.IdentifyTrait.EffectVariantEnum)` command. |

## Public functions

### identify

```
suspend fun identify(identifyTime: UShort): Unit
```

Start or stop the identification state for the receiving device.

When this command is called, the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.Attributes#identifyTime()` attribute is set to the value of `identifyTime` specified in this command.

| Parameters |
|---|---|
| `identifyTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The amount of time, in seconds, that the device should identify itself. A value of 0 stops the identification state. A value other than 0 starts the identification state, which lasts for the value (seconds) specified. |

### identifyBatchable

```
fun identifyBatchable(identifyTime: UShort): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#identify(kotlin.UShort)` command.

Start or stop the identification state for the receiving device.

When this command is called, the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.Attributes#identifyTime()` attribute is set to the value of `identifyTime` specified in this command.

| Parameters |
|---|---|
| `identifyTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The amount of time, in seconds, that the device should identify itself. A value of 0 stops the identification state. A value other than 0 starts the identification state, which lasts for the value (seconds) specified. |

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

### triggerEffect

```
suspend fun triggerEffect(
    effectIdentifier: IdentifyTrait.EffectIdentifierEnum,
    effectVariant: IdentifyTrait.EffectVariantEnum
): Unit
```

Start an effect that provides visual feedback to the user.

For example, a device's LED may turn green when it has successfully connected to the network.

| Parameters |
|---|---|
| `effectIdentifier: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectIdentifierEnum` | The identify effect to use. Must be a value from `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectIdentifierEnum`. |
| `effectVariant: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectVariantEnum` | Variant of the effect, indicated by the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#triggerEffect(com.google.home.matter.standard.IdentifyTrait.EffectIdentifierEnum,com.google.home.matter.standard.IdentifyTrait.EffectVariantEnum)` parameter, that is triggered. This must be one of the values in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectVariantEnum`. |

### triggerEffectBatchable

```
fun triggerEffectBatchable(
    effectIdentifier: IdentifyTrait.EffectIdentifierEnum,
    effectVariant: IdentifyTrait.EffectVariantEnum
): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#triggerEffect(com.google.home.matter.standard.IdentifyTrait.EffectIdentifierEnum,com.google.home.matter.standard.IdentifyTrait.EffectVariantEnum)` command.

Start an effect that provides visual feedback to the user.

For example, a device's LED may turn green when it has successfully connected to the network.

| Parameters |
|---|---|
| `effectIdentifier: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectIdentifierEnum` | The identify effect to use. Must be a value from `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectIdentifierEnum`. |
| `effectVariant: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectVariantEnum` | Variant of the effect, indicated by the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyCommands#triggerEffectBatchable(com.google.home.matter.standard.IdentifyTrait.EffectIdentifierEnum,com.google.home.matter.standard.IdentifyTrait.EffectVariantEnum)` parameter, that is triggered. This must be one of the values in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/IdentifyTrait.EffectVariantEnum`. |

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