Skip to content

Commit ebe9735

Browse files
restyled-commitsMartin-NXP
authored andcommitted
Restyled by prettier-markdown
1 parent 46667dc commit ebe9735

File tree

2 files changed

+64
-23
lines changed

2 files changed

+64
-23
lines changed

docs/guides/nxp/nxp_otbr_guide.md

+44-14
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Thread Border Router usage
22

3-
This document describes the use of the Thread Border router and secondary netwok interface for a Matter application
3+
This document describes the use of the Thread Border router and secondary netwok
4+
interface for a Matter application
45

56
<hr>
67

@@ -15,42 +16,63 @@ This document describes the use of the Thread Border router and secondary netwok
1516

1617
## Thread Border Router overwiew
1718

18-
This section contains an overview of the Border Router architecture and describes the general use cases.
19+
This section contains an overview of the Border Router architecture and
20+
describes the general use cases.
1921

2022
<a name="using-the-thread-border-router-management-cluster"></a>
2123

2224
## Using the Thread Border Router management cluster
2325

24-
The Thread Border Router management cluster allows provisioning of the Thread interface using a Matter commissioner.
26+
The Thread Border Router management cluster allows provisioning of the Thread
27+
interface using a Matter commissioner.
2528

26-
After the device has been provisioned over WIFI the set active dataset command can be used to configure the Thread active dataset on the border router. Once the dataset is set successfully the Thread network interface will be enabled and the device will create a new PAN or join an existing one if already present. Note that this command cannot be used on a device that already has an active dataset configured. In this situation the set pending dataset command must be used instead.
29+
After the device has been provisioned over WIFI the set active dataset command
30+
can be used to configure the Thread active dataset on the border router. Once
31+
the dataset is set successfully the Thread network interface will be enabled and
32+
the device will create a new PAN or join an existing one if already present.
33+
Note that this command cannot be used on a device that already has an active
34+
dataset configured. In this situation the set pending dataset command must be
35+
used instead.
2736

28-
Before using the set active dataset command a fail-safe timer must be armed (recommend using a timeout of 120 seconds):
37+
Before using the set active dataset command a fail-safe timer must be armed
38+
(recommend using a timeout of 120 seconds):
2939

3040
```
3141
ubuntu@ubuntu:~$ ./chip-tool generalcommissioning arm-fail-safe timeout-seconds 1 node-id 0
3242
```
33-
Then an active dataset in HEX TLV format (the same type used to provision a Matter over Thread device using the `ble-thread` command) can be used to provision the Border Router. What the active dataset should be is outside the scope of this README but as an example one can be obtained from the OpenThread cli on an already provisioned device using the `dataset active -x` command.
3443

35-
Note that the Thread Border Router management cluster has been set to endpoint 2 in the zap file.
44+
Then an active dataset in HEX TLV format (the same type used to provision a
45+
Matter over Thread device using the `ble-thread` command) can be used to
46+
provision the Border Router. What the active dataset should be is outside the
47+
scope of this README but as an example one can be obtained from the OpenThread
48+
cli on an already provisioned device using the `dataset active -x` command.
49+
50+
Note that the Thread Border Router management cluster has been set to endpoint 2
51+
in the zap file.
3652

3753
```
3854
ubuntu@ubuntu:~$ ./chip-tool threadborderroutermanagement set-active-dataset-request hex:<active-dataset> node id 2
3955
```
4056

41-
If the active dataset command is successful, a commissioning complete command must be send to disarm the fail-safe timer and commit the configuration to non-volatile storage.
57+
If the active dataset command is successful, a commissioning complete command
58+
must be send to disarm the fail-safe timer and commit the configuration to
59+
non-volatile storage.
4260

4361
```
4462
ubuntu@ubuntu:~$ ./chip-tool-19-jul generalcommissioning commissioning-complete node-id 0
4563
```
4664

47-
Note that this command cannot be used on a device that already has an active dataset configured. In this situation the set pending dataset command must be used instead.
65+
Note that this command cannot be used on a device that already has an active
66+
dataset configured. In this situation the set pending dataset command must be
67+
used instead.
4868

4969
```
5070
ubuntu@ubuntu:~$ ./chip-tool threadborderroutermanagement set-pending-dataset-request hex:<active-dataset> node id 2
5171
```
5272

53-
To read the active dataset of an already provisioned device, for example to make a joining Border Router use the same Thread network as an already configured one, the get active dataset command can be used:
73+
To read the active dataset of an already provisioned device, for example to make
74+
a joining Border Router use the same Thread network as an already configured
75+
one, the get active dataset command can be used:
5476

5577
```
5678
ubuntu@ubuntu:~$ ./chip-tool-19-jul threadborderroutermanagement get-active-dataset-request node-id 2
@@ -60,8 +82,12 @@ ubuntu@ubuntu:~$ ./chip-tool-19-jul threadborderroutermanagement get-active-data
6082

6183
## Using the Secondary Network commissioning interface
6284

63-
To use the secondary network commissioning interface over Thread the device must not be provisioned over WIFI.
64-
The regular `ble-thread` pairing is used as for any other Matter over Thread device. The chip-tool will read all the endpoints of the device and discover Thread network commissioning cluster on endpoint 3 and use that to provision the device. As for any other Matter over Thread device a Thread Border Router is required in this case.
85+
To use the secondary network commissioning interface over Thread the device must
86+
not be provisioned over WIFI. The regular `ble-thread` pairing is used as for
87+
any other Matter over Thread device. The chip-tool will read all the endpoints
88+
of the device and discover Thread network commissioning cluster on endpoint 3
89+
and use that to provision the device. As for any other Matter over Thread device
90+
a Thread Border Router is required in this case.
6591

6692
```
6793
ubuntu@ubuntu:~$ ./chip-tool pairing ble-thread node-id hex:<active-dataset> 20202021 3840
@@ -71,6 +97,10 @@ ubuntu@ubuntu:~$ ./chip-tool pairing ble-thread node-id hex:<active-dataset> 202
7197

7298
## Using the Thread credential sharing mechanism
7399

74-
The details about using the credential sharing mechanism are in the ot-nxp repo border router application [readme](https://github.com/NXP/ot-nxp/blob/v1.4.0-pvw1/examples/br/README-OTBR.md). See `Ephemeral Key functionality` section.
100+
The details about using the credential sharing mechanism are in the ot-nxp repo
101+
border router application
102+
[readme](https://github.com/NXP/ot-nxp/blob/v1.4.0-pvw1/examples/br/README-OTBR.md).
103+
See `Ephemeral Key functionality` section.
75104

76-
Note that all OpenThread commands executed from then Matter CLI must have `otcli` prepended before the command.
105+
Note that all OpenThread commands executed from then Matter CLI must have
106+
`otcli` prepended before the command.

examples/all-clusters-app/nxp/rt/rw61x/README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,13 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rw61x
125125

126126
#### Building with Matter over Wifi + OpenThread Border Router configuration on RW612
127127

128-
This configuration supports the Thread Border Router management cluster to provision the Thread credentials. Enabling the Matter CLI in order to control the
129-
Thread network on the Border Router is optional but recommended for other features like the Thread credential sharing.
128+
This configuration supports the Thread Border Router management cluster to
129+
provision the Thread credentials. Enabling the Matter CLI in order to control
130+
the Thread network on the Border Router is optional but recommended for other
131+
features like the Thread credential sharing.
130132

131-
Note that the Thread Border Router management cluster is only supported on the thermostat application for now.
133+
Note that the Thread Border Router management cluster is only supported on the
134+
thermostat application for now.
132135

133136
- Build Matter with Border Router configuration with BLE commissioning
134137
(ble-wifi) :
@@ -147,7 +150,11 @@ Optional GN options that can be added when building an application:
147150

148151
- To enable the
149152
[secondary network commissioning interface](../../../../../docs/guides/nxp/nxp_otbr_guide.md#using-the-secondary-network-commissioning-interface),
150-
the arguments `chip_enable_secondary_nwk_if=true` and `chip_device_config_thread_network_endpoint_id=2` must be added to the _gn gen_ command. Note that this is only supported when building the Matter over Wifi + OpenThread Border Router configuration. Note that is only supported on the on the thermostat application for now.
153+
the arguments `chip_enable_secondary_nwk_if=true` and
154+
`chip_device_config_thread_network_endpoint_id=2` must be added to the _gn
155+
gen_ command. Note that this is only supported when building the Matter over
156+
Wifi + OpenThread Border Router configuration. Note that is only supported
157+
on the on the thermostat application for now.
151158
- To enable the
152159
[matter CLI](README.md#testing-the-all-clusters-application-with-matter-cli-enabled),
153160
the argument `chip_enable_matter_cli=true` must be added to the _gn gen_
@@ -271,12 +278,13 @@ The "ble-thread" pairing method can be used in order to commission the device.
271278

272279
#### Matter over wifi with openthread border router configuration :
273280

274-
In order to create or join a Thread network on the Matter Border Router, the TBR management cluster or the
275-
`otcli` commands from the matter CLI can be used. For more information about using the TBR management cluster follow instructions from ['Using the TBR management cluster'](../../../../../docs/guides/nxp/nxp_otbr_guide.md#using-the-thread-border-router-management-cluster).
281+
In order to create or join a Thread network on the Matter Border Router, the TBR
282+
management cluster or the `otcli` commands from the matter CLI can be used. For
283+
more information about using the TBR management cluster follow instructions from
284+
['Using the TBR management cluster'](../../../../../docs/guides/nxp/nxp_otbr_guide.md#using-the-thread-border-router-management-cluster).
276285
For more information about using the matter shell, follow instructions from
277286
['Testing the all-clusters application with Matter CLI'](#testing-the-all-clusters-application-with-matter-cli-enabled).
278287

279-
280288
In this configuration, the device can be commissioned over Wi-Fi with the
281289
'ble-wifi' pairing method.
282290

@@ -391,6 +399,7 @@ Done
391399
leader
392400
Done
393401
```
402+
394403
<a name="ota-software-update"></a>
395404

396405
## OTA Software Update
@@ -404,6 +413,8 @@ dedicated guide
404413

405414
## Thread Border Router overwiew
406415

407-
To enable Thread Border Router support see the [build](README.md#building) section.
416+
To enable Thread Border Router support see the [build](README.md#building)
417+
section.
408418

409-
The complete Border Router guide is located [here](../../../../../docs/guides/nxp/nxp_otbr_guide.md).
419+
The complete Border Router guide is located
420+
[here](../../../../../docs/guides/nxp/nxp_otbr_guide.md).

0 commit comments

Comments
 (0)