forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgeneral-commissioning-cluster.xml
178 lines (175 loc) · 8.93 KB
/
general-commissioning-cluster.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
<?xml version="1.0"?>
<!--
Copyright (c) 2021-2024 Project CHIP Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<configurator>
<domain name="CHIP"/>
<enum name="CommissioningErrorEnum" type="enum8">
<cluster code="0x0030"/>
<item name="OK" value="0x0"/>
<item name="ValueOutsideRange" value="0x1"/>
<item name="InvalidAuthentication" value="0x2"/>
<item name="NoFailSafe" value="0x3"/>
<item name="BusyWithOtherAdmin" value="0x4"/>
<item name="RequiredTCNotAccepted" value="0x5" apiMaturity="provisional"/>
<item name="TCAcknowledgementsNotReceived" value="0x6" apiMaturity="provisional"/>
<item name="TCMinVersionNotMet" value="0x7" apiMaturity="provisional"/>
</enum>
<enum name="RegulatoryLocationTypeEnum" type="enum8">
<cluster code="0x0030"/>
<item name="Indoor" value="0x0"/>
<item name="Outdoor" value="0x1"/>
<item name="IndoorOutdoor" value="0x2"/>
</enum>
<struct name="BasicCommissioningInfo">
<cluster code="0x0030"/>
<item fieldId="0" name="FailSafeExpiryLengthSeconds" type="int16u"/>
<item fieldId="1" name="MaxCumulativeFailsafeSeconds" type="int16u"/>
</struct>
<cluster>
<domain>General</domain>
<name>General Commissioning</name>
<code>0x0030</code>
<define>GENERAL_COMMISSIONING_CLUSTER</define>
<description>This cluster is used to manage global aspects of the Commissioning flow.</description>
<features>
<feature bit="0" code="TC" name="TermsAndConditions" summary="Supports Terms and Conditions acknowledgement" apiMaturity="provisional">
<otherwiseConform>
<provisionalConform/>
<optionalConform/>
</otherwiseConform>
</feature>
</features>
<attribute side="server" code="0x00" name="Breadcrumb" define="BREADCRUMB" type="int64u" writable="true" default="0x0000000000000000" optional="false">
<access op="read" privilege="view"/>
<access op="write" privilege="administer"/>
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x01" name="BasicCommissioningInfo" define="BASIC_COMMISSIONING_INFO" type="BasicCommissioningInfo">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x02" name="RegulatoryConfig" define="REGULATORY_CONFIG" type="RegulatoryLocationTypeEnum">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x03" name="LocationCapability" define="LOCATION_CAPABILITY" type="RegulatoryLocationTypeEnum">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x04" name="SupportsConcurrentConnection" define="SUPPORTS_CONCURRENT_CONNECTION" type="boolean" default="1">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x05" name="TCAcceptedVersion" define="TC_ACCEPTED_VERSION" type="int16u" optional="true" apiMaturity="provisional">
<access op="read" privilege="administer"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute side="server" code="0x06" name="TCMinRequiredVersion" define="TC_MIN_REQUIRED_VERSION" type="int16u" writable="false" optional="true" apiMaturity="provisional">
<access op="read" privilege="administer"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute side="server" code="0x07" name="TCAcknowledgements" define="TC_ACKNOWLEDGEMENTS" type="bitmap16" writable="false" default="0x0000" optional="true" apiMaturity="provisional">
<access op="read" privilege="administer"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute side="server" code="0x08" name="TCAcknowledgementsRequired" define="TC_ACKNOWLEDGEMENTS_REQUIRED" type="boolean" writable="false" optional="true" apiMaturity="provisional">
<access op="read" privilege="administer"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<attribute side="server" code="0x09" name="TCUpdateDeadline" define="TC_UPDATE_DEADLINE" type="int32u" writable="false" optional="true" apiMaturity="provisional">
<access op="read" privilege="administer"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</attribute>
<command source="client" code="0x00" name="ArmFailSafe" response="ArmFailSafeResponse" optional="false" cli="chip fabric_commissioning armfailsafe">
<description>Arm the persistent fail-safe timer with an expiry time of now + ExpiryLengthSeconds using device clock</description>
<arg name="ExpiryLengthSeconds" type="int16u"/>
<arg name="Breadcrumb" type="int64u"/>
<access op="invoke" privilege="administer"/>
<mandatoryConform/>
</command>
<command source="server" code="0x01" name="ArmFailSafeResponse" optional="false" cli="chip fabric_commissioning armfailsaferesponse">
<description>Success/failure response for ArmFailSafe command</description>
<arg name="ErrorCode" type="CommissioningErrorEnum"/>
<arg name="DebugText" type="char_string" length="128"/>
<mandatoryConform/>
</command>
<command source="client" code="0x02" name="SetRegulatoryConfig" response="SetRegulatoryConfigResponse" cli="chip fabric_commissioning setregulatoryconfig">
<description>Set the regulatory configuration to be used during commissioning</description>
<arg name="NewRegulatoryConfig" type="RegulatoryLocationTypeEnum"/>
<arg name="CountryCode" type="char_string" length="2"/>
<arg name="Breadcrumb" type="int64u"/>
<access op="invoke" privilege="administer"/>
<mandatoryConform/>
</command>
<command source="server" code="0x03" name="SetRegulatoryConfigResponse" cli="chip fabric_commissioning setregulatoryconfigresponse">
<description>Success/failure response for SetRegulatoryConfig command</description>
<arg name="ErrorCode" type="CommissioningErrorEnum"/>
<arg name="DebugText" type="char_string"/>
<mandatoryConform/>
</command>
<command source="client" code="0x04" name="CommissioningComplete" response="CommissioningCompleteResponse" isFabricScoped="true" optional="false" cli="chip fabric_commissioning commissioningcomplete">
<description>Signals the Server that the Client has successfully completed all steps of Commissioning/Recofiguration needed during fail-safe period.</description>
<access op="invoke" privilege="administer"/>
<mandatoryConform/>
</command>
<command source="server" code="0x05" name="CommissioningCompleteResponse" optional="false" cli="chip fabric_commissioning commissioningcompleteresponse">
<description>Indicates to client whether CommissioningComplete command succeeded</description>
<arg name="ErrorCode" type="CommissioningErrorEnum"/>
<arg name="DebugText" type="char_string"/>
<mandatoryConform/>
</command>
<command source="client" code="0x06" name="SetTCAcknowledgements" optional="true" response="SetTCAcknowledgementsResponse" cli="chip fabric_commissioning settcacknowledgements" apiMaturity="provisional">
<description>This command sets the user acknowledgements received in the Enhanced Setup Flow Terms and Conditions into the node.</description>
<arg name="TCVersion" type="int16u"/>
<arg name="TCUserResponse" type="bitmap16"/>
<access op="invoke" privilege="administer"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</command>
<command source="server" code="0x07" name="SetTCAcknowledgementsResponse" optional="true" cli="chip fabric_commissioning settcacknowledgementsresponse" apiMaturity="provisional">
<description>This command is used to convey the result from SetTCAcknowledgements.</description>
<arg name="ErrorCode" type="CommissioningErrorEnum"/>
<otherwiseConform>
<provisionalConform/>
<mandatoryConform>
<feature name="TC"/>
</mandatoryConform>
</otherwiseConform>
</command>
</cluster>
</configurator>