README.rst
1.. zephyr:code-sample:: openthread-shell
2 :name: OpenThread shell
3 :relevant-api: net_stats
4
5 Test Thread and IEEE 802.15.4 using the OpenThread shell.
6
7Overview
8********
9
10This sample allows testing the Thread protocol and the underlying IEEE 802.15.4 drivers for various
11boards using the OpenThread shell.
12
13Building and Running
14********************
15
16Verify that the board and chip you are targeting provide IEEE 802.15.4 support.
17
18There are configuration files for different boards and setups in the shell directory:
19
20- :file:`prj.conf`
21 Generic config file.
22
23- :file:`overlay-ot-rcp-host-nxp.conf`
24 This overlay config enables support of OpenThread RCP host running on NXP chips over IMU interface.
25
26Build shell application like this:
27
28.. zephyr-app-commands::
29 :zephyr-app: samples/net/openthread/shell
30 :board: <board to use>
31 :conf: <config file to use>
32 :goals: build
33 :compact:
34
35Example building for Nordic's nRF52840 DK.
36
37.. zephyr-app-commands::
38 :zephyr-app: samples/net/openthread/shell
39 :board: nrf52840dk/nrf52840
40 :conf: "prj.conf"
41 :goals: build
42 :compact:
43
44Example building for NXP's RW612 FRDM (RCP host).
45
46.. zephyr-app-commands::
47 :zephyr-app: samples/net/openthread/shell
48 :board: frdm_rw612
49 :conf: "prj-ot-host.conf"
50 :goals: build
51 :compact:
52
53Example building for NXP's MCXW72 FRDM (host).
54
55.. zephyr-app-commands::
56 :zephyr-app: samples/net/openthread/shell
57 :board: frdm_mcxw72
58 :conf: "prj-ot-host.conf"
59 :goals: build
60 :compact:
61
62
63Sample console interaction
64==========================
65
66.. code-block:: console
67
68 uart:~$ ot scan
69 | PAN | MAC Address | Ch | dBm | LQI |
70 +------+------------------+----+-----+-----+
71 | fe09 | abcdef1234567890 | 15 | -78 | 60 |
72 Done
73
