forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGeneralCommissioningCluster.xml
315 lines (308 loc) · 13.6 KB
/
GeneralCommissioningCluster.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<?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="0x0030" name="General Commissioning Cluster" revision="2">
<revisionHistory>
<revision revision="1" summary="Initial revision"/>
<revision revision="2" summary="Add Enhanced Setup Flow"/>
</revisionHistory>
<clusterIds>
<clusterId id="0x0030" name="General Commissioning"/>
</clusterIds>
<classification hierarchy="base" role="utility" picsCode="CGEN" scope="Node"/>
<features>
<feature bit="0" code="TC" name="TermsAndConditions" summary="Supports Terms & Conditions acknowledgement">
<provisionalConform/>
</feature>
</features>
<dataTypes>
<enum name="CommissioningErrorEnum">
<item value="0" name="OK" summary="No error">
<mandatoryConform/>
</item>
<item value="1" name="ValueOutsideRange" summary="Attempting to set regulatory configuration to a region or indoor/outdoor mode for which the server does not have proper configuration.">
<mandatoryConform/>
</item>
<item value="2" name="InvalidAuthentication" summary="Executed CommissioningComplete outside CASE session.">
<mandatoryConform/>
</item>
<item value="3" name="NoFailSafe" summary="Executed CommissioningComplete when there was no active Fail-Safe context.">
<mandatoryConform/>
</item>
<item value="4" name="BusyWithOtherAdmin" summary="Attempting to arm fail-safe or execute CommissioningComplete from a fabric different than the one associated with the current fail-safe context.">
<mandatoryConform/>
</item>
<item value="5" name="RequiredTCNotAccepted" summary="One or more required TC features from the Enhanced Setup Flow were not accepted.">
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</item>
<item value="6" name="TCAcknowledgementsNotReceived" summary="TCAcknowledgementsNotReceived No acknowledgements from the user for the TC features were received.">
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</item>
<item value="7" name="TCMinVersionNotMet" summary="TCMinVersionNotMet The version of the TC features acknowledged by the user did not meet the minimum required version.">
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</item>
</enum>
<enum name="NetworkRecoveryReasonEnum">
<item value="0" name="Unspecified" summary="Unspecified / unknown reason of network failure">
<mandatoryConform/>
</item>
<item value="1" name="Route" summary="Device is unable to route to the required resources, e.g. a Thread device is unable to reach a border router or a Wi-Fi device is unable to reach the public Internet which it requires for operation.">
<mandatoryConform/>
</item>
<item value="2" name="ICD" summary="ICD-related network failure, e.g. persistent failure to have an ICD checkin to result in a subscription">
<mandatoryConform/>
</item>
<item value="3" name="Auth" summary="Credentials for the configured operational network are not valid">
<mandatoryConform/>
</item>
<item value="4" name="Visibility" summary="Configured network cannot be found (e.g. the device cannot see the configured Wi-Fi SSID, Thread end-node is unable to find a parent router on the PAN)">
<mandatoryConform/>
</item>
</enum>
<enum name="RegulatoryLocationTypeEnum">
<item value="0" name="Indoor" summary="Indoor only">
<mandatoryConform/>
</item>
<item value="1" name="Outdoor" summary="Outdoor only">
<mandatoryConform/>
</item>
<item value="2" name="IndoorOutdoor" summary="Indoor/Outdoor">
<mandatoryConform/>
</item>
</enum>
<struct name="BasicCommissioningInfo">
<field id="0" name="FailSafeExpiryLengthSeconds" type="uint16">
<mandatoryConform/>
</field>
<field id="1" name="MaxCumulativeFailsafeSeconds" type="uint16">
<mandatoryConform/>
<constraint>
<desc/>
</constraint>
</field>
</struct>
</dataTypes>
<attributes>
<attribute id="0x0000" name="Breadcrumb" type="uint64" default="0">
<access read="true" write="true" readPrivilege="view" writePrivilege="admin"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0001" name="BasicCommissioningInfo" type="BasicCommissioningInfo">
<access read="true" readPrivilege="view"/>
<quality persistence="fixed"/>
<mandatoryConform/>
<constraint>
<desc/>
</constraint>
</attribute>
<attribute id="0x0002" name="RegulatoryConfig" type="RegulatoryLocationTypeEnum">
<attribute name="LocationCapability"/>
<access read="true" readPrivilege="view"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0003" name="LocationCapability" type="RegulatoryLocationTypeEnum">
<enum default="IndoorOutdoor"/>
<access read="true" readPrivilege="view"/>
<quality persistence="fixed"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0004" name="SupportsConcurrentConnection" type="bool" default="true">
<access read="true" readPrivilege="view"/>
<quality persistence="fixed"/>
<mandatoryConform/>
</attribute>
<attribute id="0x0005" name="TCAcceptedVersion" type="uint16">
<access read="true" readPrivilege="admin"/>
<quality persistence="nonVolatile"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute id="0x0006" name="TCMinRequiredVersion" type="uint16">
<access read="true" readPrivilege="admin"/>
<quality persistence="nonVolatile"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute id="0x0007" name="TCAcknowledgements" type="map16">
<access read="true" readPrivilege="admin"/>
<quality persistence="nonVolatile"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute id="0x0008" name="TCAcknowledgementsRequired" type="bool" default="true">
<access read="true" readPrivilege="admin"/>
<quality persistence="nonVolatile"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute id="0x0009" name="TCUpdateDeadline" type="uint32">
<access read="true" readPrivilege="admin"/>
<quality nullable="true" persistence="nonVolatile"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
</attributes>
<commands>
<command id="0x00" name="ArmFailSafe" direction="commandToServer" response="ArmFailSafeResponse">
<access invokePrivilege="admin"/>
<mandatoryConform/>
<field id="0" name="ExpiryLengthSeconds" type="uint16" default="900">
<mandatoryConform/>
</field>
<field id="1" name="Breadcrumb" type="uint64">
<mandatoryConform/>
</field>
</command>
<command id="0x01" name="ArmFailSafeResponse" direction="responseFromServer">
<mandatoryConform/>
<field id="0" name="ErrorCode" type="CommissioningErrorEnum" default="SUCCESS">
<mandatoryConform/>
</field>
<field id="1" name="DebugText" type="string" default="""">
<mandatoryConform/>
<constraint>
<maxLength value="128"/>
</constraint>
</field>
</command>
<command id="0x02" name="SetRegulatoryConfig" direction="commandToServer" response="SetRegulatoryConfigResponse">
<access invokePrivilege="admin"/>
<mandatoryConform/>
<field id="0" name="NewRegulatoryConfig" type="RegulatoryLocationTypeEnum">
<mandatoryConform/>
</field>
<field id="1" name="CountryCode" type="string">
<mandatoryConform/>
<constraint>
<allowed value="2"/>
</constraint>
</field>
<field id="2" name="Breadcrumb" type="uint64">
<mandatoryConform/>
</field>
</command>
<command id="0x03" name="SetRegulatoryConfigResponse" direction="responseFromServer">
<mandatoryConform/>
<field id="0" name="ErrorCode" type="CommissioningErrorEnum" default="SUCCESS">
<mandatoryConform/>
</field>
<field id="1" name="DebugText" type="string" default="""">
<mandatoryConform/>
</field>
</command>
<command id="0x04" name="CommissioningComplete" direction="commandToServer" response="CommissioningCompleteResponse">
<access invokePrivilege="admin" fabricScoped="true"/>
<mandatoryConform/>
</command>
<command id="0x05" name="CommissioningCompleteResponse" direction="responseFromServer">
<mandatoryConform/>
<field id="0" name="ErrorCode" type="CommissioningErrorEnum" default="SUCCESS">
<mandatoryConform/>
</field>
<field id="1" name="DebugText" type="string" default="""">
<mandatoryConform/>
</field>
</command>
<command id="0x06" name="SetTCAcknowledgements" direction="commandToServer" response="SetTCAcknowledgementsResponse">
<access invokePrivilege="admin"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
<field id="0" name="TCVersion" type="uint16">
<mandatoryConform/>
</field>
<field id="1" name="TCUserResponse" type="map16">
<mandatoryConform/>
</field>
</command>
<command id="0x07" name="SetTCAcknowledgementsResponse" direction="responseFromServer">
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
<field id="0" name="ErrorCode" type="CommissioningErrorEnum" default="SUCCESS">
<mandatoryConform/>
</field>
</command>
</commands>
</cluster>