IdentifyTrait.IdentifyCommand.Request

class IdentifyTrait.IdentifyCommand.Request : ClusterStruct

The request payload for the Identify command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(identifyTime: UShort)

Creates a request payload for the Identify command.

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
UShort

The amount of time, in seconds, that the device should identify itself.

Public constructors

Request

Request(identifyTime: UShort)

Creates a request payload for the Identify command.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

identifyTime

val identifyTime: UShort

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.