DescriptorTrait.SemanticTagStruct

class DescriptorTrait.SemanticTagStruct : ClusterStruct, Tag


An object describing an endpoint label specific to a manufacturer.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

SemanticTagStruct(
    mfgCode: UShort?,
    namespaceId: UByte,
    tag: UByte,
    _label: OptionalValue<String?>
)

Creates the SemanticTagStruct 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

open String?
open UShort?

The manufacturer ID.

open UByte
open UByte

The semantic tag ID located within the namespace.

Public constructors

SemanticTagStruct

SemanticTagStruct(
    mfgCode: UShort? = null,
    namespaceId: UByte,
    tag: UByte,
    _label: OptionalValue<String?> = OptionalValue.absent()
)

Creates the SemanticTagStruct 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

label

open val labelString?

mfgCode

open val mfgCodeUShort?

The manufacturer ID.

namespaceId

open val namespaceIdUByte

tag

open val tagUByte

The semantic tag ID located within the namespace.