data_model/1.5/clusters/ClosureControl.xml

<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2025). All rights reserved.
The information within this document is the property of the Connectivity
Standards Alliance and its use and disclosure are restricted, except as
expressly set forth herein.

Connectivity Standards Alliance hereby grants you a fully-paid, non-exclusive,
nontransferable, worldwide, limited and revocable license (without the right to
sublicense), under Connectivity Standards Alliance's applicable copyright
rights, to view, download, save, reproduce and use the document solely for your
own internal purposes and in accordance with the terms of the license set forth
herein. This license does not authorize you to, and you expressly warrant that
you shall not: (a) permit others (outside your organization) to use this
document; (b) post or publish this document; (c) modify, adapt, translate, or
otherwise change this document in any manner or create any derivative work
based on this document; (d) remove or modify any notice or label on this
document, including this Copyright Notice, License and Disclaimer. The
Connectivity Standards Alliance does not grant you any license hereunder other
than as expressly stated herein.

Elements of this document may be subject to third party intellectual property
rights, including without limitation, patent, copyright or trademark rights,
and any such third party may or may not be a member of the Connectivity
Standards Alliance. Connectivity Standards Alliance members grant other
Connectivity Standards Alliance members certain intellectual property rights as
set forth in the Connectivity Standards Alliance IPR Policy. Connectivity
Standards Alliance members do not grant you any rights under this license. The
Connectivity Standards Alliance is not responsible for, and shall not be held
responsible in any manner for, identifying or failing to identify any or all
such third party intellectual property rights. Please visit www.csa-iot.org for
more information on how to become a member of the Connectivity Standards
Alliance.

This document and the information contained herein are provided on an “AS IS”
basis and the Connectivity Standards Alliance DISCLAIMS ALL WARRANTIES EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO (A) ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OF THIRD PARTIES (INCLUDING
WITHOUT LIMITATION ANY INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENT, COPYRIGHT
OR TRADEMARK RIGHTS); OR (B) ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE OR NONINFRINGEMENT. IN NO EVENT WILL THE
CONNECTIVITY STANDARDS ALLIANCE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF
BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF BUSINESS, OR FOR ANY OTHER
DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL
DAMAGES OF ANY KIND, IN CONTRACT OR IN TORT, IN CONNECTION WITH THIS DOCUMENT
OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
LOSS OR DAMAGE.

All company, brand and product names in this document may be trademarks that
are the sole property of their respective owners.

This notice and disclaimer must be included on all copies of this document.

Connectivity Standards Alliance
508 Second Street, Suite 206
Davis, CA 95616, USA

:xrefstyle: basic
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0104" name="Closure Control Cluster" revision="1">
  <revisionHistory>
    <revision revision="1" summary="Initial revision"/>
  </revisionHistory>
  <clusterIds>
    <clusterId id="0x0104" name="Closure Control">
      <provisionalConform/>
    </clusterId>
  </clusterIds>
  <classification hierarchy="base" role="application" picsCode="CLCTRL" scope="Endpoint"/>
  <features>
    <feature bit="0" code="PS" name="Positioning" summary="Supports Positioning with at least Fully Opened (0%) and Fully Closed (100%) discrete positions">
      <optionalConform choice="a" more="true" min="1"/>
    </feature>
    <feature bit="1" code="LT" name="MotionLatching" summary="Supports a latch (securing a position, or a state)">
      <optionalConform choice="a" more="true" min="1"/>
    </feature>
    <feature bit="2" code="IS" name="Instantaneous" summary="Supports the Instantaneous feature">
      <optionalConform/>
    </feature>
    <feature bit="3" code="SP" name="Speed" summary="Supports Speed motion throttling">
      <optionalConform>
        <andTerm>
          <feature name="PS"/>
          <notTerm>
            <feature name="IS"/>
          </notTerm>
        </andTerm>
      </optionalConform>
    </feature>
    <feature bit="4" code="VT" name="Ventilation" summary="Supports Ventilation discrete state">
      <optionalConform>
        <feature name="PS"/>
      </optionalConform>
    </feature>
    <feature bit="5" code="PD" name="Pedestrian" summary="Supports Pedestrian discrete state">
      <optionalConform>
        <feature name="PS"/>
      </optionalConform>
    </feature>
    <feature bit="6" code="CL" name="Calibration" summary="Supports the Calibration feature">
      <optionalConform>
        <feature name="PS"/>
      </optionalConform>
    </feature>
    <feature bit="7" code="PT" name="Protection" summary="Supports the Protection feature">
      <optionalConform/>
    </feature>
    <feature bit="8" code="MO" name="ManuallyOperable" summary="Supports the manual operation feature">
      <optionalConform/>
    </feature>
    <feature bit="9" code="ACC" name="Access" summary="The closure can grant access to a secured building or restricted area">
      <otherwiseConform>
        <provisionalConform/>
        <optionalConform/>
      </otherwiseConform>
    </feature>
  </features>
  <dataTypes>
    <enum name="ClosureErrorEnum">
      <item value="0" name="PhysicallyBlocked" summary="An obstacle is blocking the closure movement">
        <mandatoryConform/>
      </item>
      <item value="1" name="BlockedBySensor" summary="The closure is unsafe to move, as determined by a sensor (e.g. photoelectric sensor) before attempting movement">
        <mandatoryConform/>
      </item>
      <item value="2" name="TemperatureLimited" summary="A warning raised by the closure that indicates an over-temperature, e.g. due to excessive drive or stall current">
        <mandatoryConform/>
      </item>
      <item value="3" name="MaintenanceRequired" summary="Some malfunctions that are not easily recoverable are detected, or urgent servicing is needed">
        <mandatoryConform/>
      </item>
      <item value="4" name="InternalInterference" summary="An internal element is prohibiting motion, e.g. an integrated door within a bigger garage door is open and prevents motion">
        <mandatoryConform/>
      </item>
    </enum>
    <enum name="CurrentPositionEnum">
      <item value="0" name="FullyClosed" summary="Fully closed state">
        <mandatoryConform/>
      </item>
      <item value="1" name="FullyOpened" summary="Fully opened state">
        <mandatoryConform/>
      </item>
      <item value="2" name="PartiallyOpened" summary="Partially opened state (closure is not fully opened or fully closed)">
        <mandatoryConform/>
      </item>
      <item value="3" name="OpenedForPedestrian" summary="Closure is in the Pedestrian position">
        <mandatoryConform>
          <feature name="PD"/>
        </mandatoryConform>
      </item>
      <item value="4" name="OpenedForVentilation" summary="Closure is in the Ventilation position">
        <mandatoryConform>
          <feature name="VT"/>
        </mandatoryConform>
      </item>
      <item value="5" name="OpenedAtSignature" summary="Closure is in its &quot;Signature position&quot;">
        <mandatoryConform/>
      </item>
    </enum>
    <enum name="MainStateEnum">
      <item value="0" name="Stopped" summary="Closure is stopped">
        <mandatoryConform/>
      </item>
      <item value="1" name="Moving" summary="Closure is actively moving">
        <mandatoryConform/>
      </item>
      <item value="2" name="WaitingForMotion" summary="Closure is waiting before a motion (e.g. pre-heat, pre-check)">
        <mandatoryConform/>
      </item>
      <item value="3" name="Error" summary="Closure is in an error state">
        <mandatoryConform/>
      </item>
      <item value="4" name="Calibrating" summary="Closure is currently calibrating its Opened and Closed limits to determine effective physical range">
        <mandatoryConform>
          <feature name="CL"/>
        </mandatoryConform>
      </item>
      <item value="5" name="Protected" summary="Some protective measures are activated to prevent damage to the closure. Commands MAY be rejected.">
        <mandatoryConform>
          <feature name="PT"/>
        </mandatoryConform>
      </item>
      <item value="6" name="Disengaged" summary="Closure has a disengaged element preventing any actuator movements">
        <mandatoryConform>
          <feature name="MO"/>
        </mandatoryConform>
      </item>
      <item value="7" name="SetupRequired" summary="Movement commands are ignored since the closure is not operational and requires further setup and/or calibration">
        <mandatoryConform/>
      </item>
    </enum>
    <enum name="TargetPositionEnum">
      <item value="0" name="MoveToFullyClosed" summary="Move to a fully closed state">
        <mandatoryConform/>
      </item>
      <item value="1" name="MoveToFullyOpen" summary="Move to a fully open state">
        <mandatoryConform/>
      </item>
      <item value="2" name="MoveToPedestrianPosition" summary="Move to the Pedestrian position">
        <mandatoryConform>
          <feature name="PD"/>
        </mandatoryConform>
      </item>
      <item value="3" name="MoveToVentilationPosition" summary="Move to the Ventilation position">
        <mandatoryConform>
          <feature name="VT"/>
        </mandatoryConform>
      </item>
      <item value="4" name="MoveToSignaturePosition" summary="Move to the Signature position">
        <mandatoryConform/>
      </item>
    </enum>
    <bitmap name="LatchControlModesBitmap">
      <bitfield name="RemoteLatching" bit="0" summary="Remote latching capability">
        <mandatoryConform>
          <feature name="LT"/>
        </mandatoryConform>
      </bitfield>
      <bitfield name="RemoteUnlatching" bit="1" summary="Remote unlatching capability">
        <mandatoryConform>
          <feature name="LT"/>
        </mandatoryConform>
      </bitfield>
    </bitmap>
    <struct name="OverallCurrentStateStruct">
      <field id="0" name="Position" type="CurrentPositionEnum" default="null">
        <quality nullable="true"/>
        <mandatoryConform>
          <feature name="PS"/>
        </mandatoryConform>
        <constraint>
          <desc/>
        </constraint>
      </field>
      <field id="1" name="Latch" type="bool" default="null">
        <quality nullable="true"/>
        <mandatoryConform>
          <feature name="LT"/>
        </mandatoryConform>
        <constraint>
          <desc/>
        </constraint>
      </field>
      <field id="2" name="Speed" type="ThreeLevelAutoEnum" default="MS">
        <mandatoryConform>
          <feature name="SP"/>
        </mandatoryConform>
        <constraint>
          <desc/>
        </constraint>
      </field>
      <field id="3" name="SecureState" type="bool" default="null">
        <quality nullable="true"/>
        <mandatoryConform/>
        <constraint>
          <desc/>
        </constraint>
      </field>
    </struct>
    <struct name="OverallTargetStateStruct">
      <field id="0" name="Position" type="TargetPositionEnum" default="null">
        <quality nullable="true"/>
        <mandatoryConform>
          <feature name="PS"/>
        </mandatoryConform>
      </field>
      <field id="1" name="Latch" type="bool" default="null">
        <quality nullable="true"/>
        <mandatoryConform>
          <feature name="LT"/>
        </mandatoryConform>
      </field>
      <field id="2" name="Speed" type="ThreeLevelAutoEnum" default="MS">
        <mandatoryConform>
          <feature name="SP"/>
        </mandatoryConform>
      </field>
    </struct>
  </dataTypes>
  <attributes>
    <attribute id="0x0000" name="CountdownTime" type="elapsed-s" default="null">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true" quieterReporting="true"/>
      <optionalConform>
        <andTerm>
          <feature name="PS"/>
          <notTerm>
            <feature name="IS"/>
          </notTerm>
        </andTerm>
      </optionalConform>
      <constraint>
        <max value="259200"/>
      </constraint>
    </attribute>
    <attribute id="0x0001" name="MainState" type="MainStateEnum">
      <access read="true" readPrivilege="view"/>
      <mandatoryConform/>
    </attribute>
    <attribute id="0x0002" name="CurrentErrorList" type="list">
      <entry type="ClosureErrorEnum"/>
      <access read="true" readPrivilege="view"/>
      <mandatoryConform/>
      <constraint>
        <maxCount value="10"/>
      </constraint>
    </attribute>
    <attribute id="0x0003" name="OverallCurrentState" type="OverallCurrentStateStruct" default="null">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true"/>
      <mandatoryConform/>
    </attribute>
    <attribute id="0x0004" name="OverallTargetState" type="OverallTargetStateStruct" default="null">
      <access read="true" readPrivilege="view"/>
      <quality nullable="true"/>
      <mandatoryConform/>
    </attribute>
    <attribute id="0x0005" name="LatchControlModes" type="LatchControlModesBitmap">
      <access read="true" readPrivilege="view"/>
      <quality persistence="fixed"/>
      <mandatoryConform>
        <feature name="LT"/>
      </mandatoryConform>
    </attribute>
  </attributes>
  <commands>
    <command id="0x00" name="Stop" direction="commandToServer" response="Y">
      <access invokePrivilege="operate"/>
      <mandatoryConform>
        <notTerm>
          <feature name="IS"/>
        </notTerm>
      </mandatoryConform>
    </command>
    <command id="0x01" name="MoveTo" direction="commandToServer" response="Y">
      <access invokePrivilege="operate" timed="true"/>
      <mandatoryConform/>
      <field id="0" name="Position" type="TargetPositionEnum" default="desc">
        <optionalConform choice="a" more="true" min="1"/>
      </field>
      <field id="1" name="Latch" type="bool" default="desc">
        <optionalConform choice="a" more="true" min="1"/>
      </field>
      <field id="2" name="Speed" type="ThreeLevelAutoEnum">
        <default>
          <enum default="Auto"/>
        </default>
        <optionalConform choice="a" more="true" min="1"/>
      </field>
    </command>
    <command id="0x02" name="Calibrate" direction="commandToServer" response="Y">
      <access invokePrivilege="manage" timed="true"/>
      <mandatoryConform>
        <feature name="CL"/>
      </mandatoryConform>
    </command>
    <command id="0x03" name="GroupedMoveTo" direction="commandToServer" response="Y">
      <access invokePrivilege="operate"/>
      <otherwiseConform>
        <provisionalConform/>
        <mandatoryConform>
          <notTerm>
            <feature name="ACC"/>
          </notTerm>
        </mandatoryConform>
      </otherwiseConform>
      <field id="0" name="Position" type="TargetPositionEnum" default="desc">
        <optionalConform choice="a" more="true" min="1"/>
      </field>
      <field id="1" name="Latch" type="bool" default="desc">
        <optionalConform choice="a" more="true" min="1"/>
      </field>
      <field id="2" name="Speed" type="ThreeLevelAutoEnum">
        <default>
          <enum default="Auto"/>
        </default>
        <optionalConform choice="a" more="true" min="1"/>
      </field>
    </command>
  </commands>
  <events>
    <event id="0x00" name="OperationalError" priority="critical">
      <access readPrivilege="view"/>
      <mandatoryConform/>
      <field id="0" name="ErrorState" type="list">
        <entry type="ClosureErrorEnum"/>
        <mandatoryConform/>
        <constraint>
          <countBetween>
            <from value="1"/>
            <to value="10"/>
          </countBetween>
        </constraint>
      </field>
    </event>
    <event id="0x01" name="MovementCompleted" priority="info">
      <access readPrivilege="view"/>
      <mandatoryConform>
        <notTerm>
          <feature name="IS"/>
        </notTerm>
      </mandatoryConform>
    </event>
    <event id="0x02" name="EngageStateChanged" priority="info">
      <access readPrivilege="view"/>
      <mandatoryConform>
        <feature name="MO"/>
      </mandatoryConform>
      <field id="0" name="EngageValue" type="bool">
        <mandatoryConform/>
      </field>
    </event>
    <event id="0x03" name="SecureStateChanged" priority="info">
      <access readPrivilege="view"/>
      <mandatoryConform/>
      <field id="0" name="SecureValue" type="bool">
        <mandatoryConform/>
      </field>
    </event>
  </events>
</cluster>