Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename "Basic" cluster to "Basic Information". #24124

Merged
merged 2 commits into from
Dec 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .github/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ backtrace
BallastConfiguration
BarrierControl
BasicCHIPRegression
BasicInformation
baudrate
BD
BDX
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/zap_regeneration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:

runs-on: ubuntu-20.04
container:
image: connectedhomeip/chip-build:0.6.22
image: connectedhomeip/chip-build:0.6.23
defaults:
run:
shell: sh
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/zap_templates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:

runs-on: ubuntu-20.04
container:
image: connectedhomeip/chip-build:0.6.22
image: connectedhomeip/chip-build:0.6.23
defaults:
run:
shell: sh
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/access-control-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ Some typical clusters:
- Clusters.Descriptor.id
- Clusters.Binding.id
- Clusters.AccessControl.id
- Clusters.Basic.id
- Clusters.BasicInformation.id

### Examples

Expand Down
34 changes: 18 additions & 16 deletions docs/guides/python_chip_controller_building.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,24 +287,25 @@ chip-device-ctrl > zcl LevelControl MoveToLevel 1234 1 0 level=50

### Step 7: Read basic information out of the accessory.

Every Matter accessory device supports a Basic Cluster, which maintains
collection of attributes that a controller can obtain from a device, such as the
vendor name, the product name, or software version. Use `zclread` command to
read those values from the device:
Every Matter accessory device supports a Basic Information Cluster, which
maintains collection of attributes that a controller can obtain from a device,
such as the vendor name, the product name, or software version. Use `zclread`
command to read those values from the device:

```
chip-device-ctrl > zclread Basic VendorName 1234 1 0
chip-device-ctrl > zclread Basic ProductName 1234 1 0
chip-device-ctrl > zclread Basic SoftwareVersion 1234 1 0
chip-device-ctrl > zclread BasicInformation VendorName 1234 1 0
chip-device-ctrl > zclread BasicInformation ProductName 1234 1 0
chip-device-ctrl > zclread BasicInformation SoftwareVersion 1234 1 0
```

**REPL Command:**
`await devCtrl.ReadAttribute(1234, [(1, Clusters.Basic.Attributes.VendorName)])`
`await devCtrl.ReadAttribute(1234, [(1, Clusters.BasicInformation.Attributes.VendorName)])`

> Use the `zcl ? Basic` command to list all available commands for Basic
> Cluster.
> Use the `zcl ? BasicInformation` command to list all available commands for
> Basic Information Cluster.
>
> In REPL, you can type `Clusters.Basic.Attributes.` and then use the TAB key.
> In REPL, you can type `Clusters.BasicInformation.Attributes.` and then use the
> TAB key.

<hr>

Expand Down Expand Up @@ -524,7 +525,7 @@ ApplicationBasic
ApplicationLauncher
AudioOutput
BarrierControl
Basic
BasicInformation
Binding
BridgedDeviceBasic
ColorControl
Expand Down Expand Up @@ -567,10 +568,11 @@ Type `Clusters.` and hit TAB

### `zcl ? <Cluster>`

List available commands in cluster. For example, for _Basic_ cluster:
List available commands in cluster. For example, for _Basic Information_
cluster:

```
chip-device-ctrl > zcl ? Basic
chip-device-ctrl > zcl ? BasicInformation
DataModelRevision
VendorName
VendorID
Expand Down Expand Up @@ -600,15 +602,15 @@ Type `Clusters.(cluster name).Commands.` and hit TAB
Read the value of ZCL attribute. For example:

```
chip-device-ctrl > zclread Basic VendorName 1234 1 0
chip-device-ctrl > zclread BasicInformation VendorName 1234 1 0
```

**REPL Commands**

```python
# devCtrl.ReadAttribute(<nodeid>, [(<endpoint id>, Clusters.<cluster>.Attributes.<attribute>)])
# e.g.
await devCtrl.ReadAttribute(1234, [(1, Clusters.Basic.Attributes.VendorName)])
await devCtrl.ReadAttribute(1234, [(1, Clusters.BasicInformation.Attributes.VendorName)])
```

### `zclwrite <cluster> <attribute> <nodeid> <endpoint> <groupid> <value>`
Expand Down
16 changes: 8 additions & 8 deletions docs/guides/repl/Matter_REPL_Intro.ipynb

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ server cluster Actions = 37 {
readonly attribute int16u clusterRevision = 65533;
}

server cluster Basic = 40 {
server cluster BasicInformation = 40 {
struct CapabilityMinimaStruct {
int16u caseSessionsPerFabric = 0;
int16u subscriptionsPerFabric = 1;
Expand Down Expand Up @@ -3921,7 +3921,7 @@ endpoint 0 {
callback attribute clusterRevision default = 1;
}

server cluster Basic {
server cluster BasicInformation {
callback attribute dataModelRevision default = 10;
callback attribute vendorName;
callback attribute vendorID;
Expand Down
41 changes: 20 additions & 21 deletions examples/all-clusters-app/all-clusters-common/all-clusters-app.zap
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"featureLevel": 87,
"featureLevel": 89,
"creator": "zap",
"keyValuePairs": [
{
Expand All @@ -16,19 +16,19 @@
}
],
"package": [
{
"pathRelativity": "relativeToZap",
"path": "../../../src/app/zap-templates/app-templates.json",
"type": "gen-templates-json",
"version": "chip-v1"
},
{
"pathRelativity": "relativeToZap",
"path": "../../../src/app/zap-templates/zcl/zcl-with-test-extensions.json",
"type": "zcl-properties",
"category": "matter",
"version": 1,
"description": "Matter SDK ZCL data with some extensions"
},
{
"pathRelativity": "relativeToZap",
"path": "../../../src/app/zap-templates/app-templates.json",
"type": "gen-templates-json",
"version": "chip-v1"
}
],
"endpointTypes": [
Expand Down Expand Up @@ -1139,10 +1139,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "client",
"enabled": 0,
"attributes": [
Expand All @@ -1165,10 +1165,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "server",
"enabled": 1,
"attributes": [
Expand Down Expand Up @@ -10395,10 +10395,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "client",
"enabled": 0,
"attributes": [
Expand All @@ -10421,10 +10421,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "server",
"enabled": 0,
"attributes": [
Expand Down Expand Up @@ -21701,10 +21701,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "client",
"enabled": 0,
"attributes": [
Expand All @@ -21727,10 +21727,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "server",
"enabled": 0,
"attributes": [
Expand Down Expand Up @@ -24740,6 +24740,5 @@
"endpointVersion": 1,
"deviceIdentifier": 61442
}
],
"log": []
]
}
2 changes: 1 addition & 1 deletion examples/all-clusters-app/esp32/main/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ set(SRC_DIRS_LIST
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/switch-server"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/general-diagnostics-server"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/group-key-mgmt-server"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/basic"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/basic-information"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/bindings"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/diagnostic-logs-server"
"${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/app/clusters/door-lock-server"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ server cluster Actions = 37 {
readonly attribute int16u clusterRevision = 65533;
}

server cluster Basic = 40 {
server cluster BasicInformation = 40 {
struct CapabilityMinimaStruct {
int16u caseSessionsPerFabric = 0;
int16u subscriptionsPerFabric = 1;
Expand Down Expand Up @@ -3310,7 +3310,7 @@ endpoint 0 {
callback attribute clusterRevision default = 1;
}

server cluster Basic {
server cluster BasicInformation {
callback attribute dataModelRevision default = 10;
callback attribute vendorName;
callback attribute vendorID;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"featureLevel": 87,
"featureLevel": 89,
"creator": "zap",
"keyValuePairs": [
{
Expand All @@ -16,19 +16,19 @@
}
],
"package": [
{
"pathRelativity": "relativeToZap",
"path": "../../../src/app/zap-templates/app-templates.json",
"type": "gen-templates-json",
"version": "chip-v1"
},
{
"pathRelativity": "relativeToZap",
"path": "../../../src/app/zap-templates/zcl/zcl.json",
"type": "zcl-properties",
"category": "matter",
"version": 1,
"description": "Matter SDK ZCL data"
},
{
"pathRelativity": "relativeToZap",
"path": "../../../src/app/zap-templates/app-templates.json",
"type": "gen-templates-json",
"version": "chip-v1"
}
],
"endpointTypes": [
Expand Down Expand Up @@ -1139,10 +1139,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "client",
"enabled": 0,
"attributes": [
Expand All @@ -1165,10 +1165,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "server",
"enabled": 1,
"attributes": [
Expand Down Expand Up @@ -10245,10 +10245,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "client",
"enabled": 0,
"attributes": [
Expand All @@ -10271,10 +10271,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "server",
"enabled": 0,
"attributes": [
Expand Down Expand Up @@ -21477,10 +21477,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "client",
"enabled": 0,
"attributes": [
Expand All @@ -21503,10 +21503,10 @@
]
},
{
"name": "Basic",
"name": "Basic Information",
"code": 40,
"mfgCode": null,
"define": "BASIC_CLUSTER",
"define": "BASIC_INFORMATION_CLUSTER",
"side": "server",
"enabled": 0,
"attributes": [
Expand Down Expand Up @@ -24516,6 +24516,5 @@
"endpointVersion": 1,
"deviceIdentifier": 61442
}
],
"log": []
]
}
Loading