| <?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="0x0097" name="Messages Cluster" revision="3"> |
| <revisionHistory> |
| <revision revision="1" summary="Mandatory global ClusterRevision attribute added"/> |
| <revision revision="2" summary="Updated from SE1.4 version; CCB 1819"/> |
| <revision revision="3" summary="Initial Matter release; renamed from EnergyMessaging to Messages"/> |
| </revisionHistory> |
| <clusterIds> |
| <clusterId id="0x0097" name="Messages"/> |
| </clusterIds> |
| <classification hierarchy="base" role="application" picsCode="MESS" scope="Endpoint"/> |
| <features> |
| <feature bit="0" code="CONF" name="ReceivedConfirmation"> |
| <optionalConform/> |
| </feature> |
| <feature bit="1" code="RESP" name="ConfirmationResponse"> |
| <optionalConform> |
| <feature name="CONF"/> |
| </optionalConform> |
| </feature> |
| <feature bit="2" code="RPLY" name="ConfirmationReply"> |
| <optionalConform> |
| <feature name="CONF"/> |
| </optionalConform> |
| </feature> |
| <feature bit="3" code="PROT" name="ProtectedMessages"> |
| <optionalConform/> |
| </feature> |
| </features> |
| <dataTypes> |
| <enum name="FutureMessagePreferenceEnum"> |
| <item value="0" name="Allowed" summary="Similar messages are allowed"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Increased" summary="Similar messages should be sent more often"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="Reduced" summary="Similar messages should be sent less often"> |
| <mandatoryConform/> |
| </item> |
| <item value="3" name="Disallowed" summary="Similar messages should not be sent"> |
| <mandatoryConform/> |
| </item> |
| <item value="4" name="Banned" summary="No further messages should be sent"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <enum name="MessagePriorityEnum"> |
| <item value="0" name="Low" summary="Message to be transferred with a low level of importance"> |
| <mandatoryConform/> |
| </item> |
| <item value="1" name="Medium" summary="Message to be transferred with a medium level of importance"> |
| <mandatoryConform/> |
| </item> |
| <item value="2" name="High" summary="Message to be transferred with a high level of importance"> |
| <mandatoryConform/> |
| </item> |
| <item value="3" name="Critical" summary="Message to be transferred with a critical level of importance"> |
| <mandatoryConform/> |
| </item> |
| </enum> |
| <bitmap name="MessageControlBitmap"> |
| <bitfield name="ConfirmationRequired" bit="0" summary="Message requires confirmation from user"> |
| <mandatoryConform> |
| <feature name="CONF"/> |
| </mandatoryConform> |
| </bitfield> |
| <bitfield name="ResponseRequired" bit="1" summary="Message requires response from user"> |
| <mandatoryConform> |
| <feature name="RESP"/> |
| </mandatoryConform> |
| </bitfield> |
| <bitfield name="ReplyMessage" bit="2" summary="Message supports reply message from user"> |
| <mandatoryConform> |
| <feature name="RPLY"/> |
| </mandatoryConform> |
| </bitfield> |
| <bitfield name="MessageConfirmed" bit="3" summary="Message has already been confirmed"> |
| <mandatoryConform> |
| <feature name="CONF"/> |
| </mandatoryConform> |
| </bitfield> |
| <bitfield name="MessageProtected" bit="4" summary="Message required PIN/password protection"> |
| <mandatoryConform> |
| <feature name="PROT"/> |
| </mandatoryConform> |
| </bitfield> |
| </bitmap> |
| <struct name="MessageResponseOptionStruct"> |
| <field id="0" name="MessageResponseID" type="uint32"> |
| <mandatoryConform/> |
| <constraint> |
| <min value="1"/> |
| </constraint> |
| </field> |
| <field id="1" name="Label" type="string"> |
| <mandatoryConform/> |
| <constraint> |
| <maxLength value="32"/> |
| </constraint> |
| </field> |
| </struct> |
| <struct name="MessageStruct"> |
| <field id="0" name="MessageID" type="message-id"> |
| <access fabricSensitive="true"/> |
| <mandatoryConform/> |
| <constraint> |
| <allowed value="16"/> |
| </constraint> |
| </field> |
| <field id="1" name="Priority" type="MessagePriorityEnum"> |
| <access fabricSensitive="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="MessageControl" type="MessageControlBitmap"> |
| <access fabricSensitive="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="StartTime" type="epoch-s"> |
| <access fabricSensitive="true"/> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="4" name="Duration" type="uint64"> |
| <access fabricSensitive="true"/> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="5" name="MessageText" type="string"> |
| <access fabricSensitive="true"/> |
| <mandatoryConform/> |
| <constraint> |
| <maxLength value="256"/> |
| </constraint> |
| </field> |
| <field id="6" name="Responses" type="list"> |
| <entry type="MessageResponseOptionStruct"/> |
| <access fabricSensitive="true"/> |
| <mandatoryConform> |
| <feature name="RESP"/> |
| </mandatoryConform> |
| <constraint> |
| <maxCount value="4"/> |
| </constraint> |
| </field> |
| <access fabricScoped="true"/> |
| </struct> |
| </dataTypes> |
| <attributes> |
| <attribute id="0x0000" name="Messages" type="list"> |
| <entry type="MessageStruct"/> |
| <access read="true" readPrivilege="view" fabricScoped="true"/> |
| <mandatoryConform/> |
| <constraint> |
| <maxCount value="8"/> |
| </constraint> |
| </attribute> |
| <attribute id="0x0001" name="ActiveMessageIDs" type="list"> |
| <entry type="message-id"/> |
| <access read="true" readPrivilege="view"/> |
| <mandatoryConform/> |
| <constraint> |
| <maxCount value="8"/> |
| </constraint> |
| </attribute> |
| </attributes> |
| <commands> |
| <command id="0x00" name="PresentMessagesRequest" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="MessageID" type="message-id"> |
| <mandatoryConform/> |
| <constraint> |
| <allowed value="16"/> |
| </constraint> |
| </field> |
| <field id="1" name="Priority" type="MessagePriorityEnum"> |
| <mandatoryConform/> |
| </field> |
| <field id="2" name="MessageControl" type="MessageControlBitmap"> |
| <mandatoryConform/> |
| </field> |
| <field id="3" name="StartTime" type="epoch-s"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="4" name="Duration" type="uint64"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| <field id="5" name="MessageText" type="string"> |
| <mandatoryConform/> |
| <constraint> |
| <maxLength value="256"/> |
| </constraint> |
| </field> |
| <field id="6" name="Responses" type="list"> |
| <entry type="MessageResponseOptionStruct"/> |
| <mandatoryConform> |
| <feature name="RESP"/> |
| </mandatoryConform> |
| <constraint> |
| <maxCount value="4"/> |
| </constraint> |
| </field> |
| </command> |
| <command id="0x01" name="CancelMessagesRequest" direction="commandToServer" response="Y"> |
| <access invokePrivilege="operate" fabricScoped="true"/> |
| <mandatoryConform/> |
| <field id="0" name="MessageIDs" type="list"> |
| <entry type="message-id"/> |
| <mandatoryConform/> |
| <constraint> |
| <maxCount value="8"/> |
| </constraint> |
| </field> |
| </command> |
| </commands> |
| <events> |
| <event id="0x00" name="MessageQueued" priority="info"> |
| <access readPrivilege="view" fabricSensitive="true"/> |
| <mandatoryConform/> |
| <field id="0" name="MessageID" type="message-id"> |
| <mandatoryConform/> |
| <constraint> |
| <allowed value="16"/> |
| </constraint> |
| </field> |
| </event> |
| <event id="0x01" name="MessagePresented" priority="info"> |
| <access readPrivilege="view" fabricSensitive="true"/> |
| <mandatoryConform/> |
| <field id="0" name="MessageID" type="message-id"> |
| <mandatoryConform/> |
| <constraint> |
| <allowed value="16"/> |
| </constraint> |
| </field> |
| </event> |
| <event id="0x02" name="MessageComplete" priority="info"> |
| <access readPrivilege="view" fabricSensitive="true"/> |
| <mandatoryConform/> |
| <field id="0" name="MessageID" type="message-id"> |
| <mandatoryConform/> |
| <constraint> |
| <allowed value="16"/> |
| </constraint> |
| </field> |
| <field id="1" name="ResponseID" type="uint32"> |
| <quality nullable="true"/> |
| <mandatoryConform> |
| <feature name="RESP"/> |
| </mandatoryConform> |
| </field> |
| <field id="2" name="Reply" type="string"> |
| <quality nullable="true"/> |
| <mandatoryConform> |
| <feature name="RPLY"/> |
| </mandatoryConform> |
| <constraint> |
| <maxLength value="256"/> |
| </constraint> |
| </field> |
| <field id="3" name="FutureMessagesPreference" type="FutureMessagePreferenceEnum"> |
| <quality nullable="true"/> |
| <mandatoryConform/> |
| </field> |
| </event> |
| </events> |
| </cluster> |