ESPHome 2026.10.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
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[MAC_ADDRESS_SIZE];
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 // Fresh STA stack: skip the pre-attempt teardown again.
119 this->lt_first_connect_attempt_ = true;
120 } else if (!enable_sta && current_sta) {
121 ESP_LOGV(TAG, "Disabling STA");
122 }
123 if (enable_ap && !current_ap) {
124 ESP_LOGV(TAG, "Enabling AP");
125 } else if (!enable_ap && current_ap) {
126 ESP_LOGV(TAG, "Disabling AP");
127 }
128
129 uint8_t mode = 0;
130 if (enable_sta)
131 mode |= 0b01;
132 if (enable_ap)
133 mode |= 0b10;
134 bool ret = WiFi.mode(static_cast<wifi_mode_t>(mode));
135
136 if (!ret) {
137 ESP_LOGW(TAG, "Setting mode failed");
138 return false;
139 }
140
141 this->ap_started_ = enable_ap;
142
143 return ret;
144}
145bool WiFiComponent::wifi_apply_output_power_(float output_power) {
146 int8_t val = static_cast<int8_t>(output_power * 4);
147 return WiFi.setTxPower(val);
148}
150 if (!this->wifi_mode_(true, {}))
151 return false;
152
153 WiFi.setAutoReconnect(false);
154 delay(10);
155 return true;
156}
158 bool success = WiFi.setSleep(this->power_save_ != WIFI_POWER_SAVE_NONE);
159#ifdef USE_WIFI_POWER_SAVE_LISTENERS
160 if (success) {
161 for (auto *listener : this->power_save_listeners_) {
162 listener->on_wifi_power_save(this->power_save_);
163 }
164 }
165#endif
166 return success;
167}
168bool WiFiComponent::wifi_sta_ip_config_(const optional<ManualIP> &manual_ip) {
169 // enable STA
170 if (!this->wifi_mode_(true, {}))
171 return false;
172
173 if (!manual_ip.has_value()) {
174 return true;
175 }
176
177 WiFi.config(manual_ip->static_ip, manual_ip->gateway, manual_ip->subnet, manual_ip->dns1, manual_ip->dns2);
178
179 return true;
180}
181
183 if (!this->has_sta())
184 return {};
185 network::IPAddresses addresses;
186 addresses[0] = WiFi.localIP();
187#if USE_NETWORK_IPV6
188 int i = 1;
189 auto v6_addresses = WiFi.allLocalIPv6();
190 for (auto address : v6_addresses) {
191 addresses[i++] = network::IPAddress(address.toString().c_str());
192 }
193#endif /* USE_NETWORK_IPV6 */
194 return addresses;
195}
196
198 // setting is done in SYSTEM_EVENT_STA_START callback too
199 WiFi.setHostname(App.get_name().c_str());
200 return true;
201}
202bool WiFiComponent::wifi_sta_connect_(const WiFiAP &ap) {
203 // enable STA
204 if (!this->wifi_mode_(true, {}))
205 return false;
206
207 // Tear down any live session so begin() re-fires its events; skipped on the
208 // first attempt after STA-up (nothing to tear down, and BK7231N on the older
209 // Beken SDK did not come back from it). The flag is per-attempt and armed
210 // only for a live session: an idle disconnect may emit no event, and a stale
211 // flag would swallow this attempt's first real failure.
212 this->lt_teardown_event_pending_ = false;
213 if (!this->lt_first_connect_attempt_) {
214 const bool was_live = WiFi.status() == WL_CONNECTED;
215 if (WiFi.disconnect()) {
216 this->lt_teardown_event_pending_ = was_live;
217 } else {
218 ESP_LOGD(TAG, "Pre-connect teardown returned false");
219 }
220 }
221 this->lt_first_connect_attempt_ = false;
222
223#ifdef USE_WIFI_MANUAL_IP
224 if (!this->wifi_sta_ip_config_(ap.get_manual_ip())) {
225 return false;
226 }
227#else
228 if (!this->wifi_sta_ip_config_({})) {
229 return false;
230 }
231#endif
232
233 this->wifi_apply_hostname_();
234
235 // Reset state machine and disconnect counter before connecting
236 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::CONNECTING);
237 s_ignored_disconnect_count = 0;
238
239 WiFiStatus status = WiFi.begin(ap.ssid_.c_str(), ap.password_.empty() ? NULL : ap.password_.c_str(),
240 ap.get_channel(), // 0 = auto
241 ap.has_bssid() ? ap.get_bssid().data() : NULL);
242 if (status != WL_CONNECTED) {
243 ESP_LOGW(TAG, "WiFi.begin failed: %d", status);
244 // Without this reset the state machine stays at CONNECTING and each retry
245 // stalls for the full connect timeout (46 s).
246 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
247 return false;
248 }
249
250 return true;
251}
252const char *get_auth_mode_str(uint8_t mode) {
253 switch (mode) {
254 case WIFI_AUTH_OPEN:
255 return "OPEN";
256 case WIFI_AUTH_WEP:
257 return "WEP";
258 case WIFI_AUTH_WPA_PSK:
259 return "WPA PSK";
260 case WIFI_AUTH_WPA2_PSK:
261 return "WPA2 PSK";
262 case WIFI_AUTH_WPA_WPA2_PSK:
263 return "WPA/WPA2 PSK";
264 default:
265 return "UNKNOWN";
266 }
267}
268
269const char *get_op_mode_str(uint8_t mode) {
270 switch (mode) {
271 case WIFI_OFF:
272 return "OFF";
273 case WIFI_STA:
274 return "STA";
275 case WIFI_AP:
276 return "AP";
277 case WIFI_AP_STA:
278 return "AP+STA";
279 default:
280 return "UNKNOWN";
281 }
282}
283const char *get_disconnect_reason_str(uint8_t reason) {
284 switch (reason) {
285 case WIFI_REASON_AUTH_EXPIRE:
286 return "Auth Expired";
287 case WIFI_REASON_AUTH_LEAVE:
288 return "Auth Leave";
289 case WIFI_REASON_ASSOC_EXPIRE:
290 return "Association Expired";
291 case WIFI_REASON_ASSOC_TOOMANY:
292 return "Too Many Associations";
293 case WIFI_REASON_NOT_AUTHED:
294 return "Not Authenticated";
295 case WIFI_REASON_NOT_ASSOCED:
296 return "Not Associated";
297 case WIFI_REASON_ASSOC_LEAVE:
298 return "Association Leave";
299 case WIFI_REASON_ASSOC_NOT_AUTHED:
300 return "Association not Authenticated";
301 case WIFI_REASON_DISASSOC_PWRCAP_BAD:
302 return "Disassociate Power Cap Bad";
303 case WIFI_REASON_DISASSOC_SUPCHAN_BAD:
304 return "Disassociate Supported Channel Bad";
305 case WIFI_REASON_IE_INVALID:
306 return "IE Invalid";
307 case WIFI_REASON_MIC_FAILURE:
308 return "Mic Failure";
309 case WIFI_REASON_4WAY_HANDSHAKE_TIMEOUT:
310 return "4-Way Handshake Timeout";
311 case WIFI_REASON_GROUP_KEY_UPDATE_TIMEOUT:
312 return "Group Key Update Timeout";
313 case WIFI_REASON_IE_IN_4WAY_DIFFERS:
314 return "IE In 4-Way Handshake Differs";
315 case WIFI_REASON_GROUP_CIPHER_INVALID:
316 return "Group Cipher Invalid";
317 case WIFI_REASON_PAIRWISE_CIPHER_INVALID:
318 return "Pairwise Cipher Invalid";
319 case WIFI_REASON_AKMP_INVALID:
320 return "AKMP Invalid";
321 case WIFI_REASON_UNSUPP_RSN_IE_VERSION:
322 return "Unsupported RSN IE version";
323 case WIFI_REASON_INVALID_RSN_IE_CAP:
324 return "Invalid RSN IE Cap";
325 case WIFI_REASON_802_1X_AUTH_FAILED:
326 return "802.1x Authentication Failed";
327 case WIFI_REASON_CIPHER_SUITE_REJECTED:
328 return "Cipher Suite Rejected";
329 case WIFI_REASON_BEACON_TIMEOUT:
330 return "Beacon Timeout";
331 case WIFI_REASON_NO_AP_FOUND:
332 return "AP Not Found";
333 case WIFI_REASON_AUTH_FAIL:
334 return "Authentication Failed";
335 case WIFI_REASON_ASSOC_FAIL:
336 return "Association Failed";
337 case WIFI_REASON_HANDSHAKE_TIMEOUT:
338 return "Handshake Failed";
339 case WIFI_REASON_CONNECTION_FAIL:
340 return "Connection Failed";
341 case WIFI_REASON_UNSPECIFIED:
342 default:
343 return "Unspecified";
344 }
345}
346
347#define ESPHOME_EVENT_ID_WIFI_READY ARDUINO_EVENT_WIFI_READY
348#define ESPHOME_EVENT_ID_WIFI_SCAN_DONE ARDUINO_EVENT_WIFI_SCAN_DONE
349#define ESPHOME_EVENT_ID_WIFI_STA_START ARDUINO_EVENT_WIFI_STA_START
350#define ESPHOME_EVENT_ID_WIFI_STA_STOP ARDUINO_EVENT_WIFI_STA_STOP
351#define ESPHOME_EVENT_ID_WIFI_STA_CONNECTED ARDUINO_EVENT_WIFI_STA_CONNECTED
352#define ESPHOME_EVENT_ID_WIFI_STA_DISCONNECTED ARDUINO_EVENT_WIFI_STA_DISCONNECTED
353#define ESPHOME_EVENT_ID_WIFI_STA_AUTHMODE_CHANGE ARDUINO_EVENT_WIFI_STA_AUTHMODE_CHANGE
354#define ESPHOME_EVENT_ID_WIFI_STA_GOT_IP ARDUINO_EVENT_WIFI_STA_GOT_IP
355#define ESPHOME_EVENT_ID_WIFI_STA_GOT_IP6 ARDUINO_EVENT_WIFI_STA_GOT_IP6
356#define ESPHOME_EVENT_ID_WIFI_STA_LOST_IP ARDUINO_EVENT_WIFI_STA_LOST_IP
357#define ESPHOME_EVENT_ID_WIFI_AP_START ARDUINO_EVENT_WIFI_AP_START
358#define ESPHOME_EVENT_ID_WIFI_AP_STOP ARDUINO_EVENT_WIFI_AP_STOP
359#define ESPHOME_EVENT_ID_WIFI_AP_STACONNECTED ARDUINO_EVENT_WIFI_AP_STACONNECTED
360#define ESPHOME_EVENT_ID_WIFI_AP_STADISCONNECTED ARDUINO_EVENT_WIFI_AP_STADISCONNECTED
361#define ESPHOME_EVENT_ID_WIFI_AP_STAIPASSIGNED ARDUINO_EVENT_WIFI_AP_STAIPASSIGNED
362#define ESPHOME_EVENT_ID_WIFI_AP_PROBEREQRECVED ARDUINO_EVENT_WIFI_AP_PROBEREQRECVED
363#define ESPHOME_EVENT_ID_WIFI_AP_GOT_IP6 ARDUINO_EVENT_WIFI_AP_GOT_IP6
364using esphome_wifi_event_id_t = arduino_event_id_t;
365using esphome_wifi_event_info_t = arduino_event_info_t;
366
367// Event callback - runs in WiFi driver thread context
368// Only queues events for processing in main loop, no logging or state changes here
370 // Allocate on heap and fill directly to avoid extra memcpy
371 auto *to_send = new LTWiFiEvent{}; // NOLINT(cppcoreguidelines-owning-memory)
372 to_send->event_id = event;
373
374 // Copy event-specific data
375 switch (event) {
376 case ESPHOME_EVENT_ID_WIFI_STA_CONNECTED: {
377 auto &it = info.wifi_sta_connected;
378 to_send->data.sta_connected.ssid_len = it.ssid_len;
379 memcpy(to_send->data.sta_connected.ssid, it.ssid,
380 std::min(static_cast<size_t>(it.ssid_len), sizeof(to_send->data.sta_connected.ssid) - 1));
381 memcpy(to_send->data.sta_connected.bssid, it.bssid, 6);
382 to_send->data.sta_connected.channel = it.channel;
383 to_send->data.sta_connected.authmode = it.authmode;
384 break;
385 }
386 case ESPHOME_EVENT_ID_WIFI_STA_DISCONNECTED: {
387 auto &it = info.wifi_sta_disconnected;
388 to_send->data.sta_disconnected.ssid_len = it.ssid_len;
389 memcpy(to_send->data.sta_disconnected.ssid, it.ssid,
390 std::min(static_cast<size_t>(it.ssid_len), sizeof(to_send->data.sta_disconnected.ssid) - 1));
391 memcpy(to_send->data.sta_disconnected.bssid, it.bssid, 6);
392 to_send->data.sta_disconnected.reason = it.reason;
393 break;
394 }
395 case ESPHOME_EVENT_ID_WIFI_STA_AUTHMODE_CHANGE: {
396 auto &it = info.wifi_sta_authmode_change;
397 to_send->data.sta_authmode_change.old_mode = it.old_mode;
398 to_send->data.sta_authmode_change.new_mode = it.new_mode;
399 break;
400 }
401 case ESPHOME_EVENT_ID_WIFI_SCAN_DONE: {
402 auto &it = info.wifi_scan_done;
403 to_send->data.scan_done.status = it.status;
404 to_send->data.scan_done.number = it.number;
405 to_send->data.scan_done.scan_id = it.scan_id;
406 break;
407 }
408 case ESPHOME_EVENT_ID_WIFI_AP_PROBEREQRECVED: {
409 auto &it = info.wifi_ap_probereqrecved;
410 memcpy(to_send->data.ap_probe_req.mac, it.mac, MAC_ADDRESS_SIZE);
411 to_send->data.ap_probe_req.rssi = it.rssi;
412 break;
413 }
414 case ESPHOME_EVENT_ID_WIFI_AP_STACONNECTED: {
415 auto &it = info.wifi_sta_connected;
416 memcpy(to_send->data.sta_connected.bssid, it.bssid, 6);
417 break;
418 }
419 case ESPHOME_EVENT_ID_WIFI_AP_STADISCONNECTED: {
420 auto &it = info.wifi_sta_disconnected;
421 memcpy(to_send->data.sta_disconnected.bssid, it.bssid, 6);
422 break;
423 }
424 case ESPHOME_EVENT_ID_WIFI_READY:
425 case ESPHOME_EVENT_ID_WIFI_STA_START:
426 case ESPHOME_EVENT_ID_WIFI_STA_STOP:
427 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP:
428 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP6:
429 case ESPHOME_EVENT_ID_WIFI_STA_LOST_IP:
430 case ESPHOME_EVENT_ID_WIFI_AP_START:
431 case ESPHOME_EVENT_ID_WIFI_AP_STOP:
432 case ESPHOME_EVENT_ID_WIFI_AP_STAIPASSIGNED:
433 // No additional data needed
434 break;
435 default:
436 // Unknown event, don't queue
437 delete to_send; // NOLINT(cppcoreguidelines-owning-memory)
438 return;
439 }
440
441 // Queue event (don't block if queue is full)
442 if (!this->event_queue_.push(to_send)) {
443 delete to_send; // NOLINT(cppcoreguidelines-owning-memory)
444 }
445}
446
447// Process a single event from the queue - runs in main loop context.
448// Listener notifications must be deferred until after the state machine transitions
449// (in check_connecting_finished) so that conditions like wifi.connected return
450// correct values in automations.
451void WiFiComponent::wifi_process_event_(LTWiFiEvent *event) {
452 switch (event->event_id) {
453 case ESPHOME_EVENT_ID_WIFI_READY: {
454 ESP_LOGV(TAG, "Ready");
455 break;
456 }
457 case ESPHOME_EVENT_ID_WIFI_SCAN_DONE: {
458 auto &it = event->data.scan_done;
459 ESP_LOGV(TAG, "Scan done: status=%" PRIu32 " number=%u scan_id=%u", it.status, it.number, it.scan_id);
461 break;
462 }
463 case ESPHOME_EVENT_ID_WIFI_STA_START: {
464 ESP_LOGV(TAG, "STA start");
465 WiFi.setHostname(App.get_name().c_str());
466 break;
467 }
468 case ESPHOME_EVENT_ID_WIFI_STA_STOP: {
469 ESP_LOGV(TAG, "STA stop");
470 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::IDLE);
471 break;
472 }
473 case ESPHOME_EVENT_ID_WIFI_STA_CONNECTED: {
474 // Processed in queue order, so a teardown event still ahead of this
475 // CONNECTED was already consumed; a leftover flag is stale.
476 this->lt_teardown_event_pending_ = false;
477 auto &it = event->data.sta_connected;
478 char bssid_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
479 format_mac_addr_upper(it.bssid, bssid_buf);
480 ESP_LOGV(TAG, "Connected ssid='%.*s' bssid=" LOG_SECRET("%s") " channel=%u, authmode=%s", it.ssid_len,
481 (const char *) it.ssid, bssid_buf, it.channel, get_auth_mode_str(it.authmode));
482 // Note: We don't set CONNECTED state here yet - wait for GOT_IP
483 // This matches ESP32 IDF behavior where s_sta_connected is set but
484 // wifi_sta_connect_status_() also checks got_ipv4_address_
485#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
486 // Defer listener notification until state machine reaches STA_CONNECTED
487 // This ensures wifi.connected condition returns true in listener automations
488 this->pending_.connect_state = true;
489#endif
490 // For static IP configurations, GOT_IP event may not fire, so set connected state here
491#ifdef USE_WIFI_MANUAL_IP
492 if (const WiFiAP *config = this->get_selected_sta_(); config && config->get_manual_ip().has_value()) {
493 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::CONNECTED);
494#ifdef USE_WIFI_IP_STATE_LISTENERS
496#endif
497 }
498#endif
499 break;
500 }
501 case ESPHOME_EVENT_ID_WIFI_STA_DISCONNECTED: {
502 auto &it = event->data.sta_disconnected;
503
504 // Consume the disconnect our own teardown queued, without spending an
505 // ignore slot. Ungated on SSID and state: the flag is armed only for this
506 // attempt's teardown of a live session.
507 if (this->lt_teardown_event_pending_ && it.reason != WIFI_REASON_NO_AP_FOUND) {
508 this->lt_teardown_event_pending_ = false;
509 break;
510 }
511
512 // LibreTiny can send spurious disconnect events with empty ssid/bssid during connection.
513 // These are typically "Association Leave" events that don't indicate actual failures:
514 // [W][wifi_lt]: Disconnected ssid='' bssid=00:00:00:00:00:00 reason='Association Leave'
515 // [W][wifi_lt]: Disconnected ssid='' bssid=00:00:00:00:00:00 reason='Association Leave'
516 // [V][wifi_lt]: Connected ssid='WIFI' bssid=... channel=3, authmode=WPA2 PSK
517 // Without this check, the spurious events would transition state to ERROR_FAILED,
518 // causing wifi_sta_connect_status_() to return an error. The main loop would then
519 // call retry_connect(), aborting a connection that may succeed moments later.
520 // Only ignore benign reasons - real failures like NO_AP_FOUND should still be processed.
521 // However, if we get too many of these events (IGNORED_DISCONNECT_THRESHOLD), treat it
522 // as a real connection failure to avoid waiting the full timeout for a failing connection.
523 if (it.ssid_len == 0 && this->sta_state_ == static_cast<uint8_t>(LTWiFiSTAState::CONNECTING) &&
524 it.reason != WIFI_REASON_NO_AP_FOUND) {
525 s_ignored_disconnect_count++;
526 if (s_ignored_disconnect_count >= IGNORED_DISCONNECT_THRESHOLD) {
527 ESP_LOGW(TAG, "Too many disconnect events (%u) while connecting, treating as failure (reason=%s)",
528 s_ignored_disconnect_count, get_disconnect_reason_str(it.reason));
529 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
530 WiFi.disconnect();
531 this->error_from_callback_ = true;
532 // Don't break - fall through to notify listeners
533 } else {
534 ESP_LOGV(TAG, "Ignoring disconnect event with empty ssid while connecting (reason=%s, count=%u)",
535 get_disconnect_reason_str(it.reason), s_ignored_disconnect_count);
536 break;
537 }
538 }
539
540 if (it.reason == WIFI_REASON_NO_AP_FOUND) {
541 ESP_LOGW(TAG, "Disconnected ssid='%.*s' reason='Probe Request Unsuccessful'", it.ssid_len,
542 (const char *) it.ssid);
543 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_NOT_FOUND);
544 } else {
545 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
546 format_mac_addr_upper(it.bssid, bssid_s);
547 ESP_LOGW(TAG, "Disconnected ssid='%.*s' bssid=" LOG_SECRET("%s") " reason='%s'", it.ssid_len,
548 (const char *) it.ssid, bssid_s, get_disconnect_reason_str(it.reason));
549 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
550 }
551
552 uint8_t reason = it.reason;
553 if (reason == WIFI_REASON_AUTH_EXPIRE || reason == WIFI_REASON_BEACON_TIMEOUT ||
554 reason == WIFI_REASON_NO_AP_FOUND || reason == WIFI_REASON_ASSOC_FAIL ||
555 reason == WIFI_REASON_HANDSHAKE_TIMEOUT) {
556 WiFi.disconnect();
557 this->error_from_callback_ = true;
558 }
559
560 // Refresh is_connected() cache; sta_state_/error_from_callback_ make it false.
562#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
564#endif
565 break;
566 }
567 case ESPHOME_EVENT_ID_WIFI_STA_AUTHMODE_CHANGE: {
568 auto &it = event->data.sta_authmode_change;
569 ESP_LOGV(TAG, "Authmode Change old=%s new=%s", get_auth_mode_str(it.old_mode), get_auth_mode_str(it.new_mode));
570 // Mitigate CVE-2020-12638
571 // https://lbsfilm.at/blog/wpa2-authenticationmode-downgrade-in-espressif-microprocessors
572 if (it.old_mode != WIFI_AUTH_OPEN && it.new_mode == WIFI_AUTH_OPEN) {
573 ESP_LOGW(TAG, "Potential Authmode downgrade detected, disconnecting");
574 WiFi.disconnect();
575 this->error_from_callback_ = true;
576 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::ERROR_FAILED);
577 }
578 break;
579 }
580 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP: {
581 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE], gw_buf[network::IP_ADDRESS_BUFFER_SIZE];
582 ESP_LOGV(TAG, "static_ip=%s gateway=%s", network::IPAddress(WiFi.localIP()).str_to(ip_buf),
583 network::IPAddress(WiFi.gatewayIP()).str_to(gw_buf));
584 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::CONNECTED);
585#ifdef USE_WIFI_IP_STATE_LISTENERS
587#endif
588 break;
589 }
590 case ESPHOME_EVENT_ID_WIFI_STA_GOT_IP6: {
591 ESP_LOGV(TAG, "Got IPv6");
592#ifdef USE_WIFI_IP_STATE_LISTENERS
594#endif
595 break;
596 }
597 case ESPHOME_EVENT_ID_WIFI_STA_LOST_IP: {
598 ESP_LOGV(TAG, "Lost IP");
599 // Don't change state to IDLE - let the disconnect event handle that
600 break;
601 }
602 case ESPHOME_EVENT_ID_WIFI_AP_START: {
603 ESP_LOGV(TAG, "AP start");
604 break;
605 }
606 case ESPHOME_EVENT_ID_WIFI_AP_STOP: {
607 ESP_LOGV(TAG, "AP stop");
608 break;
609 }
610 case ESPHOME_EVENT_ID_WIFI_AP_STACONNECTED: {
611#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
612 auto &it = event->data.sta_connected;
613 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
614 format_mac_addr_upper(it.bssid, mac_buf);
615 ESP_LOGV(TAG, "AP client connected MAC=%s", mac_buf);
616#endif
617 break;
618 }
619 case ESPHOME_EVENT_ID_WIFI_AP_STADISCONNECTED: {
620#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
621 auto &it = event->data.sta_disconnected;
622 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
623 format_mac_addr_upper(it.bssid, mac_buf);
624 ESP_LOGV(TAG, "AP client disconnected MAC=%s", mac_buf);
625#endif
626 break;
627 }
628 case ESPHOME_EVENT_ID_WIFI_AP_STAIPASSIGNED: {
629 ESP_LOGV(TAG, "AP client assigned IP");
630 break;
631 }
632 case ESPHOME_EVENT_ID_WIFI_AP_PROBEREQRECVED: {
633#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERY_VERBOSE
634 auto &it = event->data.ap_probe_req;
635 char mac_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
636 format_mac_addr_upper(it.mac, mac_buf);
637 ESP_LOGVV(TAG, "AP receive Probe Request MAC=%s RSSI=%d", mac_buf, it.rssi);
638#endif
639 break;
640 }
641 default:
642 break;
643 }
644}
646 WiFi.onEvent(
647 [this](arduino_event_id_t event, arduino_event_info_t info) { this->wifi_event_callback_(event, info); });
648 // Make sure WiFi is in clean state before anything starts
649 this->wifi_mode_(false, false);
650}
652 // Use state machine instead of querying WiFi.status() directly
653 // State is updated in main loop from queued events, ensuring thread safety
654 switch (static_cast<LTWiFiSTAState>(this->sta_state_)) {
664 default:
666 }
667}
668bool WiFiComponent::wifi_scan_start_(bool passive) {
669 // enable STA
670 if (!this->wifi_mode_(true, {}))
671 return false;
672
673 // Reset scan_done_ before starting new scan to prevent stale flag from previous scan
674 // (e.g., roaming scan completed just before unexpected disconnect)
675 this->scan_done_ = false;
676
677 // need to use WiFi because of WiFiScanClass allocations :(
678 int16_t err = WiFi.scanNetworks(true, true, passive, 200);
679 if (err != WIFI_SCAN_RUNNING) {
680 ESP_LOGV(TAG, "WiFi.scanNetworks failed: %d", err);
681 return false;
682 }
683
684 return true;
685}
687 int16_t num = WiFi.scanComplete();
688 bool needs_full = this->needs_full_scan_results_();
689 {
690 // Mutate in place under the lock; blocking a portal request is fine and
691 // avoids scratch buffers
692 ScanResultsLock lock(this);
693 this->scan_result_.clear();
694 this->scan_done_ = true;
695
696 if (num < 0)
697 return;
698
699 // Access scan results directly via WiFi.scan struct to avoid Arduino String allocations
700 // WiFi.scan is public in LibreTiny for WiFiEvents & WiFiScan static handlers
701 auto *scan = WiFi.scan;
702
703 // First pass: count matching networks
704 size_t count = 0;
705 for (int i = 0; i < num; i++) {
706 const char *ssid_cstr = scan->ap[i].ssid;
707 if (needs_full || this->matches_configured_network_(ssid_cstr, scan->ap[i].bssid.addr)) {
708 count++;
709 }
710 }
711
712 this->scan_result_.init(count); // Exact allocation
713
714 // Second pass: store matching networks
715 for (int i = 0; i < num; i++) {
716 const char *ssid_cstr = scan->ap[i].ssid;
717 auto &ap = scan->ap[i];
718 if (needs_full || this->matches_configured_network_(ssid_cstr, ap.bssid.addr)) {
719 this->scan_result_.emplace_back(bssid_t{ap.bssid.addr[0], ap.bssid.addr[1], ap.bssid.addr[2], ap.bssid.addr[3],
720 ap.bssid.addr[4], ap.bssid.addr[5]},
721 ssid_cstr, strlen(ssid_cstr), ap.channel, ap.rssi, ap.auth != WIFI_AUTH_OPEN,
722 ssid_cstr[0] == '\0');
723 } else {
724 this->log_discarded_scan_result_(ssid_cstr, ap.bssid.addr, ap.rssi, ap.channel);
725 }
726 }
727 }
728
729 ESP_LOGV(TAG, "Scan complete: %d found, %zu stored%s", num, this->scan_result_.size(),
730 needs_full ? "" : " (filtered)");
731 WiFi.scanDelete();
732#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
734#endif
735}
736
737#ifdef USE_WIFI_AP
738bool WiFiComponent::wifi_ap_ip_config_(const optional<ManualIP> &manual_ip) {
739 // enable AP
740 if (!this->wifi_mode_({}, true))
741 return false;
742
743 if (manual_ip.has_value()) {
744 return WiFi.softAPConfig(manual_ip->static_ip, manual_ip->gateway, manual_ip->subnet);
745 } else {
746 return WiFi.softAPConfig(IPAddress(192, 168, 4, 1), IPAddress(192, 168, 4, 1), IPAddress(255, 255, 255, 0));
747 }
748}
749
750bool WiFiComponent::wifi_start_ap_(const WiFiAP &ap) {
751 // enable AP
752 if (!this->wifi_mode_({}, true))
753 return false;
754
755#ifdef USE_WIFI_MANUAL_IP
756 if (!this->wifi_ap_ip_config_(ap.get_manual_ip())) {
757 ESP_LOGV(TAG, "wifi_ap_ip_config_ failed");
758 return false;
759 }
760#else
761 if (!this->wifi_ap_ip_config_({})) {
762 ESP_LOGV(TAG, "wifi_ap_ip_config_ failed");
763 return false;
764 }
765#endif
766
767 yield();
768
769 return WiFi.softAP(ap.ssid_.c_str(), ap.password_.empty() ? NULL : ap.password_.c_str(),
770 ap.has_channel() ? ap.get_channel() : 1, ap.get_hidden());
771}
772
773network::IPAddress WiFiComponent::wifi_soft_ap_ip() { return {WiFi.softAPIP()}; }
774#endif // USE_WIFI_AP
775
777 // Reset state first so disconnect events aren't ignored
778 // and wifi_sta_connect_status_() returns IDLE instead of CONNECTING
779 this->sta_state_ = static_cast<uint8_t>(LTWiFiSTAState::IDLE);
780 return WiFi.disconnect();
781}
782
784 bssid_t bssid{};
785 uint8_t *raw_bssid = WiFi.BSSID();
786 if (raw_bssid != nullptr) {
787 for (size_t i = 0; i < bssid.size(); i++)
788 bssid[i] = raw_bssid[i];
789 }
790 return bssid;
791}
792const char *WiFiComponent::wifi_ssid_to(std::span<char, SSID_BUFFER_SIZE> buffer) {
793#ifdef USE_BK72XX
794 LinkStatusTypeDef link_status{};
795 bk_wlan_get_link_status(&link_status);
796 size_t len = strnlen(reinterpret_cast<const char *>(link_status.ssid), SSID_BUFFER_SIZE - 1);
797 memcpy(buffer.data(), link_status.ssid, len);
798#elif defined(USE_RTL87XX)
799 rtw_wifi_setting_t setting{};
800 wifi_get_setting("wlan0", &setting);
801 size_t len = strnlen(reinterpret_cast<const char *>(setting.ssid), SSID_BUFFER_SIZE - 1);
802 memcpy(buffer.data(), setting.ssid, len);
803#else
804 // LN882X: wifi_get_sta_conn_info() provides direct pointer access
805 String ssid = WiFi.SSID();
806 size_t len = std::min(static_cast<size_t>(ssid.length()), SSID_BUFFER_SIZE - 1);
807 memcpy(buffer.data(), ssid.c_str(), len);
808#endif
809 buffer[len] = '\0';
810 return buffer.data();
811}
812int8_t WiFiComponent::wifi_rssi() { return WiFi.status() == WL_CONNECTED ? WiFi.RSSI() : WIFI_RSSI_DISCONNECTED; }
813int32_t WiFiComponent::get_wifi_channel() { return WiFi.channel(); }
814network::IPAddress WiFiComponent::wifi_subnet_mask_() { return {WiFi.subnetMask()}; }
815network::IPAddress WiFiComponent::wifi_gateway_ip_() { return {WiFi.gatewayIP()}; }
816network::IPAddress WiFiComponent::wifi_dns_ip_(int num) { return {WiFi.dnsIP(num)}; }
818 // Use pop() directly instead of empty() — avoids redundant synchronization.
819 // LockFreeQueue: pop() costs 1 memw vs empty()'s 2 memw on Xtensa.
820 // FreeRTOSQueue: pop() is 1 critical section vs empty() + pop() = 2.
821 LTWiFiEvent *event = this->event_queue_.pop();
822 if (event == nullptr)
823 return false;
824
825 do {
826 wifi_process_event_(event);
827 delete event; // NOLINT(cppcoreguidelines-owning-memory)
828 } while ((event = this->event_queue_.pop()) != nullptr);
829
830 // Drops only occur when the queue is full, and only this loop drains it,
831 // so if pop() returned nullptr above we can skip this check.
832 uint16_t dropped = this->event_queue_.get_and_reset_dropped_count();
833 if (dropped > 0) {
834 ESP_LOGW(TAG, "Dropped %" PRIu16 " WiFi events due to buffer overflow", dropped);
835 }
836 return true;
837}
838
839} // namespace esphome::wifi
840#endif // USE_LIBRETINY
841#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
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)
int ret
mopeka_std_values val[3]
std::array< IPAddress, 5 > IPAddresses
Definition ip_address.h:301
const char *const TAG
Definition spi.cpp:7
std::array< uint8_t, 6 > bssid_t
const LogString * get_auth_mode_str(uint8_t mode)
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:64
void HOT delay(uint32_t ms)
Definition hal.cpp:85
Application App
Global storage of Application pointer - only one Application can exist.
char * format_mac_addr_upper(const uint8_t *mac, char *output)
Format MAC address as XX:XX:XX:XX:XX:XX (uppercase, colon separators)
Definition helpers.h:1505
static void uint32_t
char * str_to(char *buf) const
Definition ip_address.h:101
SemaphoreHandle_t lock