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