espressif/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feat/update_wifi_iperf_example_v6.0' into 'release/v6.0'

Browse Source 
Feat: update wifi iperf example v6.0

See merge request espressif/esp-idf!46083
This commit is contained in:
Jiang Jiang Jian
2026-03-21 14:08:09 +08:00
parent 9c6ca38ab3 6deb4fc73d
commit ca95f699ad
15 changed files with 91 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/bluetooth/esp_ble_mesh/wifi_coexist/main/cmd_wifi.c
+1 -154
View File
@@ -1,7 +1,7 @@
/*
* Iperf example - wifi commands
*
* SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2021-2026 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Unlicense OR CC0-1.0
*/
@@ -18,21 +18,6 @@
#include "freertos/event_groups.h"
#include "esp_wifi.h"
#include "esp_netif.h"
#include "iperf.h"
typedef struct {
struct arg_str *ip;
struct arg_lit *server;
struct arg_lit *udp;
struct arg_lit *version;
struct arg_int *port;
struct arg_int *length;
struct arg_int *interval;
struct arg_int *time;
struct arg_lit *abort;
struct arg_end *end;
} wifi_iperf_t;
static wifi_iperf_t iperf_args;
typedef struct {
struct arg_str *ssid;
@@ -293,124 +278,6 @@ static int wifi_cmd_query(int argc, char **argv)
return 0;
}
static uint32_t wifi_get_local_ip(void)
{
int bits = xEventGroupWaitBits(wifi_event_group, CONNECTED_BIT, 0, 1, 0);
esp_netif_t *ifx = ap_netif;
esp_netif_ip_info_t ip_info;
wifi_mode_t mode;
esp_wifi_get_mode(&mode);
if (WIFI_MODE_STA == mode) {
bits = xEventGroupWaitBits(wifi_event_group, CONNECTED_BIT, 0, 1, 0);
if (bits & CONNECTED_BIT) {
ifx = sta_netif;
} else {
ESP_LOGE(TAG, "sta has no IP");
return 0;
}
}
esp_netif_get_ip_info(ifx, &ip_info);
return ip_info.ip.addr;
}
static int wifi_cmd_iperf(int argc, char **argv)
{
int nerrors = arg_parse(argc, argv, (void **) &iperf_args);
iperf_cfg_t cfg;
if (nerrors != 0) {
arg_print_errors(stderr, iperf_args.end, argv[0]);
return 0;
}
memset(&cfg, 0, sizeof(cfg));
// wifi iperf only support IPV4 address
cfg.type = IPERF_IP_TYPE_IPV4;
if ( iperf_args.abort->count != 0) {
iperf_stop();
return 0;
}
if ( ((iperf_args.ip->count == 0) && (iperf_args.server->count == 0)) ||
((iperf_args.ip->count != 0) && (iperf_args.server->count != 0)) ) {
ESP_LOGE(TAG, "should specific client/server mode");
return 0;
}
if (iperf_args.ip->count == 0) {
cfg.flag |= IPERF_FLAG_SERVER;
} else {
cfg.destination_ip4 = esp_ip4addr_aton(iperf_args.ip->sval[0]);
cfg.flag |= IPERF_FLAG_CLIENT;
}
cfg.source_ip4 = wifi_get_local_ip();
if (cfg.source_ip4 == 0) {
return 0;
}
if (iperf_args.length->count == 0) {
cfg.len_send_buf = 0;
} else {
cfg.len_send_buf = iperf_args.length->ival[0];
}
if (iperf_args.udp->count == 0) {
cfg.flag |= IPERF_FLAG_TCP;
} else {
cfg.flag |= IPERF_FLAG_UDP;
}
if (iperf_args.port->count == 0) {
cfg.sport = IPERF_DEFAULT_PORT;
cfg.dport = IPERF_DEFAULT_PORT;
} else {
if (cfg.flag & IPERF_FLAG_SERVER) {
cfg.sport = iperf_args.port->ival[0];
cfg.dport = IPERF_DEFAULT_PORT;
} else {
cfg.sport = IPERF_DEFAULT_PORT;
cfg.dport = iperf_args.port->ival[0];
}
}
if (iperf_args.interval->count == 0) {
cfg.interval = IPERF_DEFAULT_INTERVAL;
} else {
cfg.interval = iperf_args.interval->ival[0];
if (cfg.interval <= 0) {
cfg.interval = IPERF_DEFAULT_INTERVAL;
}
}
if (iperf_args.time->count == 0) {
cfg.time = IPERF_DEFAULT_TIME;
} else {
cfg.time = iperf_args.time->ival[0];
if (cfg.time <= cfg.interval) {
cfg.time = cfg.interval;
}
}
ESP_LOGI(TAG, "mode=%s-%s sip=%" PRIu32 ".%" PRIu32 ".%" PRIu32 ".%" PRIu32 ":%d, \
dip=%" PRIu32 ".%" PRIu32 ".%" PRIu32 ".%" PRIu32 ":%d, interval=%" PRIu32 ", time=%" PRIu32,
cfg.flag & IPERF_FLAG_TCP ? "tcp" : "udp",
cfg.flag & IPERF_FLAG_SERVER ? "server" : "client",
cfg.source_ip4 & 0xFF, (cfg.source_ip4 >> 8) & 0xFF, (cfg.source_ip4 >> 16) & 0xFF,
(cfg.source_ip4 >> 24) & 0xFF, cfg.sport,
cfg.destination_ip4 & 0xFF, (cfg.destination_ip4 >> 8) & 0xFF, (cfg.destination_ip4 >> 16) & 0xFF,
(cfg.destination_ip4 >> 24) & 0xFF, cfg.dport,
cfg.interval, cfg.time);
iperf_start(&cfg);
return 0;
}
static int restart(int argc, char **argv)
{
ESP_LOGI(TAG, "Restarting");
@@ -484,26 +351,6 @@ void register_wifi(void)
};
ESP_ERROR_CHECK( esp_console_cmd_register(&restart_cmd) );
iperf_args.ip = arg_str0("c", "client", "<ip>", "run in client mode, connecting to <host>");
iperf_args.server = arg_lit0("s", "server", "run in server mode");
iperf_args.udp = arg_lit0("u", "udp", "use UDP rather than TCP");
iperf_args.version = arg_lit0("V", "ipv6_domain", "use IPV6 address rather than IPV4");
iperf_args.port = arg_int0("p", "port", "<port>", "server port to listen on/connect to");
iperf_args.length = arg_int0("l", "len", "<length>", "set read/write buffer size");
iperf_args.interval = arg_int0("i", "interval", "<interval>", "seconds between periodic bandwidth reports");
iperf_args.time = arg_int0("t", "time", "<time>", "time in seconds to transmit for (default 10 secs)");
iperf_args.abort = arg_lit0("a", "abort", "abort running iperf");
iperf_args.end = arg_end(1);
const esp_console_cmd_t iperf_cmd = {
.command = "iperf",
.help = "iperf command",
.hint = NULL,
.func = &wifi_cmd_iperf,
.argtable = &iperf_args
};
ESP_ERROR_CHECK( esp_console_cmd_register(&iperf_cmd) );
const esp_console_cmd_t heap_cmd = {
.command = "heap",
.help = "get min free heap size during test",
examples/bluetooth/esp_ble_mesh/wifi_coexist/main/idf_component.yml
+2 -2
View File
@@ -3,5 +3,5 @@ dependencies:
path: ${IDF_PATH}/examples/bluetooth/esp_ble_mesh/common_components/fast_prov
example_init:
path: ${IDF_PATH}/examples/bluetooth/esp_ble_mesh/common_components/example_init
espressif/iperf:
version: "~0.1.1"
espressif/iperf-cmd:
version: "^1.0.2"
examples/bluetooth/esp_ble_mesh/wifi_coexist/main/main.c
+3
View File
@@ -39,6 +39,8 @@
#include "ble_mesh_fast_prov_server_model.h"
#include "ble_mesh_example_init.h"
#include "iperf_cmd.h"
#define TAG "EXAMPLE"
extern struct _led_state led_state[3];
@@ -772,6 +774,7 @@ static void wifi_console_init(void)
/* Register commands */
register_wifi();
iperf_cmd_register_iperf();
printf("\n ==================================================\n");
printf(" | Steps to test WiFi throughput |\n");
examples/bluetooth/esp_ble_mesh/wifi_coexist/tutorial/BLE_Mesh_WiFi_Coexist_Example_Walkthrough.md
+1 -1
View File
@@ -6,7 +6,7 @@ This demo demonstrates the Wi-Fi and Bluetooth (BLE/BR/EDR) coexistence feature
* The Bluetooth function is demonstrated by the fast provisioning function. Details can be seen in `fast_prov_server`.
> Note: In this demo, you call wifi API and bluetooth API to achieve the functions you want. such as `wifi_get_local_ip` API and `esp_ble_mesh_provisioner_add_unprov_dev` API.
> Note: In this demo, you call wifi API and bluetooth API to achieve the functions you want. such as `esp_wifi_sta_get_ap_info` API and `esp_ble_mesh_provisioner_add_unprov_dev` API.
# What You Need
examples/ethernet/iperf/main/ethernet_iperf_main.c
+1 -1
View File
@@ -114,7 +114,7 @@ void app_main(void)
/* Register commands */
register_system_common();
app_register_iperf_commands();
iperf_cmd_register_iperf();
register_ethernet_commands();
printf("\n =======================================================\n");
examples/ethernet/iperf/main/idf_component.yml
+2 -2
View File
@@ -2,6 +2,6 @@ dependencies:
cmd_system:
path: ${IDF_PATH}/examples/system/console/advanced/components/cmd_system
espressif/ethernet_init:
version: "~1.2.0"
version: "~1.3.0"
espressif/iperf-cmd:
version: "~0.1.1"
version: "~1.0.2"
examples/ethernet/iperf/sdkconfig.defaults
+2
View File
@@ -11,6 +11,8 @@ CONFIG_PARTITION_TABLE_FILENAME="partitions_example.csv"
CONFIG_FREERTOS_USE_TRACE_FACILITY=y
CONFIG_FREERTOS_USE_STATS_FORMATTING_FUNCTIONS=y
CONFIG_FREERTOS_IN_IRAM=y
# --------------------------------
# Performance optimization options
# --------------------------------
examples/openthread/ot_common_components/ot_examples_common/idf_component.yml
+1 -1
View File
@@ -1,5 +1,5 @@
## IDF Component Manager Manifest File
dependencies:
espressif/iperf-cmd: "^1.0.0"
espressif/iperf-cmd: "^1.0.2"
cmd_system:
path: ${IDF_PATH}/examples/system/console/advanced/components/cmd_system
examples/wifi/getting_started/station/main/CMakeLists.txt
+1 -1
View File
@@ -1,3 +1,3 @@
idf_component_register(SRCS "station_example_main.c"
PRIV_REQUIRES esp_wifi nvs_flash bt
PRIV_REQUIRES esp_wifi nvs_flash
INCLUDE_DIRS ".")
examples/wifi/iperf/main/idf_component.yml
+1 -1
View File
@@ -2,7 +2,7 @@ dependencies:
cmd_system:
path: ${IDF_PATH}/examples/system/console/advanced/components/cmd_system
espressif/iperf-cmd:
version: "~0.1.3"
version: "~1.0.2"
esp-qa/wifi-cmd:
version: "~0.2.7"
esp-qa/ping-cmd:
examples/wifi/iperf/main/iperf_example_main.c
+9 -9
View File
@@ -39,29 +39,29 @@ extern int wifi_cmd_clr_rx_statistics(int argc, char **argv);
#include "esp_extconn.h"
#endif
void iperf_hook_show_wifi_stats(iperf_traffic_type_t type, iperf_status_t status)
void iperf_hook_show_wifi_stats(iperf_id_t instance_id, iperf_state_data_t *data, void *priv)
{
if (status == IPERF_STARTED) {
if (data->state == IPERF_STARTED) {
#if CONFIG_ESP_WIFI_ENABLE_WIFI_TX_STATS
if (type != IPERF_UDP_SERVER) {
if (data->traffic_type != IPERF_UDP_SERVER) {
wifi_cmd_clr_tx_statistics(0, NULL);
}
#endif
#if CONFIG_ESP_WIFI_ENABLE_WIFI_RX_STATS
if (type != IPERF_UDP_CLIENT) {
if (data->traffic_type != IPERF_UDP_CLIENT) {
wifi_cmd_clr_rx_statistics(0, NULL);
}
#endif
}
if (status == IPERF_STOPPED) {
if (data->state == IPERF_STOPPED) {
#if CONFIG_ESP_WIFI_ENABLE_WIFI_TX_STATS
if (type != IPERF_UDP_SERVER) {
if (data->traffic_type != IPERF_UDP_SERVER) {
wifi_cmd_get_tx_statistics(0, NULL);
}
#endif
#if CONFIG_ESP_WIFI_ENABLE_WIFI_RX_STATS
if (type != IPERF_UDP_CLIENT) {
if (data->traffic_type != IPERF_UDP_CLIENT) {
wifi_cmd_get_rx_statistics(0, NULL);
}
#endif
@@ -132,8 +132,8 @@ void app_main(void)
/* From wifi-cmd */
wifi_cmd_register_all();
/* From iperf-cmd */
app_register_iperf_commands();
app_register_iperf_hook_func(iperf_hook_show_wifi_stats);
iperf_cmd_register_iperf();
iperf_cmd_set_iperf_state_handler(iperf_hook_show_wifi_stats, NULL);
/* From ping-cmd */
ping_cmd_register_ping();
examples/wifi/iperf/sdkconfig.ci.99
+1
View File
@@ -0,0 +1 @@
CONFIG_LWIP_EXTRA_IRAM_OPTIMIZATION=y
examples/wifi/iperf/sdkconfig.defaults
+1 -2
View File
@@ -2,6 +2,7 @@ CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE=4096
CONFIG_FREERTOS_UNICORE=n
CONFIG_FREERTOS_HZ=1000
CONFIG_FREERTOS_IN_IRAM=y
CONFIG_ESP_INT_WDT=n
CONFIG_ESP_TASK_WDT_EN=n
@@ -9,8 +10,6 @@ CONFIG_ESP_TASK_WDT_EN=n
CONFIG_LWIP_IRAM_OPTIMIZATION=y
CONFIG_LWIP_TCPIP_TASK_PRIO=23
CONFIG_IPERF_TRAFFIC_TASK_PRIORITY=23
CONFIG_IPERF_REPORT_TASK_PRIORITY=24
CONFIG_COMPILER_OPTIMIZATION_PERF=y
CONFIG_PARTITION_TABLE_SINGLE_APP_LARGE=y