electrical-energy-measurement-cluster.xml

<?xml version="1.0"?>
<!--
Copyright (c) 2023 Project CHIP Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<configurator>
  <domain name="CHIP"/>
  <cluster>
    <name>Electrical Energy Measurement</name>
    <domain>Measurement &amp; Sensing</domain>
    <code>0x0091</code>
    <define>ELECTRICAL_ENERGY_MEASUREMENT_CLUSTER</define>
    <client init="false" tick="false">true</client>
    <server init="false" tick="false">true</server>
    <globalAttribute side="either" code="0xFFFD" value="1"/>
    <description>This cluster provides a mechanism for querying data about the electrical energy imported or provided by the server.</description>

    <features>
      <feature bit="0" code="IMPE" name="ImportedEnergy" summary="Measurement of energy imported by the server">
        <optionalConform choice="a" more="true"/>
      </feature>
      <feature bit="1" code="EXPE" name="ExportedEnergy" summary="Measurement of energy provided by the server">
        <optionalConform choice="a" more="true"/>
      </feature>
      <feature bit="2" code="CUME" name="CumulativeEnergy" summary="Measurements are cumulative">
        <optionalConform choice="b" more="true"/>
      </feature>
      <feature bit="3" code="PERE" name="PeriodicEnergy" summary="Measurements are periodic">
        <optionalConform choice="b" more="true"/>
      </feature>
    </features>

    <!--Attributes-->
    <attribute code="0x0000" side="server" name="Accuracy" define="ACCURACY" type="MeasurementAccuracyStruct">
      <mandatoryConform/>
    </attribute>
    <attribute code="0x0001" side="server" name="CumulativeEnergyImported" define="CUMULATIVE_ENERGY_IMPORTED" type="EnergyMeasurementStruct" optional="true" isNullable="true">
      <mandatoryConform>
        <andTerm>
          <feature name="IMPE"/>
          <feature name="CUME"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <!--Conformance feature IMPE & CUME - for now optional-->
    <attribute code="0x0002" side="server" name="CumulativeEnergyExported" define="CUMULATIVE_ENERGY_EXPORTED" type="EnergyMeasurementStruct" isNullable="true" optional="true">
      <mandatoryConform>
        <andTerm>
          <feature name="EXPE"/>
          <feature name="CUME"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <!--Conformance feature EXPE & CUME - for now optional-->
    <attribute code="0x0003" side="server" name="PeriodicEnergyImported" define="PERIODIC_ENERGY_IMPORTED" type="EnergyMeasurementStruct" isNullable="true" optional="true">
      <mandatoryConform>
        <andTerm>
          <feature name="IMPE"/>
          <feature name="PERE"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <!--Conformance feature IMPE & PERE - for now optional-->
    <attribute code="0x0004" side="server" name="PeriodicEnergyExported" define="PERIODIC_ENERGY_EXPORTED" type="EnergyMeasurementStruct" isNullable="true" optional="true">
      <mandatoryConform>
        <andTerm>
          <feature name="EXPE"/>
          <feature name="PERE"/>
        </andTerm>
      </mandatoryConform>
    </attribute>
    <attribute code="0x0005" side="server" name="CumulativeEnergyReset" define="CUMULATIVE_ENERGY_RESET" type="CumulativeEnergyResetStruct" isNullable="true" optional="true">
      <optionalConform>
        <feature name="CUME"/>
      </optionalConform>
    </attribute>
    <!--Conformance feature EXPE & PERE - for now optional-->
    <event code="0x00" side="server" name="CumulativeEnergyMeasured" priority="info" optional="true">
      <description>CumulativeEnergyMeasured</description>
      <field id="0" name="EnergyImported" type="EnergyMeasurementStruct" optional="true"/>
      <field id="1" name="EnergyExported" type="EnergyMeasurementStruct" optional="true"/>
      <mandatoryConform>
        <feature name="CUME"/>
      </mandatoryConform>
    </event>
    <event code="0x01" side="server" name="PeriodicEnergyMeasured" priority="info" optional="true">
      <description>PeriodicEnergyMeasured</description>
      <field id="0" name="EnergyImported" type="EnergyMeasurementStruct" optional="true"/>
      <field id="1" name="EnergyExported" type="EnergyMeasurementStruct" optional="true"/>
      <mandatoryConform>
        <feature name="PERE"/>
      </mandatoryConform>
    </event>
  </cluster>
  <struct name="CumulativeEnergyResetStruct">
    <cluster code="0x0091"/>
    <item fieldId="0" name="ImportedResetTimestamp" type="epoch_s" isNullable="true" optional="true"/>
    <item fieldId="1" name="ExportedResetTimestamp" type="epoch_s" isNullable="true" optional="true"/>
    <item fieldId="2" name="ImportedResetSystime" type="systime_ms" isNullable="true" optional="true"/>
    <item fieldId="3" name="ExportedResetSystime" type="systime_ms" isNullable="true" optional="true"/>
  </struct>
  <struct name="EnergyMeasurementStruct">
    <cluster code="0x0091"/>
    <item fieldId="0" name="Energy" type="energy_mwh" min="0" max="4611686018427387904"/>
    <item fieldId="1" name="StartTimestamp" type="epoch_s" optional="true"/>
    <item fieldId="2" name="EndTimestamp" type="epoch_s" optional="true"/>
    <item fieldId="3" name="StartSystime" type="systime_ms" optional="true"/>
    <item fieldId="4" name="EndSystime" type="systime_ms" optional="true"/>
  </struct>
</configurator>