esp-idf/examples/common_components/iperf/README.md

15 lines
601 B
Markdown
Raw Normal View History

2021-07-07 03:18:20 -04:00
# iperf Component
This directory contains an implementation for iperf network performance tester
Note that it's incompatible with `iperf3`
This component is used as part of the following ESP-IDF examples:
- [esp_wifi](../../wifi/iperf).
- [ble_mesh_wifi_coexist](../../bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist).
- [ethernet](../../ethernet/iperf)
To learn more about how to use this component, please check API Documentation from header file [iperf.h](./include/iperf.h).
Please note that this component is not considered to be a part of ESP-IDF stable API, and only for example use for now.