LocatorTrait.LocatorFeature

data class LocatorTrait.LocatorFeature

Map containing specific capabilities related to locating a device.

Summary

Public constructors
LocatorFeature(
    isSilenceable: Boolean,
    isRingable: Boolean,
    reportsLocation: Boolean
)

Creates the LocatorFeature data class.

Public functions
open ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties
String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.
Boolean

The device can play audio to indicate its location.
Boolean

The device can be silenced while ringing.
Boolean

The device can provide its coordinates for vocalized location.
String

Trait identifier of the Matter Cluster that defines the bitmap Data Type.

Public constructors

LocatorFeature

LocatorFeature(
    isSilenceable: Boolean = false,
    isRingable: Boolean = false,
    reportsLocation: Boolean = false
)

Creates the LocatorFeature data class.

Public functions

toRaw

open fun toRaw(): ULong

Convert this ClusterBitmap to raw (bytes) format

Public properties

bitmapName

val bitmapName: String

Name of the Matter bitmap, in UpperCamelCase, e.g. "OnOffControlBitmap" from OnOff Cluster.

isRingable

val isRingable: Boolean

The device can play audio to indicate its location.

isSilenceable

val isSilenceable: Boolean

The device can be silenced while ringing.

reportsLocation

val reportsLocation: Boolean

The device can provide its coordinates for vocalized location.

traitId

val traitId: String

Trait identifier of the Matter Cluster that defines the bitmap Data Type. Refer to ClusterId.traitId for the format.