energy-preference-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="Energy Management"/>
  <cluster apiMaturity="provisional">
    <name>Energy Preference</name>
    <domain>Energy Management</domain>
    <code>0x009B</code>
    <define>ENERGY_PREFERENCE_CLUSTER</define>
    <client init="false" tick="false">true</client>
    <server init="false" tick="false">true</server>
    <description>This cluster provides an interface to specify preferences for how devices should consume energy.</description>
    <!--Attributes-->
    <globalAttribute side="either" code="0xFFFD" value="1"/>

    <features>
      <feature bit="0" code="BALA" name="EnergyBalance" summary="Device can balance energy consumption vs. another priority">
        <optionalConform choice="a" more="true"/>
      </feature>
      <feature bit="1" code="LPMS" name="LowPowerModeSensitivity" summary="Device can adjust the conditions for entering a low power mode">
        <optionalConform choice="a" more="true"/>
      </feature>
    </features>

    <!--Conformance feature BALA - for now optional-->
    <attribute code="0x0000" side="server" name="EnergyBalances" type="array" entryType="BalanceStruct" define="ENERGY_PREFERENCE_ENERGY_BALANCES" min="2" max="10" optional="true">
      <mandatoryConform>
        <feature name="BALA"/>
      </mandatoryConform>
    </attribute>
    
    <!--Conformance feature BALA - for now optional-->
    <attribute code="0x0001" side="server" name="CurrentEnergyBalance" type="int8u" define="ENERGY_PREFERENCE_CURRENT_ENERGY_BALANCE" writable="true" optional="true">
      <access op="read" privilege="view"/>
      <access op="write" privilege="operate"/>
      <mandatoryConform>
        <feature name="BALA"/>
      </mandatoryConform>
    </attribute>

    <!--Conformance feature BALA - for now optional-->
    <attribute code="0x0002" side="server" name="EnergyPriorities" type="array" entryType="EnergyPriorityEnum" define="ENERGY_PREFERENCE_ENERGY_PRIORITIES" max="2" optional="true">
      <mandatoryConform>
        <feature name="BALA"/>
      </mandatoryConform>
    </attribute>

    <!--Conformance feature LPMS - for now optional-->
    <attribute code="0x0003" side="server" name="LowPowerModeSensitivities" type="array" entryType="BalanceStruct" define="ENERGY_PREFERENCE_LOW_POWER_MODE_SENSITIVITIES" min="2" max="10" optional="true">
      <mandatoryConform>
        <feature name="LPMS"/>
      </mandatoryConform>
    </attribute>

    <!--Conformance feature LPMS - for now optional-->
    <attribute code="0x0004" side="server" type="int8u" define="ENERGY_PREFERENCE_CURRENT_LOW_POWER_MODE_SENSITIVITY" writable="true" optional="true">
      <access op="read" privilege="view"/>
      <access op="write" privilege="operate"/>
      <description>CurrentLowPowerModeSensitivity</description>
      <mandatoryConform>
        <feature name="LPMS"/>
      </mandatoryConform>
    </attribute>

  </cluster>

  <enum name="EnergyPriorityEnum" type="enum8">
    <cluster code="0x009B"/>
    <item name="Comfort" value="0x00"/>
    <item name="Speed" value="0x01"/>
    <item name="Efficiency" value="0x02"/>
    <item name="WaterConsumption" value="0x03"/>
  </enum>

  <struct name="BalanceStruct">
    <cluster code="0x009B"/>
    <item name="Step" type="percent"/>
    <item name="Label" type="char_string" optional="true" length="64"/>
  </struct>

</configurator>