valve-configuration-and-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="CHIP"/>


  <bitmap name="ValveFaultBitmap" type="bitmap16">
    <cluster code="0x0081"/>
    <field name="GeneralFault" mask="0x01"/>
    <field name="Blocked" mask="0x02"/>
    <field name="Leaking" mask="0x04"/>
    <field name="NotConnected" mask="0x08"/>
    <field name="ShortCircuit" mask="0x10"/>
    <field name="CurrentExceeded" mask="0x20"/>
  </bitmap>

  <enum name="ValveStateEnum" type="enum8">
    <cluster code="0x0081"/>
    <item name="Closed" value="0x0"/>
    <item name="Open" value="0x1"/>
    <item name="Transitioning" value="0x2"/>
  </enum>

  <enum name="StatusCodeEnum" type="enum8">
    <cluster code="0x0081"/>
     <item name="FailureDueToFault" value="0x02"/>
  </enum>

  <cluster>
    <domain>HVAC</domain>
    <name>Valve Configuration and Control</name>
    <code>0x0081</code>
    <define>VALVE_CONFIGURATION_AND_CONTROL_CLUSTER</define>
    <client tick="false" init="false">true</client>
    <server tick="false" init="false">true</server>
    <description>This cluster is used to configure a valve.</description>
    <globalAttribute side="either" code="0xFFFD" value="1"/>

    <features>
      <feature bit="0" code="TS" name="TimeSync" summary="UTC time is used for time indications"/>
      <feature bit="1" code="LVL" name="Level" summary="Device supports setting the specific position of the valve">
        <optionalConform/>
      </feature>
    </features>

    <!-- min max definition for attribute size larger than 2 bytes is not allowed by zap codegen https://github.com/project-chip/zap/issues/1187 -->
    <!-- Therefore, this check needs to be done in code. -->
    <attribute side="server" code="0x0000" name="OpenDuration" define="OPEN_DURATION" type="elapsed_s" isNullable="true">
      <mandatoryConform/>
    </attribute>
    <!-- min max definition for attribute size larger than 2 bytes is not allowed by zap codegen https://github.com/project-chip/zap/issues/1187 -->
    <!-- Therefore, this check needs to be done in code. -->
    <attribute side="server" code="0x0001" name="DefaultOpenDuration" define="DEFAULT_OPEN_DURATION" type="elapsed_s" isNullable="true" writable="true">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0002" name="AutoCloseTime" define="AUTO_CLOSE_TIME" type="epoch_us" isNullable="true" optional="true">
      <mandatoryConform>
        <feature name="TS"/>
      </mandatoryConform>
    </attribute>
    <attribute side="server" code="0x0003" name="RemainingDuration" define="REMAINING_DURATION" type="elapsed_s" isNullable="true">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0004" name="CurrentState" define="CURRENT_STATE" type="ValveStateEnum" isNullable="true">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0005" name="TargetState" define="TARGET_STATE" type="ValveStateEnum" isNullable="true">
      <mandatoryConform/>
    </attribute>
    <attribute side="server" code="0x0006" name="CurrentLevel" define="CURRENT_LEVEL" type="percent" isNullable="true" optional="true">
      <mandatoryConform>
        <feature name="LVL"/>
      </mandatoryConform>
    </attribute>
    <attribute side="server" code="0x0007" name="TargetLevel" define="TARGET_LEVEL" type="percent" isNullable="true" optional="true">
      <mandatoryConform>
        <feature name="LVL"/>
      </mandatoryConform>
    </attribute>
    <attribute side="server" code="0x0008" name="DefaultOpenLevel" define="DEFAULT_OPEN_LEVEL" type="percent" min="1" max="100" writable="true" default="100" optional="true">
      <optionalConform>
        <feature name="LVL"/>
      </optionalConform>
    </attribute>
    <attribute side="server" code="0x0009" name="ValveFault" define="VALVE_FAULT" type="ValveFaultBitmap" optional="true">
      <optionalConform/>
    </attribute>
    <attribute side="server" code="0x000A" name="LevelStep" define="LEVEL_STEP" type="int8u" min="1" max="50" optional="true">
      <optionalConform>
        <feature name="LVL"/>
      </optionalConform>
    </attribute>
    
    <command source="client" code="0x00" name="Open" optional="false">
      <description>This command is used to set the valve to its open position.</description>
      <arg name="OpenDuration" type="elapsed_s" optional="true" isNullable="true"/>
      <arg name="TargetLevel" type="percent" optional="true"/>
      <mandatoryConform/>
    </command>

    <command source="client" code="0x01" name="Close" optional="false">
      <description>This command is used to set the valve to its closed position.</description>
      <mandatoryConform/>
    </command>

    <event side="server" code="0x00" priority="info" name="ValveStateChanged" optional="true">
      <description>This event SHALL be generated when the valve state changed.</description>
      <field id="0" name="ValveState" type="ValveStateEnum"/>
      <field id="1" name="ValveLevel" type="percent" optional="true"/>
      <optionalConform/>
    </event>

    <event side="server" code="0x01" priority="info" name="ValveFault" optional="true">
      <description>This event SHALL be generated when the valve registers or clears a fault.</description>
      <field id="0" name="ValveFault" type="ValveFaultBitmap"/>
      <optionalConform/>
    </event>
  </cluster>
</configurator>