Skip to content

Commit 1438626

Browse files
bzbarsky-applepull[bot]
authored andcommitted
Align naming in General Commissioning cluster XML with the spec. (#24241)
* Align naming in General Commissioning cluster XML with the spec. * Regenerate generated files.
1 parent 3f13215 commit 1438626

File tree

9 files changed

+100
-86
lines changed

9 files changed

+100
-86
lines changed

src/app/tests/suites/TestArmFailSafe.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ tests:
4545
command: "ArmFailSafe"
4646
arguments:
4747
values:
48-
- name: "expiryLengthSeconds"
48+
- name: "ExpiryLengthSeconds"
4949
value: 0
50-
- name: "breadcrumb"
50+
- name: "Breadcrumb"
5151
value: 0
5252
response:
5353
values:
54-
- name: "errorCode"
54+
- name: "ErrorCode"
5555
value: 0
5656

5757
- label: "Reads NodeLabel mandatory attribute of target device"

src/app/tests/suites/TestGeneralCommissioning.yaml

+18-18
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ tests:
9292
command: "CommissioningComplete"
9393
response:
9494
values:
95-
- name: errorCode
95+
- name: ErrorCode
9696
value: 3 # NoFailSafe
9797

9898
- label: "Check Breadcrumb was not touched by invalid CommissioningComplete"
@@ -115,13 +115,13 @@ tests:
115115
command: "ArmFailSafe"
116116
arguments:
117117
values:
118-
- name: expiryLengthSeconds
118+
- name: ExpiryLengthSeconds
119119
value: 10
120-
- name: breadcrumb
120+
- name: Breadcrumb
121121
value: 5000
122122
response:
123123
values:
124-
- name: errorCode
124+
- name: ErrorCode
125125
value: 4 # BusyWithOtherAdmin
126126

127127
- label:
@@ -162,13 +162,13 @@ tests:
162162
command: "ArmFailSafe"
163163
arguments:
164164
values:
165-
- name: expiryLengthSeconds
165+
- name: ExpiryLengthSeconds
166166
value: 500
167-
- name: breadcrumb
167+
- name: Breadcrumb
168168
value: 2
169169
response:
170170
values:
171-
- name: errorCode
171+
- name: ErrorCode
172172
value: 0 # OK
173173

174174
- label: "Check Breadcrumb was properly set by ArmFailSafe"
@@ -182,13 +182,13 @@ tests:
182182
identity: "beta"
183183
arguments:
184184
values:
185-
- name: expiryLengthSeconds
185+
- name: ExpiryLengthSeconds
186186
value: 10
187-
- name: breadcrumb
187+
- name: Breadcrumb
188188
value: 5000
189189
response:
190190
values:
191-
- name: errorCode
191+
- name: ErrorCode
192192
value: 4 # BusyWithOtherAdmin
193193

194194
- label:
@@ -204,7 +204,7 @@ tests:
204204
identity: "beta"
205205
response:
206206
values:
207-
- name: errorCode
207+
- name: ErrorCode
208208
value: 2 # InvalidAuthentication
209209

210210
- label:
@@ -219,7 +219,7 @@ tests:
219219
command: "CommissioningComplete"
220220
response:
221221
values:
222-
- name: errorCode
222+
- name: ErrorCode
223223
value: 0 # Ok
224224

225225
- label: "Check Breadcrumb was reset to 0 by CommissioningComplete"
@@ -232,13 +232,13 @@ tests:
232232
command: "ArmFailSafe"
233233
arguments:
234234
values:
235-
- name: expiryLengthSeconds
235+
- name: ExpiryLengthSeconds
236236
value: 500
237-
- name: breadcrumb
237+
- name: Breadcrumb
238238
value: 3
239239
response:
240240
values:
241-
- name: errorCode
241+
- name: ErrorCode
242242
value: 0 # OK
243243

244244
- label: "Check Breadcrumb was set by arming fail-safe again"
@@ -251,13 +251,13 @@ tests:
251251
command: "ArmFailSafe"
252252
arguments:
253253
values:
254-
- name: expiryLengthSeconds
254+
- name: ExpiryLengthSeconds
255255
value: 0
256-
- name: breadcrumb
256+
- name: Breadcrumb
257257
value: 4
258258
response:
259259
values:
260-
- name: errorCode
260+
- name: ErrorCode
261261
value: 0 # OK
262262

263263
- label: "Check Breadcrumb was reset by expiring the fail-safe"

src/app/zap-templates/zcl/data-model/chip/general-commissioning-cluster.xml

+11-11
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
<domain name="CHIP"/>
1919
<enum name="CommissioningError" type="ENUM8">
2020
<cluster code="0x0030"/>
21-
<item name="Ok" value="0x0"/>
21+
<item name="OK" value="0x0"/>
2222
<item name="ValueOutsideRange" value="0x1"/>
2323
<item name="InvalidAuthentication" value="0x2"/>
2424
<item name="NoFailSafe" value="0x3"/>
@@ -53,35 +53,35 @@ limitations under the License.
5353

5454
<command source="client" code="0x00" name="ArmFailSafe" response="ArmFailSafeResponse" optional="false" cli="chip fabric_commissioning armfailsafe">
5555
<description>Arm the persistent fail-safe timer with an expiry time of now + ExpiryLengthSeconds using device clock</description>
56-
<arg name="expiryLengthSeconds" type="INT16U"/>
57-
<arg name="breadcrumb" type="INT64U"/>
56+
<arg name="ExpiryLengthSeconds" type="INT16U"/>
57+
<arg name="Breadcrumb" type="INT64U"/>
5858
<access op="invoke" privilege="administer"/>
5959
</command>
6060
<command source="server" code="0x01" name="ArmFailSafeResponse" optional="false" cli="chip fabric_commissioning armfailsaferesponse">
6161
<description>Success/failure response for ArmFailSafe command</description>
62-
<arg name="errorCode" type="CommissioningError"/>
63-
<arg name="debugText" type="CHAR_STRING"/>
62+
<arg name="ErrorCode" type="CommissioningError"/>
63+
<arg name="DebugText" type="CHAR_STRING"/>
6464
</command>
6565
<command source="client" code="0x02" name="SetRegulatoryConfig" response="SetRegulatoryConfigResponse" cli="chip fabric_commissioning setregulatoryconfig">
6666
<description>Set the regulatory configuration to be used during commissioning</description>
6767
<arg name="NewRegulatoryConfig" type="RegulatoryLocationType"/>
68-
<arg name="countryCode" type="CHAR_STRING"/>
69-
<arg name="breadcrumb" type="INT64U"/>
68+
<arg name="CountryCode" type="CHAR_STRING"/>
69+
<arg name="Breadcrumb" type="INT64U"/>
7070
<access op="invoke" privilege="administer"/>
7171
</command>
7272
<command source="server" code="0x03" name="SetRegulatoryConfigResponse" cli="chip fabric_commissioning setregulatoryconfigresponse">
7373
<description>Success/failure response for SetRegulatoryConfig command</description>
74-
<arg name="errorCode" type="CommissioningError"/>
75-
<arg name="debugText" type="CHAR_STRING"/>
74+
<arg name="ErrorCode" type="CommissioningError"/>
75+
<arg name="DebugText" type="CHAR_STRING"/>
7676
</command>
7777
<command source="client" code="0x04" name="CommissioningComplete" response="CommissioningCompleteResponse" isFabricScoped="true" optional="false" cli="chip fabric_commissioning commissioningcomplete">
7878
<description>Signals the Server that the Client has successfully completed all steps of Commissioning/Recofiguration needed during fail-safe period.</description>
7979
<access op="invoke" privilege="administer"/>
8080
</command>
8181
<command source="server" code="0x05" name="CommissioningCompleteResponse" optional="false" cli="chip fabric_commissioning commissioningcompleteresponse">
8282
<description>Indicates to client whether CommissioningComplete command succeeded</description>
83-
<arg name="errorCode" type="CommissioningError"/>
84-
<arg name="debugText" type="CHAR_STRING"/>
83+
<arg name="ErrorCode" type="CommissioningError"/>
84+
<arg name="DebugText" type="CHAR_STRING"/>
8585
</command>
8686
</cluster>
8787
</configurator>

src/controller/java/zap-generated/CHIPInvokeCallbacks.cpp

+25-25
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/controller/java/zap-generated/chip/devicecontroller/ClusterInfoMapping.java

+15-15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/darwin/Framework/CHIP/templates/availability.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -5119,6 +5119,9 @@
51195119
- ValueA
51205120
- ValueB
51215121
- ValueC
5122+
GeneralCommissioning:
5123+
CommissioningError:
5124+
- OK
51225125
bitmaps:
51235126
UnitTesting:
51245127
- Bitmap8MaskMap
@@ -5204,6 +5207,10 @@
52045207
Switch:
52055208
MultiPressComplete:
52065209
- newPosition
5210+
enum values:
5211+
GeneralCommissioning:
5212+
CommissioningError:
5213+
- Ok
52075214
apis:
52085215
- Timed Invoke for server to client commands
52095216
- Deprecated global attribute names
@@ -5267,3 +5274,7 @@
52675274
Descriptor:
52685275
DeviceTypeStruct:
52695276
deviceType: type
5277+
enum values:
5278+
GeneralCommissioning:
5279+
CommissioningError:
5280+
OK: Ok

src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.h

+4-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/app-common/app-common/zap-generated/callback.h

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)