mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

xuxiao 9d1f3d0d16 feat(example): modify iperf sdkconfig to imporve iperf performance		2024-01-16 10:50:18 +08:00
..
main	feat(examples): add local components via idf_component.yml	2023-09-19 10:38:24 +02:00
CMakeLists.txt	feat(examples): add local components via idf_component.yml	2023-09-19 10:38:24 +02:00
pytest_iperf.py	fix(ci): remove useless example iperf sdkconfigs	2023-09-08 15:42:33 +08:00
README.md	docs(iperf): Update documentation with console interface details	2023-08-10 16:07:07 +08:00
sdkconfig.ci.99	test: support multiple targets for iperf example test	2021-05-20 16:58:38 +08:00
sdkconfig.defaults	feat(example): modify iperf sdkconfig to imporve iperf performance	2024-01-16 10:50:18 +08:00
sdkconfig.defaults.esp32	esp_wifi: Merge wpa_supplicant and esp_wifi Kconfig	2023-02-11 07:38:45 +08:00
sdkconfig.defaults.esp32c2	feat(example): modify iperf sdkconfig to imporve iperf performance	2024-01-16 10:50:18 +08:00
sdkconfig.defaults.esp32c3	feat(example): modify iperf sdkconfig to imporve iperf performance	2024-01-16 10:50:18 +08:00
sdkconfig.defaults.esp32c6	feat(example): modify iperf sdkconfig to imporve iperf performance	2024-01-16 10:50:18 +08:00
sdkconfig.defaults.esp32s2	feat(example): modify iperf sdkconfig to imporve iperf performance	2024-01-16 10:50:18 +08:00
sdkconfig.defaults.esp32s3	esp_wifi: Merge wpa_supplicant and esp_wifi Kconfig	2023-02-11 07:38:45 +08:00

README.md

Supported Targets	ESP32	ESP32-C2	ESP32-C3	ESP32-C6	ESP32-S2	ESP32-S3

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:

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 or ESP32-C6-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.
Build the iperf example with sdkconfig.defaults, which contains performance test specific configurations
Run the demo as station mode and join the target AP sta ssid password
Run iperf as server on AP side iperf -s -i 3
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.