ESPHome 2026.10.0-dev
Loading...
Searching...
No Matches
wifi_component_esp8266.cpp
Go to the documentation of this file.
1#include "wifi_component.h"
3
4#ifdef USE_WIFI
5#ifdef USE_ESP8266
6
7#include <user_interface.h>
8
9#include <cassert>
10#include <utility>
11#include <algorithm>
12#ifdef USE_WIFI_WPA2_EAP
13#include <wpa2_enterprise.h>
14#endif
15
16extern "C" {
17#include "lwip/err.h"
18#include "lwip/dns.h"
19#include "lwip/dhcp.h"
20#include "lwip/init.h" // LWIP_VERSION_
21#include "lwip/apps/sntp.h"
22#include "lwip/netif.h" // struct netif
23#include <AddrList.h>
24#include "LwipDhcpServer.h"
25#if USE_ARDUINO_VERSION_CODE < VERSION_CODE(3, 1, 0)
26#include <ESP8266WiFi.h>
27#include "ESP8266WiFiAP.h"
28#define wifi_softap_set_dhcps_lease(lease) dhcpSoftAP.set_dhcps_lease(lease)
29#define wifi_softap_set_dhcps_lease_time(time) dhcpSoftAP.set_dhcps_lease_time(time)
30#define wifi_softap_set_dhcps_offer_option(offer, mode) dhcpSoftAP.set_dhcps_offer_option(offer, mode)
31#endif
32}
33
35#include "esphome/core/hal.h"
37#include "esphome/core/log.h"
39#include "esphome/core/util.h"
40
41namespace esphome::wifi {
42
43static const char *const TAG = "wifi_esp8266";
44
45enum class ESP8266WiFiSTAState : uint8_t {
46 IDLE, // Not connecting
47 CONNECTING, // Connection in progress
48 ASSOCIATED, // Associated to AP, waiting for IP
49 CONNECTED, // Successfully connected with IP
50 ERROR_NOT_FOUND, // AP not found (probe failed)
51 ERROR_FAILED, // Connection failed (auth, timeout, etc.)
52};
53
54bool WiFiComponent::wifi_mode_(optional<bool> sta, optional<bool> ap) {
55 uint8_t current_mode = wifi_get_opmode();
56 bool current_sta = current_mode & 0b01;
57 bool current_ap = current_mode & 0b10;
58 bool target_sta = sta.value_or(current_sta);
59 bool target_ap = ap.value_or(current_ap);
60 if (current_sta == target_sta && current_ap == target_ap)
61 return true;
62
63 if (target_sta && !current_sta) {
64 ESP_LOGV(TAG, "Enabling STA");
65 } else if (!target_sta && current_sta) {
66 ESP_LOGV(TAG, "Disabling STA");
67 // Stop DHCP client when disabling STA
68 // See https://github.com/esp8266/Arduino/pull/5703
69 wifi_station_dhcpc_stop();
70 }
71 if (target_ap && !current_ap) {
72 ESP_LOGV(TAG, "Enabling AP");
73 } else if (!target_ap && current_ap) {
74 ESP_LOGV(TAG, "Disabling AP");
75 }
76
77 ETS_UART_INTR_DISABLE();
78 uint8_t mode = 0;
79 if (target_sta)
80 mode |= 0b01;
81 if (target_ap)
82 mode |= 0b10;
83 bool ret = wifi_set_opmode_current(mode);
84 ETS_UART_INTR_ENABLE();
85
86 if (!ret) {
87 ESP_LOGW(TAG, "Set mode failed");
88 return false;
89 }
90
91 this->ap_started_ = target_ap;
92
93 return ret;
94}
96 // ESP8266 sleep types have confusing names — LIGHT_SLEEP_T is the MORE aggressive mode.
97 // SDK enum: NONE_SLEEP_T=0, LIGHT_SLEEP_T=1, MODEM_SLEEP_T=2
98 // https://github.com/esp8266/Arduino/blob/3.1.2/tools/sdk/include/user_interface.h#L447-L451
99 // Arduino ESP32 compat confirms: WIFI_PS_MIN_MODEM=MODEM_SLEEP, WIFI_PS_MAX_MODEM=LIGHT_SLEEP
100 // https://github.com/esp8266/Arduino/blob/3.1.2/libraries/ESP8266WiFi/src/ESP8266WiFiType.h#L53-L55
101 sleep_type_t power_save;
102 switch (this->power_save_) {
104 // MODEM_SLEEP_T: only the WiFi modem sleeps between DTIM beacons, CPU stays active.
105 // Matches ESP32's WIFI_PS_MIN_MODEM.
106 power_save = MODEM_SLEEP_T;
107 break;
109 // LIGHT_SLEEP_T: both WiFi modem AND CPU suspend between DTIM beacons.
110 // Most aggressive — prevents TCP processing during sleep. Matches ESP32's WIFI_PS_MAX_MODEM.
111 // See https://github.com/esphome/esphome/issues/14999
112 power_save = LIGHT_SLEEP_T;
113 break;
115 default:
116 power_save = NONE_SLEEP_T;
117 break;
118 }
119 wifi_fpm_auto_sleep_set_in_null_mode(1);
120 bool success = wifi_set_sleep_type(power_save);
121#ifdef USE_WIFI_POWER_SAVE_LISTENERS
122 if (success) {
123 for (auto *listener : this->power_save_listeners_) {
124 listener->on_wifi_power_save(this->power_save_);
125 }
126 }
127#endif
128 return success;
129}
130
131#if LWIP_VERSION_MAJOR != 1
132/*
133 lwip v2 needs to be notified of IP changes, see also
134 https://github.com/d-a-v/Arduino/blob/0e7d21e17144cfc5f53c016191daca8723e89ee8/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp#L251
135 */
136#undef netif_set_addr // need to call lwIP-v1.4 netif_set_addr()
137#undef netif_set_down // need to call lwIP-v1.4 netif_set_down()
138extern "C" {
139struct netif *eagle_lwip_getif(int netif_index);
140void netif_set_addr(struct netif *netif, const ip4_addr_t *ip, const ip4_addr_t *netmask, const ip4_addr_t *gw);
141void netif_set_down(struct netif *netif);
142};
143
144// The SDK can free its WiFi connection node before taking the STA netif down, letting lwIP
145// timers (e.g. IGMP reports armed by mDNS) transmit into the dead driver and crash in
146// cnx_node_search; taking the netif down first makes the glue drop such frames (#18308).
147static void sta_netif_down() {
148 struct netif *iface = eagle_lwip_getif(STATION_IF);
149 if (iface != nullptr)
150 netif_set_down(iface);
151}
152#endif
153
154bool WiFiComponent::wifi_sta_ip_config_(const optional<ManualIP> &manual_ip) {
155 // enable STA
156 if (!this->wifi_mode_(true, {}))
157 return false;
158
159 enum dhcp_status dhcp_status = wifi_station_dhcpc_status();
160 if (!manual_ip.has_value()) {
161 // lwIP starts the SNTP client if it gets an SNTP server from DHCP. We don't need the time, and more importantly,
162 // the built-in SNTP client has a memory leak in certain situations. Disable this feature.
163 // https://github.com/esphome/issues/issues/2299
164 sntp_servermode_dhcp(false);
165
166 // Use DHCP client
167 if (dhcp_status != DHCP_STARTED) {
168 bool ret = wifi_station_dhcpc_start();
169 if (!ret) {
170 ESP_LOGV(TAG, "Starting DHCP client failed");
171 }
172 return ret;
173 }
174 return true;
175 }
176
177 bool ret = true;
178
179#if LWIP_VERSION_MAJOR != 1
180 // get current->previous IP address
181 // (check below)
182 ip_info previp{};
183 wifi_get_ip_info(STATION_IF, &previp);
184#endif
185
186 struct ip_info info {};
187 info.ip = manual_ip->static_ip;
188 info.gw = manual_ip->gateway;
189 info.netmask = manual_ip->subnet;
190
191 if (dhcp_status == DHCP_STARTED) {
192 bool dhcp_stop_ret = wifi_station_dhcpc_stop();
193 if (!dhcp_stop_ret) {
194 ESP_LOGV(TAG, "Stopping DHCP client failed");
195 ret = false;
196 }
197 }
198 bool wifi_set_info_ret = wifi_set_ip_info(STATION_IF, &info);
199 if (!wifi_set_info_ret) {
200 ESP_LOGV(TAG, "Set manual IP info failed");
201 ret = false;
202 }
203
204 ip_addr_t dns;
205 if (manual_ip->dns1.is_set()) {
206 dns = manual_ip->dns1;
207 dns_setserver(0, &dns);
208 }
209 if (manual_ip->dns2.is_set()) {
210 dns = manual_ip->dns2;
211 dns_setserver(1, &dns);
212 }
213
214#if LWIP_VERSION_MAJOR != 1
215 // trigger address change by calling lwIP-v1.4 api
216 // only when ip is already set by other mean (generally dhcp)
217 if (previp.ip.addr != 0 && previp.ip.addr != info.ip.addr) {
218 netif_set_addr(eagle_lwip_getif(STATION_IF), reinterpret_cast<const ip4_addr_t *>(&info.ip),
219 reinterpret_cast<const ip4_addr_t *>(&info.netmask), reinterpret_cast<const ip4_addr_t *>(&info.gw));
220 }
221#endif
222 return ret;
223}
224
226 if (!this->has_sta())
227 return {};
228 network::IPAddresses addresses;
229 uint8_t index = 0;
230 // addrList enumerates all lwIP netifs, including the SoftAP / fallback hotspot. Filter out
231 // the AP address so the STA address is reported as the device IP (see issue #17181).
232 struct ip_info ap_ip {};
233 wifi_get_ip_info(SOFTAP_IF, &ap_ip);
234 network::IPAddress ap_address(&ap_ip.ip);
235 bool filter_ap = ap_address.is_set();
236 for (auto &addr : addrList) {
237 network::IPAddress ip(addr.ipFromNetifNum());
238 if (filter_ap && ip == ap_address)
239 continue;
240 assert(index < addresses.size());
241 addresses[index++] = ip;
242 }
243 return addresses;
244}
246 const auto &hostname = App.get_name();
247 bool ret = wifi_station_set_hostname(const_cast<char *>(hostname.c_str()));
248 if (!ret) {
249 ESP_LOGV(TAG, "Set hostname failed");
250 }
251
252 // Update hostname on all lwIP interfaces so DHCP packets include it.
253 // lwIP includes the hostname in DHCP DISCOVER/REQUEST automatically
254 // via LWIP_NETIF_HOSTNAME — no dhcp_renew() needed. The hostname is
255 // fixed at compile time and never changes at runtime.
256 for (netif *intf = netif_list; intf; intf = intf->next) {
257#if LWIP_VERSION_MAJOR == 1
258 intf->hostname = (char *) wifi_station_get_hostname();
259#else
260 intf->hostname = wifi_station_get_hostname();
261#endif
262 }
263
264 return ret;
265}
266
268 // enable STA
269 if (!this->wifi_mode_(true, {}))
270 return false;
271
272 this->wifi_disconnect_();
273
274 struct station_config conf {};
275 memset(&conf, 0, sizeof(conf));
276 if (ap.ssid_.size() > sizeof(conf.ssid)) {
277 ESP_LOGE(TAG, "SSID too long");
278 return false;
279 }
280 if (ap.password_.size() > sizeof(conf.password)) {
281 ESP_LOGE(TAG, "Password too long");
282 return false;
283 }
284 memcpy(reinterpret_cast<char *>(conf.ssid), ap.ssid_.c_str(), ap.ssid_.size());
285 memcpy(reinterpret_cast<char *>(conf.password), ap.password_.c_str(), ap.password_.size());
286
287 if (ap.has_bssid()) {
288 conf.bssid_set = 1;
289 memcpy(conf.bssid, ap.get_bssid().data(), 6);
290 } else {
291 conf.bssid_set = 0;
292 }
293
294 if (ap.password_.empty()) {
295 conf.threshold.authmode = AUTH_OPEN;
296 } else {
297 // Set threshold based on configured minimum auth mode
298 // Note: ESP8266 doesn't support WPA3
299 switch (this->min_auth_mode_) {
301 conf.threshold.authmode = AUTH_WPA_PSK;
302 break;
304 case WIFI_MIN_AUTH_MODE_WPA3: // Fall back to WPA2 for ESP8266
305 conf.threshold.authmode = AUTH_WPA2_PSK;
306 break;
307 }
308 }
309 conf.threshold.rssi = -127;
310
311 ETS_UART_INTR_DISABLE();
312 bool ret = wifi_station_set_config_current(&conf);
313 ETS_UART_INTR_ENABLE();
314
315 if (!ret) {
316 ESP_LOGV(TAG, "Set Station config failed");
317 return false;
318 }
319
320#ifdef USE_WIFI_MANUAL_IP
321 if (!this->wifi_sta_ip_config_(ap.get_manual_ip())) {
322 return false;
323 }
324#else
325 if (!this->wifi_sta_ip_config_({})) {
326 return false;
327 }
328#endif
329
330 // setup enterprise authentication if required
331#ifdef USE_WIFI_WPA2_EAP
332 const auto &eap_opt = ap.get_eap();
333 if (eap_opt.has_value()) {
334 // note: all certificates and keys have to be null terminated. Lengths are appended by +1 to include \0.
335 const EAPAuth &eap = *eap_opt;
336 ret = wifi_station_set_enterprise_identity((uint8_t *) eap.identity.c_str(), eap.identity.length());
337 if (ret) {
338 ESP_LOGV(TAG, "esp_wifi_sta_wpa2_ent_set_identity failed: %d", ret);
339 }
340 int ca_cert_len = strlen(eap.ca_cert);
341 int client_cert_len = strlen(eap.client_cert);
342 int client_key_len = strlen(eap.client_key);
343 if (ca_cert_len) {
344 ret = wifi_station_set_enterprise_ca_cert((uint8_t *) eap.ca_cert, ca_cert_len + 1);
345 if (ret) {
346 ESP_LOGV(TAG, "esp_wifi_sta_wpa2_ent_set_ca_cert failed: %d", ret);
347 }
348 }
349 // workout what type of EAP this is
350 // validation is not required as the config tool has already validated it
351 if (client_cert_len && client_key_len) {
352 // if we have certs, this must be EAP-TLS
353 ret = wifi_station_set_enterprise_cert_key((uint8_t *) eap.client_cert, client_cert_len + 1,
354 (uint8_t *) eap.client_key, client_key_len + 1,
355 (uint8_t *) eap.password.c_str(), eap.password.length());
356 if (ret) {
357 ESP_LOGV(TAG, "esp_wifi_sta_wpa2_ent_set_cert_key failed: %d", ret);
358 }
359 } else {
360 // in the absence of certs, assume this is username/password based
361 ret = wifi_station_set_enterprise_username((uint8_t *) eap.username.c_str(), eap.username.length());
362 if (ret) {
363 ESP_LOGV(TAG, "esp_wifi_sta_wpa2_ent_set_username failed: %d", ret);
364 }
365 ret = wifi_station_set_enterprise_password((uint8_t *) eap.password.c_str(), eap.password.length());
366 if (ret) {
367 ESP_LOGV(TAG, "esp_wifi_sta_wpa2_ent_set_password failed: %d", ret);
368 }
369 }
370 ret = wifi_station_set_wpa2_enterprise_auth(true);
371 if (ret) {
372 ESP_LOGV(TAG, "esp_wifi_sta_wpa2_ent_enable failed: %d", ret);
373 }
374 }
375#endif // USE_WIFI_WPA2_EAP
376
377 this->wifi_apply_hostname_();
378
379 // Reset flags, do this _before_ wifi_station_connect as the callback method
380 // may be called from wifi_station_connect
381 this->sta_state_ = static_cast<uint8_t>(ESP8266WiFiSTAState::CONNECTING);
382
383 ETS_UART_INTR_DISABLE();
384 ret = wifi_station_connect();
385 ETS_UART_INTR_ENABLE();
386 if (!ret) {
387 ESP_LOGV(TAG, "wifi_station_connect failed");
388 return false;
389 }
390
391#if USE_NETWORK_IPV6
392 bool connected = false;
393 while (!connected) {
394 uint8_t ipv6_addr_count = 0;
395 for (auto addr : addrList) {
396 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
397 ESP_LOGV(TAG, "Address %s", network::IPAddress(addr.ipFromNetifNum()).str_to(ip_buf));
398 if (addr.isV6()) {
399 ipv6_addr_count++;
400 }
401 }
402 delay(500); // NOLINT
403 connected = (ipv6_addr_count >= USE_NETWORK_MIN_IPV6_ADDR_COUNT);
404 }
405#endif /* USE_NETWORK_IPV6 */
406
407 if (ap.has_channel()) {
408 ret = wifi_set_channel(ap.get_channel());
409 if (!ret) {
410 ESP_LOGV(TAG, "wifi_set_channel failed");
411 return false;
412 }
413 }
414
415 return true;
416}
417
418class WiFiMockClass : public ESP8266WiFiGenericClass {
419 public:
420 static void _event_callback(void *event) { ESP8266WiFiGenericClass::_eventCallback(event); } // NOLINT
421};
422
423// Auth mode strings indexed by AUTH_* constants (0-4), with UNKNOWN at last index
424// Static asserts verify the SDK constants are contiguous as expected
425static_assert(AUTH_OPEN == 0 && AUTH_WEP == 1 && AUTH_WPA_PSK == 2 && AUTH_WPA2_PSK == 3 && AUTH_WPA_WPA2_PSK == 4,
426 "AUTH_* constants are not contiguous");
427PROGMEM_STRING_TABLE(AuthModeStrings, "OPEN", "WEP", "WPA PSK", "WPA2 PSK", "WPA/WPA2 PSK", "UNKNOWN");
428
429const LogString *get_auth_mode_str(uint8_t mode) {
430 return AuthModeStrings::get_log_str(mode, AuthModeStrings::LAST_INDEX);
431}
432
433// WiFi op mode strings indexed by WIFI_* constants (0-3), with UNKNOWN at last index
434static_assert(WIFI_OFF == 0 && WIFI_STA == 1 && WIFI_AP == 2 && WIFI_AP_STA == 3,
435 "WIFI_* op mode constants are not contiguous");
436PROGMEM_STRING_TABLE(OpModeStrings, "OFF", "STA", "AP", "AP+STA", "UNKNOWN");
437
438const LogString *get_op_mode_str(uint8_t mode) { return OpModeStrings::get_log_str(mode, OpModeStrings::LAST_INDEX); }
439
440// Use if-chain instead of switch to avoid jump tables in RODATA (wastes RAM on ESP8266).
441// A single switch would generate a sparse lookup table with ~175 default entries, wasting 700 bytes of RAM.
442// Even split switches still generate smaller jump tables in RODATA.
443const LogString *get_disconnect_reason_str(uint8_t reason) {
444 if (reason == REASON_AUTH_EXPIRE)
445 return LOG_STR("Auth Expired");
446 if (reason == REASON_AUTH_LEAVE)
447 return LOG_STR("Auth Leave");
448 if (reason == REASON_ASSOC_EXPIRE)
449 return LOG_STR("Association Expired");
450 if (reason == REASON_ASSOC_TOOMANY)
451 return LOG_STR("Too Many Associations");
452 if (reason == REASON_NOT_AUTHED)
453 return LOG_STR("Not Authenticated");
454 if (reason == REASON_NOT_ASSOCED)
455 return LOG_STR("Not Associated");
456 if (reason == REASON_ASSOC_LEAVE)
457 return LOG_STR("Association Leave");
458 if (reason == REASON_ASSOC_NOT_AUTHED)
459 return LOG_STR("Association not Authenticated");
460 if (reason == REASON_DISASSOC_PWRCAP_BAD)
461 return LOG_STR("Disassociate Power Cap Bad");
462 if (reason == REASON_DISASSOC_SUPCHAN_BAD)
463 return LOG_STR("Disassociate Supported Channel Bad");
464 if (reason == REASON_IE_INVALID)
465 return LOG_STR("IE Invalid");
466 if (reason == REASON_MIC_FAILURE)
467 return LOG_STR("Mic Failure");
468 if (reason == REASON_4WAY_HANDSHAKE_TIMEOUT)
469 return LOG_STR("4-Way Handshake Timeout");
470 if (reason == REASON_GROUP_KEY_UPDATE_TIMEOUT)
471 return LOG_STR("Group Key Update Timeout");
472 if (reason == REASON_IE_IN_4WAY_DIFFERS)
473 return LOG_STR("IE In 4-Way Handshake Differs");
474 if (reason == REASON_GROUP_CIPHER_INVALID)
475 return LOG_STR("Group Cipher Invalid");
476 if (reason == REASON_PAIRWISE_CIPHER_INVALID)
477 return LOG_STR("Pairwise Cipher Invalid");
478 if (reason == REASON_AKMP_INVALID)
479 return LOG_STR("AKMP Invalid");
480 if (reason == REASON_UNSUPP_RSN_IE_VERSION)
481 return LOG_STR("Unsupported RSN IE version");
482 if (reason == REASON_INVALID_RSN_IE_CAP)
483 return LOG_STR("Invalid RSN IE Cap");
484 if (reason == REASON_802_1X_AUTH_FAILED)
485 return LOG_STR("802.1x Authentication Failed");
486 if (reason == REASON_CIPHER_SUITE_REJECTED)
487 return LOG_STR("Cipher Suite Rejected");
488 if (reason == REASON_BEACON_TIMEOUT)
489 return LOG_STR("Beacon Timeout");
490 if (reason == REASON_NO_AP_FOUND)
491 return LOG_STR("AP Not Found");
492 if (reason == REASON_AUTH_FAIL)
493 return LOG_STR("Authentication Failed");
494 if (reason == REASON_ASSOC_FAIL)
495 return LOG_STR("Association Failed");
496 if (reason == REASON_HANDSHAKE_TIMEOUT)
497 return LOG_STR("Handshake Failed");
498 return LOG_STR("Unspecified");
499}
500
501void WiFiComponent::wifi_event_callback(System_Event_t *event) {
502 switch (event->event) {
503 case EVENT_STAMODE_CONNECTED: {
504 auto it = event->event_info.connected;
505#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
506 char bssid_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
507 format_mac_addr_upper(it.bssid, bssid_buf);
508 ESP_LOGV(TAG, "Connected ssid='%.*s' bssid=%s channel=%u", it.ssid_len, (const char *) it.ssid, bssid_buf,
509 it.channel);
510#endif
512#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
513 // Defer listener notification until state machine reaches STA_CONNECTED
514 // This ensures wifi.connected condition returns true in listener automations
516#endif
517 break;
518 }
519 case EVENT_STAMODE_DISCONNECTED: {
520 auto it = event->event_info.disconnected;
521 if (it.reason == REASON_NO_AP_FOUND) {
522 ESP_LOGW(TAG, "Disconnected ssid='%.*s' reason='Probe Request Unsuccessful'", it.ssid_len,
523 (const char *) it.ssid);
525 } else {
526 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
527 format_mac_addr_upper(it.bssid, bssid_s);
528 ESP_LOGW(TAG, "Disconnected ssid='%.*s' bssid=" LOG_SECRET("%s") " reason='%s'", it.ssid_len,
529 (const char *) it.ssid, bssid_s, LOG_STR_ARG(get_disconnect_reason_str(it.reason)));
531 }
533#if LWIP_VERSION_MAJOR != 1
534 sta_netif_down();
535#endif
536#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
538#endif
539 break;
540 }
541 case EVENT_STAMODE_AUTHMODE_CHANGE: {
542 auto it = event->event_info.auth_change;
543 ESP_LOGV(TAG, "Changed Authmode old=%s new=%s", LOG_STR_ARG(get_auth_mode_str(it.old_mode)),
544 LOG_STR_ARG(get_auth_mode_str(it.new_mode)));
545 // Mitigate CVE-2020-12638
546 // https://lbsfilm.at/blog/wpa2-authenticationmode-downgrade-in-espressif-microprocessors
547 if (it.old_mode != AUTH_OPEN && it.new_mode == AUTH_OPEN) {
548 ESP_LOGW(TAG, "Potential Authmode downgrade detected, disconnecting");
549#if LWIP_VERSION_MAJOR != 1
550 sta_netif_down();
551#endif
552 wifi_station_disconnect();
554 }
555 break;
556 }
557 case EVENT_STAMODE_GOT_IP: {
558 auto it = event->event_info.got_ip;
559 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE], gw_buf[network::IP_ADDRESS_BUFFER_SIZE],
560 mask_buf[network::IP_ADDRESS_BUFFER_SIZE];
561 ESP_LOGV(TAG, "static_ip=%s gateway=%s netmask=%s", network::IPAddress(&it.ip).str_to(ip_buf),
562 network::IPAddress(&it.gw).str_to(gw_buf), network::IPAddress(&it.mask).str_to(mask_buf));
564#ifdef USE_WIFI_IP_STATE_LISTENERS
565 // Defer listener callbacks to main loop - system context has limited stack
567#endif
568 break;
569 }
570 case EVENT_STAMODE_DHCP_TIMEOUT: {
571 ESP_LOGW(TAG, "DHCP request timeout");
572 break;
573 }
574 case EVENT_SOFTAPMODE_STACONNECTED: {
575#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
576 auto it = event->event_info.sta_connected;
577 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
578 format_mac_addr_upper(it.mac, mac_buf);
579 ESP_LOGV(TAG, "AP client connected MAC=%s aid=%u", mac_buf, it.aid);
580#endif
581 break;
582 }
583 case EVENT_SOFTAPMODE_STADISCONNECTED: {
584#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
585 auto it = event->event_info.sta_disconnected;
586 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
587 format_mac_addr_upper(it.mac, mac_buf);
588 ESP_LOGV(TAG, "AP client disconnected MAC=%s aid=%u", mac_buf, it.aid);
589#endif
590 break;
591 }
592 case EVENT_SOFTAPMODE_PROBEREQRECVED: {
593#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERY_VERBOSE
594 auto it = event->event_info.ap_probereqrecved;
595 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
596 format_mac_addr_upper(it.mac, mac_buf);
597 ESP_LOGVV(TAG, "AP receive Probe Request MAC=%s RSSI=%d", mac_buf, it.rssi);
598#endif
599 break;
600 }
601 case EVENT_OPMODE_CHANGED: {
602 auto it = event->event_info.opmode_changed;
603 ESP_LOGV(TAG, "Changed Mode old=%s new=%s", LOG_STR_ARG(get_op_mode_str(it.old_opmode)),
604 LOG_STR_ARG(get_op_mode_str(it.new_opmode)));
605 break;
606 }
607 case EVENT_SOFTAPMODE_DISTRIBUTE_STA_IP: {
608#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
609 auto it = event->event_info.distribute_sta_ip;
610 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
611 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
612 format_mac_addr_upper(it.mac, mac_buf);
613 ESP_LOGV(TAG, "AP Distribute Station IP MAC=%s IP=%s aid=%u", mac_buf, network::IPAddress(&it.ip).str_to(ip_buf),
614 it.aid);
615#endif
616 break;
617 }
618 default:
619 break;
620 }
621
622 WiFiMockClass::_event_callback(event);
623}
624
626 uint8_t val = static_cast<uint8_t>(output_power * 4);
627 system_phy_set_max_tpw(val);
628 return true;
629}
631 if (!this->wifi_mode_(true, {}))
632 return false;
633
634 bool ret1, ret2;
635 ETS_UART_INTR_DISABLE();
636 ret1 = wifi_station_set_auto_connect(0);
637 ret2 = wifi_station_set_reconnect_policy(false);
638 ETS_UART_INTR_ENABLE();
639
640 if (!ret1 || !ret2) {
641 ESP_LOGV(TAG, "Disabling Auto-Connect failed");
642 }
643
644#ifdef USE_WIFI_PHY_MODE
645 if (!this->wifi_apply_phy_mode_()) {
646 ESP_LOGV(TAG, "Setting PHY Mode failed");
647 }
648#endif
649
650 delay(10);
651 return true;
652}
653
654#ifdef USE_WIFI_PHY_MODE
657 return true;
658 // Values of WiFi8266PhyMode are aligned with the SDK's phy_mode_t enum.
659 return wifi_set_phy_mode(static_cast<phy_mode_t>(this->phy_mode_));
660}
661#endif
662
664 wifi_set_event_handler_cb(&WiFiComponent::wifi_event_callback);
665
666 // Make sure WiFi is in clean state before anything starts
667 this->wifi_mode_(false, false);
668}
669
671 // Use cached state from wifi_event_callback() instead of calling
672 // wifi_station_get_connect_status() which queries the SDK every time.
673 // Use if statements with early returns instead of switch to avoid GCC
674 // generating a CSWTCH lookup table in .rodata (flash) on ESP8266.
675 auto state = static_cast<ESP8266WiFiSTAState>(this->sta_state_);
685}
686
688 // enable STA
689 if (!this->wifi_mode_(true, {}))
690 return false;
691
692 // Reset scan_done_ before starting new scan to prevent stale flag from previous scan
693 // (e.g., roaming scan completed just before unexpected disconnect)
694 this->scan_done_ = false;
695
696 struct scan_config config {};
697 memset(&config, 0, sizeof(config));
698 config.ssid = nullptr;
699 config.bssid = nullptr;
700 config.channel = 0;
701 config.show_hidden = 1;
702 config.scan_type = passive ? WIFI_SCAN_TYPE_PASSIVE : WIFI_SCAN_TYPE_ACTIVE;
703 // Use shorter dwell times for roaming scans - we only need to detect strong
704 // nearby APs, not do a thorough survey. This also reduces off-channel time
705 // which can cause Beacon Timeout disconnects on some APs.
706 // Roaming times match the ESP32 IDF scan defaults.
707 static constexpr uint32_t SCAN_PASSIVE_DEFAULT_MS = 500;
708 static constexpr uint32_t SCAN_PASSIVE_ROAMING_MS = 300;
709 static constexpr uint32_t SCAN_ACTIVE_MIN_DEFAULT_MS = 400;
710 static constexpr uint32_t SCAN_ACTIVE_MAX_DEFAULT_MS = 500;
711 static constexpr uint32_t SCAN_ACTIVE_MIN_ROAMING_MS = 100;
712 static constexpr uint32_t SCAN_ACTIVE_MAX_ROAMING_MS = 300;
713 bool roaming = this->is_roaming_scan_active();
714 if (passive) {
715 config.scan_time.passive = roaming ? SCAN_PASSIVE_ROAMING_MS : SCAN_PASSIVE_DEFAULT_MS;
716 } else {
717 config.scan_time.active.min = roaming ? SCAN_ACTIVE_MIN_ROAMING_MS : SCAN_ACTIVE_MIN_DEFAULT_MS;
718 config.scan_time.active.max = roaming ? SCAN_ACTIVE_MAX_ROAMING_MS : SCAN_ACTIVE_MAX_DEFAULT_MS;
719 }
720 bool ret = wifi_station_scan(&config, &WiFiComponent::s_wifi_scan_done_callback);
721 if (!ret) {
722 ESP_LOGV(TAG, "wifi_station_scan failed");
723 return false;
724 }
725
726 return ret;
727}
729 bool ret = true;
730 // Only call disconnect if interface is up
731 if (wifi_get_opmode() & WIFI_STA) {
732#if LWIP_VERSION_MAJOR != 1
733 sta_netif_down();
734#endif
735 ret = wifi_station_disconnect();
736 }
737 station_config conf{};
738 memset(&conf, 0, sizeof(conf));
739 ETS_UART_INTR_DISABLE();
740 wifi_station_set_config_current(&conf);
741 ETS_UART_INTR_ENABLE();
742 return ret;
743}
747
748void WiFiComponent::wifi_scan_done_callback_(void *arg, STATUS status) {
749 // Compiles to nothing here; kept so every scan_result_ mutation holds the lock
750 ScanResultsLock lock(this);
751 this->scan_result_.clear();
752
753 if (status != OK) {
754 ESP_LOGV(TAG, "Scan failed: %d", status);
755 // Don't call retry_connect() here - this callback runs in SDK system context
756 // where yield() cannot be called. Instead, just set scan_done_ and let
757 // check_scanning_finished() handle the empty scan_result_ from loop context.
758 this->scan_done_ = true;
759 return;
760 }
761
762 auto *head = reinterpret_cast<bss_info *>(arg);
763 bool needs_full = this->needs_full_scan_results_();
764
765 // First pass: count matching networks (linked list is non-destructive)
766 size_t total = 0;
767 size_t count = 0;
768 for (bss_info *it = head; it != nullptr; it = STAILQ_NEXT(it, next)) {
769 total++;
770 const char *ssid_cstr = reinterpret_cast<const char *>(it->ssid);
771 if (needs_full || this->matches_configured_network_(ssid_cstr, it->bssid)) {
772 count++;
773 }
774 }
775
776 this->scan_result_.init(count); // Exact allocation
777
778 // Second pass: store matching networks
779 for (bss_info *it = head; it != nullptr; it = STAILQ_NEXT(it, next)) {
780 const char *ssid_cstr = reinterpret_cast<const char *>(it->ssid);
781 if (needs_full || this->matches_configured_network_(ssid_cstr, it->bssid)) {
782 this->scan_result_.emplace_back(
783 bssid_t{it->bssid[0], it->bssid[1], it->bssid[2], it->bssid[3], it->bssid[4], it->bssid[5]}, ssid_cstr,
784 it->ssid_len, it->channel, it->rssi, it->authmode != AUTH_OPEN, it->is_hidden != 0);
785 } else {
786 this->log_discarded_scan_result_(ssid_cstr, it->bssid, it->rssi, it->channel);
787 }
788 }
789 ESP_LOGV(TAG, "Scan complete: %zu found, %zu stored%s", total, this->scan_result_.size(),
790 needs_full ? LOG_STR_LITERAL("") : LOG_STR_LITERAL(" (filtered)"));
791 this->scan_done_ = true;
792#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
793 this->pending_.scan_complete = true; // Defer listener callbacks to main loop
794#endif
795}
796
797#ifdef USE_WIFI_AP
798bool WiFiComponent::wifi_ap_ip_config_(const optional<ManualIP> &manual_ip) {
799 // enable AP
800 if (!this->wifi_mode_({}, true))
801 return false;
802
803 struct ip_info info {};
804 if (manual_ip.has_value()) {
805 info.ip = manual_ip->static_ip;
806 info.gw = manual_ip->gateway;
807 info.netmask = manual_ip->subnet;
808 } else {
809 info.ip = network::IPAddress(192, 168, 4, 1);
810 info.gw = network::IPAddress(192, 168, 4, 1);
811 info.netmask = network::IPAddress(255, 255, 255, 0);
812 }
813
814 if (wifi_softap_dhcps_status() == DHCP_STARTED) {
815 if (!wifi_softap_dhcps_stop()) {
816 ESP_LOGW(TAG, "Stopping DHCP server failed");
817 }
818 }
819
820 if (!wifi_set_ip_info(SOFTAP_IF, &info)) {
821 ESP_LOGE(TAG, "Set SoftAP info failed");
822 return false;
823 }
824
825#if USE_ARDUINO_VERSION_CODE < VERSION_CODE(3, 1, 0)
826 dhcpSoftAP.begin(&info);
827#endif
828
829 struct dhcps_lease lease {};
830 lease.enable = true;
831 network::IPAddress start_address = network::IPAddress(&info.ip);
832 start_address += 99;
833 lease.start_ip = start_address;
834#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
835 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
836#endif
837 ESP_LOGV(TAG, "DHCP server IP lease start: %s", start_address.str_to(ip_buf));
838 start_address += 10;
839 lease.end_ip = start_address;
840 ESP_LOGV(TAG, "DHCP server IP lease end: %s", start_address.str_to(ip_buf));
841 if (!wifi_softap_set_dhcps_lease(&lease)) {
842 ESP_LOGE(TAG, "Set SoftAP DHCP lease failed");
843 return false;
844 }
845
846 // lease time 1440 minutes (=24 hours)
847 if (!wifi_softap_set_dhcps_lease_time(1440)) {
848 ESP_LOGE(TAG, "Set SoftAP DHCP lease time failed");
849 return false;
850 }
851
852#if USE_ARDUINO_VERSION_CODE >= VERSION_CODE(3, 1, 0)
853 ESP8266WiFiClass::softAPDhcpServer().setRouter(true); // send ROUTER option with netif's gateway IP
854#else
855 uint8_t mode = 1;
856 // bit0, 1 enables router information from ESP8266 SoftAP DHCP server.
857 if (!wifi_softap_set_dhcps_offer_option(OFFER_ROUTER, &mode)) {
858 ESP_LOGE(TAG, "wifi_softap_set_dhcps_offer_option failed");
859 return false;
860 }
861#endif
862
863 if (!wifi_softap_dhcps_start()) {
864 ESP_LOGE(TAG, "Starting SoftAP DHCPS failed");
865 return false;
866 }
867
868 return true;
869}
870
872 // enable AP
873 if (!this->wifi_mode_({}, true))
874 return false;
875
876 struct softap_config conf {};
877 if (ap.ssid_.size() > sizeof(conf.ssid)) {
878 ESP_LOGE(TAG, "AP SSID too long");
879 return false;
880 }
881 memcpy(reinterpret_cast<char *>(conf.ssid), ap.ssid_.c_str(), ap.ssid_.size());
882 conf.ssid_len = static_cast<uint8>(ap.ssid_.size());
883 conf.channel = ap.has_channel() ? ap.get_channel() : 1;
884 conf.ssid_hidden = ap.get_hidden();
885 conf.max_connection = 5;
886 conf.beacon_interval = 100;
887
888 if (ap.password_.empty()) {
889 conf.authmode = AUTH_OPEN;
890 *conf.password = 0;
891 } else {
892 conf.authmode = AUTH_WPA2_PSK;
893 if (ap.password_.size() > sizeof(conf.password)) {
894 ESP_LOGE(TAG, "AP password too long");
895 return false;
896 }
897 memcpy(reinterpret_cast<char *>(conf.password), ap.password_.c_str(), ap.password_.size());
898 }
899
900 ETS_UART_INTR_DISABLE();
901 bool ret = wifi_softap_set_config_current(&conf);
902 ETS_UART_INTR_ENABLE();
903
904 if (!ret) {
905 ESP_LOGV(TAG, "wifi_softap_set_config_current failed");
906 return false;
907 }
908
909#ifdef USE_WIFI_MANUAL_IP
910 if (!this->wifi_ap_ip_config_(ap.get_manual_ip())) {
911 ESP_LOGV(TAG, "wifi_ap_ip_config_ failed");
912 return false;
913 }
914#else
915 if (!this->wifi_ap_ip_config_({})) {
916 ESP_LOGV(TAG, "wifi_ap_ip_config_ failed");
917 return false;
918 }
919#endif
920
921 return true;
922}
923
925 struct ip_info ip {};
926 wifi_get_ip_info(SOFTAP_IF, &ip);
927 return network::IPAddress(&ip.ip);
928}
929#endif // USE_WIFI_AP
930
932 bssid_t bssid{};
933 struct station_config conf {};
934 if (wifi_station_get_config(&conf)) {
935 std::copy_n(conf.bssid, bssid.size(), bssid.begin());
936 }
937 return bssid;
938}
939const char *WiFiComponent::wifi_ssid_to(std::span<char, SSID_BUFFER_SIZE> buffer) {
940 struct station_config conf {};
941 if (!wifi_station_get_config(&conf)) {
942 buffer[0] = '\0';
943 return buffer.data();
944 }
945 // conf.ssid is uint8[32], not null-terminated if full
946 size_t len = strnlen(reinterpret_cast<const char *>(conf.ssid), sizeof(conf.ssid));
947 memcpy(buffer.data(), conf.ssid, len);
948 buffer[len] = '\0';
949 return buffer.data();
950}
952 if (wifi_station_get_connect_status() != STATION_GOT_IP)
953 return WIFI_RSSI_DISCONNECTED;
954 sint8 rssi = wifi_station_get_rssi();
955 // Values >= 31 are error codes per NONOS SDK API, not valid RSSI readings
956 return rssi >= 31 ? WIFI_RSSI_DISCONNECTED : rssi;
957}
958int32_t WiFiComponent::get_wifi_channel() { return wifi_get_channel(); }
960 struct ip_info ip {};
961 wifi_get_ip_info(STATION_IF, &ip);
962 return network::IPAddress(&ip.netmask);
963}
965 struct ip_info ip {};
966 wifi_get_ip_info(STATION_IF, &ip);
967 return network::IPAddress(&ip.gw);
968}
972 return true;
973}
974
976 // Process callbacks deferred from ESP8266 SDK system context (~2KB stack)
977 // to main loop context (full stack). Connect state listeners are handled
978 // by notify_connect_state_listeners_() in the shared state machine code.
979
980#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
981 if (this->pending_.disconnect) {
982 this->pending_.disconnect = false;
983 // Refresh is_connected() cache here, not in the SDK callback (sys context).
986 }
987#endif
988
989#ifdef USE_WIFI_IP_STATE_LISTENERS
990 if (this->pending_.got_ip) {
991 this->pending_.got_ip = false;
993 }
994#endif
995
996#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
997 if (this->pending_.scan_complete) {
998 this->pending_.scan_complete = false;
1000 }
1001#endif
1002}
1003
1004} // namespace esphome::wifi
1005#endif
1006#endif
BedjetMode mode
BedJet operating mode.
uint8_t status
Definition bl0942.h:8
const StringRef & get_name() const
Get the name of this Application set by pre_setup().
const char * c_str() const
Guards WiFiComponent::scan_result_.
uint8_t get_channel() const
const optional< EAPAuth > & get_eap() const
const optional< ManualIP > & get_manual_ip() const
const bssid_t & get_bssid() const
void wifi_scan_done_callback_(void *arg, STATUS status)
void notify_scan_results_listeners_()
Notify scan results listeners with current scan results.
WiFiSTAConnectStatus wifi_sta_connect_status_() const
wifi_scan_vector_t< WiFiScanResult > scan_result_
void notify_ip_state_listeners_()
Notify IP state listeners with current addresses.
bool wifi_sta_ip_config_(const optional< ManualIP > &manual_ip)
static void wifi_event_callback(System_Event_t *event)
void notify_disconnect_state_listeners_()
Notify connect state listeners of disconnection.
void log_discarded_scan_result_(const char *ssid, const uint8_t *bssid, int8_t rssi, uint8_t channel)
Log a discarded scan result at VERBOSE level (skipped during roaming scans to avoid log overflow)
const char * wifi_ssid_to(std::span< char, SSID_BUFFER_SIZE > buffer)
Write SSID to buffer without heap allocation.
static void s_wifi_scan_done_callback(void *arg, STATUS status)
bool is_roaming_scan_active() const
True while a post-connect roaming scan holds the radio off-channel.
network::IPAddress wifi_dns_ip_(int num)
bool matches_configured_network_(const char *ssid, const uint8_t *bssid) const
Check if network matches any configured network (for scan result filtering) Matches by SSID when conf...
struct esphome::wifi::WiFiComponent::@194 pending_
bool wifi_ap_ip_config_(const optional< ManualIP > &manual_ip)
bool needs_full_scan_results_() const
Check if full scan results are needed (captive portal active, improv, listeners)
StaticVector< WiFiPowerSaveListener *, ESPHOME_WIFI_POWER_SAVE_LISTENERS > power_save_listeners_
bool wifi_apply_output_power_(float output_power)
bool wifi_mode_(optional< bool > sta, optional< bool > ap)
network::IPAddresses wifi_sta_ip_addresses()
bool state
Definition fan.h:2
struct in_addr ip4_addr_t
Definition ip_address.h:23
int ret
mopeka_std_values val[3]
std::array< IPAddress, 5 > IPAddresses
Definition ip_address.h:301
const char *const TAG
Definition spi.cpp:7
std::array< uint8_t, 6 > bssid_t
const LogString * get_auth_mode_str(uint8_t mode)
void netif_set_down(struct netif *netif)
const LogString * get_disconnect_reason_str(uint8_t reason)
struct netif * eagle_lwip_getif(int netif_index)
void netif_set_addr(struct netif *netif, const ip4_addr_t *ip, const ip4_addr_t *netmask, const ip4_addr_t *gw)
WiFiComponent * global_wifi_component
PROGMEM_STRING_TABLE(AuthModeStrings, "OPEN", "WEP", "WPA PSK", "WPA2 PSK", "WPA/WPA2 PSK", "UNKNOWN")
const LogString * get_op_mode_str(uint8_t mode)
const void size_t len
Definition hal.h:64
void HOT delay(uint32_t ms)
Definition hal.cpp:85
Application App
Global storage of Application pointer - only one Application can exist.
char * format_mac_addr_upper(const uint8_t *mac, char *output)
Format MAC address as XX:XX:XX:XX:XX:XX (uppercase, colon separators)
Definition helpers.h:1505
static void uint32_t
char * str_to(char *buf) const
Definition ip_address.h:101
SemaphoreHandle_t lock