ServiceAreaTrait.LandmarkInfoStruct
class ServiceAreaTrait.LandmarkInfoStruct : ClusterStruct
The data from this structure indicates a landmark and device position relative to the landmark.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
LandmarkInfoStruct(landmarkTag: UByte, relativePositionTag: UByte?)Creates the LandmarkInfoStruct class. |
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 |
|
|---|---|
UByte |
Indicates that the area is associated with a landmark. |
UByte? |
The position of the area relative to a landmark. |
Public constructors
LandmarkInfoStruct
LandmarkInfoStruct(landmarkTag: UByte, relativePositionTag: UByte? = null)
Creates the LandmarkInfoStruct class.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
landmarkTag
val landmarkTag: UByte
Indicates that the area is associated with a landmark. This field is the ID of a landmark semantic tag, located within the Common Landmark Namespace defined in the Matter specification.
relativePositionTag
val relativePositionTag: UByte?
The position of the area relative to a landmark. This is a static description of a zone known to the server, and this field never reflects the device's own proximity or position relative to the landmark, but that of the zone. This field is the ID of a relative position semantic tag, located within the Common Relative Position Namespace defined in the Matter specification.