ElectricalPowerMeasurementTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ElectricalPowerMeasurementTrait.Attributes : ClusterStruct
ElectricalPowerMeasurement |
API for the ElectricalPowerMeasurement trait. |
Attributes for the ElectricalPowerMeasurement cluster.
Summary
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 |
|
|---|---|
List<UInt> |
A list of client-generated commands which are supported by this cluster server instance. |
List<ElectricalPowerMeasurementTrait.MeasurementAccuracyStruct>? |
List of accuracy specifications for the measurement types supported by the server. |
Long? |
The most recent current reading in milliamps (mA). |
Long? |
The most recent power reading in milliwatts (mW). |
Long? |
The most recent |
Long? |
The most recent |
List<UInt> |
A list of the attribute IDs of the attributes supported by the cluster instance. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
ElectricalPowerMeasurementTrait.Feature |
Whether the server supports zero or more optional cluster features. |
Long? |
The most recent frequency reading in millihertz (mHz). |
List<UInt> |
A list of server-generated commands (server to client) which are supported by this cluster server instance. |
List<ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct>? |
A list of |
List<ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct>? |
A list of |
Long? |
The most recent |
UByte? |
Maximum number of measurement types the server is capable of reporting. |
Long? |
The power factor ratio in +/- 1/100ths of a percent. |
ElectricalPowerMeasurementTrait.PowerModeEnum? |
The current mode of the server. |
List<ElectricalPowerMeasurementTrait.MeasurementRangeStruct>? |
The measured ranges for different measurement types. |
Long? |
The most recent |
Long? |
The most recent |
Long? |
Root mean squared current in milliamps (mA). |
Long? |
Root mean squared power in milliwatts (mW). |
Long? |
Root mean squared voltage in millivolts (mV). |
Long? |
Voltage in millivolts (mV). |
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
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
accuracy
val accuracy: List<ElectricalPowerMeasurementTrait.MeasurementAccuracyStruct>?
List of accuracy specifications for the measurement types supported by the server.
Access type: Read
activeCurrent
val activeCurrent: Long?
The most recent current reading in milliamps (mA). A positive value means that current is flowing into the server, and a negative value means that current is flowing out of the server.
Access type: Read
activePower
val activePower: Long?
The most recent power reading in milliwatts (mW). A positive value means that power is being imported, and a negative value means that power is being exported.
Access type: Read
apparentCurrent
val apparentCurrent: Long?
The most recent apparentCurrent (square root sum of the squares of active and reactive currents) reading in milliamps (mA).
Access type: Read
apparentPower
val apparentPower: Long?
The most recent apparentPower reading in millivolt-amps (mVA). A positive value denotes power imported, and a negative value denotes power exported.
Access type: Read
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
featureMap
val featureMap: ElectricalPowerMeasurementTrait.Feature
Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).
frequency
val frequency: Long?
The most recent frequency reading in millihertz (mHz).
Access type: Read
generatedCommandList
val generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
harmonicCurrents
val harmonicCurrents: List<ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct>?
A list of HarmonicMeasurementStruct values, where each value represents the harmonic current reading for the harmonic order as specified by order.
Access type: Read
harmonicPhases
val harmonicPhases: List<ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct>?
A list of HarmonicMeasurementStruct values, where each value represents the harmonic phase reading for the harmonic order as specified by order.
Access type: Read
neutralCurrent
val neutralCurrent: Long?
The most recent neutralCurrent reading in milliamps (mA). Typically, this is the magnitude of the vector sum of the phase currents. A positive value represents an imbalance between the phase currents when power is imported. A negative value represents an imbalance between the phase currents when power is exported.
Access type: Read
numberOfMeasurementTypes
val numberOfMeasurementTypes: UByte?
Maximum number of measurement types the server is capable of reporting.
Access type: Read
powerFactor
val powerFactor: Long?
The power factor ratio in +/- 1/100ths of a percent.
Access type: Read
powerMode
val powerMode: ElectricalPowerMeasurementTrait.PowerModeEnum?
The current mode of the server.
Access type: Read
ranges
val ranges: List<ElectricalPowerMeasurementTrait.MeasurementRangeStruct>?
The measured ranges for different measurement types. Each measurement type is limited to one entry in this list, which represents the range of measurements in the most recent measurement period.
Access type: Read
reactiveCurrent
val reactiveCurrent: Long?
The most recent reactiveCurrent reading in milliamps (mA). A positive value means that current is flowing into the server, and a negative value means that current is flowing out of the server.
Access type: Read
reactivePower
val reactivePower: Long?
The most recent reactivePower reading in millivolt-amps reactive (mVAR). A positive value denotes power imported, and a negative value denotes power exported.
Access type: Read
rmsCurrent
val rmsCurrent: Long?
Root mean squared current in milliamps (mA). A positive value means that current is flowing into the server, and a negative value means that current is flowing out of the server.
Access type: Read