Identify

interface Identify : IdentifyTrait.Attributes, MatterTrait, Updatable, IdentifyCommands

API for the Identify trait. This trait supports an endpoint identification state (such as a flashing light) that indicates to an observer (such as an installer) which of several nodes or endpoints it is.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<Identify>

Inherited functions
From com.google.home.matter.standard.IdentifyCommands
suspend Unit
identify(identifyTime: UShort)

Start or stop the identification state for the receiving device.
suspend Unit
triggerEffect(
    effectIdentifier: IdentifyTrait.EffectIdentifierEnum,
    effectVariant: IdentifyTrait.EffectVariantEnum
)

Start an effect that provides visual feedback to the user.
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend Identify
update(optimisticReturn: (Identify) -> Unit, init: IdentifyTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties
From com.google.home.matter.standard.IdentifyTrait.Attributes
List<UInt>

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

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

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

Whether the server supports zero or more optional cluster features.
List<UInt>

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

The remaining length of time, in seconds, that the endpoint will continue to identify itself.
IdentifyTrait.IdentifyTypeEnum?

How the identification state is presented to the user.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Identify.Attribute): Boolean

supports

fun supports(command: Identify.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Identify>