| <?xml version="1.0"?> |
| <!--
|
| Copyright (C) Connectivity Standards Alliance (2021). 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
|
|
|
| :sectnums:
|
| --> |
| <cluster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="types types.xsd cluster cluster.xsd" id="0x0025" name="Actions Cluster" revision="1"> |
| <revisionHistory> |
| <revision revision="1" summary="Initial revision"/> |
| </revisionHistory> |
| <clusterIds> |
| <clusterId id="0x0025" name="Actions"/> |
| </clusterIds> |
| <classification hierarchy="base" role="application" picsCode="ACT" scope="Node"/> |
| <dataTypes> |
| <enum name="ActionErrorEnum"> |
| <item value="0" name="Unknown" summary="Other reason not listed in the row(s) below"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Interrupted" summary="The action was interrupted by another command or interaction"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <enum name="ActionStateEnum"> |
| <item value="0" name="Inactive" summary="The action is not active"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Active" summary="The action is active"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="Paused" summary="The action has been paused"> |
| <mandatoryConform/> |
| </item> |
| <item value="3" name="Disabled" summary="The action has been disabled"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <enum name="ActionTypeEnum"> |
| <item value="0" name="Other" summary="Use this only when none of the other values applies"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Scene" summary="Bring the endpoints into a certain state"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="Sequence" summary="A sequence of states with a certain time pattern"> |
| <mandatoryConform/> |
| </item> |
| <item value="3" name="Automation" summary="Control an automation (e.g. motion sensor controlling lights)"> |
| <mandatoryConform/> |
| </item> |
| <item value="4" name="Exception" summary="Sequence that will run when something doesn't happen"> |
| <mandatoryConform/> |
| </item> |
| <item value="5" name="Notification" summary="Use the endpoints to send a message to user"> |
| <mandatoryConform/> |
| </item> |
| <item value="6" name="Alarm" summary="Higher priority notification"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <enum name="EndpointListTypeEnum"> |
| <item value="0" name="Other" summary="Another group of endpoints"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Room" summary="User-configured group of endpoints where an endpoint can be in only one room"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="Zone" summary="User-configured group of endpoints where an endpoint can be in any number of zones"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <bitmap name="CommandBits"> |
| <bitfield name="InstantAction" bit="0" summary="Indicate support for InstantAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="InstantActionWithTransition" bit="1" summary="Indicate support for InstantActionWithTransition command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="StartAction" bit="2" summary="Indicate support for StartAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="StartActionWithDuration" bit="3" summary="Indicate support for StartActionWithDuration command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="StopAction" bit="4" summary="Indicate support for StopAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="PauseAction" bit="5" summary="Indicate support for PauseAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="PauseActionWithDuration" bit="6" summary="Indicate support for PauseActionWithDuration command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="ResumeAction" bit="7" summary="Indicate support for ResumeAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="EnableAction" bit="8" summary="Indicate support for EnableAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="EnableActionWithDuration" bit="9" summary="Indicate support for EnableActionWithDuration command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="DisableAction" bit="10" summary="Indicate support for DisableAction command"> |
| <mandatoryConform/> |
| </bitfield> |
| <bitfield name="DisableActionWithDuration" bit="11" summary="Indicate support for DisableActionWithDuration command"> |
| <mandatoryConform/> |
| </bitfield> |
| </bitmap> |
| <struct name="ActionStruct"> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="Name" type="string"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="Type" type="ActionTypeEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="EndpointListID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="4" name="SupportedCommands" type="CommandBits"> |
| <mandatoryConform/> |
| <constraint type="between" from="0" to="0x0FFF"/> |
| </field> |
| <field id="5" name="State" type="ActionStateEnum"> |
| <mandatoryConform/> |
| </field> |
| </struct> |
| <struct name="EndpointListStruct"> |
| <field id="0" name="EndpointListID" type="uint16"> |
| <access read="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="Name" type="string"> |
| <access read="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="Type" type="EndpointListTypeEnum"> |
| <access read="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="Endpoints" type="list"> |
| <entry type="endpoint-no"/> |
| <access read="true"/> |
| <mandatoryConform/> |
| <constraint type="maxCount" value="256"/> |
| </field> |
| </struct> |
| </dataTypes> |
| <attributes> |
| <attribute id="0x0000" name="ActionList" type="list" default="empty"> |
| <entry type="ActionStruct"/> |
| <access read="true" readPrivilege="view"/> |
| <mandatoryConform/> |
| <constraint type="maxCount" value="256"/> |
| </attribute> |
| <attribute id="0x0001" name="EndpointLists" type="list" default="empty"> |
| <entry type="EndpointListStruct"/> |
| <access read="true" readPrivilege="view"/> |
| <mandatoryConform/> |
| <constraint type="maxCount" value="256"/> |
| </attribute> |
| <attribute id="0x0002" name="SetupURL" type="string" default="empty"> |
| <access read="true" readPrivilege="view"/> |
| <optionalConform/> |
| <constraint type="maxLength" value="512"/> |
| </attribute> |
| </attributes> |
| <commands> |
| <command id="0x00" name="InstantAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x01" name="InstantActionWithTransition" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| <field id="2" name="TransitionTime" type="uint16" default="MS"> |
| <mandatoryConform/> |
| </field> |
| </command> |
| <command id="0x02" name="StartAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x03" name="StartActionWithDuration" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| <field id="2" name="Duration" type="uint32" default="MS"> |
| <mandatoryConform/> |
| </field> |
| </command> |
| <command id="0x04" name="StopAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x05" name="PauseAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x06" name="PauseActionWithDuration" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| <field id="2" name="Duration" type="uint32" default="MS"> |
| <mandatoryConform/> |
| </field> |
| </command> |
| <command id="0x07" name="ResumeAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x08" name="EnableAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x09" name="EnableActionWithDuration" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| <field id="2" name="Duration" type="uint32" default="MS"> |
| <mandatoryConform/> |
| </field> |
| </command> |
| <command id="0x0A" name="DisableAction" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| </command> |
| <command id="0x0B" name="DisableActionWithDuration" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate"/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <optionalConform/> |
| </field> |
| <field id="2" name="Duration" type="uint32" default="MS"> |
| <mandatoryConform/> |
| </field> |
| </command> |
| </commands> |
| <events> |
| <event id="0x00" name="StateChanged" priority="info"> |
| <access readPrivilege="view"/> |
| <mandatoryConform/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="NewState" type="ActionStateEnum"> |
| <mandatoryConform/> |
| </field> |
| </event> |
| <event id="0x01" name="ActionFailed" priority="info"> |
| <access readPrivilege="view"/> |
| <mandatoryConform/> |
| <field id="0" name="ActionID" type="uint16"> |
| <mandatoryConform/> |
| </field> |
| <field id="1" name="InvokeID" type="uint32"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="NewState" type="ActionStateEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="Error" type="ActionErrorEnum"> |
| <mandatoryConform/> |
| </field> |
| </event> |
| </events> |
| </cluster> |
