Chapter 4. API Guides
Field Description
ssid SSID of AP; if the ssid[0] is 0xFF and ssid[1] is 0xFF, the AP defaults the SSID to ESP_aabbcc,
where “aabbcc”is the last three bytes of the AP MAC.
pass-
word
Password of AP; if the auth mode is WIFI_AUTH_OPEN, this field will be ignored.
ssid_len Length of SSID; if ssid_len is 0, check the SSID until there is a termination character. If ssid_len >
32, change it to 32; otherwise, set the SSID length according to ssid_len.
channel Channel of AP; if the channel is out of range, the Wi-Fi driver defaults the channel to channel 1. So,
please make sure the channel is within the required range. For more details, refer to Wi-Fi Country
Code.
auth-
mode
Auth mode of ESP AP; currently, ESP Wi-Fi does not support AUTH_WEP. If the authmode is an
invalid value, AP defaults the value to WIFI_AUTH_OPEN.
ssid_hiddenIf ssid_hidden is 1, AP does not broadcast the SSID; otherwise, it does broadcast the SSID.
max_connectionCurrently, ESP Wi-Fi supports up to 10 Wi-Fi connections. If max_connection > 10, AP defaults the
value to 10.
bea-
con_interval
Beacon interval; the value is 100 ~ 60000 ms, with default value being 100 ms. If the value is out of
range, AP defaults it to 100 ms.
Wi-Fi Protocol Mode
Currently, the IDF supports the following protocol modes:
Pro-
tocol
Mode
Description
802.11
B
Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B) to set the station/AP to 802.11B-only mode.
802.11
BG
Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_ PROTOCOL_11G) to set the sta-
tion/AP to 802.11BG mode.
802.11
BGN
Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B| WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N)
to set the station/ AP to BGN mode.
802.11
BGNLR
Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B| WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N|WIFI_PROTOCOL_LR)
to set the station/AP to BGN and the Espressif-specific mode.
802.11
LR
Call esp_wifi_set_protocol (ifx, WIFI_PROTOCOL_LR) to set the station/AP only to the Espressif-
specific mode.
This mode is an Espressif-patented mode which can achieve a one-kilometer line of sight range.
Please, make sure both the station and the AP are connected to an ESP device
Long Range (LR)
Long Range (LR) mode is an Espressif-patented Wi-Fi mode which can achieve a one-kilometer line of sight range. It
has better reception sensitivity, stronger anti-interference ability and longer transmission distance than the traditional
802.11B mode.
LR Compatibility Since LR is Espressif unique Wi-Fi mode, only ESP32-S2 devices can transmit and receive the
LR data. In other words, the ESP32-S2 device should NOT transmit the data in LR data rate if the connected device
doesn’t support LR. The application can achieve this by configuring suitable Wi-Fi mode. If the negotiated mode
supports LR, the ESP32-S2 may transmit data in LR rate, otherwise, ESP32-S2 will transmit all data in traditional
Wi-Fi data rate.
Following table depicts the Wi-Fi mode negotiation:
Espressif Systems 1534
Submit Document Feedback
Release v4.4