Skip to content

Commit 04c20f6

Browse files
bzbarsky-applebzbarsky-apple
authored
Rename "Basic" cluster to "Basic Information". (#24124)
* Rename "Basic" cluster to "Basic Information". This matches the spec name. * Use newer ZAP version.
1 parent 93da711 commit 04c20f6

File tree

598 files changed

+4083
-4008
lines changed

Some content is hidden

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

598 files changed

+4083
-4008
lines changed

‎.github/.wordlist.txt

+1
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ backtrace
125125
BallastConfiguration
126126
BarrierControl
127127
BasicCHIPRegression
128+
BasicInformation
128129
baudrate
129130
BD
130131
BDX

‎.github/workflows/zap_regeneration.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828

2929
runs-on: ubuntu-20.04
3030
container:
31-
image: connectedhomeip/chip-build:0.6.22
31+
image: connectedhomeip/chip-build:0.6.23
3232
defaults:
3333
run:
3434
shell: sh

‎.github/workflows/zap_templates.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929

3030
runs-on: ubuntu-20.04
3131
container:
32-
image: connectedhomeip/chip-build:0.6.22
32+
image: connectedhomeip/chip-build:0.6.23
3333
defaults:
3434
run:
3535
shell: sh

‎docs/guides/access-control-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ Some typical clusters:
395395
- Clusters.Descriptor.id
396396
- Clusters.Binding.id
397397
- Clusters.AccessControl.id
398-
- Clusters.Basic.id
398+
- Clusters.BasicInformation.id
399399

400400
### Examples
401401

‎docs/guides/python_chip_controller_building.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -287,24 +287,25 @@ chip-device-ctrl > zcl LevelControl MoveToLevel 1234 1 0 level=50
287287
288288
### Step 7: Read basic information out of the accessory.
289289
290-
Every Matter accessory device supports a Basic Cluster, which maintains
291-
collection of attributes that a controller can obtain from a device, such as the
292-
vendor name, the product name, or software version. Use `zclread` command to
293-
read those values from the device:
290+
Every Matter accessory device supports a Basic Information Cluster, which
291+
maintains collection of attributes that a controller can obtain from a device,
292+
such as the vendor name, the product name, or software version. Use `zclread`
293+
command to read those values from the device:
294294
295295
```
296-
chip-device-ctrl > zclread Basic VendorName 1234 1 0
297-
chip-device-ctrl > zclread Basic ProductName 1234 1 0
298-
chip-device-ctrl > zclread Basic SoftwareVersion 1234 1 0
296+
chip-device-ctrl > zclread BasicInformation VendorName 1234 1 0
297+
chip-device-ctrl > zclread BasicInformation ProductName 1234 1 0
298+
chip-device-ctrl > zclread BasicInformation SoftwareVersion 1234 1 0
299299
```
300300
301301
**REPL Command:**
302-
`await devCtrl.ReadAttribute(1234, [(1, Clusters.Basic.Attributes.VendorName)])`
302+
`await devCtrl.ReadAttribute(1234, [(1, Clusters.BasicInformation.Attributes.VendorName)])`
303303
304-
> Use the `zcl ? Basic` command to list all available commands for Basic
305-
> Cluster.
304+
> Use the `zcl ? BasicInformation` command to list all available commands for
305+
> Basic Information Cluster.
306306
>
307-
> In REPL, you can type `Clusters.Basic.Attributes.` and then use the TAB key.
307+
> In REPL, you can type `Clusters.BasicInformation.Attributes.` and then use the
308+
> TAB key.
308309
309310
<hr>
310311
@@ -524,7 +525,7 @@ ApplicationBasic
524525
ApplicationLauncher
525526
AudioOutput
526527
BarrierControl
527-
Basic
528+
BasicInformation
528529
Binding
529530
BridgedDeviceBasic
530531
ColorControl
@@ -567,10 +568,11 @@ Type `Clusters.` and hit TAB
567568

568569
### `zcl ? <Cluster>`
569570

570-
List available commands in cluster. For example, for _Basic_ cluster:
571+
List available commands in cluster. For example, for _Basic Information_
572+
cluster:
571573

572574
```
573-
chip-device-ctrl > zcl ? Basic
575+
chip-device-ctrl > zcl ? BasicInformation
574576
DataModelRevision
575577
VendorName
576578
VendorID
@@ -600,15 +602,15 @@ Type `Clusters.(cluster name).Commands.` and hit TAB
600602
Read the value of ZCL attribute. For example:
601603

602604
```
603-
chip-device-ctrl > zclread Basic VendorName 1234 1 0
605+
chip-device-ctrl > zclread BasicInformation VendorName 1234 1 0
604606
```
605607

606608
**REPL Commands**
607609

608610
```python
609611
# devCtrl.ReadAttribute(<nodeid>, [(<endpoint id>, Clusters.<cluster>.Attributes.<attribute>)])
610612
# e.g.
611-
await devCtrl.ReadAttribute(1234, [(1, Clusters.Basic.Attributes.VendorName)])
613+
await devCtrl.ReadAttribute(1234, [(1, Clusters.BasicInformation.Attributes.VendorName)])
612614
```
613615

614616
### `zclwrite <cluster> <attribute> <nodeid> <endpoint> <groupid> <value>`

‎docs/guides/repl/Matter_REPL_Intro.ipynb

+8-8
Large diffs are not rendered by default.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ server cluster Actions = 37 {
567567
readonly attribute int16u clusterRevision = 65533;
568568
}
569569

570-
server cluster Basic = 40 {
570+
server cluster BasicInformation = 40 {
571571
struct CapabilityMinimaStruct {
572572
int16u caseSessionsPerFabric = 0;
573573
int16u subscriptionsPerFabric = 1;
@@ -3921,7 +3921,7 @@ endpoint 0 {
39213921
callback attribute clusterRevision default = 1;
39223922
}
39233923

3924-
server cluster Basic {
3924+
server cluster BasicInformation {
39253925
callback attribute dataModelRevision default = 10;
39263926
callback attribute vendorName;
39273927
callback attribute vendorID;

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

+20-21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"featureLevel": 87,
2+
"featureLevel": 89,
33
"creator": "zap",
44
"keyValuePairs": [
55
{
@@ -16,19 +16,19 @@
1616
}
1717
],
1818
"package": [
19+
{
20+
"pathRelativity": "relativeToZap",
21+
"path": "../../../src/app/zap-templates/app-templates.json",
22+
"type": "gen-templates-json",
23+
"version": "chip-v1"
24+
},
1925
{
2026
"pathRelativity": "relativeToZap",
2127
"path": "../../../src/app/zap-templates/zcl/zcl-with-test-extensions.json",
2228
"type": "zcl-properties",
2329
"category": "matter",
2430
"version": 1,
2531
"description": "Matter SDK ZCL data with some extensions"
26-
},
27-
{
28-
"pathRelativity": "relativeToZap",
29-
"path": "../../../src/app/zap-templates/app-templates.json",
30-
"type": "gen-templates-json",
31-
"version": "chip-v1"
3232
}
3333
],
3434
"endpointTypes": [
@@ -1139,10 +1139,10 @@
11391139
]
11401140
},
11411141
{
1142-
"name": "Basic",
1142+
"name": "Basic Information",
11431143
"code": 40,
11441144
"mfgCode": null,
1145-
"define": "BASIC_CLUSTER",
1145+
"define": "BASIC_INFORMATION_CLUSTER",
11461146
"side": "client",
11471147
"enabled": 0,
11481148
"attributes": [
@@ -1165,10 +1165,10 @@
11651165
]
11661166
},
11671167
{
1168-
"name": "Basic",
1168+
"name": "Basic Information",
11691169
"code": 40,
11701170
"mfgCode": null,
1171-
"define": "BASIC_CLUSTER",
1171+
"define": "BASIC_INFORMATION_CLUSTER",
11721172
"side": "server",
11731173
"enabled": 1,
11741174
"attributes": [
@@ -10395,10 +10395,10 @@
1039510395
]
1039610396
},
1039710397
{
10398-
"name": "Basic",
10398+
"name": "Basic Information",
1039910399
"code": 40,
1040010400
"mfgCode": null,
10401-
"define": "BASIC_CLUSTER",
10401+
"define": "BASIC_INFORMATION_CLUSTER",
1040210402
"side": "client",
1040310403
"enabled": 0,
1040410404
"attributes": [
@@ -10421,10 +10421,10 @@
1042110421
]
1042210422
},
1042310423
{
10424-
"name": "Basic",
10424+
"name": "Basic Information",
1042510425
"code": 40,
1042610426
"mfgCode": null,
10427-
"define": "BASIC_CLUSTER",
10427+
"define": "BASIC_INFORMATION_CLUSTER",
1042810428
"side": "server",
1042910429
"enabled": 0,
1043010430
"attributes": [
@@ -21701,10 +21701,10 @@
2170121701
]
2170221702
},
2170321703
{
21704-
"name": "Basic",
21704+
"name": "Basic Information",
2170521705
"code": 40,
2170621706
"mfgCode": null,
21707-
"define": "BASIC_CLUSTER",
21707+
"define": "BASIC_INFORMATION_CLUSTER",
2170821708
"side": "client",
2170921709
"enabled": 0,
2171021710
"attributes": [
@@ -21727,10 +21727,10 @@
2172721727
]
2172821728
},
2172921729
{
21730-
"name": "Basic",
21730+
"name": "Basic Information",
2173121731
"code": 40,
2173221732
"mfgCode": null,
21733-
"define": "BASIC_CLUSTER",
21733+
"define": "BASIC_INFORMATION_CLUSTER",
2173421734
"side": "server",
2173521735
"enabled": 0,
2173621736
"attributes": [
@@ -24740,6 +24740,5 @@
2474024740
"endpointVersion": 1,
2474124741
"deviceIdentifier": 61442
2474224742
}
24743-
],
24744-
"log": []
24743+
]
2474524744
}

‎examples/all-clusters-app/esp32/main/CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ set(SRC_DIRS_LIST
7878
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/switch-server"
7979
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/general-diagnostics-server"
8080
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/group-key-mgmt-server"
81-
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/basic"
81+
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/basic-information"
8282
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/bindings"
8383
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/diagnostic-logs-server"
8484
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/door-lock-server"

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ server cluster Actions = 37 {
510510
readonly attribute int16u clusterRevision = 65533;
511511
}
512512

513-
server cluster Basic = 40 {
513+
server cluster BasicInformation = 40 {
514514
struct CapabilityMinimaStruct {
515515
int16u caseSessionsPerFabric = 0;
516516
int16u subscriptionsPerFabric = 1;
@@ -3310,7 +3310,7 @@ endpoint 0 {
33103310
callback attribute clusterRevision default = 1;
33113311
}
33123312

3313-
server cluster Basic {
3313+
server cluster BasicInformation {
33143314
callback attribute dataModelRevision default = 10;
33153315
callback attribute vendorName;
33163316
callback attribute vendorID;

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

+20-21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"featureLevel": 87,
2+
"featureLevel": 89,
33
"creator": "zap",
44
"keyValuePairs": [
55
{
@@ -16,19 +16,19 @@
1616
}
1717
],
1818
"package": [
19-
{
20-
"pathRelativity": "relativeToZap",
21-
"path": "../../../src/app/zap-templates/app-templates.json",
22-
"type": "gen-templates-json",
23-
"version": "chip-v1"
24-
},
2519
{
2620
"pathRelativity": "relativeToZap",
2721
"path": "../../../src/app/zap-templates/zcl/zcl.json",
2822
"type": "zcl-properties",
2923
"category": "matter",
3024
"version": 1,
3125
"description": "Matter SDK ZCL data"
26+
},
27+
{
28+
"pathRelativity": "relativeToZap",
29+
"path": "../../../src/app/zap-templates/app-templates.json",
30+
"type": "gen-templates-json",
31+
"version": "chip-v1"
3232
}
3333
],
3434
"endpointTypes": [
@@ -1139,10 +1139,10 @@
11391139
]
11401140
},
11411141
{
1142-
"name": "Basic",
1142+
"name": "Basic Information",
11431143
"code": 40,
11441144
"mfgCode": null,
1145-
"define": "BASIC_CLUSTER",
1145+
"define": "BASIC_INFORMATION_CLUSTER",
11461146
"side": "client",
11471147
"enabled": 0,
11481148
"attributes": [
@@ -1165,10 +1165,10 @@
11651165
]
11661166
},
11671167
{
1168-
"name": "Basic",
1168+
"name": "Basic Information",
11691169
"code": 40,
11701170
"mfgCode": null,
1171-
"define": "BASIC_CLUSTER",
1171+
"define": "BASIC_INFORMATION_CLUSTER",
11721172
"side": "server",
11731173
"enabled": 1,
11741174
"attributes": [
@@ -10245,10 +10245,10 @@
1024510245
]
1024610246
},
1024710247
{
10248-
"name": "Basic",
10248+
"name": "Basic Information",
1024910249
"code": 40,
1025010250
"mfgCode": null,
10251-
"define": "BASIC_CLUSTER",
10251+
"define": "BASIC_INFORMATION_CLUSTER",
1025210252
"side": "client",
1025310253
"enabled": 0,
1025410254
"attributes": [
@@ -10271,10 +10271,10 @@
1027110271
]
1027210272
},
1027310273
{
10274-
"name": "Basic",
10274+
"name": "Basic Information",
1027510275
"code": 40,
1027610276
"mfgCode": null,
10277-
"define": "BASIC_CLUSTER",
10277+
"define": "BASIC_INFORMATION_CLUSTER",
1027810278
"side": "server",
1027910279
"enabled": 0,
1028010280
"attributes": [
@@ -21477,10 +21477,10 @@
2147721477
]
2147821478
},
2147921479
{
21480-
"name": "Basic",
21480+
"name": "Basic Information",
2148121481
"code": 40,
2148221482
"mfgCode": null,
21483-
"define": "BASIC_CLUSTER",
21483+
"define": "BASIC_INFORMATION_CLUSTER",
2148421484
"side": "client",
2148521485
"enabled": 0,
2148621486
"attributes": [
@@ -21503,10 +21503,10 @@
2150321503
]
2150421504
},
2150521505
{
21506-
"name": "Basic",
21506+
"name": "Basic Information",
2150721507
"code": 40,
2150821508
"mfgCode": null,
21509-
"define": "BASIC_CLUSTER",
21509+
"define": "BASIC_INFORMATION_CLUSTER",
2151021510
"side": "server",
2151121511
"enabled": 0,
2151221512
"attributes": [
@@ -24516,6 +24516,5 @@
2451624516
"endpointVersion": 1,
2451724517
"deviceIdentifier": 61442
2451824518
}
24519-
],
24520-
"log": []
24519+
]
2452124520
}

0 commit comments

Comments
 (0)