mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 19:13:21 +00:00
zhuanghang
177 lines
4.6 KiB
Markdown
177 lines
4.6 KiB
Markdown
| Supported Targets | ESP32-C5 | ESP32-C6 | ESP32-H2 | ESP32-H4 | ESP32-S31 |
|
|
| ----------------- | -------- | -------- | -------- | -------- | --------- |
|
|
|
|
# OpenThread Command Line Example
|
|
|
|
This example demonstrates an [OpenThread CLI](https://github.com/openthread/openthread/blob/master/src/cli/README.md), with some additional features such as TCP, UDP and Iperf.
|
|
|
|
## How to use example
|
|
|
|
### Hardware Required
|
|
|
|
To run this example, a board with IEEE 802.15.4 module (for example ESP32-H2) is required.
|
|
|
|
### Configure the project
|
|
|
|
```
|
|
idf.py menuconfig
|
|
```
|
|
|
|
The example can run with the default configuration. OpenThread Command Line is enabled with UART as the default interface. Additionally, USB JTAG is also supported and can be activated through the menuconfig:
|
|
|
|
```
|
|
Component config → ESP System Settings → Channel for console output → USB Serial/JTAG Controller
|
|
```
|
|
|
|
### Build, Flash, and Run
|
|
|
|
Build the project and flash it to the board, then run monitor tool to view serial output:
|
|
|
|
```
|
|
idf.py -p PORT build flash monitor
|
|
```
|
|
|
|
Now you'll get an OpenThread command line shell.
|
|
|
|
### Example Output
|
|
|
|
The `help` command will print all of the supported commands.
|
|
```bash
|
|
esp32h2> ot help
|
|
I(7058) OPENTHREAD:[INFO]-CLI-----: execute command: help
|
|
bbr
|
|
bufferinfo
|
|
ccathreshold
|
|
channel
|
|
child
|
|
childip
|
|
childmax
|
|
childsupervision
|
|
childtimeout
|
|
coap
|
|
contextreusedelay
|
|
counters
|
|
dataset
|
|
delaytimermin
|
|
diag
|
|
discover
|
|
dns
|
|
domainname
|
|
eidcache
|
|
eui64
|
|
extaddr
|
|
extpanid
|
|
factoryreset
|
|
...
|
|
```
|
|
|
|
## Set Up Network
|
|
|
|
To run this example, at least two ESP32-H2 boards flashed with this ot_cli example are required.
|
|
|
|
On the first device, run the following commands:
|
|
```bash
|
|
esp32h2> ot factoryreset
|
|
... # the device will reboot
|
|
|
|
esp32h2> ot dataset init new
|
|
Done
|
|
esp32h2> ot dataset commit active
|
|
Done
|
|
esp32h2> ot ifconfig up
|
|
Done
|
|
esp32h2> ot thread start
|
|
Done
|
|
|
|
# After some seconds
|
|
|
|
esp32h2> ot state
|
|
leader
|
|
Done
|
|
```
|
|
Now the first device has formed a Thread network as a leader. Get some information which will be used in next steps:
|
|
```bash
|
|
esp32h2> ot ipaddr
|
|
fdde:ad00:beef:0:0:ff:fe00:fc00
|
|
fdde:ad00:beef:0:0:ff:fe00:8000
|
|
fdde:ad00:beef:0:a7c6:6311:9c8c:271b
|
|
fe80:0:0:0:5c27:a723:7115:c8f8
|
|
|
|
# Get the Active Dataset
|
|
esp32h2> ot dataset active -x
|
|
0e080000000000010000000300001835060004001fffe00208fe7bb701f5f1125d0708fd75cbde7c6647bd0510b3914792d44f45b6c7d76eb9306eec94030f4f70656e5468726561642d35383332010258320410e35c581af5029b054fc904a24c2b27700c0402a0fff8
|
|
```
|
|
|
|
On the second device, set the active dataset from leader, and start Thread interface:
|
|
```bash
|
|
esp32h2> ot factoryreset
|
|
... # the device will reboot
|
|
|
|
esp32h2> ot dataset set active 0e080000000000010000000300001835060004001fffe00208fe7bb701f5f1125d0708fd75cbde7c6647bd0510b3914792d44f45b6c7d76eb9306eec94030f4f70656e5468726561642d35383332010258320410e35c581af5029b054fc904a24c2b27700c0402a0fff8
|
|
esp32h2> ot ifconfig up
|
|
Done
|
|
esp32h2> ot thread start
|
|
Done
|
|
|
|
# After some seconds
|
|
|
|
esp32h2> ot state
|
|
router # child is also a valid state
|
|
Done
|
|
```
|
|
The second device has joined the Thread network as a router (or a child).
|
|
|
|
## Extension commands
|
|
|
|
You can refer to the [extension command](https://github.com/espressif/esp-thread-br/blob/main/components/esp_ot_cli_extension/README.md) about the extension commands.
|
|
|
|
The following examples are supported by `ot_cli`:
|
|
|
|
* TCP and UDP Example
|
|
|
|
## Using iPerf to measure bandwidth
|
|
|
|
iPerf is a tool used to obtain TCP or UDP throughput on the Thread network. To run iPerf, you need to have two Thread devices on the same network.
|
|
|
|
Refer to [the iperf-cmd component](https://components.espressif.com/components/espressif/iperf-cmd) for details on specific configurations.
|
|
|
|
### Typical usage on a thread network
|
|
|
|
For measuring the TCP throughput, first create an iperf service on one node:
|
|
```bash
|
|
> iperf -V -s -t 20 -i 3 -p 5001 -f k
|
|
Done
|
|
```
|
|
|
|
Then create an iperf client connecting to the service on another node. Note that the [ML-EID](https://openthread.io/guides/thread-primer/ipv6-addressing#unicast_address_types) address is used for iperf.
|
|
|
|
```bash
|
|
> ipaddr mleid
|
|
fdde:ad00:beef:0:a7c6:6311:9c8c:271b
|
|
Done
|
|
|
|
> iperf -V -c fdde:ad00:beef:0:a7c6:6311:9c8c:271b -t 20 -i 1 -p 5001 -l 85 -f k
|
|
Done
|
|
[ ID] Interval Transfer Bandwidth
|
|
[ 1] 0.0- 1.0 sec 3.15 KBytes 25.16 Kbits/sec
|
|
[ 1] 1.0- 2.0 sec 2.89 KBytes 23.12 Kbits/sec
|
|
[ 1] 2.0- 3.0 sec 2.98 KBytes 23.80 Kbits/sec
|
|
...
|
|
[ 1] 9.0-10.0 sec 2.55 KBytes 20.40 Kbits/sec
|
|
[ 1] 0.0-10.0 sec 27.80 KBytes 22.24 Kbits/sec
|
|
```
|
|
|
|
For measuring the UDP throughput, first create an iperf service similarly:
|
|
|
|
```bash
|
|
> iperf -V -u -s -t 20 -i 3 -p 5001 -f k
|
|
Done
|
|
```
|
|
|
|
Then create an iperf client:
|
|
|
|
```bash
|
|
> iperf -V -u -c fdde:ad00:beef:0:a7c6:6311:9c8c:271b -t 20 -i 1 -p 5001 -l 85 -f k
|
|
Done
|
|
```
|