Skip to content

Commit 2328a4d

Browse files
peknisArekBalysNordic
authored andcommitted
doc improvement: Fixes in the Matter cluster docs
Fixing the GUI element spelling and other minor fixes. Signed-off-by: Pekka Niskanen <[email protected]>
1 parent 793abf4 commit 2328a4d

File tree

2 files changed

+98
-41
lines changed

2 files changed

+98
-41
lines changed

doc/nrf/protocols/matter/getting_started/custom_clusters.rst

Lines changed: 47 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,19 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
6363
Once you have the tool installed, you can create a new cluster description file.
6464
Complete the following steps:
6565

66-
1. Edit the :guilabel:`Cluster` tab contents.
66+
1. Edit the :guilabel:`CLUSTER` tab contents.
6767

68-
a. Open the :guilabel:`Cluster` tab.
68+
a. Open the :guilabel:`CLUSTER` tab.
6969
#. Fill in the domain, name, code, define, and description of the cluster as follows:
7070

7171
.. figure:: images/matter_creating_custom_cluster_cluster_page.png
7272
:alt: Cluster tab
7373

74-
#. Add a new command in the :guilabel:`Commands` tab.
74+
CLUSTER tab
7575

76-
a. Open the :guilabel:`Commands` tab.
76+
#. Add a new command in the :guilabel:`COMMANDS` tab.
77+
78+
a. Open the :guilabel:`COMMANDS` tab.
7779
#. Click :guilabel:`Add command` to open edit box.
7880
#. In the edit box, set the following values:
7981

@@ -94,18 +96,22 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
9496
.. figure:: images/matter_creating_custom_cluster_arguments_page.png
9597
:alt: Arguments tab
9698

99+
Arguments tab
100+
97101
#. Click :guilabel:`Save` to save the arguments.
98102

99103
The following figure shows the filled in edit box dialog with the new command added:
100104

101105
.. figure:: images/matter_creating_custom_cluster_commands_page.png
102106
:alt: Commands tab
103107

108+
Commands tab
109+
104110
#. Click :guilabel:`Save` to save the command.
105111

106-
#. Add a new argument in the :guilabel:`Attributes` tab.
112+
#. Add a new argument in the :guilabel:`ATTRIBUTES` tab.
107113

108-
a. Open the :guilabel:`Attributes` tab.
114+
a. Open the :guilabel:`ATTRIBUTES` tab.
109115
#. Click :guilabel:`Add attribute` to open edit box dialog.
110116
#. Set the following values:
111117

@@ -121,11 +127,13 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
121127
.. figure:: images/matter_creating_custom_cluster_attributes_page.png
122128
:alt: Attributes tab
123129

130+
Attributes tab
131+
124132
#. Click :guilabel:`Save` to save the attribute.
125133

126-
#. Add a new event in the :guilabel:`Events` tab.
134+
#. Add a new event in the :guilabel:`EVENTS` tab.
127135

128-
a. Open the :guilabel:`Events` tab.
136+
a. Open the :guilabel:`EVENTS` tab.
129137
#. Click :guilabel:`Add event` to open edit box dialog.
130138
#. In the edit box, set the following values:
131139

@@ -148,18 +156,22 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
148156
.. figure:: images/matter_creating_custom_cluster_fields_page.png
149157
:alt: Fields tab
150158

159+
Fields tab
160+
151161
#. Click :guilabel:`Save` to save the field.
152162

153163
The following figure shows the filled in edit box dialog with the new event added:
154164

155165
.. figure:: images/matter_creating_custom_cluster_event_page.png
156166
:alt: Event page
157167

158-
#. Click on the :guilabel:`Save` button to save the event.
168+
Events tab
169+
170+
#. Click :guilabel:`Save` to save the event.
159171

160-
#. Add a new structure in the :guilabel:`Structures` tab.
172+
#. Add a new structure in the :guilabel:`STRUCTURES` tab.
161173

162-
a. Open the :guilabel:`Structures` tab.
174+
a. Open the :guilabel:`STRUCTURES` tab.
163175
#. Click :guilabel:`Add structure` to open edit box dialog.
164176
#. In the edit box, set the following values:
165177

@@ -180,6 +192,8 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
180192
.. figure:: images/matter_creating_custom_cluster_structure_items_page.png
181193
:alt: Structure items tab
182194

195+
Structure items tab
196+
183197
#. Click :guilabel:`Save` to save the item.
184198
#. Click :guilabel:`Assigned clusters` to open edit box dialog.
185199
#. In the new edit box, click the plus icon to create a new cluster assignment.
@@ -190,18 +204,22 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
190204
.. figure:: images/matter_creating_custom_cluster_assigned_clusters_page.png
191205
:alt: Assigned clusters tab
192206

207+
Assigned clusters tab
208+
193209
#. Click :guilabel:`Save` to save the cluster.
194210

195211
The following figure shows the filled in edit box dialog with the new structure added:
196212

197213
.. figure:: images/matter_creating_custom_cluster_structures_page.png
198214
:alt: Structures tab
199215

216+
Structures tab
217+
200218
#. Click :guilabel:`Save` to save the structure.
201219

202-
#. Add a new enum in the :guilabel:`Enums` tab.
220+
#. Add a new enum in the :guilabel:`ENUMS` tab.
203221

204-
a. Open the :guilabel:`Enums` tab.
222+
a. Open the :guilabel:`ENUMS` tab.
205223
#. Click :guilabel:`Add enum` to open edit box dialog.
206224
#. Set the following values:
207225

@@ -226,6 +244,8 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
226244
.. figure:: images/matter_creating_custom_cluster_items_enum_page.png
227245
:alt: Items tab
228246

247+
Items tab
248+
229249
#. Click :guilabel:`Save` to save the item.
230250
#. Click :guilabel:`Assigned clusters` to open edit box dialog.
231251
#. In the new edit box, click the plus icon to create a new cluster assignment.
@@ -236,29 +256,37 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
236256
.. figure:: images/matter_creating_custom_cluster_assigned_clusters_page.png
237257
:alt: Assigned clusters tab
238258

259+
Assigned clusters tab
260+
239261
#. Click :guilabel:`Save` to save the cluster.
240262

241263
The following figure shows the filled in edit box dialog with the new enum added:
242264

243265
.. figure:: images/matter_creating_custom_cluster_enums_page.png
244266
:alt: Enums tab
245267

268+
Enums tab
269+
246270
#. Click :guilabel:`Save` to save the enum.
247271

248-
#. Add a new device type in the :guilabel:`Device Type` tab.
272+
#. Add a new device type in the :guilabel:`DEVICE TYPE` tab.
249273

250-
a. Open the :guilabel:`Device Type` tab.
274+
a. Open the :guilabel:`DEVICE TYPE` tab.
251275
#. Fill the fields as follows:
252276

253277
.. figure:: images/matter_creating_custom_cluster_device_type_page.png
254278
:alt: Device type tab
255279

280+
Device type tab
281+
256282
#. Click :guilabel:`Add cluster assignment to device type` to open edit box dialog.
257283
#. Fill the Cluster fields as follows:
258284

259285
.. figure:: images/matter_creating_custom_cluster_device_type_cluster_assignment_page.png
260286
:alt: Device type cluster assignment tab
261287

288+
Device type cluster assignment tab
289+
262290
#. Click :guilabel:`Save` to save the cluster assignment.
263291

264292
#. Click the :guilabel:`Save cluster to file` button to save the cluster description file to the sample directory and name it as ``MyCluster.xml``.
@@ -517,7 +545,7 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
517545
</deviceType>
518546
519547
.. note::
520-
The descriptions of the elements above show only the basic functionality.
548+
The descriptions of the elements show only the basic functionality.
521549
To see the full list of available elements for each part of the XML file, refer to the Matter Specification.
522550

523551
For an example, you can use the following template for the :file:`MyCluster.xml` file:
@@ -622,21 +650,21 @@ This guide focuses on the :ref:`ug_matter_gs_tools_matter_west_commands_zap_tool
622650

623651
#. Click the gear icon to open the cluster configuration and enable the attributes, commands, and events.
624652

625-
a. In the :guilabel:`ATTRIBUTES` tab, ensure that you have the required attributes enabled.
653+
a. In the :guilabel:`Attributes` tab, ensure that you have the required attributes enabled.
626654

627655
.. figure:: images/matter_creating_custom_cluster_attributes.png
628656
:alt: Attributes of the new custom cluster in ZAP tool
629657

630658
Attributes of the new custom cluster in ZAP tool
631659

632-
#. In the :guilabel:`COMMANDS` tab, ensure that you have the required commands enabled.
660+
#. In the :guilabel:`Commands` tab, ensure that you have the required commands enabled.
633661

634662
.. figure:: images/matter_creating_custom_cluster_commands.png
635663
:alt: Commands of the new custom cluster in ZAP tool
636664

637665
Commands of the new custom cluster in ZAP tool
638666

639-
#. In the :guilabel:`EVENTS` tab, ensure that you have the required events enabled.
667+
#. In the :guilabel:`Events` tab, ensure that you have the required events enabled.
640668

641669
.. figure:: images/matter_creating_custom_cluster_events.png
642670
:alt: Events of the new custom cluster in ZAP tool

0 commit comments

Comments
 (0)