Skip to content

Commit

Permalink
[nxp noup][doc][rt1060] Documentation rework - moving matter border r…
Browse files Browse the repository at this point in the history
…outer support to README.md

Signed-off-by: Dina Benamar <[email protected]>
  • Loading branch information
dinabenamar authored and andrei-menzopol committed Apr 10, 2024
1 parent 449c1e9 commit a825f13
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 105 deletions.
74 changes: 74 additions & 0 deletions examples/all-clusters-app/nxp/rt/rt1060/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,20 @@ commissioning and different cluster control.
- [Hardware requirements RT1060+8801](#hardware-requirements-rt10608801)
- [Hardware requirements RT1060 + K32W0](#hardware-requirements-rt1060--k32w0)
- [Hardware requirements RT1060-EVKC+IW612](#hardware-requirements-rt1060-evkciw612)
- [Hardware requirements RT1060 + 88W8801 + K32W0x1DK6](#hardware-requirements-rt1060--88w8801--k32w0x1dk6)
- [Building](#building)
- [Building with Matter over Wifi configuratiom on RT1060 + transceiver](#building-with-matter-over-wifi-configuratiom-on-rt1060--transceiver)
- [Build with Matter over Thread configuration on RT1060 + transceiver](#build-with-matter-over-thread-configuration-on-rt1060--transceiver)
- [Build with Matter over Thread configuration on RT1060 + K32W0](#build-with-matter-over-thread-configuration-on-rt1060--k32w0)
- [Build with Matter over Thread configuration on RT1060-EVKC + IW612](#build-with-matter-over-thread-configuration-on-rt1060-evkc--iw612)
- [Build with Matter over Wi-Fi + OpenThread Border Router configuration on RT1060 + 88W8801 + K32W0x1DK6](#build-with-matter-over-wi-fi--openthread-border-router-configuration-on-rt1060--88w8801--k32w0x1dk6)
- [General Information](#general-information)
- [Manufacturing data](#manufacturing-data)
- [Flashing and debugging](#flashing-and-debugging)
- [Testing the example](#testing-the-example)
- [Matter over wifi configuration :](#matter-over-wifi-configuration-)
- [Matter over thread configuration :](#matter-over-thread-configuration-)
- [Matter over wifi with openthread border router configuration :](#matter-over-wifi-with-openthread-border-router-configuration-)
- [Testing the all-clusters application without Matter CLI:](#testing-the-all-clusters-application-without-matter-cli)
- [Testing the all-clusters application with Matter CLI enabled:](#testing-the-all-clusters-application-with-matter-cli-enabled)

Expand All @@ -48,6 +51,7 @@ The example supports:

- Matter over Wi-Fi
- Matter over Openthread
- Matter over Wi-Fi with Openthread Border Router support

The example targets the
[NXP MIMXRT1060-EVKB](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/mimxrt1060-evk-i-mx-rt1060-evaluation-kit:MIMXRT1060-EVK)
Expand All @@ -69,6 +73,10 @@ Matter over Thread :
- RT1060 + K32W0 (15.4 + BLE)
- **Experimental:** _RT1060-EVKC + IW612 (15.4 + BLE)_

Matter over Wi-Fi with Openthread Border Router support :

- RT1060 + 88W8801 + K32W0x1DK6

### Hardware requirements RT1060 + transceiver

#### Hardware requirements RT1060+IW416
Expand Down Expand Up @@ -211,6 +219,15 @@ Transceiver part :

The IW612 module should be plugged to the M.2 connector on RT1060-EVKC board.

#### Hardware requirements RT1060 + 88W8801 + K32W0x1DK6

- i.MX RT1060 EVKA or EVKB board
- 88W8801 module (for Wi-Fi connection), for example 88W8801 2DS M.2 Module
(rev A) and Murata uSD-M.2 Adapter (rev B1)
- K32W0x1 mezzanine module (for Thread connection)
- IOTZTB-DK006 carrier board for the K32W0x1 module (referenced as DK6 carrier
board)

<a name="building"></a>

## Building
Expand Down Expand Up @@ -348,6 +365,18 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt106
user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ ninja -C out/debug
```

### Build with Matter over Wi-Fi + OpenThread Border Router configuration on RT1060 + 88W8801 + K32W0x1DK6

This configuration requires enabling the Matter CLI in order to control the
Thread network on the Border Router.

- Build Matter with Border Router configuration with ble-wifi commissioning:

```
user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ gn gen --args="chip_enable_wifi=true w8801_transceiver=true chip_enable_matter_cli=true chip_config_network_layer_ble=true chip_enable_openthread=true k32w0_transceiver=true k32w0_transceiver_bin_path=\"/path/to/ot-rcp/ot-rcp-ble-hci-bb-k32w061.elf.bin.h\" hci_spinel_single_uart=true openthread_root =\"//third_party/connectedhomeip/third_party/openthread/ot-nxp/openthread-br\"" out/debug
user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ ninja -C out/debug
```

### General Information

The resulting output file can be found in
Expand Down Expand Up @@ -530,6 +559,16 @@ The "ble-wifi" pairing method can be used in order to commission the device.

The "ble-thread" pairing method can be used in order to commission the device.

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

In order to create or join a Thread network on the Matter Border Router, the
`otcli` commands from the matter CLI can be used. For more information about
using the matter shell, follow instructions from
['Testing the all-clusters application with Matter CLI'](#testing-the-all-clusters-application-with-matter-cli-enabled).

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

### Testing the all-clusters application without Matter CLI:

1. Prepare the board with the flashed `All-cluster application` (as shown
Expand Down Expand Up @@ -600,3 +639,38 @@ Here are described steps to use the all-cluster-app with the Matter CLI enabled
[chip-tool](../../../../../examples/chip-tool/README.md) application as it is
described
[here](../../../../../examples/chip-tool/README.md#using-the-client-to-send-matter-commands).

For Matter with OpenThread Border Router support, the matter CLI can be used to
start/join the Thread network, using the following ot-cli commands. (Note that
setting channel, panid, and network key is not enough anymore because of an Open
Thread stack update. We first need to initialize a new dataset.)

```
> otcli dataset init new
Done
> otcli dataset
Active Timestamp: 1
Channel: 25
Channel Mask: 0x07fff800
Ext PAN ID: 42af793f623aab54
Mesh Local Prefix: fd6e:c358:7078:5a8d::/64
Network Key: f824658f79d8ca033fbb85ecc3ca91cc
Network Name: OpenThread-b870
PAN ID: 0xb870
PSKc: f438a194a5e968cc43cc4b3a6f560ca4
Security Policy: 672 onrc 0
Done
> otcli dataset panid 0xabcd
Done
> otcli dataset channel 25
Done
> otcli dataset commit active
Done
> otcli ifconfig up
Done
> otcli thread start
Done
> otcli state
leader
Done
```
105 changes: 0 additions & 105 deletions examples/all-clusters-app/nxp/rt/rt1060/README_Border_Router.md

This file was deleted.

0 comments on commit a825f13

Please sign in to comment.