Skip to content

Commit 9989fc1

Browse files
vivien-applevivien-apple
authored
[Darwin] Update templates to preserve acronyms (e.g ACL) in APIs (#22665)
* Update ZAP repo * [darwin] Add cluster and commands description from XML into MTRBaseClusters.zapt * [Darwin] Update template to preserve acronyms (e.g ACL) in APIs * Update constants name in TemperatureSensorViewController.m * Ota -> OTA in src/darwin/Framework/CHIPTests/MTRTestOTAProvider.m * Exclude src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.h from restyle as we seems to have colliding versions * Update generated code
1 parent e3160eb commit 9989fc1

File tree

84 files changed

+18709
-19115
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+18709
-19115
lines changed

‎.restyled.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ exclude:
7373
- "examples/chef/sample_app_util/test_files/*.yaml"
7474
- "examples/chef/zzz_generated/**/*"
7575
- "src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.mm" # https://github.com/project-chip/connectedhomeip/issues/20236
76+
- "src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.h" # https://github.com/project-chip/connectedhomeip/issues/20236
7677

7778

7879
changed_paths:

‎examples/all-clusters-app/all-clusters-common/all-clusters-app.matter

+16-16
Original file line numberDiff line numberDiff line change
@@ -636,18 +636,18 @@ client cluster OtaSoftwareUpdateProvider = 41 {
636636
INT32U softwareVersion = 2;
637637
OTADownloadProtocol protocolsSupported[] = 3;
638638
optional INT16U hardwareVersion = 4;
639-
optional CHAR_STRING location = 5;
639+
optional CHAR_STRING<2> location = 5;
640640
optional BOOLEAN requestorCanConsent = 6;
641-
optional OCTET_STRING metadataForProvider = 7;
641+
optional OCTET_STRING<512> metadataForProvider = 7;
642642
}
643643

644644
request struct ApplyUpdateRequestRequest {
645-
OCTET_STRING updateToken = 0;
645+
OCTET_STRING<32> updateToken = 0;
646646
INT32U newVersion = 1;
647647
}
648648

649649
request struct NotifyUpdateAppliedRequest {
650-
OCTET_STRING updateToken = 0;
650+
OCTET_STRING<32> updateToken = 0;
651651
INT32U softwareVersion = 1;
652652
}
653653

@@ -724,7 +724,7 @@ server cluster OtaSoftwareUpdateRequestor = 42 {
724724
node_id providerNodeId = 0;
725725
vendor_id vendorId = 1;
726726
OTAAnnouncementReason announcementReason = 2;
727-
optional OCTET_STRING metadataForNode = 3;
727+
optional OCTET_STRING<512> metadataForNode = 3;
728728
endpoint_no endpoint = 4;
729729
}
730730

@@ -1002,33 +1002,33 @@ server cluster NetworkCommissioning = 49 {
10021002
readonly attribute int16u clusterRevision = 65533;
10031003

10041004
request struct ScanNetworksRequest {
1005-
optional nullable OCTET_STRING ssid = 0;
1005+
optional nullable OCTET_STRING<32> ssid = 0;
10061006
optional INT64U breadcrumb = 1;
10071007
}
10081008

10091009
request struct AddOrUpdateWiFiNetworkRequest {
1010-
OCTET_STRING ssid = 0;
1011-
OCTET_STRING credentials = 1;
1010+
OCTET_STRING<32> ssid = 0;
1011+
OCTET_STRING<64> credentials = 1;
10121012
optional INT64U breadcrumb = 2;
10131013
}
10141014

10151015
request struct AddOrUpdateThreadNetworkRequest {
1016-
OCTET_STRING operationalDataset = 0;
1016+
OCTET_STRING<254> operationalDataset = 0;
10171017
optional INT64U breadcrumb = 1;
10181018
}
10191019

10201020
request struct RemoveNetworkRequest {
1021-
OCTET_STRING networkID = 0;
1021+
OCTET_STRING<32> networkID = 0;
10221022
optional INT64U breadcrumb = 1;
10231023
}
10241024

10251025
request struct ConnectNetworkRequest {
1026-
OCTET_STRING networkID = 0;
1026+
OCTET_STRING<32> networkID = 0;
10271027
optional INT64U breadcrumb = 1;
10281028
}
10291029

10301030
request struct ReorderNetworkRequest {
1031-
OCTET_STRING networkID = 0;
1031+
OCTET_STRING<32> networkID = 0;
10321032
INT8U networkIndex = 1;
10331033
optional INT64U breadcrumb = 2;
10341034
}
@@ -1042,7 +1042,7 @@ server cluster NetworkCommissioning = 49 {
10421042

10431043
response struct NetworkConfigResponse = 5 {
10441044
NetworkCommissioningStatus networkingStatus = 0;
1045-
optional CHAR_STRING debugText = 1;
1045+
optional CHAR_STRING<512> debugText = 1;
10461046
optional INT8U networkIndex = 2;
10471047
}
10481048

@@ -1086,7 +1086,7 @@ server cluster DiagnosticLogs = 50 {
10861086
request struct RetrieveLogsRequestRequest {
10871087
LogsIntent intent = 0;
10881088
LogsTransferProtocol requestedProtocol = 1;
1089-
OCTET_STRING transferFileDesignator = 2;
1089+
OCTET_STRING<32> transferFileDesignator = 2;
10901090
}
10911091

10921092
command RetrieveLogsRequest(RetrieveLogsRequestRequest): RetrieveLogsResponse = 0;
@@ -1188,7 +1188,7 @@ server cluster GeneralDiagnostics = 51 {
11881188
readonly attribute int16u clusterRevision = 65533;
11891189

11901190
request struct TestEventTriggerRequest {
1191-
OCTET_STRING enableKey = 0;
1191+
OCTET_STRING<16> enableKey = 0;
11921192
INT64U eventTrigger = 1;
11931193
}
11941194

@@ -1613,7 +1613,7 @@ server cluster OperationalCredentials = 62 {
16131613
}
16141614

16151615
request struct UpdateFabricLabelRequest {
1616-
CHAR_STRING label = 0;
1616+
CHAR_STRING<32> label = 0;
16171617
}
16181618

16191619
request struct RemoveFabricRequest {

‎examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter

+18-18
Original file line numberDiff line numberDiff line change
@@ -571,18 +571,18 @@ client cluster OtaSoftwareUpdateProvider = 41 {
571571
INT32U softwareVersion = 2;
572572
OTADownloadProtocol protocolsSupported[] = 3;
573573
optional INT16U hardwareVersion = 4;
574-
optional CHAR_STRING location = 5;
574+
optional CHAR_STRING<2> location = 5;
575575
optional BOOLEAN requestorCanConsent = 6;
576-
optional OCTET_STRING metadataForProvider = 7;
576+
optional OCTET_STRING<512> metadataForProvider = 7;
577577
}
578578

579579
request struct ApplyUpdateRequestRequest {
580-
OCTET_STRING updateToken = 0;
580+
OCTET_STRING<32> updateToken = 0;
581581
INT32U newVersion = 1;
582582
}
583583

584584
request struct NotifyUpdateAppliedRequest {
585-
OCTET_STRING updateToken = 0;
585+
OCTET_STRING<32> updateToken = 0;
586586
INT32U softwareVersion = 1;
587587
}
588588

@@ -659,7 +659,7 @@ server cluster OtaSoftwareUpdateRequestor = 42 {
659659
node_id providerNodeId = 0;
660660
vendor_id vendorId = 1;
661661
OTAAnnouncementReason announcementReason = 2;
662-
optional OCTET_STRING metadataForNode = 3;
662+
optional OCTET_STRING<512> metadataForNode = 3;
663663
endpoint_no endpoint = 4;
664664
}
665665

@@ -931,33 +931,33 @@ server cluster NetworkCommissioning = 49 {
931931
readonly attribute int16u clusterRevision = 65533;
932932

933933
request struct ScanNetworksRequest {
934-
optional nullable OCTET_STRING ssid = 0;
934+
optional nullable OCTET_STRING<32> ssid = 0;
935935
optional INT64U breadcrumb = 1;
936936
}
937937

938938
request struct AddOrUpdateWiFiNetworkRequest {
939-
OCTET_STRING ssid = 0;
940-
OCTET_STRING credentials = 1;
939+
OCTET_STRING<32> ssid = 0;
940+
OCTET_STRING<64> credentials = 1;
941941
optional INT64U breadcrumb = 2;
942942
}
943943

944944
request struct AddOrUpdateThreadNetworkRequest {
945-
OCTET_STRING operationalDataset = 0;
945+
OCTET_STRING<254> operationalDataset = 0;
946946
optional INT64U breadcrumb = 1;
947947
}
948948

949949
request struct RemoveNetworkRequest {
950-
OCTET_STRING networkID = 0;
950+
OCTET_STRING<32> networkID = 0;
951951
optional INT64U breadcrumb = 1;
952952
}
953953

954954
request struct ConnectNetworkRequest {
955-
OCTET_STRING networkID = 0;
955+
OCTET_STRING<32> networkID = 0;
956956
optional INT64U breadcrumb = 1;
957957
}
958958

959959
request struct ReorderNetworkRequest {
960-
OCTET_STRING networkID = 0;
960+
OCTET_STRING<32> networkID = 0;
961961
INT8U networkIndex = 1;
962962
optional INT64U breadcrumb = 2;
963963
}
@@ -971,7 +971,7 @@ server cluster NetworkCommissioning = 49 {
971971

972972
response struct NetworkConfigResponse = 5 {
973973
NetworkCommissioningStatus networkingStatus = 0;
974-
optional CHAR_STRING debugText = 1;
974+
optional CHAR_STRING<512> debugText = 1;
975975
optional INT8U networkIndex = 2;
976976
}
977977

@@ -1015,7 +1015,7 @@ server cluster DiagnosticLogs = 50 {
10151015
request struct RetrieveLogsRequestRequest {
10161016
LogsIntent intent = 0;
10171017
LogsTransferProtocol requestedProtocol = 1;
1018-
OCTET_STRING transferFileDesignator = 2;
1018+
OCTET_STRING<32> transferFileDesignator = 2;
10191019
}
10201020

10211021
command RetrieveLogsRequest(RetrieveLogsRequestRequest): RetrieveLogsResponse = 0;
@@ -1111,7 +1111,7 @@ server cluster GeneralDiagnostics = 51 {
11111111
readonly attribute int16u clusterRevision = 65533;
11121112

11131113
request struct TestEventTriggerRequest {
1114-
OCTET_STRING enableKey = 0;
1114+
OCTET_STRING<16> enableKey = 0;
11151115
INT64U eventTrigger = 1;
11161116
}
11171117

@@ -1458,7 +1458,7 @@ server cluster OperationalCredentials = 62 {
14581458
}
14591459

14601460
request struct UpdateFabricLabelRequest {
1461-
CHAR_STRING label = 0;
1461+
CHAR_STRING<32> label = 0;
14621462
}
14631463

14641464
request struct RemoveFabricRequest {
@@ -2922,11 +2922,11 @@ server cluster AccountLogin = 1294 {
29222922
readonly attribute int16u clusterRevision = 65533;
29232923

29242924
request struct GetSetupPINRequest {
2925-
CHAR_STRING tempAccountIdentifier = 0;
2925+
CHAR_STRING<100> tempAccountIdentifier = 0;
29262926
}
29272927

29282928
request struct LoginRequest {
2929-
CHAR_STRING tempAccountIdentifier = 0;
2929+
CHAR_STRING<100> tempAccountIdentifier = 0;
29302930
CHAR_STRING setupPIN = 1;
29312931
}
29322932

‎examples/bridge-app/bridge-common/bridge-app.matter

+11-11
Original file line numberDiff line numberDiff line change
@@ -695,33 +695,33 @@ server cluster NetworkCommissioning = 49 {
695695
readonly attribute int16u clusterRevision = 65533;
696696

697697
request struct ScanNetworksRequest {
698-
optional nullable OCTET_STRING ssid = 0;
698+
optional nullable OCTET_STRING<32> ssid = 0;
699699
optional INT64U breadcrumb = 1;
700700
}
701701

702702
request struct AddOrUpdateWiFiNetworkRequest {
703-
OCTET_STRING ssid = 0;
704-
OCTET_STRING credentials = 1;
703+
OCTET_STRING<32> ssid = 0;
704+
OCTET_STRING<64> credentials = 1;
705705
optional INT64U breadcrumb = 2;
706706
}
707707

708708
request struct AddOrUpdateThreadNetworkRequest {
709-
OCTET_STRING operationalDataset = 0;
709+
OCTET_STRING<254> operationalDataset = 0;
710710
optional INT64U breadcrumb = 1;
711711
}
712712

713713
request struct RemoveNetworkRequest {
714-
OCTET_STRING networkID = 0;
714+
OCTET_STRING<32> networkID = 0;
715715
optional INT64U breadcrumb = 1;
716716
}
717717

718718
request struct ConnectNetworkRequest {
719-
OCTET_STRING networkID = 0;
719+
OCTET_STRING<32> networkID = 0;
720720
optional INT64U breadcrumb = 1;
721721
}
722722

723723
request struct ReorderNetworkRequest {
724-
OCTET_STRING networkID = 0;
724+
OCTET_STRING<32> networkID = 0;
725725
INT8U networkIndex = 1;
726726
optional INT64U breadcrumb = 2;
727727
}
@@ -735,7 +735,7 @@ server cluster NetworkCommissioning = 49 {
735735

736736
response struct NetworkConfigResponse = 5 {
737737
NetworkCommissioningStatus networkingStatus = 0;
738-
optional CHAR_STRING debugText = 1;
738+
optional CHAR_STRING<512> debugText = 1;
739739
optional INT8U networkIndex = 2;
740740
}
741741

@@ -779,7 +779,7 @@ server cluster DiagnosticLogs = 50 {
779779
request struct RetrieveLogsRequestRequest {
780780
LogsIntent intent = 0;
781781
LogsTransferProtocol requestedProtocol = 1;
782-
OCTET_STRING transferFileDesignator = 2;
782+
OCTET_STRING<32> transferFileDesignator = 2;
783783
}
784784

785785
command RetrieveLogsRequest(RetrieveLogsRequestRequest): RetrieveLogsResponse = 0;
@@ -881,7 +881,7 @@ server cluster GeneralDiagnostics = 51 {
881881
readonly attribute int16u clusterRevision = 65533;
882882

883883
request struct TestEventTriggerRequest {
884-
OCTET_STRING enableKey = 0;
884+
OCTET_STRING<16> enableKey = 0;
885885
INT64U eventTrigger = 1;
886886
}
887887

@@ -1306,7 +1306,7 @@ server cluster OperationalCredentials = 62 {
13061306
}
13071307

13081308
request struct UpdateFabricLabelRequest {
1309-
CHAR_STRING label = 0;
1309+
CHAR_STRING<32> label = 0;
13101310
}
13111311

13121312
request struct RemoveFabricRequest {

‎examples/chef/devices/noip_rootnode_dimmablelight_bCwGYSDpoe.matter

+12-12
Original file line numberDiff line numberDiff line change
@@ -526,30 +526,30 @@ client cluster OtaSoftwareUpdateProvider = 41 {
526526
INT32U softwareVersion = 2;
527527
OTADownloadProtocol protocolsSupported[] = 3;
528528
optional INT16U hardwareVersion = 4;
529-
optional CHAR_STRING location = 5;
529+
optional CHAR_STRING<2> location = 5;
530530
optional BOOLEAN requestorCanConsent = 6;
531-
optional OCTET_STRING metadataForProvider = 7;
531+
optional OCTET_STRING<512> metadataForProvider = 7;
532532
}
533533

534534
request struct ApplyUpdateRequestRequest {
535-
OCTET_STRING updateToken = 0;
535+
OCTET_STRING<32> updateToken = 0;
536536
INT32U newVersion = 1;
537537
}
538538

539539
request struct NotifyUpdateAppliedRequest {
540-
OCTET_STRING updateToken = 0;
540+
OCTET_STRING<32> updateToken = 0;
541541
INT32U softwareVersion = 1;
542542
}
543543

544544
response struct QueryImageResponse = 1 {
545545
OTAQueryStatus status = 0;
546546
optional INT32U delayedActionTime = 1;
547-
optional CHAR_STRING imageURI = 2;
547+
optional CHAR_STRING<256> imageURI = 2;
548548
optional INT32U softwareVersion = 3;
549-
optional CHAR_STRING softwareVersionString = 4;
550-
optional OCTET_STRING updateToken = 5;
549+
optional CHAR_STRING<64> softwareVersionString = 4;
550+
optional OCTET_STRING<32> updateToken = 5;
551551
optional BOOLEAN userConsentNeeded = 6;
552-
optional OCTET_STRING metadataForRequestor = 7;
552+
optional OCTET_STRING<512> metadataForRequestor = 7;
553553
}
554554

555555
response struct ApplyUpdateResponse = 3 {
@@ -625,7 +625,7 @@ server cluster OtaSoftwareUpdateRequestor = 42 {
625625
node_id providerNodeId = 0;
626626
vendor_id vendorId = 1;
627627
OTAAnnouncementReason announcementReason = 2;
628-
optional OCTET_STRING metadataForNode = 3;
628+
optional OCTET_STRING<512> metadataForNode = 3;
629629
endpoint_no endpoint = 4;
630630
}
631631

@@ -750,7 +750,7 @@ server cluster DiagnosticLogs = 50 {
750750
request struct RetrieveLogsRequestRequest {
751751
LogsIntent intent = 0;
752752
LogsTransferProtocol requestedProtocol = 1;
753-
OCTET_STRING transferFileDesignator = 2;
753+
OCTET_STRING<32> transferFileDesignator = 2;
754754
}
755755

756756
command RetrieveLogsRequest(RetrieveLogsRequestRequest): RetrieveLogsResponse = 0;
@@ -849,7 +849,7 @@ server cluster GeneralDiagnostics = 51 {
849849
readonly attribute int16u clusterRevision = 65533;
850850

851851
request struct TestEventTriggerRequest {
852-
OCTET_STRING enableKey = 0;
852+
OCTET_STRING<16> enableKey = 0;
853853
INT64U eventTrigger = 1;
854854
}
855855

@@ -1271,7 +1271,7 @@ server cluster OperationalCredentials = 62 {
12711271
}
12721272

12731273
request struct UpdateFabricLabelRequest {
1274-
CHAR_STRING label = 0;
1274+
CHAR_STRING<32> label = 0;
12751275
}
12761276

12771277
request struct RemoveFabricRequest {

0 commit comments

Comments
 (0)