alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
93b64fd6d6
esp-idf/examples/wifi/iperf
History
xuxiao b25e486cd6 feat(wifi): optimize iperf performance (Backport V4.4)
2023-10-13 11:36:03 +08:00
..
main feat(wifi): optimize iperf performance (Backport V4.4) 2023-10-13 11:36:03 +08:00
CMakeLists.txt examples: unify iperf component 2021-07-16 11:59:52 +08:00
iperf_test.py Added bandwidth limitaion option to iperf test scripts 2022-04-06 10:44:31 +00:00
Makefile examples: unify iperf component 2021-07-16 11:59:52 +08:00
README.md docs(iperf): Update documentation with console interface details 2023-08-23 19:53:43 +08:00
sdkconfig.ci.00 examples: fix sdkconfig warnings 2019-11-21 15:36:06 +01:00
sdkconfig.ci.01 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.ci.02 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.ci.03 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.ci.04 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.ci.05 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.ci.06 examples: fix sdkconfig warnings 2019-11-21 15:36:06 +01:00
sdkconfig.ci.07 examples: fix sdkconfig warnings 2019-11-21 15:36:06 +01:00
sdkconfig.ci.99 test: support multiple targets for iperf example test 2021-05-20 16:58:38 +08:00
sdkconfig.defaults feat(wifi): optimize iperf performance (Backport V4.4) 2023-10-13 11:36:03 +08:00
sdkconfig.defaults.esp32 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.defaults.esp32c3 update esp32c3 iperf config 2021-04-27 14:41:08 +08:00
sdkconfig.defaults.esp32s2 Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdkconfig.defaults.esp32s3 add docs "How to improve Wi-Fi performance" in api-guides for esp32s3. 2021-10-11 15:08:02 +08:00

README.md

Iperf Example

Note about iperf version

The iperf example doesn't support all features in standard iperf. It's compitable with iperf version 2.x.

Note about 80MHz flash frequency

The iperf can get better throughput if the SPI flash frequency is set to 80MHz, but the system may crash in 80MHz mode for ESP-WROVER-KIT. Removing R140~R145 from the board can fix this issue. Currently the default SPI frequency is set to 40MHz, if you want to change the SPI flash frequency to 80MHz, please make sure R140~R145 are removed from ESP-WROVER-KIT or use ESP32 DevKitC.

Introduction

This example implements the protocol used by the common performance measurement tool iPerf. 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:

  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.

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

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

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

  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:

iperf> sta aptest

I (5325) iperf: sta connecting to 'aptest'

iperf> I (6017) event: ip: 192.168.10.248, mask: 255.255.255.0, gw: 192.168.10.1

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

iperf> accept: 192.168.10.42,62958

0- 3 sec 8.43 Mbits/sec

3- 6 sec 36.16 Mbits/sec

6- 9 sec 36.22 Mbits/sec

9- 12 sec 36.44 Mbits/sec

12- 15 sec 36.25 Mbits/sec

15- 18 sec 24.36 Mbits/sec

18- 21 sec 27.79 Mbits/sec

Steps to test station/soft-AP TCP/UDP RX/TX throughput are similar as test steps in station TCP TX.

See the README.md file in the upper level 'examples' directory for more information about examples.