ESPHome 2026.5.0b1
Loading...
Searching...
No Matches
wifi_component_libretiny.cpp
Go to the documentation of this file.
1#include "wifi_component.h"
2
3#ifdef USE_WIFI
4#ifdef USE_LIBRETINY
5
6#include <cinttypes>
7#include <utility>
8#include <algorithm>
9#include "lwip/ip_addr.h"
10#include "lwip/err.h"
11#include "lwip/dns.h"
12
13#ifdef USE_BK72XX
14extern "C" {
15// BDK 3.0.78 (required for BK7238) redeclares wifi_event_sta_disconnected_t,
16// which LibreTiny's Arduino WiFi API already defines. ESPHome doesn't use the
17// BDK version, so rename it across this include to avoid the collision.
18#define wifi_event_sta_disconnected_t bdk_wifi_event_sta_disconnected_t
19#include <wlan_ui_pub.h>
20#undef wifi_event_sta_disconnected_t
21}
22#endif
23
24#ifdef USE_RTL87XX
25extern "C" {
26#include <wifi_conf.h>
27#include <wifi_structures.h>
28}
29#endif
30
32#include "esphome/core/hal.h"
34#include "esphome/core/log.h"
35#include "esphome/core/util.h"
36
37namespace esphome::wifi {
38
39static const char *const TAG = "wifi_lt";
40
41// Thread-safe event handling for LibreTiny WiFi
42//
43// LibreTiny's WiFi.onEvent() callback runs in the WiFi driver's thread context,
44// not the main ESPHome loop. Without synchronization, modifying shared state
45// (like connection status flags) from the callback causes race conditions:
46// - The main loop may never see state changes (values cached in registers)
47// - State changes may be visible in inconsistent order
48//
49// Solution: Queue events in the callback and process them in the main loop.
50// This is the same approach used by ESP32 IDF's wifi_process_event_().
51// All state modifications happen in the main loop context, eliminating races.
52//
53// On platforms with hardware atomics (RTL87xx, LN882x): LockFreeQueue (SPSC ring buffer)
54// On platforms without (BK72xx): FreeRTOSQueue (xQueue wrapper with critical sections)
55
56// Event structure for queued WiFi events - contains a copy of event data
57// to avoid lifetime issues with the original event data from the callback
58struct LTWiFiEvent {
59 arduino_event_id_t event_id;
60 union {
61 struct {
62 uint8_t ssid[33];
63 uint8_t ssid_len;
64 uint8_t bssid[6];
65 uint8_t channel;
66 uint8_t authmode;
67 } sta_connected;
68 struct {
69 uint8_t ssid[33];
70 uint8_t ssid_len;
71 uint8_t bssid[6];
72 uint8_t reason;
73 } sta_disconnected;
74 struct {
75 uint8_t old_mode;
76 uint8_t new_mode;
77 } sta_authmode_change;
78 struct {
79 uint32_t status;
80 uint8_t number;
81 uint8_t scan_id;
82 } scan_done;
83 struct {
84 uint8_t mac[6];
85 int rssi;
86 } ap_probe_req;
87 } data;
88};
89
90// Connection state machine - only modified from main loop after queue processing
91enum class LTWiFiSTAState : uint8_t {
92 IDLE, // Not connecting
93 CONNECTING, // Connection in progress
94 CONNECTED, // Successfully connected with IP
95 ERROR_NOT_FOUND, // AP not found (probe failed)
96 ERROR_FAILED, // Connection failed (auth, timeout, etc.)
97};
98
99// Count of ignored disconnect events during connection - too many indicates real failure
100static uint8_t s_ignored_disconnect_count = 0; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
101// Threshold for ignored disconnect events before treating as connection failure
102// LibreTiny sends spurious "Association Leave" events, but more than this many
103// indicates the connection is failing repeatedly. Value of 3 balances fast failure
104// detection with tolerance for occasional spurious events on successful connections.
105static constexpr uint8_t IGNORED_DISCONNECT_THRESHOLD = 3;
106
107bool WiFiComponent::wifi_mode_(optional<bool> sta, optional<bool> ap) {
108 uint8_t current_mode = WiFi.getMode();
109 bool current_sta = current_mode & 0b01;
110 bool current_ap = current_mode & 0b10;
111 bool enable_sta = sta.value_or(current_sta);
112 bool enable_ap = ap.value_or(current_ap);
113 if (current_sta == enable_sta && current_ap == enable_ap)
114 return true;
115
116 if (enable_sta && !current_sta) {
117 ESP_LOGV(TAG, "Enabling STA");
118 } else if (!enable_sta && current_sta) {
119 ESP_LOGV(TAG, "Disabling STA");
120 }
121 if (enable_ap && !current_ap) {
122 ESP_LOGV(TAG, "Enabling AP");
123 } else if (!enable_ap && current_ap) {
124 ESP_LOGV(TAG, "Disabling AP");
125 }
126
127 uint8_t mode = 0;
128 if (enable_sta)
129 mode |= 0b01;
130 if (enable_ap)
131 mode |= 0b10;
132 bool ret = WiFi.mode(static_cast<wifi_mode_t>(mode));
133
134 if (!ret) {
135 ESP_LOGW(TAG, "Setting mode failed");
136 return false;
137 }
138
139 this->ap_started_ = enable_ap;
140
141 return ret;
142}
143bool WiFiComponent::wifi_apply_output_power_(float output_power) {
144 int8_t val = static_cast<int8_t>(output_power * 4);
145 return WiFi.setTxPower(val);
146}
148 if (!this->wifi_mode_(true, {}))
149 return false;
150
151 WiFi.setAutoReconnect(false);
152 delay(10);
153 return true;
154}
156 bool success = WiFi.setSleep(this->power_save_ != WIFI_POWER_SAVE_NONE);
157#ifdef USE_WIFI_POWER_SAVE_LISTENERS
158 if (success) {
159 for (auto *listener : this->power_save_listeners_) {
160 listener->on_wifi_power_save(this->power_save_);
161 }
162 }
163#endif
164 return success;
165}
166bool WiFiComponent::wifi_sta_ip_config_(const optional<ManualIP> &manual_ip) {
167 // enable STA
168 if (!this->wifi_mode_(true, {}))
169 return false;
170
171 if (!manual_ip.has_value()) {
172 return true;
173 }
174
175 WiFi.config(manual_ip->static_ip, manual_ip->gateway, manual_ip->subnet, manual_ip->dns1, manual_ip->dns2);
176
177 return true;
178}
179
181 if (!this->has_sta())
182 return {};
183 network::IPAddresses addresses;
184 addresses[0] = WiFi.localIP();
185#if USE_NETWORK_IPV6
186 int i = 1;
187 auto v6_addresses = WiFi.allLocalIPv6();
188 for (auto address : v6_addresses) {
189 addresses[i++] = network::IPAddress(address.toString().c_str());
190 }
191#endif /* USE_NETWORK_IPV6 */
192 return addresses;
193}
194
196 // setting is done in SYSTEM_EVENT_STA_START callback too
197 WiFi.setHostname(App.get_name().c_str());
198 return true;
199}
200bool WiFiComponent::wifi_sta_connect_(const WiFiAP &ap) {
201 // enable STA
202 if (!this->wifi_mode_(true, {}))
203 return false;
204
205 String ssid = WiFi.SSID();
206 if (ssid && strcmp(ssid.c_str(), ap.ssid_.c_str()) != 0) {
207 WiFi.disconnect();
208 }
209
210#ifdef USE_WIFI_MANUAL_IP
211 if (!this->wifi_sta_ip_config_(ap.get_manual_ip())) {
212 return false;
213 }
214#else
215 if (!this->wifi_sta_ip_config_({})) {
216 return false;
217 }
218#endif
219
220 this->wifi_apply_hostname_();
221
222 // Reset state machine and disconnect counter before connecting
223 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::CONNECTING);
224 s_ignored_disconnect_count = 0;
225
226 WiFiStatus status = WiFi.begin(ap.ssid_.c_str(), ap.password_.empty() ? NULL : ap.password_.c_str(),
227 ap.get_channel(), // 0 = auto
228 ap.has_bssid() ? ap.get_bssid().data() : NULL);
229 if (status != WL_CONNECTED) {
230 ESP_LOGW(TAG, "esp_wifi_connect failed: %d", status);
231 return false;
232 }
233
234 return true;
235}
236const char *get_auth_mode_str(uint8_t mode) {
237 switch (mode) {
238 case WIFI_AUTH_OPEN:
239 return "OPEN";
240 case WIFI_AUTH_WEP:
241 return "WEP";
242 case WIFI_AUTH_WPA_PSK:
243 return "WPA PSK";
244 case WIFI_AUTH_WPA2_PSK:
245 return "WPA2 PSK";
246 case WIFI_AUTH_WPA_WPA2_PSK:
247 return "WPA/WPA2 PSK";
248 default:
249 return "UNKNOWN";
250 }
251}
252
253const char *get_op_mode_str(uint8_t mode) {
254 switch (mode) {
255 case WIFI_OFF:
256 return "OFF";
257 case WIFI_STA:
258 return "STA";
259 case WIFI_AP:
260 return "AP";
261 case WIFI_AP_STA:
262 return "AP+STA";
263 default:
264 return "UNKNOWN";
265 }
266}
267const char *get_disconnect_reason_str(uint8_t reason) {
268 switch (reason) {
269 case WIFI_REASON_AUTH_EXPIRE:
270 return "Auth Expired";
271 case WIFI_REASON_AUTH_LEAVE:
272 return "Auth Leave";
273 case WIFI_REASON_ASSOC_EXPIRE:
274 return "Association Expired";
275 case WIFI_REASON_ASSOC_TOOMANY:
276 return "Too Many Associations";
277 case WIFI_REASON_NOT_AUTHED:
278 return "Not Authenticated";
279 case WIFI_REASON_NOT_ASSOCED:
280 return "Not Associated";
281 case WIFI_REASON_ASSOC_LEAVE:
282 return "Association Leave";
283 case WIFI_REASON_ASSOC_NOT_AUTHED:
284 return "Association not Authenticated";
285 case WIFI_REASON_DISASSOC_PWRCAP_BAD:
286 return "Disassociate Power Cap Bad";
287 case WIFI_REASON_DISASSOC_SUPCHAN_BAD:
288 return "Disassociate Supported Channel Bad";
289 case WIFI_REASON_IE_INVALID:
290 return "IE Invalid";
291 case WIFI_REASON_MIC_FAILURE:
292 return "Mic Failure";
293 case WIFI_REASON_4WAY_HANDSHAKE_TIMEOUT:
294 return "4-Way Handshake Timeout";
295 case WIFI_REASON_GROUP_KEY_UPDATE_TIMEOUT:
296 return "Group Key Update Timeout";
297 case WIFI_REASON_IE_IN_4WAY_DIFFERS:
298 return "IE In 4-Way Handshake Differs";
299 case WIFI_REASON_GROUP_CIPHER_INVALID:
300 return "Group Cipher Invalid";
301 case WIFI_REASON_PAIRWISE_CIPHER_INVALID:
302 return "Pairwise Cipher Invalid";
303 case WIFI_REASON_AKMP_INVALID:
304 return "AKMP Invalid";
305 case WIFI_REASON_UNSUPP_RSN_IE_VERSION:
306 return "Unsupported RSN IE version";
307 case WIFI_REASON_INVALID_RSN_IE_CAP:
308 return "Invalid RSN IE Cap";
309 case WIFI_REASON_802_1X_AUTH_FAILED:
310 return "802.1x Authentication Failed";
311 case WIFI_REASON_CIPHER_SUITE_REJECTED:
312 return "Cipher Suite Rejected";
313 case WIFI_REASON_BEACON_TIMEOUT:
314 return "Beacon Timeout";
315 case WIFI_REASON_NO_AP_FOUND:
316 return "AP Not Found";
317 case WIFI_REASON_AUTH_FAIL:
318 return "Authentication Failed";
319 case WIFI_REASON_ASSOC_FAIL:
320 return "Association Failed";
321 case WIFI_REASON_HANDSHAKE_TIMEOUT:
322 return "Handshake Failed";
323 case WIFI_REASON_CONNECTION_FAIL:
324 return "Connection Failed";
325 case WIFI_REASON_UNSPECIFIED:
326 default:
327 return "Unspecified";
328 }
329}
330
331#define ESPHOME_EVENT_ID_WIFI_READY ARDUINO_EVENT_WIFI_READY
332#define ESPHOME_EVENT_ID_WIFI_SCAN_DONE ARDUINO_EVENT_WIFI_SCAN_DONE
333#define ESPHOME_EVENT_ID_WIFI_STA_START ARDUINO_EVENT_WIFI_STA_START
334#define ESPHOME_EVENT_ID_WIFI_STA_STOP ARDUINO_EVENT_WIFI_STA_STOP
335#define ESPHOME_EVENT_ID_WIFI_STA_CONNECTED ARDUINO_EVENT_WIFI_STA_CONNECTED
336#define ESPHOME_EVENT_ID_WIFI_STA_DISCONNECTED ARDUINO_EVENT_WIFI_STA_DISCONNECTED
337#define ESPHOME_EVENT_ID_WIFI_STA_AUTHMODE_CHANGE ARDUINO_EVENT_WIFI_STA_AUTHMODE_CHANGE
338#define ESPHOME_EVENT_ID_WIFI_STA_GOT_IP ARDUINO_EVENT_WIFI_STA_GOT_IP
339#define ESPHOME_EVENT_ID_WIFI_STA_GOT_IP6 ARDUINO_EVENT_WIFI_STA_GOT_IP6
340#define ESPHOME_EVENT_ID_WIFI_STA_LOST_IP ARDUINO_EVENT_WIFI_STA_LOST_IP
341#define ESPHOME_EVENT_ID_WIFI_AP_START ARDUINO_EVENT_WIFI_AP_START
342#define ESPHOME_EVENT_ID_WIFI_AP_STOP ARDUINO_EVENT_WIFI_AP_STOP
343#define ESPHOME_EVENT_ID_WIFI_AP_STACONNECTED ARDUINO_EVENT_WIFI_AP_STACONNECTED
344#define ESPHOME_EVENT_ID_WIFI_AP_STADISCONNECTED ARDUINO_EVENT_WIFI_AP_STADISCONNECTED
345#define ESPHOME_EVENT_ID_WIFI_AP_STAIPASSIGNED ARDUINO_EVENT_WIFI_AP_STAIPASSIGNED
346#define ESPHOME_EVENT_ID_WIFI_AP_PROBEREQRECVED ARDUINO_EVENT_WIFI_AP_PROBEREQRECVED
347#define ESPHOME_EVENT_ID_WIFI_AP_GOT_IP6 ARDUINO_EVENT_WIFI_AP_GOT_IP6
348using esphome_wifi_event_id_t = arduino_event_id_t;
349using esphome_wifi_event_info_t = arduino_event_info_t;
350
351// Event callback - runs in WiFi driver thread context
352// Only queues events for processing in main loop, no logging or state changes here
354 // Allocate on heap and fill directly to avoid extra memcpy
355 auto *to_send = new LTWiFiEvent{}; // NOLINT(cppcoreguidelines-owning-memory)
356 to_send->event_id = event;
357
358 // Copy event-specific data
359 switch (event) {
360 case ESPHOME_EVENT_ID_WIFI_STA_CONNECTED: {
361 auto &it = info.wifi_sta_connected;
362 to_send->data.sta_connected.ssid_len = it.ssid_len;
363 memcpy(to_send->data.sta_connected.ssid, it.ssid,
364 std::min(static_cast<size_t>(it.ssid_len), sizeof(to_send->data.sta_connected.ssid) - 1));
365 memcpy(to_send->data.sta_connected.bssid, it.bssid, 6);
366 to_send->data.sta_connected.channel = it.channel;
367 to_send->data.sta_connected.authmode = it.authmode;
368 break;
369 }
370 case ESPHOME_EVENT_ID_WIFI_STA_DISCONNECTED: {
371 auto &it = info.wifi_sta_disconnected;
372 to_send->data.sta_disconnected.ssid_len = it.ssid_len;
373 memcpy(to_send->data.sta_disconnected.ssid, it.ssid,
374 std::min(static_cast<size_t>(it.ssid_len), sizeof(to_send->data.sta_disconnected.ssid) - 1));
375 memcpy(to_send->data.sta_disconnected.bssid, it.bssid, 6);
376 to_send->data.sta_disconnected.reason = it.reason;
377 break;
378 }
379 case ESPHOME_EVENT_ID_WIFI_STA_AUTHMODE_CHANGE: {
380 auto &it = info.wifi_sta_authmode_change;
381 to_send->data.sta_authmode_change.old_mode = it.old_mode;
382 to_send->data.sta_authmode_change.new_mode = it.new_mode;
383 break;
384 }
385 case ESPHOME_EVENT_ID_WIFI_SCAN_DONE: {
386 auto &it = info.wifi_scan_done;
387 to_send->data.scan_done.status = it.status;
388 to_send->data.scan_done.number = it.number;
389 to_send->data.scan_done.scan_id = it.scan_id;
390 break;
391 }
392 case ESPHOME_EVENT_ID_WIFI_AP_PROBEREQRECVED: {
393 auto &it = info.wifi_ap_probereqrecved;
394 memcpy(to_send->data.ap_probe_req.mac, it.mac, 6);
395 to_send->data.ap_probe_req.rssi = it.rssi;
396 break;
397 }
398 case ESPHOME_EVENT_ID_WIFI_AP_STACONNECTED: {
399 auto &it = info.wifi_sta_connected;
400 memcpy(to_send->data.sta_connected.bssid, it.bssid, 6);
401 break;
402 }
403 case ESPHOME_EVENT_ID_WIFI_AP_STADISCONNECTED: {
404 auto &it = info.wifi_sta_disconnected;
405 memcpy(to_send->data.sta_disconnected.bssid, it.bssid, 6);
406 break;
407 }
408 case ESPHOME_EVENT_ID_WIFI_READY:
409 case ESPHOME_EVENT_ID_WIFI_STA_START:
410 case ESPHOME_EVENT_ID_WIFI_STA_STOP:
411 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP:
412 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP6:
413 case ESPHOME_EVENT_ID_WIFI_STA_LOST_IP:
414 case ESPHOME_EVENT_ID_WIFI_AP_START:
415 case ESPHOME_EVENT_ID_WIFI_AP_STOP:
416 case ESPHOME_EVENT_ID_WIFI_AP_STAIPASSIGNED:
417 // No additional data needed
418 break;
419 default:
420 // Unknown event, don't queue
421 delete to_send; // NOLINT(cppcoreguidelines-owning-memory)
422 return;
423 }
424
425 // Queue event (don't block if queue is full)
426 if (!this->event_queue_.push(to_send)) {
427 delete to_send; // NOLINT(cppcoreguidelines-owning-memory)
428 }
429}
430
431// Process a single event from the queue - runs in main loop context.
432// Listener notifications must be deferred until after the state machine transitions
433// (in check_connecting_finished) so that conditions like wifi.connected return
434// correct values in automations.
435void WiFiComponent::wifi_process_event_(LTWiFiEvent *event) {
436 switch (event->event_id) {
437 case ESPHOME_EVENT_ID_WIFI_READY: {
438 ESP_LOGV(TAG, "Ready");
439 break;
440 }
441 case ESPHOME_EVENT_ID_WIFI_SCAN_DONE: {
442 auto &it = event->data.scan_done;
443 ESP_LOGV(TAG, "Scan done: status=%" PRIu32 " number=%u scan_id=%u", it.status, it.number, it.scan_id);
445 break;
446 }
447 case ESPHOME_EVENT_ID_WIFI_STA_START: {
448 ESP_LOGV(TAG, "STA start");
449 WiFi.setHostname(App.get_name().c_str());
450 break;
451 }
452 case ESPHOME_EVENT_ID_WIFI_STA_STOP: {
453 ESP_LOGV(TAG, "STA stop");
454 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::IDLE);
455 break;
456 }
457 case ESPHOME_EVENT_ID_WIFI_STA_CONNECTED: {
458 auto &it = event->data.sta_connected;
459 char bssid_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
460 format_mac_addr_upper(it.bssid, bssid_buf);
461 ESP_LOGV(TAG, "Connected ssid='%.*s' bssid=" LOG_SECRET("%s") " channel=%u, authmode=%s", it.ssid_len,
462 (const char *) it.ssid, bssid_buf, it.channel, get_auth_mode_str(it.authmode));
463 // Note: We don't set CONNECTED state here yet - wait for GOT_IP
464 // This matches ESP32 IDF behavior where s_sta_connected is set but
465 // wifi_sta_connect_status_() also checks got_ipv4_address_
466#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
467 // Defer listener notification until state machine reaches STA_CONNECTED
468 // This ensures wifi.connected condition returns true in listener automations
469 this->pending_.connect_state = true;
470#endif
471 // For static IP configurations, GOT_IP event may not fire, so set connected state here
472#ifdef USE_WIFI_MANUAL_IP
473 if (const WiFiAP *config = this->get_selected_sta_(); config && config->get_manual_ip().has_value()) {
474 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::CONNECTED);
475#ifdef USE_WIFI_IP_STATE_LISTENERS
477#endif
478 }
479#endif
480 break;
481 }
482 case ESPHOME_EVENT_ID_WIFI_STA_DISCONNECTED: {
483 auto &it = event->data.sta_disconnected;
484
485 // LibreTiny can send spurious disconnect events with empty ssid/bssid during connection.
486 // These are typically "Association Leave" events that don't indicate actual failures:
487 // [W][wifi_lt]: Disconnected ssid='' bssid=00:00:00:00:00:00 reason='Association Leave'
488 // [W][wifi_lt]: Disconnected ssid='' bssid=00:00:00:00:00:00 reason='Association Leave'
489 // [V][wifi_lt]: Connected ssid='WIFI' bssid=... channel=3, authmode=WPA2 PSK
490 // Without this check, the spurious events would transition state to ERROR_FAILED,
491 // causing wifi_sta_connect_status_() to return an error. The main loop would then
492 // call retry_connect(), aborting a connection that may succeed moments later.
493 // Only ignore benign reasons - real failures like NO_AP_FOUND should still be processed.
494 // However, if we get too many of these events (IGNORED_DISCONNECT_THRESHOLD), treat it
495 // as a real connection failure to avoid waiting the full timeout for a failing connection.
496 if (it.ssid_len == 0 && this->sta_state_ == static_cast<uint8_t>(LTWiFiSTAState::CONNECTING) &&
497 it.reason != WIFI_REASON_NO_AP_FOUND) {
498 s_ignored_disconnect_count++;
499 if (s_ignored_disconnect_count >= IGNORED_DISCONNECT_THRESHOLD) {
500 ESP_LOGW(TAG, "Too many disconnect events (%u) while connecting, treating as failure (reason=%s)",
501 s_ignored_disconnect_count, get_disconnect_reason_str(it.reason));
502 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
503 WiFi.disconnect();
504 this->error_from_callback_ = true;
505 // Don't break - fall through to notify listeners
506 } else {
507 ESP_LOGV(TAG, "Ignoring disconnect event with empty ssid while connecting (reason=%s, count=%u)",
508 get_disconnect_reason_str(it.reason), s_ignored_disconnect_count);
509 break;
510 }
511 }
512
513 if (it.reason == WIFI_REASON_NO_AP_FOUND) {
514 ESP_LOGW(TAG, "Disconnected ssid='%.*s' reason='Probe Request Unsuccessful'", it.ssid_len,
515 (const char *) it.ssid);
516 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_NOT_FOUND);
517 } else {
518 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
519 format_mac_addr_upper(it.bssid, bssid_s);
520 ESP_LOGW(TAG, "Disconnected ssid='%.*s' bssid=" LOG_SECRET("%s") " reason='%s'", it.ssid_len,
521 (const char *) it.ssid, bssid_s, get_disconnect_reason_str(it.reason));
522 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
523 }
524
525 uint8_t reason = it.reason;
526 if (reason == WIFI_REASON_AUTH_EXPIRE || reason == WIFI_REASON_BEACON_TIMEOUT ||
527 reason == WIFI_REASON_NO_AP_FOUND || reason == WIFI_REASON_ASSOC_FAIL ||
528 reason == WIFI_REASON_HANDSHAKE_TIMEOUT) {
529 WiFi.disconnect();
530 this->error_from_callback_ = true;
531 }
532
533 // Refresh is_connected() cache; sta_state_/error_from_callback_ make it false.
535#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
537#endif
538 break;
539 }
540 case ESPHOME_EVENT_ID_WIFI_STA_AUTHMODE_CHANGE: {
541 auto &it = event->data.sta_authmode_change;
542 ESP_LOGV(TAG, "Authmode Change old=%s new=%s", get_auth_mode_str(it.old_mode), get_auth_mode_str(it.new_mode));
543 // Mitigate CVE-2020-12638
544 // https://lbsfilm.at/blog/wpa2-authenticationmode-downgrade-in-espressif-microprocessors
545 if (it.old_mode != WIFI_AUTH_OPEN && it.new_mode == WIFI_AUTH_OPEN) {
546 ESP_LOGW(TAG, "Potential Authmode downgrade detected, disconnecting");
547 WiFi.disconnect();
548 this->error_from_callback_ = true;
549 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
550 }
551 break;
552 }
553 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP: {
554 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE], gw_buf[network::IP_ADDRESS_BUFFER_SIZE];
555 ESP_LOGV(TAG, "static_ip=%s gateway=%s", network::IPAddress(WiFi.localIP()).str_to(ip_buf),
556 network::IPAddress(WiFi.gatewayIP()).str_to(gw_buf));
557 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::CONNECTED);
558#ifdef USE_WIFI_IP_STATE_LISTENERS
560#endif
561 break;
562 }
563 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP6: {
564 ESP_LOGV(TAG, "Got IPv6");
565#ifdef USE_WIFI_IP_STATE_LISTENERS
567#endif
568 break;
569 }
570 case ESPHOME_EVENT_ID_WIFI_STA_LOST_IP: {
571 ESP_LOGV(TAG, "Lost IP");
572 // Don't change state to IDLE - let the disconnect event handle that
573 break;
574 }
575 case ESPHOME_EVENT_ID_WIFI_AP_START: {
576 ESP_LOGV(TAG, "AP start");
577 break;
578 }
579 case ESPHOME_EVENT_ID_WIFI_AP_STOP: {
580 ESP_LOGV(TAG, "AP stop");
581 break;
582 }
583 case ESPHOME_EVENT_ID_WIFI_AP_STACONNECTED: {
584#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
585 auto &it = event->data.sta_connected;
586 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
587 format_mac_addr_upper(it.bssid, mac_buf);
588 ESP_LOGV(TAG, "AP client connected MAC=%s", mac_buf);
589#endif
590 break;
591 }
592 case ESPHOME_EVENT_ID_WIFI_AP_STADISCONNECTED: {
593#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
594 auto &it = event->data.sta_disconnected;
595 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
596 format_mac_addr_upper(it.bssid, mac_buf);
597 ESP_LOGV(TAG, "AP client disconnected MAC=%s", mac_buf);
598#endif
599 break;
600 }
601 case ESPHOME_EVENT_ID_WIFI_AP_STAIPASSIGNED: {
602 ESP_LOGV(TAG, "AP client assigned IP");
603 break;
604 }
605 case ESPHOME_EVENT_ID_WIFI_AP_PROBEREQRECVED: {
606#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERY_VERBOSE
607 auto &it = event->data.ap_probe_req;
608 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
609 format_mac_addr_upper(it.mac, mac_buf);
610 ESP_LOGVV(TAG, "AP receive Probe Request MAC=%s RSSI=%d", mac_buf, it.rssi);
611#endif
612 break;
613 }
614 default:
615 break;
616 }
617}
619 WiFi.onEvent(
620 [this](arduino_event_id_t event, arduino_event_info_t info) { this->wifi_event_callback_(event, info); });
621 // Make sure WiFi is in clean state before anything starts
622 this->wifi_mode_(false, false);
623}
625 // Use state machine instead of querying WiFi.status() directly
626 // State is updated in main loop from queued events, ensuring thread safety
627 switch (static_cast<LTWiFiSTAState>(this->sta_state_)) {
637 default:
639 }
640}
641bool WiFiComponent::wifi_scan_start_(bool passive) {
642 // enable STA
643 if (!this->wifi_mode_(true, {}))
644 return false;
645
646 // Reset scan_done_ before starting new scan to prevent stale flag from previous scan
647 // (e.g., roaming scan completed just before unexpected disconnect)
648 this->scan_done_ = false;
649
650 // need to use WiFi because of WiFiScanClass allocations :(
651 int16_t err = WiFi.scanNetworks(true, true, passive, 200);
652 if (err != WIFI_SCAN_RUNNING) {
653 ESP_LOGV(TAG, "WiFi.scanNetworks failed: %d", err);
654 return false;
655 }
656
657 return true;
658}
660 this->scan_result_.clear();
661 this->scan_done_ = true;
662
663 int16_t num = WiFi.scanComplete();
664 if (num < 0)
665 return;
666
667 bool needs_full = this->needs_full_scan_results_();
668
669 // Access scan results directly via WiFi.scan struct to avoid Arduino String allocations
670 // WiFi.scan is public in LibreTiny for WiFiEvents & WiFiScan static handlers
671 auto *scan = WiFi.scan;
672
673 // First pass: count matching networks
674 size_t count = 0;
675 for (int i = 0; i < num; i++) {
676 const char *ssid_cstr = scan->ap[i].ssid;
677 if (needs_full || this->matches_configured_network_(ssid_cstr, scan->ap[i].bssid.addr)) {
678 count++;
679 }
680 }
681
682 this->scan_result_.init(count); // Exact allocation
683
684 // Second pass: store matching networks
685 for (int i = 0; i < num; i++) {
686 const char *ssid_cstr = scan->ap[i].ssid;
687 if (needs_full || this->matches_configured_network_(ssid_cstr, scan->ap[i].bssid.addr)) {
688 auto &ap = scan->ap[i];
689 this->scan_result_.emplace_back(bssid_t{ap.bssid.addr[0], ap.bssid.addr[1], ap.bssid.addr[2], ap.bssid.addr[3],
690 ap.bssid.addr[4], ap.bssid.addr[5]},
691 ssid_cstr, strlen(ssid_cstr), ap.channel, ap.rssi, ap.auth != WIFI_AUTH_OPEN,
692 ssid_cstr[0] == '\0');
693 } else {
694 auto &ap = scan->ap[i];
695 this->log_discarded_scan_result_(ssid_cstr, ap.bssid.addr, ap.rssi, ap.channel);
696 }
697 }
698 ESP_LOGV(TAG, "Scan complete: %d found, %zu stored%s", num, this->scan_result_.size(),
699 needs_full ? "" : " (filtered)");
700 WiFi.scanDelete();
701#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
703#endif
704}
705
706#ifdef USE_WIFI_AP
707bool WiFiComponent::wifi_ap_ip_config_(const optional<ManualIP> &manual_ip) {
708 // enable AP
709 if (!this->wifi_mode_({}, true))
710 return false;
711
712 if (manual_ip.has_value()) {
713 return WiFi.softAPConfig(manual_ip->static_ip, manual_ip->gateway, manual_ip->subnet);
714 } else {
715 return WiFi.softAPConfig(IPAddress(192, 168, 4, 1), IPAddress(192, 168, 4, 1), IPAddress(255, 255, 255, 0));
716 }
717}
718
719bool WiFiComponent::wifi_start_ap_(const WiFiAP &ap) {
720 // enable AP
721 if (!this->wifi_mode_({}, true))
722 return false;
723
724#ifdef USE_WIFI_MANUAL_IP
725 if (!this->wifi_ap_ip_config_(ap.get_manual_ip())) {
726 ESP_LOGV(TAG, "wifi_ap_ip_config_ failed");
727 return false;
728 }
729#else
730 if (!this->wifi_ap_ip_config_({})) {
731 ESP_LOGV(TAG, "wifi_ap_ip_config_ failed");
732 return false;
733 }
734#endif
735
736 yield();
737
738 return WiFi.softAP(ap.ssid_.c_str(), ap.password_.empty() ? NULL : ap.password_.c_str(),
739 ap.has_channel() ? ap.get_channel() : 1, ap.get_hidden());
740}
741
742network::IPAddress WiFiComponent::wifi_soft_ap_ip() { return {WiFi.softAPIP()}; }
743#endif // USE_WIFI_AP
744
746 // Reset state first so disconnect events aren't ignored
747 // and wifi_sta_connect_status_() returns IDLE instead of CONNECTING
748 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::IDLE);
749 return WiFi.disconnect();
750}
751
753 bssid_t bssid{};
754 uint8_t *raw_bssid = WiFi.BSSID();
755 if (raw_bssid != nullptr) {
756 for (size_t i = 0; i < bssid.size(); i++)
757 bssid[i] = raw_bssid[i];
758 }
759 return bssid;
760}
761std::string WiFiComponent::wifi_ssid() { return WiFi.SSID().c_str(); }
762const char *WiFiComponent::wifi_ssid_to(std::span<char, SSID_BUFFER_SIZE> buffer) {
763#ifdef USE_BK72XX
764 LinkStatusTypeDef link_status{};
765 bk_wlan_get_link_status(&link_status);
766 size_t len = strnlen(reinterpret_cast<const char *>(link_status.ssid), SSID_BUFFER_SIZE - 1);
767 memcpy(buffer.data(), link_status.ssid, len);
768#elif defined(USE_RTL87XX)
769 rtw_wifi_setting_t setting{};
770 wifi_get_setting("wlan0", &setting);
771 size_t len = strnlen(reinterpret_cast<const char *>(setting.ssid), SSID_BUFFER_SIZE - 1);
772 memcpy(buffer.data(), setting.ssid, len);
773#else
774 // LN882X: wifi_get_sta_conn_info() provides direct pointer access
775 String ssid = WiFi.SSID();
776 size_t len = std::min(static_cast<size_t>(ssid.length()), SSID_BUFFER_SIZE - 1);
777 memcpy(buffer.data(), ssid.c_str(), len);
778#endif
779 buffer[len] = '\0';
780 return buffer.data();
781}
782int8_t WiFiComponent::wifi_rssi() { return WiFi.status() == WL_CONNECTED ? WiFi.RSSI() : WIFI_RSSI_DISCONNECTED; }
783int32_t WiFiComponent::get_wifi_channel() { return WiFi.channel(); }
784network::IPAddress WiFiComponent::wifi_subnet_mask_() { return {WiFi.subnetMask()}; }
785network::IPAddress WiFiComponent::wifi_gateway_ip_() { return {WiFi.gatewayIP()}; }
786network::IPAddress WiFiComponent::wifi_dns_ip_(int num) { return {WiFi.dnsIP(num)}; }
788 // Use pop() directly instead of empty() — avoids redundant synchronization.
789 // LockFreeQueue: pop() costs 1 memw vs empty()'s 2 memw on Xtensa.
790 // FreeRTOSQueue: pop() is 1 critical section vs empty() + pop() = 2.
791 LTWiFiEvent *event = this->event_queue_.pop();
792 if (event == nullptr)
793 return false;
794
795 do {
796 wifi_process_event_(event);
797 delete event; // NOLINT(cppcoreguidelines-owning-memory)
798 } while ((event = this->event_queue_.pop()) != nullptr);
799
800 // Drops only occur when the queue is full, and only this loop drains it,
801 // so if pop() returned nullptr above we can skip this check.
802 uint16_t dropped = this->event_queue_.get_and_reset_dropped_count();
803 if (dropped > 0) {
804 ESP_LOGW(TAG, "Dropped %" PRIu16 " WiFi events due to buffer overflow", dropped);
805 }
806 return true;
807}
808
809} // namespace esphome::wifi
810#endif // USE_LIBRETINY
811#endif
BedjetMode mode
BedJet operating mode.
uint8_t address
Definition bl0906.h:4
uint8_t status
Definition bl0942.h:8
const StringRef & get_name() const
Get the name of this Application set by pre_setup().
uint16_t get_and_reset_dropped_count()
bool push(T *element)
constexpr const char * c_str() const
Definition string_ref.h:73
const optional< ManualIP > & get_manual_ip() const
void notify_scan_results_listeners_()
Notify scan results listeners with current scan results.
const WiFiAP * get_selected_sta_() const
WiFiSTAConnectStatus wifi_sta_connect_status_() const
wifi_scan_vector_t< WiFiScanResult > scan_result_
struct esphome::wifi::WiFiComponent::@190 pending_
void notify_ip_state_listeners_()
Notify IP state listeners with current addresses.
bool wifi_sta_ip_config_(const optional< ManualIP > &manual_ip)
void wifi_process_event_(IDFWiFiEvent *data)
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)
ESPDEPRECATED("Use wifi_ssid_to() instead. Removed in 2026.9.0", "2026.3.0") std const char * wifi_ssid_to(std::span< char, SSID_BUFFER_SIZE > buffer)
Write SSID to buffer without heap allocation.
void wifi_event_callback_(arduino_event_id_t event, arduino_event_info_t info)
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...
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)
LockFreeQueue< IDFWiFiEvent, 17 > event_queue_
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()
void yield(void)
mopeka_std_values val[3]
std::array< IPAddress, 5 > IPAddresses
Definition ip_address.h:187
const char *const TAG
Definition spi.cpp:7
std::array< uint8_t, 6 > bssid_t
const LogString * get_auth_mode_str(uint8_t mode)
arduino_event_info_t esphome_wifi_event_info_t
const LogString * get_disconnect_reason_str(uint8_t reason)
arduino_event_id_t esphome_wifi_event_id_t
const LogString * get_op_mode_str(uint8_t mode)
std::string size_t len
void HOT delay(uint32_t ms)
Definition hal.cpp:82
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:1453
static void uint32_t