data_model/1.4/clusters/OperationalState.xml

<?xml version="1.0"?>
<!--
Copyright (C) Connectivity Standards Alliance (2023). 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
-->
<cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0060" name="Operational State Cluster" revision="3">
  <revisionHistory>
    <revision revision="1" summary="Initial revision"/>
    <revision revision="2" summary="The Pause and Resume commands are usable in all compatible states. Define reserved ranges for base/derived clusters."/>
    <revision revision="3" summary="Changed CountdownTime attribute to Q quality."/>
  </revisionHistory>
  <clusterIds>
    <clusterId id="0x0060" name="Operational State"/>
  </clusterIds>
  <classification hierarchy="base" role="application" picsCode="OPSTATE" scope="Endpoint"/>
  <dataTypes>
    <enum name="ErrorStateEnum">
      <item from="0x00" to="0x3F" name="GeneralErrors" summary="Generally applicable values for error, defined herein">
        <mandatoryConform/>
      </item>
      <item from="0x40" to="0x7F" name="DerivedClusterErrors" summary="Derived Cluster defined errors">
        <mandatoryConform/>
      </item>
      <item from="0x80" to="0xBF" name="ManufacturerError" summary="Vendor specific errors">
        <mandatoryConform/>
      </item>
    </enum>
    <enum name="OperationalStateEnum">
      <item from="0x00" to="0x3F" name="GeneralStates" summary="Generally applicable values for state, defined herein">
        <mandatoryConform/>
      </item>
      <item from="0x40" to="0x7F" name="DerivedClusterStates" summary="Derived Cluster defined states">
        <mandatoryConform/>
      </item>
      <item from="0x80" to="0xBF" name="ManufacturerStates" summary="Vendor specific states">
        <mandatoryConform/>
      </item>
    </enum>
    <struct name="ErrorStateStruct">
      <field id="0" name="ErrorStateID" type="ErrorStateEnum" default="0">
        <mandatoryConform/>
      </field>
      <field id="1" name="ErrorStateLabel" type="string" default="empty">
        <constraint type="maxLength" value="64"/>
      </field>
      <field id="2" name="ErrorStateDetails" type="string" default="empty">
        <optionalConform/>
        <constraint type="maxLength" value="64"/>
      </field>
    </struct>
    <struct name="OperationalStateStruct">
      <field id="0" name="OperationalStateID" type="OperationalStateEnum" default="0">
        <mandatoryConform/>
      </field>
      <field id="1" name="OperationalStateLabel" type="string">
        <constraint type="maxLength" value="64"/>
      </field>
    </struct>
  </dataTypes>
  <attributes>
    <attribute id="0x0000" name="PhaseList" type="list" default="MS">
      <entry type="string">
        <constraint type="maxLength" value="64"/>
      </entry>
      <access read="true" readPrivilege="view"/>
      <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false" sourceAttribution="false" quieterReporting="false"/>
      <mandatoryConform/>
      <constraint type="maxCount" value="32"/>
    </attribute>
    <attribute id="0x0001" name="CurrentPhase" type="uint8" default="MS">
      <access read="true" readPrivilege="view"/>
      <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false" sourceAttribution="false" quieterReporting="false"/>
      <mandatoryConform/>
      <constraint type="desc"/>
    </attribute>
    <attribute id="0x0002" name="CountdownTime" type="elapsed-s" default="null">
      <access read="true" readPrivilege="view"/>
      <quality changeOmitted="false" nullable="true" scene="false" persistence="volatile" reportable="false" sourceAttribution="false" quieterReporting="true"/>
      <optionalConform/>
      <constraint type="max" value="259200"/>
    </attribute>
    <attribute id="0x0003" name="OperationalStateList" type="list" default="MS">
      <entry type="OperationalStateStruct"/>
      <access read="true" readPrivilege="view"/>
      <mandatoryConform/>
      <constraint type="desc"/>
    </attribute>
    <attribute id="0x0004" name="OperationalState" type="OperationalStateEnum">
      <access read="true" readPrivilege="view"/>
      <mandatoryConform/>
    </attribute>
    <attribute id="0x0005" name="OperationalError" type="ErrorStateStruct">
      <access read="true" readPrivilege="view"/>
      <mandatoryConform/>
      <constraint type="desc"/>
    </attribute>
  </attributes>
  <commands>
    <command id="0x00" name="Pause" direction="commandToServer" response="OperationalCommandResponse">
      <access invokePrivilege="operate"/>
      <otherwiseConform>
        <mandatoryConform>
          <command name="Resume"/>
        </mandatoryConform>
        <optionalConform/>
      </otherwiseConform>
    </command>
    <command id="0x01" name="Stop" direction="commandToServer" response="OperationalCommandResponse">
      <access invokePrivilege="operate"/>
      <otherwiseConform>
        <mandatoryConform>
          <command name="Start"/>
        </mandatoryConform>
        <optionalConform/>
      </otherwiseConform>
    </command>
    <command id="0x02" name="Start" direction="commandToServer" response="OperationalCommandResponse">
      <access invokePrivilege="operate"/>
      <optionalConform/>
    </command>
    <command id="0x03" name="Resume" direction="commandToServer" response="OperationalCommandResponse">
      <access invokePrivilege="operate"/>
      <otherwiseConform>
        <mandatoryConform>
          <command name="Pause"/>
        </mandatoryConform>
        <optionalConform/>
      </otherwiseConform>
    </command>
    <command id="0x04" name="OperationalCommandResponse" direction="responseFromServer">
      <mandatoryConform>
        <orTerm>
          <command name="Pause"/>
          <command name="Stop"/>
          <command name="Start"/>
          <command name="Resume"/>
        </orTerm>
      </mandatoryConform>
      <field id="0" name="CommandResponseState" type="ErrorStateStruct">
        <mandatoryConform/>
      </field>
    </command>
  </commands>
  <events>
    <event id="0x00" name="OperationalError" priority="critical">
      <access readPrivilege="view"/>
      <mandatoryConform/>
      <field id="0" name="ErrorState" type="ErrorStateStruct">
        <mandatoryConform/>
      </field>
    </event>
    <event id="0x01" name="OperationCompletion" priority="info">
      <access readPrivilege="view"/>
      <otherwiseConform>
        <provisionalConform/>
        <optionalConform/>
      </otherwiseConform>
      <field id="0" name="CompletionErrorCode" type="enum8">
        <mandatoryConform/>
      </field>
      <field id="1" name="TotalOperationalTime" type="elapsed-s">
        <quality nullable="true"/>
        <optionalConform/>
      </field>
      <field id="2" name="PausedTime" type="elapsed-s">
        <quality nullable="true"/>
        <optionalConform/>
      </field>
    </event>
  </events>
</cluster>