device-energy-management-mode-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/Mode_DeviceEnergyManagement.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="CHIP"/>
  <enum name="ModeTag" type="enum16">
    <cluster code="0x009F"/>
    <!-- These are the base values (see `enum class ModeTag`
         in src/app/clusters/mode-base-server/mode-base-cluster-objects.h for the namespace source of truth
         until it is possible to auto-include these without duplication in codegen. -->
    <item value="0x0000" name="Auto"/>
    <item value="0x0001" name="Quick"/>
    <item value="0x0002" name="Quiet"/>
    <item value="0x0003" name="LowNoise"/>
    <item value="0x0004" name="LowEnergy"/>
    <item value="0x0005" name="Vacation"/>
    <item value="0x0006" name="Min"/>
    <item value="0x0007" name="Max"/>
    <item value="0x0008" name="Night"/>
    <item value="0x0009" name="Day"/>
    <!-- Derived cluster-specific values -->
    <item value="0x4000" name="NoOptimization"/>
    <item value="0x4001" name="DeviceOptimization"/>
    <item value="0x4002" name="LocalOptimization"/>
    <item value="0x4003" name="GridOptimization"/>
  </enum>

  <cluster apiMaturity="provisional">
    <domain>Energy Management</domain>
    <name>Device Energy Management Mode</name>
    <code>0x009F</code>
    <define>DEVICE_ENERGY_MANAGEMENT_MODE_CLUSTER</define>
    <client init="false" tick="false">true</client>
    <server init="false" tick="false">true</server>
    <description>Attributes and commands for selecting a mode from a list of supported options.</description>
    <globalAttribute side="either" code="0xFFFD" value="2"/>
    <features>
      <feature bit="0" code="DEPONOFF" name="OnOff" summary="Dependency with the OnOff cluster">
        <disallowConform/>
      </feature>
    </features>
    <!-- Base data types -->
    <attribute side="server" code="0x0000" name="SupportedModes" define="SUPPORTED_MODES" type="array" entryType="ModeOptionStruct" length="255" minLength="2">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0001" name="CurrentMode" define="CURRENT_MODE" type="int8u">
      <mandatoryConform/>
    </attribute>
    <!-- Commands -->
    <command source="client" code="0x00" name="ChangeToMode" response="ChangeToModeResponse" optional="false">
      <description>This command is used to change device modes.</description>
      <arg id="0" name="NewMode" type="int8u"/>
      <mandatoryConform/>
    </command>

    <command source="server" code="0x01" name="ChangeToModeResponse" disableDefaultResponse="true" optional="false">
      <description>This command is sent by the device on receipt of the ChangeToMode command.</description>
      <arg id="0" name="Status" type="enum8"/>
      <arg id="1" name="StatusText" type="char_string" length="64" optional="true"/>
      <mandatoryConform/>
    </command>

  </cluster>
</configurator>