mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
129 lines
2.8 KiB
Markdown
129 lines
2.8 KiB
Markdown
| Supported Targets | ESP32-C6 | ESP32-H4 |
|
|
| ----------------- | -------- | -------- |
|
|
|
|
# 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, an ESP32-H4 board is required.
|
|
|
|
### Configure the project
|
|
|
|
```
|
|
idf.py menuconfig
|
|
```
|
|
|
|
The example can run with the default configuration.
|
|
|
|
### 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
|
|
> 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-H4 boards flashed with this ot_cli example are required.
|
|
|
|
On the first device, run the following commands:
|
|
```bash
|
|
> factoryreset
|
|
... # the device will reboot
|
|
|
|
> dataset init new
|
|
Done
|
|
> dataset commit active
|
|
Done
|
|
> ifconfig up
|
|
Done
|
|
> thread start
|
|
Done
|
|
|
|
# After some seconds
|
|
|
|
> 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
|
|
> 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
|
|
> dataset active -x
|
|
0e080000000000010000000300001835060004001fffe00208fe7bb701f5f1125d0708fd75cbde7c6647bd0510b3914792d44f45b6c7d76eb9306eec94030f4f70656e5468726561642d35383332010258320410e35c581af5029b054fc904a24c2b27700c0402a0fff8
|
|
```
|
|
|
|
On the second device, set the active dataset from leader, and start Thread interface:
|
|
```bash
|
|
> factoryreset
|
|
... # the device will reboot
|
|
|
|
> dataset set active 0e080000000000010000000300001835060004001fffe00208fe7bb701f5f1125d0708fd75cbde7c6647bd0510b3914792d44f45b6c7d76eb9306eec94030f4f70656e5468726561642d35383332010258320410e35c581af5029b054fc904a24c2b27700c0402a0fff8
|
|
> ifconfig up
|
|
Done
|
|
> thread start
|
|
Done
|
|
|
|
# After some seconds
|
|
|
|
> 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
|
|
* Iperf Example
|
|
|