Skip to content

Commit 4b0cae0

Browse files
doc: matter: Add Mac-OS entry to Manufacturer-specific cluster page
- Added entry for Mac-OS to the download section. - Moved manufacturer cluster editor tool to getting_started section. - Aligned index.rst Signed-off-by: Arkadiusz Balys <[email protected]>
1 parent 115d4d7 commit 4b0cae0

29 files changed

+55
-28
lines changed
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
.. note::
2-
The nRF Connect Matter Manufacturer Cluster Editor is currently in the preview stage and is available only on Linux and Windows platforms.
3-
You can download, use and test it, but the full version will be available in the future.
2+
The nRF Connect Matter Manufacturer Cluster Editor is currently in the preview stage.

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
.. _ug_matter_creating_accessory_vendor_cluster:
22
.. _ug_matter_creating_custom_cluster:
33

4-
Creating custom clusters in Matter application
5-
##############################################
4+
Creating manufacturer-specific clusters in Matter application
5+
#############################################################
66

77
.. contents::
88
:local:
99
:depth: 2
1010

11-
This guide describes how you can create a custom cluster for the :ref:`matter_template_sample` sample.
11+
This guide describes how you can create a manufacturer-specific cluster for the :ref:`matter_template_sample` sample.
1212
The :ref:`matter_manufacturer_specific_sample` sample already contains a custom ``NordicDevkit`` cluster that you can use as a reference.
1313

1414
Overview
1515
********
1616

17-
A custom cluster is a manufacturer-specific cluster that is not defined in the Matter Device Type Library Specification.
17+
A manufacturer-specific cluster is a cluster that is not defined in the Matter Device Type Library Specification.
1818
The cluster description is written in XML format and is used to generate the C++ source files that provide the cluster implementation.
1919
You can add the cluster to the Matter data model definition file and use it in the :ref:`ug_matter_gs_tools_zap` to generate the source files.
2020

@@ -28,7 +28,7 @@ To take advantage of this guide, you need to be familiar with the :ref:`ug_matte
2828
Copy Matter template sample
2929
***************************
3030

31-
Use the :ref:`matter_template_sample` sample as the base for building a sensor device as follows:
31+
Use the :ref:`matter_template_sample` sample as the base for building a manufacturer-specific device as follows:
3232

3333
1. Make sure that you meet the requirements for building the sample.
3434
#. Copy the contents of the :file:`samples/matter/template` directory to a new directory meant for your custom application.
@@ -55,6 +55,8 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
5555

5656
.. tab:: Using the nRF Connect Matter Manufacturer Cluster Editor
5757

58+
.. include:: /includes/matter_manufacturer_cluster_editor_note.txt
59+
5860
Before using the tool, you need to download its preview version and unpack it on your machine.
5961
First, make sure you have completed the steps listed in the :ref:`ug_nrfconnect_manufacturer_cluster_editor_tool_downloading_installing` user guide.
6062

@@ -84,7 +86,7 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
8486
#. Click :guilabel:`Arguments`.
8587
#. In the new edit box, click the plus icon to create a new argument.
8688
#. Fill in :guilabel:`Name` as ``arg1``, :guilabel:`Type` as ``int8u``.
87-
#. Click the plus icon icon again to create second argument.
89+
#. Click the plus icon again to create second argument.
8890
#. Fill in :guilabel:`Name` as ``arg2``, :guilabel:`Type` as ``int8u``.
8991

9092
The following figure shows the filled in edit box dialog with two arguments added:
@@ -134,7 +136,7 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
134136
* **Description** as ``Event that is generated by the server``
135137

136138
#. Click :guilabel:`Fields`.
137-
#. In the new edit box, click the plus icon icon to add a new field.
139+
#. In the new edit box, click the plus icon to add a new field.
138140
#. Fill in the following values:
139141

140142
* **Field Id** as ``0x1``
@@ -165,7 +167,7 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
165167
* **Is Fabric Scoped** as ``true``
166168

167169
#. Click :guilabel:`Items`.
168-
#. In the new edit box, click the plus icon icon to create a new item.
170+
#. In the new edit box, click the plus icon to create a new item.
169171
#. Fill in the following values:
170172

171173
* **Field Id** as ``0x1``
@@ -180,7 +182,7 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
180182

181183
#. Click :guilabel:`Save` to save the item.
182184
#. Click :guilabel:`Assigned clusters` to open edit box dialog.
183-
#. In the new edit box, click the plus icon icon to create a new cluster assignment.
185+
#. In the new edit box, click the plus icon to create a new cluster assignment.
184186
#. Fill in ``Code`` with the value of the cluster code defined in first step as ``0xFFF1FC01``.
185187

186188
The following figure shows the filled in edit box dialog with the new cluster added:
@@ -207,13 +209,13 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
207209
* **Type** as ``int8u``
208210

209211
#. Click :guilabel:`Items`.
210-
#. In the new edit box, click the plus icon icon to create a new item.
212+
#. In the new edit box, click the plus icon to create a new item.
211213
#. Fill in the following values:
212214

213215
* **Name** as ``EnumValue1``
214216
* **Value** as ``0``
215217

216-
#. Click the plus icon icon to create a new item.
218+
#. Click the plus icon to create a new item.
217219
#. Fill in the following values:
218220

219221
* **Name** as ``EnumValue2``
@@ -226,7 +228,7 @@ To learn more about the tool, see the :ref:`ug_nrfconnect_manufacturer_cluster_e
226228

227229
#. Click :guilabel:`Save` to save the item.
228230
#. Click :guilabel:`Assigned clusters` to open edit box dialog.
229-
#. In the new edit box, click the plus icon icon to create a new cluster assignment.
231+
#. In the new edit box, click the plus icon to create a new cluster assignment.
230232
#. Fill in ``Code`` with the value of the cluster code defined in first step as ``0xFFF1FC01``.
231233

232234
The following figure shows the filled in edit box dialog with the new cluster assignment added:

0 commit comments

Comments
 (0)