water-heater-management-cluster.xml

<?xml version="1.0"?>
<!--
Copyright (c) 2024 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.
-->
<!--
XML generated by Alchemy; DO NOT EDIT.
Source: src/app_clusters/WaterHeaterManagement.adoc
Parameters: in-progress 
Git: 1.4-prerelease-ipr-69-ge15ff5700
-->
<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd">
  <domain name="Energy Management"/>
  <bitmap name="WaterHeaterHeatSourceBitmap" type="bitmap8" apiMaturity="provisional">
    <cluster code="0x0094"/>
    <field name="ImmersionElement1" mask="0x01"/>
    <field name="ImmersionElement2" mask="0x02"/>
    <field name="HeatPump" mask="0x04"/>
    <field name="Boiler" mask="0x08"/>
    <field name="Other" mask="0x10"/>
  </bitmap>

  <enum name="BoostStateEnum" type="enum8" apiMaturity="provisional">
    <cluster code="0x0094"/>
    <item name="Inactive" value="0x00"/>
    <item name="Active" value="0x01"/>
  </enum>

  <struct name="WaterHeaterBoostInfoStruct" apiMaturity="provisional">
    <cluster code="0x0094"/>
    <item fieldId="0" name="Duration" type="elapsed_s" min="1"/>
    <item fieldId="1" name="OneShot" type="boolean" optional="true" default="0"/>
    <item fieldId="2" name="EmergencyBoost" type="boolean" optional="true" default="0"/>
    <item fieldId="3" name="TemporarySetpoint" type="temperature" optional="true"/>
    <item fieldId="4" name="TargetPercentage" type="percent" optional="true"/>
    <item fieldId="5" name="TargetReheat" type="percent" optional="true"/>
  </struct>

  <cluster code="0x0094" apiMaturity="provisional">
    <domain>Energy Management</domain>
    <name>Water Heater Management</name>
    <code>0x0094</code>
    <define>WATER_HEATER_MANAGEMENT_CLUSTER</define>
    <description>This cluster is used to allow clients to control the operation of a hot water heating appliance so that it can be used with energy management.</description>
    <client init="false" tick="false">true</client>
    <features>
      <feature bit="0" code="EM" name="EnergyManagement" summary="Allows energy management control of the tank">
        <optionalConform/>
      </feature>
      <feature bit="1" code="TP" name="TankPercent" summary="Supports monitoring the percentage of hot water in the tank">
        <optionalConform/>
      </feature>
    </features>
    <server init="false" tick="false">true</server>
    <globalAttribute code="0xFFFD" side="either" value="2"/>
    <attribute code="0x0000" side="server" name="HeaterTypes" define="HEATER_TYPES" type="WaterHeaterHeatSourceBitmap" min="0x00" max="0x1F" default="0x00">
      <mandatoryConform/>
    </attribute>
    <attribute code="0x0001" side="server" name="HeatDemand" define="HEAT_DEMAND" type="WaterHeaterHeatSourceBitmap" min="0x00" max="0x1F" default="0x00">
      <mandatoryConform/>
    </attribute>
    <attribute code="0x0002" side="server" name="TankVolume" define="TANK_VOLUME" type="int16u" default="0" optional="true">
      <mandatoryConform>
        <feature name="EM"/>
      </mandatoryConform>
    </attribute>
    <attribute code="0x0003" side="server" name="EstimatedHeatRequired" define="ESTIMATED_HEAT_REQUIRED" type="energy_mwh" default="0" optional="true" min="0">
      <mandatoryConform>
        <feature name="EM"/>
      </mandatoryConform>
    </attribute>
    <attribute code="0x0004" side="server" name="TankPercentage" define="TANK_PERCENTAGE" type="percent" default="0" optional="true">
      <mandatoryConform>
        <feature name="TP"/>
      </mandatoryConform>
    </attribute>
    <attribute code="0x0005" side="server" name="BoostState" define="BOOST_STATE" type="BoostStateEnum" default="0" min="0x00" max="0x01">
      <mandatoryConform/>
    </attribute>
    <command code="0x00" source="client" name="Boost" optional="false" apiMaturity="provisional">
      <description>Allows a client to request that the water heater is put into a Boost state.</description>
      <arg id="0" name="BoostInfo" type="WaterHeaterBoostInfoStruct"/>
      <access op="invoke" privilege="manage"/>
      <mandatoryConform/>
    </command>

    <command code="0x01" source="client" name="CancelBoost" optional="false" apiMaturity="provisional">
      <description>Allows a client to cancel an ongoing Boost operation.</description>
      <access op="invoke" privilege="manage"/>
      <mandatoryConform/>
    </command>

    <event code="0x0000" name="BoostStarted" priority="info" side="server">
      <description>This event SHALL be generated whenever a Boost command is accepted.</description>
      <field id="0" name="BoostInfo" type="WaterHeaterBoostInfoStruct"/>
      <mandatoryConform/>
    </event>

    <event code="0x0001" name="BoostEnded" priority="info" side="server">
      <description>This event SHALL be generated whenever the BoostState transitions from Active to Inactive.</description>
      <mandatoryConform/>
    </event>

  </cluster>
</configurator>