Skip to content

Commit

Permalink
Merge branch 'contrib/github_pr_12039_v4.4' into 'release/v4.4'
Browse files Browse the repository at this point in the history
docs(iperf): Update documentation with console interface details(v4.4)

See merge request espressif/esp-idf!25513
  • Loading branch information
jack0c committed Aug 30, 2023
2 parents 8ec3b60 + 64c10df commit 937b82e
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions examples/wifi/iperf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,35 @@ frequency to 80MHz, please make sure R140~R145 are removed from ESP-WROVER-KIT o
This example implements the protocol used by the common performance measurement tool [iPerf](https://iperf.fr/).
Performance can be measured between two ESP32s running this example, or between a single ESP32 and a computer running the iPerf tool

Demo steps to test station TCP Tx performance:
Demo steps to test station TCP Tx performance:
1. Configure in `menuconfig` which serial output you are using. Execute `idf.py menuconfig` and go to `Component config/ESP System Settings/Channel for console output`, then select the appropiate interface. By default the UART0 interface is used, this means that for example in the ESP32-S3-DevKitC-1 you should connect to the micro-usb connector labeled as UART and not to the one labeled as USB. To use the one labeled as USB you should change the aforementioned setting to `USB Serial/JTAG Controller`.

1. Build the iperf example with sdkconfig.defaults, which contains performance test specific configurations
2. Build the iperf example with sdkconfig.defaults, which contains performance test specific configurations

2. Run the demo as station mode and join the target AP
3. Run the demo as station mode and join the target AP
sta ssid password

3. Run iperf as server on AP side
4. Run iperf as server on AP side
iperf -s -i 3

4. Run iperf as client on ESP32 side
5. Run iperf as client on ESP32 side
iperf -c 192.168.10.42 -i 3 -t 60

The console output, which is printed by station TCP RX throughput test, looks like:

>esp32> sta aptest
>iperf> sta aptest
>
>I (5325) iperf: sta connecting to 'aptest'
>
>esp32> I (6017) event: ip: 192.168.10.248, mask: 255.255.255.0, gw: 192.168.10.1
>iperf> I (6017) event: ip: 192.168.10.248, mask: 255.255.255.0, gw: 192.168.10.1
>
>esp32> iperf -s -i 3 -t 1000
>iperf> iperf -s -i 3 -t 1000
>
>I (14958) iperf: mode=tcp-server sip=192.168.10.248:5001, dip=0.0.0.0:5001, interval=3, time=1000
>
>Interval Bandwidth
>
>esp32> accept: 192.168.10.42,62958
>iperf> accept: 192.168.10.42,62958
>
>0- 3 sec 8.43 Mbits/sec
>
Expand Down

0 comments on commit 937b82e

Please sign in to comment.