ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct
class ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct : ClusterStruct
Measurements of various harmonics.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
HarmonicMeasurementStruct(order: UByte, measurement: Long?)Creates the HarmonicMeasurementStruct 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 |
|
|---|---|
Long? |
The measured value for the given harmonic order. |
UByte |
The order of the harmonic being measured, which is typically an odd number unless the server is set up to report even harmonics. |
Public constructors
HarmonicMeasurementStruct
HarmonicMeasurementStruct(order: UByte, measurement: Long? = null)
Creates the HarmonicMeasurementStruct 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.