data_model/1.6/clusters/ElectricalEnergyMeasurement.xml

<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2025). All rights reserved.
The information within this document is the property of the Connectivity
Standards Alliance and its use and disclosure are restricted, except as
expressly set forth herein.

Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
nontransferable, worldwide, limited and revocable license (without the right to
sublicense), under Connectivity Standards Alliance's applicable copyright
rights, to view, download, save, reproduce and use the document solely for your
own internal purposes and in accordance with the terms of the license set forth
herein. This license does not authorize you to, and you expressly warrant that
you shall not: (a) permit others (outside your organization) to use this
document; (b) post or publish this document; (c) modify, adapt, translate, or
otherwise change this document in any manner or create any derivative work
based on this document; (d) remove or modify any notice or label on this
document, including this Copyright Notice, License and Disclaimer. The
Connectivity Standards Alliance does not grant you any license hereunder other
than as expressly stated herein.

Elements of this document may be subject to third party intellectual property
rights, including without limitation, patent, copyright or trademark rights,
and any such third party may or may not be a member of the Connectivity
Standards Alliance. Connectivity Standards Alliance members grant other
Connectivity Standards Alliance members certain intellectual property rights as
set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
Standards Alliance members do not grant you any rights under this license. The
Connectivity Standards Alliance is not responsible for, and shall not be held
responsible in any manner for, identifying or failing to identify any or all
such third party intellectual property rights. Please visit www.csa-iot.org for
more information on how to become a member of the Connectivity Standards
Alliance.

This document and the information contained herein are provided on an “AS IS”
basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
LOSS OR DAMAGE.

All company, brand and product names in this document may be trademarks that
are the sole property of their respective owners.

This notice and disclaimer must be included on all copies of this document.

Connectivity Standards Alliance
508 Second Street, Suite 206
Davis, CA 95616, USA

:xrefstyle: basic
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0091" name="Electrical Energy Measurement Cluster" revision="2">
  <revisionHistory>
    <revision revision="1" summary="Initial revision"/>
    <revision revision="2" summary="Added support for apparent and reactive energy measurement"/>
  </revisionHistory>
  <clusterIds>
    <clusterId id="0x0091" name="Electrical Energy Measurement"/>
  </clusterIds>
  <classification hierarchy="base" role="application" picsCode="EEM" scope="Endpoint"/>
  <features>
    <feature bit="0" code="IMPE" name="ImportedEnergy" summary="Measurement of energy imported by the server">
      <optionalConform choice="a" more="true" min="1"/>
    </feature>
    <feature bit="1" code="EXPE" name="ExportedEnergy" summary="Measurement of energy provided by the server">
      <optionalConform choice="a" more="true" min="1"/>
    </feature>
    <feature bit="2" code="CUME" name="CumulativeEnergy" summary="Measurements are cumulative">
      <optionalConform choice="b" more="true" min="1"/>
    </feature>
    <feature bit="3" code="PERE" name="PeriodicEnergy" summary="Measurements are periodic">
      <optionalConform choice="b" more="true" min="1"/>
    </feature>
    <feature bit="4" code="APPE" name="ApparentEnergy" summary="Measurements report apparent energy">
      <otherwiseConform>
        <provisionalConform/>
        <optionalConform/>
      </otherwiseConform>
    </feature>
    <feature bit="5" code="REAE" name="ReactiveEnergy" summary="Measurements report reactive energy">
      <otherwiseConform>
        <provisionalConform/>
        <optionalConform/>
      </otherwiseConform>
    </feature>
  </features>
  <dataTypes>
    <enum name="MeasurementTypeEnum">
      <item value="0" name="Unspecified">
        <mandatoryConform/>
      </item>
      <item value="1" name="Voltage" summary="Voltage in millivolts (mV)">
        <mandatoryConform/>
      </item>
      <item value="2" name="ActiveCurrent" summary="Active current in milliamps (mA)">
        <mandatoryConform/>
      </item>
      <item value="3" name="ReactiveCurrent" summary="Reactive current in milliamps (mA)">
        <mandatoryConform/>
      </item>
      <item value="4" name="ApparentCurrent" summary="Apparent current in milliamps (mA)">
        <mandatoryConform/>
      </item>
      <item value="5" name="ActivePower" summary="Active power in milliwatts (mW)">
        <mandatoryConform/>
      </item>
      <item value="6" name="ReactivePower" summary="Reactive power in millivolt-amps reactive (mVAR)">
        <mandatoryConform/>
      </item>
      <item value="7" name="ApparentPower" summary="Apparent power in millivolt-amps (mVA)">
        <mandatoryConform/>
      </item>
      <item value="8" name="RMSVoltage" summary="Root mean squared voltage in millivolts (mV)">
        <mandatoryConform/>
      </item>
      <item value="9" name="RMSCurrent" summary="Root mean squared current in milliamps (mA)">
        <mandatoryConform/>
      </item>
      <item value="10" name="RMSPower" summary="Root mean squared power in milliwatts (mW)">
        <mandatoryConform/>
      </item>
      <item value="11" name="Frequency" summary="AC frequency in millihertz (mHz)">
        <mandatoryConform/>
      </item>
      <item value="12" name="PowerFactor" summary="Power Factor ratio in +/- 1/100ths of a percent.">
        <mandatoryConform/>
      </item>
      <item value="13" name="NeutralCurrent" summary="AC neutral current in milliamps (mA)">
        <mandatoryConform/>
      </item>
      <item value="14" name="ElectricalEnergy" summary="Electrical energy in milliwatt-hours (mWh)">
        <mandatoryConform/>
      </item>
      <item value="15" name="ReactiveEnergy" summary="Reactive power in millivolt-amp-hours reactive (mVARh)">
        <mandatoryConform/>
      </item>
      <item value="16" name="ApparentEnergy" summary="Apparent power in millivolt-amp-hours (mVAh)">
        <mandatoryConform/>
      </item>
    </enum>
    <struct name="CumulativeEnergyResetStruct">
      <field id="0" name="ImportedResetTimestamp" type="epoch-s" default="null">
        <quality nullable="true"/>
        <optionalConform>
          <feature name="IMPE"/>
        </optionalConform>
      </field>
      <field id="1" name="ExportedResetTimestamp" type="epoch-s" default="null">
        <quality nullable="true"/>
        <optionalConform>
          <feature name="EXPE"/>
        </optionalConform>
      </field>
      <field id="2" name="ImportedResetSystime" type="systime-ms" default="null">
        <quality nullable="true"/>
        <optionalConform>
          <feature name="IMPE"/>
        </optionalConform>
      </field>
      <field id="3" name="ExportedResetSystime" type="systime-ms" default="null">
        <quality nullable="true"/>
        <optionalConform>
          <feature name="EXPE"/>
        </optionalConform>
      </field>
    </struct>
    <struct name="EnergyMeasurementStruct">
      <field id="0" name="Energy" type="energy-mWh">
        <mandatoryConform/>
        <constraint>
          <between>
            <from value="0"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
      <field id="1" name="StartTimestamp" type="epoch-s">
        <describedConform/>
      </field>
      <field id="2" name="EndTimestamp" type="epoch-s">
        <describedConform/>
        <constraint>
          <min>
            <compute>
              <operation>add</operation>
              <left>
                <field name="StartTimestamp"/>
              </left>
              <right value="1"/>
            </compute>
          </min>
        </constraint>
      </field>
      <field id="3" name="StartSystime" type="systime-ms">
        <describedConform/>
      </field>
      <field id="4" name="EndSystime" type="systime-ms">
        <describedConform/>
        <constraint>
          <min>
            <compute>
              <operation>add</operation>
              <left>
                <field name="StartSystime"/>
              </left>
              <right value="1"/>
            </compute>
          </min>
        </constraint>
      </field>
      <field id="5" name="ApparentEnergy" type="energy-mVAh">
        <otherwiseConform>
          <provisionalConform/>
          <mandatoryConform>
            <feature name="APPE"/>
          </mandatoryConform>
        </otherwiseConform>
        <constraint>
          <between>
            <from value="0"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
      <field id="6" name="ReactiveEnergy" type="energy-mVARh">
        <otherwiseConform>
          <provisionalConform/>
          <mandatoryConform>
            <feature name="REAE"/>
          </mandatoryConform>
        </otherwiseConform>
        <constraint>
          <between>
            <from value="0"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
    </struct>
    <struct name="MeasurementAccuracyRangeStruct">
      <field id="0" name="RangeMin" type="int64">
        <mandatoryConform/>
        <constraint>
          <between>
            <from value="-4611686018427387904"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
      <field id="1" name="RangeMax" type="int64">
        <mandatoryConform/>
        <constraint>
          <between>
            <from value="-4611686018427387904"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
      <field id="2" name="PercentMax" type="percent100ths">
        <optionalConform choice="a" more="true" min="1"/>
      </field>
      <field id="3" name="PercentMin" type="percent100ths">
        <optionalConform>
          <field name="PercentMax"/>
        </optionalConform>
        <constraint>
          <max>
            <field name="PercentTypical"/>
          </max>
        </constraint>
      </field>
      <field id="4" name="PercentTypical" type="percent100ths">
        <optionalConform>
          <field name="PercentMin"/>
        </optionalConform>
        <constraint>
          <between>
            <from>
              <field name="PercentMin"/>
            </from>
            <to>
              <field name="PercentMax"/>
            </to>
          </between>
        </constraint>
      </field>
      <field id="5" name="FixedMax" type="uint64">
        <optionalConform choice="a" more="true" min="1"/>
        <constraint>
          <max>
            <compute>
              <operation>subtract</operation>
              <left value="4611686018427387904"/>
              <right value="1"/>
            </compute>
          </max>
        </constraint>
      </field>
      <field id="6" name="FixedMin" type="uint64">
        <optionalConform>
          <field name="FixedMax"/>
        </optionalConform>
        <constraint>
          <max>
            <field name="FixedMax"/>
          </max>
        </constraint>
      </field>
      <field id="7" name="FixedTypical" type="uint64">
        <optionalConform>
          <field name="FixedMin"/>
        </optionalConform>
        <constraint>
          <between>
            <from>
              <field name="FixedMin"/>
            </from>
            <to>
              <field name="FixedMax"/>
            </to>
          </between>
        </constraint>
      </field>
    </struct>
    <struct name="MeasurementAccuracyStruct">
      <field id="0" name="MeasurementType" type="MeasurementTypeEnum">
        <mandatoryConform/>
      </field>
      <field id="1" name="Measured" type="bool">
        <mandatoryConform/>
      </field>
      <field id="2" name="MinMeasuredValue" type="int64">
        <mandatoryConform/>
        <constraint>
          <between>
            <from value="-4611686018427387904"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
      <field id="3" name="MaxMeasuredValue" type="int64">
        <mandatoryConform/>
        <constraint>
          <between>
            <from value="-4611686018427387904"/>
            <to value="4611686018427387904"/>
          </between>
        </constraint>
      </field>
      <field id="4" name="AccuracyRanges" type="list">
        <entry type="MeasurementAccuracyRangeStruct"/>
        <mandatoryConform/>
        <constraint>
          <minCount value="1"/>
        </constraint>
      </field>
    </struct>
  </dataTypes>
  <attributes>
    <attribute id="0x0000" name="Accuracy" type="MeasurementAccuracyStruct">
      <access read="true" readPrivilege="view"/>
      <quality persistence="fixed"/>
      <mandatoryConform/>
    </attribute>
    <attribute id="0x0001" name="CumulativeEnergyImported" type="EnergyMeasurementStruct">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true" quieterReporting="true"/>
      <mandatoryConform>
        <andTerm>
          <feature name="IMPE"/>
          <feature name="CUME"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <attribute id="0x0002" name="CumulativeEnergyExported" type="EnergyMeasurementStruct">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true" quieterReporting="true"/>
      <mandatoryConform>
        <andTerm>
          <feature name="EXPE"/>
          <feature name="CUME"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <attribute id="0x0003" name="PeriodicEnergyImported" type="EnergyMeasurementStruct">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true" quieterReporting="true"/>
      <mandatoryConform>
        <andTerm>
          <feature name="IMPE"/>
          <feature name="PERE"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <attribute id="0x0004" name="PeriodicEnergyExported" type="EnergyMeasurementStruct">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true" quieterReporting="true"/>
      <mandatoryConform>
        <andTerm>
          <feature name="EXPE"/>
          <feature name="PERE"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <attribute id="0x0005" name="CumulativeEnergyReset" type="CumulativeEnergyResetStruct" default="null">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true"/>
      <optionalConform>
        <feature name="CUME"/>
      </optionalConform>
    </attribute>
  </attributes>
  <events>
    <event id="0x00" name="CumulativeEnergyMeasured" priority="info">
      <access readPrivilege="view"/>
      <mandatoryConform>
        <feature name="CUME"/>
      </mandatoryConform>
      <field id="0" name="EnergyImported" type="EnergyMeasurementStruct">
        <mandatoryConform>
          <andTerm>
            <feature name="CUME"/>
            <feature name="IMPE"/>
          </andTerm>
        </mandatoryConform>
      </field>
      <field id="1" name="EnergyExported" type="EnergyMeasurementStruct">
        <mandatoryConform>
          <andTerm>
            <feature name="CUME"/>
            <feature name="EXPE"/>
          </andTerm>
        </mandatoryConform>
      </field>
    </event>
    <event id="0x01" name="PeriodicEnergyMeasured" priority="info">
      <access readPrivilege="view"/>
      <mandatoryConform>
        <feature name="PERE"/>
      </mandatoryConform>
      <field id="0" name="EnergyImported" type="EnergyMeasurementStruct">
        <mandatoryConform>
          <andTerm>
            <feature name="PERE"/>
            <feature name="IMPE"/>
          </andTerm>
        </mandatoryConform>
      </field>
      <field id="1" name="EnergyExported" type="EnergyMeasurementStruct">
        <mandatoryConform>
          <andTerm>
            <feature name="PERE"/>
            <feature name="EXPE"/>
          </andTerm>
        </mandatoryConform>
      </field>
    </event>
  </events>
</cluster>