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