fan-control-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="HVAC"/>

  <enum name="FanModeEnum" type="enum8">
    <cluster code="0x0202"/>
    <item name="Off" value="0x00"/>
    <item name="Low" value="0x01"/>
    <item name="Medium" value="0x02"/>
    <item name="High" value="0x03"/>
    <item name="On" value="0x04"/>
    <item name="Auto" value="0x05"/>
    <item name="Smart" value="0x06"/>
  </enum>

  <enum name="FanModeSequenceEnum" type="enum8">
    <cluster code="0x0202"/>
    <item name="OffLowMedHigh" value="0x00"/>
    <item name="OffLowHigh" value="0x01"/>
    <item name="OffLowMedHighAuto" value="0x02"/>
    <item name="OffLowHighAuto" value="0x03"/>
    <item name="OffHighAuto" value="0x04"/>
    <item name="OffHigh" value="0x05"/>
  </enum>

  <bitmap name="RockBitmap" type="bitmap8">
    <cluster code="0x0202" />
    <field name="RockLeftRight" mask="0x01" />
    <field name="RockUpDown" mask="0x02" />
    <field name="RockRound" mask="0x04" />
  </bitmap>

  <bitmap name="WindBitmap" type="bitmap8">
    <cluster code="0x0202" />
    <field name="Sleep Wind" mask="0x01" />
    <field name="Natural Wind" mask="0x02" />
  </bitmap>

  <enum name="StepDirectionEnum" type="enum8">
    <cluster code="0x0202"/>
    <item name="Increase" value="0x00"/>
    <item name="Decrease" value="0x01"/>
  </enum>

  <enum name="AirflowDirectionEnum" type="enum8">
    <cluster code="0x0202"/>
    <item name="Forward" value="0x00"/>
    <item name="Reverse" value="0x01"/>
  </enum>

  <cluster>
    <name>Fan Control</name>
    <domain>HVAC</domain>
    <description>An interface for controlling a fan in a heating/cooling system.</description>
    <code>0x0202</code>
    <define>FAN_CONTROL_CLUSTER</define>

    <client tick="false" init="false">true</client>
    <server tick="false" init="false">true</server>

    <globalAttribute side="either" code="0xFFFD" value="4"/>

    <features>
      <feature bit="0" code="SPD" name="MultiSpeed" summary="0-SpeedMax Fan Speeds">
        <optionalConform/>
      </feature>
      <feature bit="1" code="AUT" name="Auto" summary="Automatic mode supported for fan speed">
        <optionalConform/>
      </feature>
      <feature bit="2" code="RCK" name="Rocking" summary="Rocking movement supported">
        <optionalConform/>
      </feature>
      <feature bit="3" code="WND" name="Wind" summary="Wind emulation supported">
        <optionalConform/>
      </feature>
      <feature bit="4" code="STEP" name="Step" summary="Step command supported">
        <optionalConform/>
      </feature>
      <feature bit="5" code="DIR" name="AirflowDirection" summary="Airflow Direction attribute is supported">
        <optionalConform/>
      </feature>
    </features>

    <attribute side="server" code="0x0000" define="FAN_MODE" type="FanModeEnum" min="0" max="6" writable="true" default="0" optional="false">FanMode</attribute>
    <attribute side="server" code="0x0001" define="FAN_MODE_SEQUENCE" type="FanModeSequenceEnum" min="0" max="5" writable="false" default="2" optional="false">FanModeSequence</attribute>
    <attribute side="server" code="0x0002" define="PERCENT_SETTING" type="percent" min="0" max="100" writable="true" default="0" isNullable="true" optional="false">PercentSetting</attribute>
    <attribute side="server" code="0x0003" define="PERCENT_CURRENT" type="percent" min="0" max="100" writable="false" default="0" optional="false">PercentCurrent</attribute>
    <attribute side="server" code="0x0004" define="SPEED_MAX" type="int8u" min="1" max="100" writable="false" default="1" optional="true">SpeedMax</attribute>
    <attribute side="server" code="0x0005" define="SPEED_SETTING" type="int8u" min="0" max="100" writable="true" default="0" isNullable="true" optional="true">SpeedSetting</attribute>
    <attribute side="server" code="0x0006" define="SPEED_CURRENT" type="int8u" min="0" max="100" writable="false" default="0" optional="true">SpeedCurrent</attribute>
    <attribute side="server" code="0x0007" define="ROCK_SUPPORT" type="RockBitmap" writable="false" default="0x00" optional="true">RockSupport</attribute>
    <attribute side="server" code="0x0008" define="ROCK_SETTING" type="RockBitmap" writable="true" default="0x00" optional="true">RockSetting</attribute>
    <attribute side="server" code="0x0009" define="WIND_SUPPORT" type="WindBitmap" writable="false" default="0x00" optional="true">WindSupport</attribute>
    <attribute side="server" code="0x000A" define="WIND_SETTING" type="WindBitmap" writable="true" default="0x00" optional="true">WindSetting</attribute>
    <attribute side="server" code="0x000B" define="AIRFLOW_DIRECTION" type="AirflowDirectionEnum" writable="true" default="0" optional="true">AirflowDirection</attribute>

    <command source="client" code="0x00" name="Step" optional="true">
      <description>The Step command speeds up or slows down the fan, in steps.</description>
      <arg name="Direction" type="StepDirectionEnum"/>
      <arg name="Wrap" type="boolean" optional="true"/>
      <arg name="LowestOff" type="boolean" optional="true"/>
    </command>
  </cluster>
</configurator>