Locator

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Locator : LocatorTrait.Attributes, MatterTrait, LocatorCommands

API for the Locator trait. This trait is used to locate devices, which can be found by means of a local indicator, such as beeping, ringing, or flashing.

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

Inherited functions
From com.google.home.google.LocatorCommands
suspend Unit
locate(lang: String, reportLocation: Boolean)

Locate the target device by generating a local alert.
BatchableCommand<Unit>
locateBatchable(lang: String, reportLocation: Boolean)

The batchable version of locate command.
suspend Unit

Silence any in-progress alarms on devices that make an audible response for local alerts.
BatchableCommand<Unit>

The batchable version of silence command.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.google.LocatorTrait.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.
LocatorTrait.LocatorFeature

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.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Locator.Attribute): Boolean

supports

fun supports(command: Locator.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Locator>