diff --git a/examples/openthread/extension_command/README.md b/examples/openthread/extension_command/README.md index 113f5932dd..664a44bf0d 100644 --- a/examples/openthread/extension_command/README.md +++ b/examples/openthread/extension_command/README.md @@ -1,15 +1,16 @@ -# Openthread Extension Command +# Openthread Extension Commands -The Openthread Extension Command is a series of command lines extended from [OpenThread CLI](https://github.com/openthread/openthread/blob/main/src/cli/README.md). -Openthread Extension Command doesn't run alone, it needs to be used in conjunction with these examples: +The ESP OpenThread examples provide a series of extension commands in addition to the standard [OpenThread CLI](https://github.com/openthread/openthread/blob/main/src/cli/README.md). +The extension commands are available in the following examples: * [ot_cli](../ot_cli) * [ot_br](../ot_br) -## How to use the example +## Enabling the extension commands -Run the configuration command `idf.py menuconfig` to enable the operations you need for your example: `OpenThread Extension CLI` -> `Enable Espressif's extended features`. +To enable OpenThread extension commands, the following Kconfig option needs to be enabled: +`OpenThread Extension CLI` -> `Enable Espressif's extended features`. -## OT Extension Command Line List +## Commands * [iperf](#iperf) * [tcpsockclient](#tcpsockclient) @@ -20,40 +21,39 @@ Run the configuration command `idf.py menuconfig` to enable the operations you n ### iperf -Iperf is a tool for active measurements of the maximum achievable bandwidth on Thread network, which is based TCP and UDP. +Iperf is a tool for performing TCP or UDP throughput on the Thread network. + +For running iperf, you need to have two Thread devices on the same network. + +* General Options -Print the iperf help: ```bash iperf ---iperf parameter--- -s : server mode, only receive -u : upd mode --V : use IPV6 address +-V : use IPV6 address -c : client mode, only transmit -i : seconds between periodic bandwidth reports -t