esp_wifi_get_bandwidth() function

Get the bandwidth of specified interface @attention 1. Can not get WiFi bandwidth under band mode 2.4G + 5G (WIFI_BAND_MODE_AUTO), you can use esp_wifi_get_bandwidths instead @attention 2. API return ESP_ERR_NOT_SUPPORTED if the band mode is set to 2.4G + 5G (WIFI_BAND_MODE_AUTO)

Syntax

Show:

Summary

Declaration

from esp_wifi.h:758

esp_err_t esp_wifi_get_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t *bw);

Arguments

Argument

Description

ifx

interface to be configured

store bandwidth of interface ifx

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init - ESP_ERR_WIFI_IF: invalid interface - ESP_ERR_INVALID_ARG: invalid argument - ESP_ERR_NOT_SUPPORTED: This API is not supported when the band mode is set to 2.4G + 5G (WIFI_BAND_MODE_AUTO)

Examples

esp_wifi_get_bandwidth() is referenced by 1 libraries and example projects:

References

from examples

esp_wifi_get_bandwidth() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle