ESPHome 2026.8.2
Loading...
Searching...
No Matches
wifi_component.cpp
Go to the documentation of this file.
1#include "wifi_component.h"
2#ifdef USE_WIFI
3#include <cassert>
4#include <cinttypes>
5#include <cmath>
6#include <type_traits>
7
8#ifdef USE_ESP32
9#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 0)
10#include <esp_eap_client.h>
11#else
12#include <esp_wpa2.h>
13#endif
14#endif
15
16#if defined(USE_ESP32)
17#include <esp_wifi.h>
18#endif
19#ifdef USE_ESP8266
20#include <user_interface.h>
21#endif
22
23#include <algorithm>
24#include <new>
25#include <utility>
26#include "lwip/dns.h"
27#include "lwip/err.h"
28
30#include "esphome/core/hal.h"
32#include "esphome/core/log.h"
34#include "esphome/core/util.h"
35
36#ifdef USE_CAPTIVE_PORTAL
38#endif
39
40#ifdef USE_IMPROV
42#endif
43
44#ifdef USE_IMPROV_SERIAL
46#endif
47
48#ifdef USE_PROVISIONING
50#endif
51
52namespace esphome::wifi {
53
54static const char *const TAG = "wifi";
55
56// CompactString implementation
57CompactString::CompactString(const char *str, size_t len) {
58 if (len > MAX_LENGTH) {
59 len = MAX_LENGTH; // Clamp to max valid length
60 }
61
62 this->length_ = len;
63 if (len <= INLINE_CAPACITY) {
64 // Store inline with null terminator
65 this->is_heap_ = 0;
66 if (len > 0) {
67 std::memcpy(this->storage_, str, len);
68 }
69 this->storage_[len] = '\0';
70 } else {
71 // Heap allocate with null terminator
72 this->is_heap_ = 1;
73 char *heap_data = new char[len + 1]; // NOLINT(cppcoreguidelines-owning-memory)
74 std::memcpy(heap_data, str, len);
75 heap_data[len] = '\0';
76 this->set_heap_ptr_(heap_data);
77 }
78}
79
80CompactString::CompactString(const CompactString &other) : CompactString(other.data(), other.size()) {}
81
83 if (this != &other) {
84 this->~CompactString();
85 new (this) CompactString(other);
86 }
87 return *this;
88}
89
90CompactString::CompactString(CompactString &&other) noexcept : length_(other.length_), is_heap_(other.is_heap_) {
91 // Copy full storage (includes null terminator for inline, or pointer for heap)
92 std::memcpy(this->storage_, other.storage_, INLINE_CAPACITY + 1);
93 other.length_ = 0;
94 other.is_heap_ = 0;
95 other.storage_[0] = '\0';
96}
97
99 if (this != &other) {
100 this->~CompactString();
101 new (this) CompactString(std::move(other));
102 }
103 return *this;
104}
105
107 if (this->is_heap_) {
108 delete[] this->get_heap_ptr_(); // NOLINT(cppcoreguidelines-owning-memory)
109 }
110}
111
112bool CompactString::operator==(const CompactString &other) const {
113 return this->size() == other.size() && std::memcmp(this->data(), other.data(), this->size()) == 0;
114}
115bool CompactString::operator==(const StringRef &other) const {
116 return this->size() == other.size() && std::memcmp(this->data(), other.c_str(), this->size()) == 0;
117}
118
314
315#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_INFO
316#ifdef USE_WIFI_PHY_MODE
317// Use if-chain instead of switch to avoid jump table in RODATA (wastes RAM on ESP8266)
318static const LogString *phy_mode_to_log_string(WiFi8266PhyMode mode) {
320 return LOG_STR("11B");
322 return LOG_STR("11G");
324 return LOG_STR("11N");
325 return LOG_STR("Auto");
326}
327#endif
328// Use if-chain instead of switch to avoid jump table in RODATA (wastes RAM on ESP8266)
329static const LogString *retry_phase_to_log_string(WiFiRetryPhase phase) {
331 return LOG_STR("INITIAL_CONNECT");
332#ifdef USE_WIFI_FAST_CONNECT
334 return LOG_STR("FAST_CONNECT_CYCLING");
335#endif
337 return LOG_STR("EXPLICIT_HIDDEN");
339 return LOG_STR("SCAN_CONNECTING");
340 if (phase == WiFiRetryPhase::RETRY_HIDDEN)
341 return LOG_STR("RETRY_HIDDEN");
343 return LOG_STR("RESTARTING");
344 return LOG_STR("UNKNOWN");
345}
346#endif // ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_INFO
347
349 // If first configured network is marked hidden, we went through EXPLICIT_HIDDEN phase
350 // This means those networks were already tried and should be skipped in RETRY_HIDDEN
351 return !this->sta_.empty() && this->sta_[0].get_hidden();
352}
353
355 // Find the first network that is NOT marked hidden:true
356 // This is where EXPLICIT_HIDDEN phase would have stopped
357 for (size_t i = 0; i < this->sta_.size(); i++) {
358 if (!this->sta_[i].get_hidden()) {
359 return static_cast<int8_t>(i);
360 }
361 }
362 return -1; // All networks are hidden
363}
364
365// 2 attempts per BSSID in SCAN_CONNECTING phase
366// Rationale: This is the ONLY phase where we decrease BSSID priority, so we must be very sure.
367// Auth failures are common immediately after scan due to WiFi stack state transitions.
368// Trying twice filters out false positives and prevents unnecessarily marking a good BSSID as bad.
369// After 2 genuine failures, priority degradation ensures we skip this BSSID on subsequent scans.
370static constexpr uint8_t WIFI_RETRY_COUNT_PER_BSSID = 2;
371
372// 1 attempt per SSID in RETRY_HIDDEN phase
373// Rationale: Try hidden mode once, then rescan to get next best BSSID via priority system
374static constexpr uint8_t WIFI_RETRY_COUNT_PER_SSID = 1;
375
376// 1 attempt per AP in fast_connect mode (INITIAL_CONNECT and FAST_CONNECT_CYCLING_APS)
377// Rationale: Fast connect prioritizes speed - try each AP once to find a working one quickly
378static constexpr uint8_t WIFI_RETRY_COUNT_PER_AP = 1;
379
382static constexpr uint32_t WIFI_COOLDOWN_DURATION_MS = 500;
383
387static constexpr uint32_t WIFI_COOLDOWN_WITH_AP_ACTIVE_MS = 30000;
388
392static constexpr uint32_t WIFI_SCAN_TIMEOUT_MS = 31000;
393
402static constexpr uint32_t WIFI_CONNECT_TIMEOUT_MS = 46000;
403
404static constexpr uint8_t get_max_retries_for_phase(WiFiRetryPhase phase) {
405 switch (phase) {
407#ifdef USE_WIFI_FAST_CONNECT
409#endif
410 // INITIAL_CONNECT and FAST_CONNECT_CYCLING_APS both use 1 attempt per AP (fast_connect mode)
411 return WIFI_RETRY_COUNT_PER_AP;
413 // Explicitly hidden network: 1 attempt (user marked as hidden, try once then scan)
414 return WIFI_RETRY_COUNT_PER_SSID;
416 // Scan-based phase: 2 attempts per BSSID (handles transient auth failures after scan)
417 return WIFI_RETRY_COUNT_PER_BSSID;
419 // Hidden network mode: 1 attempt per SSID
420 return WIFI_RETRY_COUNT_PER_SSID;
421 default:
422 return WIFI_RETRY_COUNT_PER_BSSID;
423 }
424}
425
426static void apply_scan_result_to_params(WiFiAP &params, const WiFiScanResult &scan) {
427 params.set_hidden(false);
428 params.set_ssid(scan.get_ssid());
429 params.set_bssid(scan.get_bssid());
430 params.set_channel(scan.get_channel());
431}
432
434 // Only SCAN_CONNECTING phase needs scan results
436 return false;
437 }
438 // Need scan if we have no results or no matching networks
439 return this->scan_result_.empty() || !this->scan_result_[0].get_matches();
440}
441
443 // Check if this SSID is configured as hidden
444 // If explicitly marked hidden, we should always try hidden mode regardless of scan results
445 for (const auto &conf : this->sta_) {
446 if (conf.ssid_ == ssid && conf.get_hidden()) {
447 return false; // Treat as not seen - force hidden mode attempt
448 }
449 }
450
451 // Otherwise, check if we saw it in scan results
452 for (const auto &scan : this->scan_result_) {
453 if (scan.ssid_ == ssid) {
454 return true;
455 }
456 }
457 return false;
458}
459
461 // Components that require full scan results (for example, scan result listeners)
462 // are expected to call request_wifi_scan_results(), which sets keep_scan_results_.
463 if (this->keep_scan_results_) {
464 return true;
465 }
466
467#ifdef USE_CAPTIVE_PORTAL
468 // Captive portal needs full results when active (showing network list to user)
470 return true;
471 }
472#endif
473
474#ifdef USE_IMPROV_SERIAL
475 // Improv serial needs results during provisioning (before connected)
477 return true;
478 }
479#endif
480
481#ifdef USE_IMPROV
482 // BLE improv also needs results during provisioning
484 return true;
485 }
486#endif
487
488 return false;
489}
490
491bool WiFiComponent::matches_configured_network_(const char *ssid, const uint8_t *bssid) const {
492 // Hidden networks in scan results have empty SSIDs - skip them
493 if (ssid[0] == '\0') {
494 return false;
495 }
496 for (const auto &sta : this->sta_) {
497 // Skip hidden network configs (they don't appear in normal scans)
498 if (sta.get_hidden()) {
499 continue;
500 }
501 // For BSSID-only configs (empty SSID), match by BSSID
502 if (sta.ssid_.empty()) {
503 if (sta.has_bssid() && std::memcmp(sta.get_bssid().data(), bssid, 6) == 0) {
504 return true;
505 }
506 continue;
507 }
508 // Match by SSID
509 if (sta.ssid_ == ssid) {
510 return true;
511 }
512 }
513 return false;
514}
515
517 for (auto &it : this->sta_priorities_) {
518 if (it.bssid == bssid) {
519 it.priority = priority;
520 return;
521 }
522 }
523 this->sta_priorities_.push_back(WiFiSTAPriority{
524 .bssid = bssid,
525 .priority = priority,
526 });
527}
528
529void WiFiComponent::log_discarded_scan_result_(const char *ssid, const uint8_t *bssid, int8_t rssi, uint8_t channel) {
530#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
531 // Skip logging during roaming scans to avoid log buffer overflow
532 // (roaming scans typically find many networks but only care about same-SSID APs)
533 if (this->is_roaming_scan_active()) {
534 return;
535 }
536 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
537 format_mac_addr_upper(bssid, bssid_s);
538 ESP_LOGV(TAG, "- " LOG_SECRET("'%s'") " " LOG_SECRET("(%s)") " %ddB Ch:%u", ssid, bssid_s, rssi, channel);
539#endif
540}
541
542int8_t WiFiComponent::find_next_hidden_sta_(int8_t start_index) {
543 // Find next SSID to try in RETRY_HIDDEN phase.
544 //
545 // This function operates in two modes based on retry_hidden_mode_:
546 //
547 // 1. SCAN_BASED mode:
548 // After SCAN_CONNECTING phase, only returns networks that were NOT visible
549 // in the scan (truly hidden networks that need probe requests).
550 //
551 // 2. BLIND_RETRY mode:
552 // When captive portal/improv is active, scanning is skipped to avoid
553 // disrupting the AP. In this mode, ALL configured networks are returned
554 // as candidates, cycling through them sequentially. This allows the device
555 // to keep trying all networks while users configure WiFi via captive portal.
556 //
557 // Additionally, if EXPLICIT_HIDDEN phase was executed (first network marked hidden:true),
558 // those networks are skipped here since they were already tried.
559 //
560 bool include_explicit_hidden = !this->went_through_explicit_hidden_phase_();
561 // Start searching from start_index + 1
562 for (size_t i = start_index + 1; i < this->sta_.size(); i++) {
563 const auto &sta = this->sta_[i];
564
565 // Skip networks that were already tried in EXPLICIT_HIDDEN phase
566 // Those are: networks marked hidden:true that appear before the first non-hidden network
567 // If all networks are hidden (first_non_hidden_idx == -1), skip all of them
568 if (!include_explicit_hidden && sta.get_hidden()) {
569 int8_t first_non_hidden_idx = this->find_first_non_hidden_index_();
570 if (first_non_hidden_idx < 0 || static_cast<int8_t>(i) < first_non_hidden_idx) {
571 ESP_LOGD(TAG, "Skipping " LOG_SECRET("'%s'") " (explicit hidden, already tried)", sta.ssid_.c_str());
572 continue;
573 }
574 }
575
576 // In BLIND_RETRY mode, treat all networks as candidates
577 // In SCAN_BASED mode, only retry networks that weren't seen in the scan
579 ESP_LOGD(TAG, "Hidden candidate " LOG_SECRET("'%s'") " at index %d", sta.ssid_.c_str(), static_cast<int>(i));
580 return static_cast<int8_t>(i);
581 }
582 ESP_LOGD(TAG, "Skipping hidden retry for visible network " LOG_SECRET("'%s'"), sta.ssid_.c_str());
583 }
584 // No hidden SSIDs found
585 return -1;
586}
587
589 // If first network (highest priority) is explicitly marked hidden, try it first before scanning
590 // This respects user's priority order when they explicitly configure hidden networks
591 if (!this->sta_.empty() && this->sta_[0].get_hidden()) {
592 ESP_LOGI(TAG, "Starting with explicit hidden network (highest priority)");
593 this->selected_sta_index_ = 0;
596 this->start_connecting(params);
597 } else {
598 this->start_scanning();
599 }
600}
601
602#if defined(USE_ESP32) && defined(USE_WIFI_WPA2_EAP) && ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
603static const char *eap_phase2_to_str(esp_eap_ttls_phase2_types type) {
604 switch (type) {
605 case ESP_EAP_TTLS_PHASE2_PAP:
606 return "pap";
607 case ESP_EAP_TTLS_PHASE2_CHAP:
608 return "chap";
609 case ESP_EAP_TTLS_PHASE2_MSCHAP:
610 return "mschap";
611 case ESP_EAP_TTLS_PHASE2_MSCHAPV2:
612 return "mschapv2";
613 case ESP_EAP_TTLS_PHASE2_EAP:
614 return "eap";
615 default:
616 return "unknown";
617 }
618}
619#endif
620
622
624 this->wifi_pre_setup_();
625
626#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
627 // Create semaphore for high-performance mode requests
628 // Start at 0, increment on request, decrement on release
629 this->high_performance_semaphore_ = xSemaphoreCreateCounting(UINT32_MAX, 0);
630 if (this->high_performance_semaphore_ == nullptr) {
631 ESP_LOGE(TAG, "Failed semaphore");
632 }
633
634 // Store the configured power save mode as baseline
636#endif
637
638 if (this->enable_on_boot_) {
639#ifdef USE_ESP32
640 this->wifi_lazy_init_();
641#endif
642 this->start();
643 } else {
645 }
646}
647
649 ESP_LOGCONFIG(TAG, "Starting");
650 this->last_connected_ = millis();
651
652 uint32_t hash = this->has_sta() ? App.get_config_version_hash() : 88491487UL;
653
655#ifdef USE_WIFI_FAST_CONNECT
656#ifdef USE_WIFI_FAST_CONNECT_IN_FLASH
657 const bool fast_connect_in_flash = true;
658#else
659 const bool fast_connect_in_flash = false;
660#endif
661 this->fast_connect_pref_ =
663#endif
664
665 SavedWifiSettings save{};
666 if (this->pref_.load(&save)) {
667 ESP_LOGD(TAG, "Loaded settings: %s", save.ssid);
668
669 WiFiAP sta{};
670 sta.set_ssid(save.ssid);
671 sta.set_password(save.password);
672 this->set_sta(sta);
673 }
674
675 if (this->has_sta()) {
676 this->wifi_sta_pre_setup_();
677 if (!std::isnan(this->output_power_) && !this->wifi_apply_output_power_(this->output_power_)) {
678 ESP_LOGV(TAG, "Setting Output Power Option failed");
679 }
680
681#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
682 // Synchronize power_save_ with semaphore state before applying
683 if (this->high_performance_semaphore_ != nullptr) {
684 UBaseType_t semaphore_count = uxSemaphoreGetCount(this->high_performance_semaphore_);
685 if (semaphore_count > 0) {
687 this->is_high_performance_mode_ = true;
688 } else {
690 this->is_high_performance_mode_ = false;
691 }
692 }
693#endif
694 if (!this->wifi_apply_power_save_()) {
695 ESP_LOGV(TAG, "Setting Power Save Option failed");
696 }
697
699#ifdef USE_WIFI_FAST_CONNECT
700 WiFiAP params;
701 bool loaded_fast_connect = this->load_fast_connect_settings_(params);
702 // Fast connect optimization: only use when we have saved BSSID+channel data
703 // Without saved data, try first configured network or use normal flow
704 if (loaded_fast_connect) {
705 ESP_LOGI(TAG, "Starting fast_connect (saved) " LOG_SECRET("'%s'"), params.ssid_.c_str());
706 this->start_connecting(params);
707 } else if (!this->sta_.empty() && !this->sta_[0].get_hidden()) {
708 // No saved data, but have configured networks - try first non-hidden network
709 ESP_LOGI(TAG, "Starting fast_connect (config) " LOG_SECRET("'%s'"), this->sta_[0].ssid_.c_str());
710 this->selected_sta_index_ = 0;
711 params = this->build_params_for_current_phase_();
712 this->start_connecting(params);
713 } else {
714 // No saved data and (no networks OR first is hidden) - use normal flow
716 }
717#else
718 // Without fast_connect: go straight to scanning (or hidden mode if all networks are hidden)
720#endif
721#ifdef USE_WIFI_AP
722 } else if (this->has_ap()) {
723 this->setup_ap_config_();
724 if (!std::isnan(this->output_power_) && !this->wifi_apply_output_power_(this->output_power_)) {
725 ESP_LOGV(TAG, "Setting Output Power Option failed");
726 }
727#ifdef USE_CAPTIVE_PORTAL
729 this->wifi_sta_pre_setup_();
730 this->start_scanning();
732 }
733#endif
734#endif // USE_WIFI_AP
735 }
736#ifdef USE_IMPROV
737 if (!this->has_sta() && esp32_improv::global_improv_component != nullptr) {
738 if (this->wifi_mode_(true, {}))
740 }
741#endif
742 this->wifi_apply_hostname_();
743}
744
746 ESP_LOGW(TAG, "Restarting adapter");
747 this->wifi_mode_(false, {});
748 // Clear error flag here because restart_adapter() enters COOLDOWN state,
749 // and check_connecting_finished() is called after cooldown without going
750 // through start_connecting() first. Without this clear, stale errors would
751 // trigger spurious "failed (callback)" logs. The canonical clear location
752 // is in start_connecting(); this is the only exception to that pattern.
753 this->error_from_callback_ = false;
754}
755
757 bool events_processed = this->wifi_loop_();
759 // Connection state can only change when events are processed (ESP-IDF/LibreTiny)
760 // or polled (ESP8266/Pico W). Skip the expensive wifi_sta_connect_status_() call
761 // when no events arrived and we're already in steady state.
762 // Must also run when connected_ is false — after state transitions to STA_CONNECTED,
763 // connected_ won't be set until update_connected_state_() runs.
764 if (events_processed || !this->connected_) {
766 }
767
768 if (this->has_sta()) {
769#if defined(USE_WIFI_CONNECT_TRIGGER) || defined(USE_WIFI_DISCONNECT_TRIGGER)
770 if (this->is_connected() != this->handled_connected_state_) {
771#ifdef USE_WIFI_DISCONNECT_TRIGGER
772 if (this->handled_connected_state_) {
774 }
775#endif
776#ifdef USE_WIFI_CONNECT_TRIGGER
777 if (!this->handled_connected_state_) {
779 }
780#endif
782 }
783#endif // USE_WIFI_CONNECT_TRIGGER || USE_WIFI_DISCONNECT_TRIGGER
784
785 switch (this->state_) {
787 this->status_set_warning(LOG_STR("waiting to reconnect"));
788 // Skip cooldown if new credentials were provided while connecting
789 if (this->skip_cooldown_next_cycle_) {
790 this->skip_cooldown_next_cycle_ = false;
791 this->check_connecting_finished(now);
792 break;
793 }
794 // Use longer cooldown when captive portal/improv is active to avoid disrupting user config
795 bool portal_active = this->is_captive_portal_active_() || this->is_esp32_improv_active_();
796 uint32_t cooldown_duration = portal_active ? WIFI_COOLDOWN_WITH_AP_ACTIVE_MS : WIFI_COOLDOWN_DURATION_MS;
797 if (now - this->action_started_ > cooldown_duration) {
798 // After cooldown we either restarted the adapter because of
799 // a failure, or something tried to connect over and over
800 // so we entered cooldown. In both cases we call
801 // check_connecting_finished to continue the state machine.
802 this->check_connecting_finished(now);
803 }
804 break;
805 }
807 this->status_set_warning(LOG_STR("scanning for networks"));
809 break;
810 }
812 this->status_set_warning(LOG_STR("associating to network"));
813 this->check_connecting_finished(now);
814 break;
815 }
816
818 // Use cached connected_ set unconditionally at the top of loop()
819 if (!this->connected_) {
820 ESP_LOGW(TAG, "Connection lost; reconnecting");
822 this->retry_connect();
823 } else {
824 this->status_clear_warning();
825 this->last_connected_ = now;
826
827#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
828 // A driver-initiated roam (e.g. 802.11v BTM) re-associates without the
829 // state machine ever leaving STA_CONNECTED, so the notification the
830 // connected event marked pending would never be flushed by
831 // check_connecting_finished(). Cheap when nothing is pending: the
832 // method returns immediately on a single flag test.
834#endif
835
836 // Post-connect roaming: check for better AP
837 if (this->post_connect_roaming_) {
838 if (this->is_roaming_scan_active()) {
839 if (this->scan_done_) {
840 this->process_roaming_scan_();
841 }
842 // else: scan in progress, wait
845 this->check_roaming_(now);
846 }
847 }
848 }
849 break;
850 }
853 break;
855 return;
856 }
857
858#ifdef USE_WIFI_AP
859 if (this->has_ap() && !this->ap_setup_) {
860 if (this->ap_timeout_ != 0 && (now - this->last_connected_ > this->ap_timeout_)) {
861 ESP_LOGI(TAG, "Starting fallback AP");
862 this->setup_ap_config_();
863#ifdef USE_CAPTIVE_PORTAL
865 // Reset so we force one full scan after captive portal starts
866 // (previous scans were filtered because captive portal wasn't active yet)
869 }
870#endif
871 }
872 }
873#endif // USE_WIFI_AP
874
875#ifdef USE_IMPROV
877 !esp32_improv::global_improv_component->should_start()) {
878 if (now - this->last_connected_ > esp32_improv::global_improv_component->get_wifi_timeout()) {
879 if (this->wifi_mode_(true, {}))
881 }
882 }
883
884#endif
885
886 if (!this->has_ap() && this->reboot_timeout_ != 0) {
887 if (now - this->last_connected_ > this->reboot_timeout_) {
888 bool suppress = false;
889#ifdef USE_PROVISIONING
890 // Don't reboot while a provisioning window is pending (device unprovisioned).
891 // The device is legitimately waiting to be onboarded (Wi-Fi must come up
892 // before the controller can set credentials), and an auto-reboot would reopen
893 // the window without the deliberate power cycle / reset that is meant to be
894 // required. Resumes normal reboot behavior once provisioned.
895 suppress = provisioning::global_provisioning_manager != nullptr &&
897#endif
898 if (!suppress) {
899 ESP_LOGE(TAG, "Can't connect; rebooting");
900 App.reboot();
901 }
902 }
903 }
904 }
905
906#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
907 // Check if power save mode needs to be updated based on high-performance requests
908 if (this->high_performance_semaphore_ != nullptr) {
909 // Semaphore count directly represents active requests (starts at 0, increments on request)
910 UBaseType_t semaphore_count = uxSemaphoreGetCount(this->high_performance_semaphore_);
911
912 if (semaphore_count > 0 && !this->is_high_performance_mode_) {
913 // Transition to high-performance mode (no power save)
914 ESP_LOGV(TAG, "Switching to high-performance mode (%" PRIu32 " active %s)", (uint32_t) semaphore_count,
915 semaphore_count == 1 ? "request" : "requests");
917 if (this->wifi_apply_power_save_()) {
918 this->is_high_performance_mode_ = true;
919 }
920 } else if (semaphore_count == 0 && this->is_high_performance_mode_) {
921 // Restore to configured power save mode
922 ESP_LOGV(TAG, "Restoring power save mode to configured setting");
924 if (this->wifi_apply_power_save_()) {
925 this->is_high_performance_mode_ = false;
926 }
927 }
928 }
929#endif
930}
931
933
934#ifdef USE_WIFI_11KV_SUPPORT
935void WiFiComponent::set_btm(bool btm) { this->btm_ = btm; }
936void WiFiComponent::set_rrm(bool rrm) { this->rrm_ = rrm; }
937#endif
939 if (this->has_sta())
940 return this->wifi_sta_ip_addresses();
941
942#ifdef USE_WIFI_AP
943 if (this->has_ap())
944 return {this->wifi_soft_ap_ip()};
945#endif // USE_WIFI_AP
946
947 return {};
948}
950 if (this->has_sta())
951 return this->wifi_dns_ip_(num);
952 return {};
953}
954
955#ifdef USE_WIFI_AP
957 this->wifi_mode_({}, true);
958
959 if (this->ap_setup_)
960 return;
961
962 if (this->ap_.ssid_.empty()) {
963 // Build AP SSID from app name without heap allocation
964 // WiFi SSID max is 32 bytes, with MAC suffix we keep first 25 + last 7
965 static constexpr size_t AP_SSID_MAX_LEN = 32;
966 static constexpr size_t AP_SSID_PREFIX_LEN = 25;
967 static constexpr size_t AP_SSID_SUFFIX_LEN = 7;
968
969 const auto &app_name = App.get_name();
970 const char *name_ptr = app_name.c_str();
971 size_t name_len = app_name.length();
972
973 if (name_len <= AP_SSID_MAX_LEN) {
974 // Name fits, use directly
975 this->ap_.set_ssid(name_ptr);
976 } else {
977 // Name too long, need to truncate into stack buffer
978 char ssid_buf[AP_SSID_MAX_LEN + 1];
980 // Keep first 25 chars and last 7 chars (MAC suffix), remove middle
981 memcpy(ssid_buf, name_ptr, AP_SSID_PREFIX_LEN);
982 memcpy(ssid_buf + AP_SSID_PREFIX_LEN, name_ptr + name_len - AP_SSID_SUFFIX_LEN, AP_SSID_SUFFIX_LEN);
983 } else {
984 memcpy(ssid_buf, name_ptr, AP_SSID_MAX_LEN);
985 }
986 ssid_buf[AP_SSID_MAX_LEN] = '\0';
987 this->ap_.set_ssid(ssid_buf);
988 }
989 }
990 this->ap_setup_ = this->wifi_start_ap_(this->ap_);
991
992 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
993 ESP_LOGCONFIG(TAG,
994 "Setting up AP:\n"
995 " AP SSID: '%s'\n"
996 " AP Password: '%s'\n"
997 " IP Address: %s",
998 this->ap_.ssid_.c_str(), this->ap_.password_.c_str(), this->wifi_soft_ap_ip().str_to(ip_buf));
999
1000#ifdef USE_WIFI_MANUAL_IP
1001 auto manual_ip = this->ap_.get_manual_ip();
1002 if (manual_ip.has_value()) {
1003 char static_ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
1004 char gateway_buf[network::IP_ADDRESS_BUFFER_SIZE];
1005 char subnet_buf[network::IP_ADDRESS_BUFFER_SIZE];
1006 ESP_LOGCONFIG(TAG,
1007 " AP Static IP: '%s'\n"
1008 " AP Gateway: '%s'\n"
1009 " AP Subnet: '%s'",
1010 manual_ip->static_ip.str_to(static_ip_buf), manual_ip->gateway.str_to(gateway_buf),
1011 manual_ip->subnet.str_to(subnet_buf));
1012 }
1013#endif
1014
1015 if (!this->has_sta()) {
1017 }
1018}
1019
1021 this->ap_ = ap;
1022 this->has_ap_ = true;
1023}
1024#endif // USE_WIFI_AP
1025
1026void WiFiComponent::init_sta(size_t count) { this->sta_.init(count); }
1027void WiFiComponent::add_sta(const WiFiAP &ap) { this->sta_.push_back(ap); }
1029 // Clear roaming state - no more configured networks
1030 this->clear_roaming_state_();
1031 this->sta_.clear();
1032 this->selected_sta_index_ = -1;
1033}
1035 this->clear_sta(); // Also clears roaming state
1036 this->init_sta(1);
1037 this->add_sta(ap);
1038 this->selected_sta_index_ = 0;
1039 // When new credentials are set (e.g., from improv), skip cooldown to retry immediately
1040 this->skip_cooldown_next_cycle_ = true;
1041}
1042
1044 const WiFiAP *config = this->get_selected_sta_();
1045 if (config == nullptr) {
1046 ESP_LOGE(TAG, "No valid network config (selected_sta_index_=%d, sta_.size()=%zu)",
1047 static_cast<int>(this->selected_sta_index_), this->sta_.size());
1048 // Return empty params - caller should handle this gracefully
1049 return WiFiAP();
1050 }
1051
1052 WiFiAP params = *config;
1053
1054 switch (this->retry_phase_) {
1056#ifdef USE_WIFI_FAST_CONNECT
1058#endif
1059 // Fast connect phases: use config-only (no scan results)
1060 // BSSID/channel from config if user specified them, otherwise empty
1061 break;
1062
1065 // Hidden network mode: clear BSSID/channel to trigger probe request
1066 // (both explicit hidden and retry hidden use same behavior)
1067 params.clear_bssid();
1068 params.clear_channel();
1069 break;
1070
1072 // Scan-based phase: always use best scan result (index 0 - highest priority after sorting)
1073 if (!this->scan_result_.empty()) {
1074 apply_scan_result_to_params(params, this->scan_result_[0]);
1075 }
1076 break;
1077
1079 // Should not be building params during restart
1080 break;
1081 }
1082
1083 return params;
1084}
1085
1087 const WiFiAP *config = this->get_selected_sta_();
1088 return config ? *config : WiFiAP{};
1089}
1090void WiFiComponent::save_wifi_sta(const std::string &ssid, const std::string &password) {
1091 this->save_wifi_sta(ssid.c_str(), password.c_str());
1092}
1093void WiFiComponent::save_wifi_sta(const char *ssid, const char *password) {
1094 SavedWifiSettings save{}; // zero-initialized - all bytes set to \0, guaranteeing null termination
1095 strncpy(save.ssid, ssid, sizeof(save.ssid) - 1); // max 32 chars, byte 32 remains \0
1096 strncpy(save.password, password, sizeof(save.password) - 1); // max 64 chars, byte 64 remains \0
1097 this->pref_.save(&save);
1098 // ensure it's written immediately
1100
1101 WiFiAP sta{};
1102 sta.set_ssid(ssid);
1103 sta.set_password(password);
1104 this->set_sta(sta);
1105
1106 // Trigger connection attempt (exits cooldown if needed, no-op if already connecting/connected)
1107 this->connect_soon_();
1108}
1109
1111 // Only trigger retry if we're in cooldown - if already connecting/connected, do nothing
1113 ESP_LOGD(TAG, "Exiting cooldown early due to new WiFi credentials");
1114 this->retry_connect();
1115 }
1116}
1117
1119 // Log connection attempt at INFO level with priority
1120 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1121 int8_t priority = 0;
1122
1123 if (ap.has_bssid()) {
1124 format_mac_addr_upper(ap.get_bssid().data(), bssid_s);
1125 priority = this->get_sta_priority(ap.get_bssid());
1126 }
1127
1128 ESP_LOGI(TAG,
1129 "Connecting to " LOG_SECRET("'%s'") " " LOG_SECRET("(%s)") " (priority %d, attempt %u/%u in phase %s)...",
1130 ap.ssid_.c_str(), ap.has_bssid() ? bssid_s : LOG_STR_LITERAL("any"), priority, this->num_retried_ + 1,
1131 get_max_retries_for_phase(this->retry_phase_), LOG_STR_ARG(retry_phase_to_log_string(this->retry_phase_)));
1132
1133#ifdef ESPHOME_LOG_HAS_VERBOSE
1134 ESP_LOGV(TAG,
1135 "Connection Params:\n"
1136 " SSID: '%s'",
1137 ap.ssid_.c_str());
1138 if (ap.has_bssid()) {
1139 ESP_LOGV(TAG, " BSSID: %s", bssid_s);
1140 } else {
1141 ESP_LOGV(TAG, " BSSID: Not Set");
1142 }
1143
1144#ifdef USE_WIFI_WPA2_EAP
1145 const auto &eap_opt = ap.get_eap();
1146 if (eap_opt.has_value()) {
1147 const EAPAuth &eap_config = *eap_opt;
1148 // clang-format off
1149 ESP_LOGV(
1150 TAG,
1151 " WPA2 Enterprise authentication configured:\n"
1152 " Identity: " LOG_SECRET("'%s'") "\n"
1153 " Username: " LOG_SECRET("'%s'") "\n"
1154 " Password: " LOG_SECRET("'%s'"),
1155 eap_config.identity.c_str(), eap_config.username.c_str(), eap_config.password.c_str());
1156 // clang-format on
1157#if defined(USE_ESP32) && defined(USE_WIFI_WPA2_EAP) && ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
1158 ESP_LOGV(TAG, " TTLS Phase 2: " LOG_SECRET("'%s'"), eap_phase2_to_str(eap_config.ttls_phase_2));
1159#endif
1160 bool ca_cert_present = eap_config.ca_cert != nullptr && strlen(eap_config.ca_cert);
1161 bool client_cert_present = eap_config.client_cert != nullptr && strlen(eap_config.client_cert);
1162 bool client_key_present = eap_config.client_key != nullptr && strlen(eap_config.client_key);
1163 ESP_LOGV(TAG,
1164 " CA Cert: %s\n"
1165 " Client Cert: %s\n"
1166 " Client Key: %s",
1167 ca_cert_present ? "present" : "not present", client_cert_present ? "present" : "not present",
1168 client_key_present ? "present" : "not present");
1169 } else {
1170#endif
1171 ESP_LOGV(TAG, " Password: " LOG_SECRET("'%s'"), ap.password_.c_str());
1172#ifdef USE_WIFI_WPA2_EAP
1173 }
1174#endif
1175 if (ap.has_channel()) {
1176 ESP_LOGV(TAG, " Channel: %u", ap.get_channel());
1177 } else {
1178 ESP_LOGV(TAG, " Channel not set");
1179 }
1180#ifdef USE_WIFI_MANUAL_IP
1181 auto manual_ip = ap.get_manual_ip();
1182 if (manual_ip.has_value()) {
1183 ManualIP m = *manual_ip;
1184 char static_ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
1185 char gateway_buf[network::IP_ADDRESS_BUFFER_SIZE];
1186 char subnet_buf[network::IP_ADDRESS_BUFFER_SIZE];
1187 char dns1_buf[network::IP_ADDRESS_BUFFER_SIZE];
1188 char dns2_buf[network::IP_ADDRESS_BUFFER_SIZE];
1189 ESP_LOGV(TAG, " Manual IP: Static IP=%s Gateway=%s Subnet=%s DNS1=%s DNS2=%s", m.static_ip.str_to(static_ip_buf),
1190 m.gateway.str_to(gateway_buf), m.subnet.str_to(subnet_buf), m.dns1.str_to(dns1_buf),
1191 m.dns2.str_to(dns2_buf));
1192 } else
1193#endif
1194 {
1195 ESP_LOGV(TAG, " Using DHCP IP");
1196 }
1197 ESP_LOGV(TAG, " Hidden: %s", YESNO(ap.get_hidden()));
1198#endif
1199
1200 // Clear any stale error from previous connection attempt.
1201 // This is the canonical location for clearing the flag since all connection
1202 // attempts go through start_connecting(). The only other clear is in
1203 // restart_adapter() which enters COOLDOWN without calling start_connecting().
1204 this->error_from_callback_ = false;
1205
1206 if (!this->wifi_sta_connect_(ap)) {
1207 ESP_LOGE(TAG, "wifi_sta_connect_ failed");
1208 // Enter cooldown to allow WiFi hardware to stabilize
1209 // (immediate failure suggests hardware not ready, different from connection timeout)
1211 } else {
1213 }
1214 this->action_started_ = millis();
1215}
1216
1217const LogString *get_signal_bars(int8_t rssi) {
1218 // LOWER ONE QUARTER BLOCK
1219 // Unicode: U+2582, UTF-8: E2 96 82
1220 // LOWER HALF BLOCK
1221 // Unicode: U+2584, UTF-8: E2 96 84
1222 // LOWER THREE QUARTERS BLOCK
1223 // Unicode: U+2586, UTF-8: E2 96 86
1224 // FULL BLOCK
1225 // Unicode: U+2588, UTF-8: E2 96 88
1226 if (rssi >= -50) {
1227 return LOG_STR("\033[0;32m" // green
1228 "\xe2\x96\x82"
1229 "\xe2\x96\x84"
1230 "\xe2\x96\x86"
1231 "\xe2\x96\x88"
1232 "\033[0m");
1233 } else if (rssi >= -65) {
1234 return LOG_STR("\033[0;33m" // yellow
1235 "\xe2\x96\x82"
1236 "\xe2\x96\x84"
1237 "\xe2\x96\x86"
1238 "\033[0;37m"
1239 "\xe2\x96\x88"
1240 "\033[0m");
1241 } else if (rssi >= -85) {
1242 return LOG_STR("\033[0;33m" // yellow
1243 "\xe2\x96\x82"
1244 "\xe2\x96\x84"
1245 "\033[0;37m"
1246 "\xe2\x96\x86"
1247 "\xe2\x96\x88"
1248 "\033[0m");
1249 } else {
1250 return LOG_STR("\033[0;31m" // red
1251 "\xe2\x96\x82"
1252 "\033[0;37m"
1253 "\xe2\x96\x84"
1254 "\xe2\x96\x86"
1255 "\xe2\x96\x88"
1256 "\033[0m");
1257 }
1258}
1259
1261 bssid_t bssid = wifi_bssid();
1262 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1263 format_mac_addr_upper(bssid.data(), bssid_s);
1264 // Use stack buffers for IP address formatting to avoid heap allocations
1265 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
1266 for (auto &ip : wifi_sta_ip_addresses()) {
1267 if (ip.is_set()) {
1268 ESP_LOGCONFIG(TAG, " IP Address: %s", ip.str_to(ip_buf));
1269 }
1270 }
1271 int8_t rssi = wifi_rssi();
1272 // Use stack buffers for SSID and all IP addresses to avoid heap allocations
1273 char ssid_buf[SSID_BUFFER_SIZE];
1274 char subnet_buf[network::IP_ADDRESS_BUFFER_SIZE];
1275 char gateway_buf[network::IP_ADDRESS_BUFFER_SIZE];
1276 char dns1_buf[network::IP_ADDRESS_BUFFER_SIZE];
1277 char dns2_buf[network::IP_ADDRESS_BUFFER_SIZE];
1278 // clang-format off
1279 ESP_LOGCONFIG(TAG,
1280 " SSID: " LOG_SECRET("'%s'") "\n"
1281 " BSSID: " LOG_SECRET("%s") "\n"
1282 " Hostname: '%s'\n"
1283 " Signal strength: %d dB %s\n"
1284 " Channel: %" PRId32 "\n"
1285 " Subnet: %s\n"
1286 " Gateway: %s\n"
1287 " DNS1: %s\n"
1288 " DNS2: %s",
1289 wifi_ssid_to(ssid_buf), bssid_s, App.get_name().c_str(), rssi, LOG_STR_ARG(get_signal_bars(rssi)),
1290 get_wifi_channel(), wifi_subnet_mask_().str_to(subnet_buf), wifi_gateway_ip_().str_to(gateway_buf),
1291 wifi_dns_ip_(0).str_to(dns1_buf), wifi_dns_ip_(1).str_to(dns2_buf));
1292 // clang-format on
1293#ifdef ESPHOME_LOG_HAS_VERBOSE
1294 if (const WiFiAP *config = this->get_selected_sta_(); config && config->has_bssid()) {
1295 ESP_LOGV(TAG, " Priority: %d", this->get_sta_priority(config->get_bssid()));
1296 }
1297#endif
1298#ifdef USE_WIFI_11KV_SUPPORT
1299 ESP_LOGCONFIG(TAG,
1300 " BTM: %s\n"
1301 " RRM: %s",
1302 this->btm_ ? "enabled" : "disabled", this->rrm_ ? "enabled" : "disabled");
1303#endif
1304}
1305
1308 return;
1309
1310 ESP_LOGD(TAG, "Enabling");
1312#ifdef USE_ESP32
1313 // Idempotent — only allocates DMA buffers + netifs on the first call. After this,
1314 // start() can safely run.
1315 this->wifi_lazy_init_();
1316#endif
1317 this->start();
1318}
1319
1322 return;
1323
1324 ESP_LOGD(TAG, "Disabling");
1326 this->wifi_disconnect_();
1327 this->wifi_mode_(false, false);
1328}
1329
1331
1333 this->action_started_ = millis();
1334 ESP_LOGD(TAG, "Starting scan");
1335 this->wifi_scan_start_(this->passive_scan_);
1337}
1338
1372[[nodiscard]] inline static bool wifi_scan_result_is_better(const WiFiScanResult &a, const WiFiScanResult &b) {
1373 // Matching networks always come before non-matching
1374 if (a.get_matches() && !b.get_matches())
1375 return true;
1376 if (!a.get_matches() && b.get_matches())
1377 return false;
1378
1379 // Both matching: check priority first (tracks connection failures via priority degradation)
1380 // Priority is decreased when a BSSID fails to connect, so lower priority = previously failed
1381 if (a.get_matches() && b.get_matches() && a.get_priority() != b.get_priority()) {
1382 return a.get_priority() > b.get_priority();
1383 }
1384
1385 // Use RSSI as tiebreaker (for equal-priority matching networks or all non-matching networks)
1386 return a.get_rssi() > b.get_rssi();
1387}
1388
1389// Helper function for insertion sort of WiFi scan results
1390// Using insertion sort instead of std::stable_sort saves flash memory
1391// by avoiding template instantiations (std::rotate, std::stable_sort, lambdas)
1392// IMPORTANT: This sort is stable (preserves relative order of equal elements)
1393//
1394// Uses raw memcpy instead of copy assignment to avoid CompactString's
1395// destructor/constructor overhead (heap delete[]/new[] for long SSIDs).
1396// Copy assignment calls ~CompactString() then placement-new for every shift,
1397// which means delete[]/new[] per shift for heap-allocated SSIDs. With 70+
1398// networks (e.g., captive portal showing full scan results), this caused
1399// event loop blocking from hundreds of heap operations in a tight loop.
1400//
1401// This is safe because we're permuting elements within the same array —
1402// each slot is overwritten exactly once, so no ownership duplication occurs.
1403// All members of WiFiScanResult are either trivially copyable (bssid, channel,
1404// rssi, priority, flags) or CompactString, which stores either inline data or
1405// a heap pointer — never a self-referential pointer (unlike std::string's SSO
1406// on some implementations). This was not possible before PR#13472 replaced
1407// std::string with CompactString, since std::string's internal layout is
1408// implementation-defined and may use self-referential pointers.
1409//
1410// TODO: If C++ standardizes std::trivially_relocatable, add the assertion for
1411// WiFiScanResult/CompactString here to formally express the memcpy safety guarantee.
1412template<typename VectorType> static void insertion_sort_scan_results(VectorType &results) {
1413 // memcpy-based sort requires no self-referential pointers or virtual dispatch.
1414 // These static_asserts guard the assumptions. If any fire, the memcpy sort
1415 // must be reviewed for safety before updating the expected values.
1416 //
1417 // No vtable pointers (memcpy would corrupt vptr)
1418 static_assert(!std::is_polymorphic<WiFiScanResult>::value, "WiFiScanResult must not have vtable");
1419 static_assert(!std::is_polymorphic<CompactString>::value, "CompactString must not have vtable");
1420 // Standard layout ensures predictable memory layout with no virtual bases
1421 // and no mixed-access-specifier reordering
1422 static_assert(std::is_standard_layout<WiFiScanResult>::value, "WiFiScanResult must be standard layout");
1423 static_assert(std::is_standard_layout<CompactString>::value, "CompactString must be standard layout");
1424 // Size checks catch added/removed fields that may need safety review
1425 static_assert(sizeof(WiFiScanResult) == 32, "WiFiScanResult size changed - verify memcpy sort is still safe");
1426 static_assert(sizeof(CompactString) == 20, "CompactString size changed - verify memcpy sort is still safe");
1427 // Alignment must match for reinterpret_cast of key_buf to be valid
1428 static_assert(alignof(WiFiScanResult) <= alignof(std::max_align_t), "WiFiScanResult alignment exceeds max_align_t");
1429 const size_t size = results.size();
1430 constexpr size_t elem_size = sizeof(WiFiScanResult);
1431 // Suppress warnings for intentional memcpy on non-trivially-copyable type.
1432 // Safety is guaranteed by the static_asserts above and the permutation invariant.
1433 // NOLINTNEXTLINE(bugprone-undefined-memory-manipulation)
1434 auto *memcpy_fn = &memcpy;
1435 for (size_t i = 1; i < size; i++) {
1436 alignas(WiFiScanResult) uint8_t key_buf[elem_size];
1437 memcpy_fn(key_buf, &results[i], elem_size);
1438 const auto &key = *reinterpret_cast<const WiFiScanResult *>(key_buf);
1439 int32_t j = i - 1;
1440
1441 // Move elements that are worse than key to the right
1442 // For stability, we only move if key is strictly better than results[j]
1443 while (j >= 0 && wifi_scan_result_is_better(key, results[j])) {
1444 memcpy_fn(&results[j + 1], &results[j], elem_size);
1445 j--;
1446 }
1447 memcpy_fn(&results[j + 1], key_buf, elem_size);
1448 }
1449}
1450
1451// Helper function to log matching scan results - marked noinline to prevent re-inlining into loop
1452//
1453// IMPORTANT: This function deliberately uses a SINGLE log call to minimize blocking.
1454// In environments with many matching networks (e.g., 18+ mesh APs), multiple log calls
1455// per network would block the main loop for an unacceptable duration. Each log call
1456// has overhead from UART transmission, so combining INFO+DEBUG into one line halves
1457// the blocking time. Do NOT split this into separate ESP_LOGI/ESP_LOGD calls.
1458__attribute__((noinline)) static void log_scan_result(const WiFiScanResult &res) {
1459 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1460 auto bssid = res.get_bssid();
1461 format_mac_addr_upper(bssid.data(), bssid_s);
1462
1463#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_DEBUG
1464 // Single combined log line with all details when DEBUG enabled
1465 ESP_LOGI(TAG, "- '%s' %s" LOG_SECRET("(%s) ") "%s Ch:%2u %3ddB P:%d", res.get_ssid().c_str(),
1466 res.get_is_hidden() ? LOG_STR_LITERAL("(HIDDEN) ") : LOG_STR_LITERAL(""), bssid_s,
1467 LOG_STR_ARG(get_signal_bars(res.get_rssi())), res.get_channel(), res.get_rssi(), res.get_priority());
1468#else
1469 ESP_LOGI(TAG, "- '%s' %s" LOG_SECRET("(%s) ") "%s", res.get_ssid().c_str(),
1470 res.get_is_hidden() ? LOG_STR_LITERAL("(HIDDEN) ") : LOG_STR_LITERAL(""), bssid_s,
1471 LOG_STR_ARG(get_signal_bars(res.get_rssi())));
1472#endif
1473}
1474
1476 if (!this->scan_done_) {
1477 if (millis() - this->action_started_ > WIFI_SCAN_TIMEOUT_MS) {
1478 ESP_LOGE(TAG, "Scan timeout");
1479 this->retry_connect();
1480 }
1481 return;
1482 }
1483 this->scan_done_ = false;
1485 true; // Track that we've done a scan since captive portal started
1487
1488 if (this->scan_result_.empty()) {
1489 ESP_LOGW(TAG, "No networks found");
1490 this->retry_connect();
1491 return;
1492 }
1493
1494 ESP_LOGD(TAG, "Found networks:");
1495 {
1496 ScanResultsLock lock(this);
1497 for (auto &res : this->scan_result_) {
1498 for (auto &ap : this->sta_) {
1499 if (res.matches(ap)) {
1500 res.set_matches(true);
1501 // Cache priority lookup - do single search instead of 2 separate searches
1502 const bssid_t &bssid = res.get_bssid();
1503 if (!this->has_sta_priority(bssid)) {
1504 this->set_sta_priority(bssid, ap.get_priority());
1505 }
1506 res.set_priority(this->get_sta_priority(bssid));
1507 break;
1508 }
1509 }
1510 }
1511
1512 // Sort scan results using insertion sort for better memory efficiency
1513 insertion_sort_scan_results(this->scan_result_);
1514 }
1515
1516 // Log matching networks (non-matching already logged at VERBOSE in scan callback)
1517 for (auto &res : this->scan_result_) {
1518 if (res.get_matches()) {
1519 log_scan_result(res);
1520 }
1521 }
1522
1523 // SYNCHRONIZATION POINT: Establish link between scan_result_[0] and selected_sta_index_
1524 // After sorting, scan_result_[0] contains the best network. Now find which sta_[i] config
1525 // matches that network and record it in selected_sta_index_. This keeps the two indices
1526 // synchronized so build_params_for_current_phase_() can safely use both to build connection parameters.
1527 const WiFiScanResult &scan_res = this->scan_result_[0];
1528 bool found_match = false;
1529 if (scan_res.get_matches()) {
1530 for (size_t i = 0; i < this->sta_.size(); i++) {
1531 if (scan_res.matches(this->sta_[i])) {
1532 // Safe cast: sta_.size() limited to MAX_WIFI_NETWORKS (127) in __init__.py validation
1533 // No overflow check needed - YAML validation prevents >127 networks
1534 this->selected_sta_index_ = static_cast<int8_t>(i); // Links scan_result_[0] with sta_[i]
1535 found_match = true;
1536 break;
1537 }
1538 }
1539 }
1540
1541 if (!found_match) {
1542 ESP_LOGW(TAG, "No matching network found");
1543 // No scan results matched our configured networks - transition directly to hidden mode
1544 // Don't call retry_connect() since we never attempted a connection (no BSSID to penalize)
1546 // If no hidden networks to try, skip connection attempt (will be handled on next loop)
1547 if (this->selected_sta_index_ == -1) {
1548 return;
1549 }
1550 // Now start connection attempt in hidden mode
1552 return; // scan started, wait for next loop iteration
1553 }
1554
1555 yield();
1556
1557 WiFiAP params = this->build_params_for_current_phase_();
1558 // Ensure we're in SCAN_CONNECTING phase when connecting with scan results
1559 // (needed when scan was started directly without transition_to_phase_, e.g., initial scan)
1560 this->start_connecting(params);
1561}
1562
1564 char mac_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1565 ESP_LOGCONFIG(TAG,
1566 "WiFi:\n"
1567 " Local MAC: %s\n"
1568 " Connected: %s",
1569 get_mac_address_pretty_into_buffer(mac_s), YESNO(this->is_connected()));
1570 if (this->is_disabled()) {
1571 ESP_LOGCONFIG(TAG, " Disabled");
1572 return;
1573 }
1574#if defined(USE_ESP32) && defined(SOC_WIFI_SUPPORT_5G)
1575 const char *band_mode_s;
1576 switch (this->band_mode_) {
1577 case WIFI_BAND_MODE_2G_ONLY:
1578 band_mode_s = "2.4GHz";
1579 break;
1580 case WIFI_BAND_MODE_5G_ONLY:
1581 band_mode_s = "5GHz";
1582 break;
1583 case WIFI_BAND_MODE_AUTO:
1584 default:
1585 band_mode_s = "Auto";
1586 break;
1587 }
1588 ESP_LOGCONFIG(TAG, " Band Mode: %s", band_mode_s);
1589#endif
1590#ifdef USE_WIFI_PHY_MODE
1591 ESP_LOGCONFIG(TAG, " PHY Mode: %s", LOG_STR_ARG(phy_mode_to_log_string(this->phy_mode_)));
1592#endif
1593 if (this->is_connected()) {
1594 this->print_connect_params_();
1595 }
1596}
1597
1599 auto status = this->wifi_sta_connect_status_();
1600
1602 char ssid_buf[SSID_BUFFER_SIZE];
1603 if (wifi_ssid_to(ssid_buf)[0] == '\0') {
1604 ESP_LOGW(TAG, "Connection incomplete");
1605 this->retry_connect();
1606 return;
1607 }
1608
1609 ESP_LOGI(TAG, "Connected");
1610 // Warn if we had to retry with hidden network mode for a network that's not marked hidden
1611 // Only warn if we actually connected without scan data (SSID only), not if scan succeeded on retry
1612 if (const WiFiAP *config = this->get_selected_sta_(); this->retry_phase_ == WiFiRetryPhase::RETRY_HIDDEN &&
1613 config && !config->get_hidden() &&
1614 this->scan_result_.empty()) {
1615 ESP_LOGW(TAG, LOG_SECRET("'%s'") " should be marked hidden", config->ssid_.c_str());
1616 }
1617 // Reset to initial phase on successful connection (don't log transition, just reset state)
1619 this->num_retried_ = 0;
1620 if (this->has_ap()) {
1621#ifdef USE_CAPTIVE_PORTAL
1622 if (this->is_captive_portal_active_()) {
1624 }
1625#endif
1626 ESP_LOGD(TAG, "Disabling AP");
1627 this->wifi_mode_({}, false);
1628 }
1629#ifdef USE_IMPROV
1630 if (this->is_esp32_improv_active_()) {
1632 }
1633#endif
1634
1636 // Refresh is_connected() cache; loop()'s refresh ran before this transition.
1638 this->num_retried_ = 0;
1639 this->print_connect_params_();
1640
1641 // Reset roaming state on successful connection
1642 this->roaming_last_check_ = now;
1643 // Only preserve attempts if reconnecting after a failed roam attempt
1644 // This prevents ping-pong between APs when a roam target is unreachable
1646 // Successful roam to better AP on first try - reset attempts so we can roam again later
1647 ESP_LOGD(TAG, "Roam successful");
1648 this->roaming_attempts_ = 0;
1649 } else if (this->roaming_state_ == RoamingState::RECONNECTING) {
1650 // Check if we ended up on the roam target despite needing a retry
1651 // (e.g., first connect failed but scan-based retry found and connected to the same better AP)
1652 bssid_t current_bssid = this->wifi_bssid();
1653 if (this->roaming_target_bssid_ != bssid_t{} && current_bssid == this->roaming_target_bssid_) {
1654 char bssid_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1655 format_mac_addr_upper(current_bssid.data(), bssid_buf);
1656 ESP_LOGD(TAG, "Roam successful (via retry, attempt %u/%u) to %s", this->roaming_attempts_, ROAMING_MAX_ATTEMPTS,
1657 bssid_buf);
1658 this->roaming_attempts_ = 0;
1659 } else if (this->roaming_target_bssid_ != bssid_t{}) {
1660 // Failed roam to specific target, reconnected to different AP - keep attempts to prevent ping-pong
1661 ESP_LOGD(TAG, "Reconnected after failed roam (attempt %u/%u)", this->roaming_attempts_, ROAMING_MAX_ATTEMPTS);
1662 } else {
1663 // Reconnected after scan-induced disconnect (no roam target) - keep attempts
1664 ESP_LOGD(TAG, "Reconnected after roam scan (attempt %u/%u)", this->roaming_attempts_, ROAMING_MAX_ATTEMPTS);
1665 }
1666 } else {
1667 // Normal connection (boot, credentials changed, etc.)
1668 this->roaming_attempts_ = 0;
1669 }
1671 this->roaming_target_bssid_ = {};
1672 this->roaming_scan_end_ = 0;
1673
1674 // Clear all priority penalties - the next reconnect will happen when an AP disconnects,
1675 // which means the landscape has likely changed and previous tracked failures are stale
1677
1678#ifdef USE_WIFI_FAST_CONNECT
1680#endif
1681
1682 this->release_scan_results_();
1683
1684#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
1685 // Notify listeners now that state machine has reached STA_CONNECTED
1686 // This ensures wifi.connected condition returns true in listener automations
1688#endif
1689
1690#if defined(USE_ESP8266) && defined(USE_WIFI_IP_STATE_LISTENERS) && defined(USE_WIFI_MANUAL_IP)
1691 // On ESP8266, GOT_IP event may not fire for static IP configurations,
1692 // so notify IP state listeners here as a fallback.
1693 if (const WiFiAP *config = this->get_selected_sta_(); config && config->get_manual_ip().has_value()) {
1695 }
1696#endif
1697
1698 return;
1699 }
1700
1701 if (now - this->action_started_ > WIFI_CONNECT_TIMEOUT_MS) {
1702 ESP_LOGW(TAG, "Connection timeout, aborting connection attempt");
1703 this->wifi_disconnect_();
1704 this->retry_connect();
1705 return;
1706 }
1707
1708 if (this->error_from_callback_) {
1709 // ESP8266: logging done in callback, listeners deferred via pending_.disconnect
1710 // Other platforms: just log generic failure message
1711#ifndef USE_ESP8266
1712 ESP_LOGW(TAG, "Connecting to network failed (callback)");
1713#endif
1714 this->retry_connect();
1715 return;
1716 }
1717
1719 return;
1720 }
1721
1723 ESP_LOGW(TAG, "Network no longer found");
1724 this->retry_connect();
1725 return;
1726 }
1727
1729 ESP_LOGW(TAG, "Connecting to network failed");
1730 this->retry_connect();
1731 return;
1732 }
1733
1734 ESP_LOGW(TAG, "Unknown connection status %d", (int) status);
1735 this->retry_connect();
1736}
1737
1745 switch (this->retry_phase_) {
1747#ifdef USE_WIFI_FAST_CONNECT
1749 // INITIAL_CONNECT and FAST_CONNECT_CYCLING_APS: no retries, try next AP or fall back to scan
1750 if (this->selected_sta_index_ < static_cast<int8_t>(this->sta_.size()) - 1) {
1751 return WiFiRetryPhase::FAST_CONNECT_CYCLING_APS; // Move to next AP
1752 }
1753#endif
1754 // Check if we should try explicit hidden networks before scanning
1755 // This handles reconnection after connection loss where first network is hidden
1756 if (!this->sta_.empty() && this->sta_[0].get_hidden()) {
1758 }
1759 // No more APs to try, fall back to scan
1761
1763 // Try all explicitly hidden networks before scanning
1764 if (this->num_retried_ + 1 < WIFI_RETRY_COUNT_PER_SSID) {
1765 return WiFiRetryPhase::EXPLICIT_HIDDEN; // Keep retrying same SSID
1766 }
1767
1768 // Exhausted retries on current SSID - check for more explicitly hidden networks
1769 // Stop when we reach a visible network (proceed to scanning)
1770 size_t next_index = this->selected_sta_index_ + 1;
1771 if (next_index < this->sta_.size() && this->sta_[next_index].get_hidden()) {
1772 // Found another explicitly hidden network
1774 }
1775
1776 // No more consecutive explicitly hidden networks
1777 // If ALL networks are hidden, skip scanning and go directly to restart
1778 if (this->find_first_non_hidden_index_() < 0) {
1780 }
1781 // Otherwise proceed to scanning for non-hidden networks
1783 }
1784
1786 // If scan found no networks or no matching networks, skip to hidden network mode
1787 if (this->scan_result_.empty() || !this->scan_result_[0].get_matches()) {
1789 }
1790
1791 if (this->num_retried_ + 1 < WIFI_RETRY_COUNT_PER_BSSID) {
1792 return WiFiRetryPhase::SCAN_CONNECTING; // Keep retrying same BSSID
1793 }
1794
1795 // Exhausted retries on current BSSID (scan_result_[0])
1796 // Its priority has been decreased, so on next scan it will be sorted lower
1797 // and we'll try the next best BSSID.
1798 // Check if there are any potentially hidden networks to try
1799 if (this->find_next_hidden_sta_(-1) >= 0) {
1800 return WiFiRetryPhase::RETRY_HIDDEN; // Found hidden networks to try
1801 }
1802 // No hidden networks - always go through RESTARTING_ADAPTER phase
1803 // This ensures num_retried_ gets reset and a fresh scan is triggered
1804 // The actual adapter restart will be skipped if captive portal/improv is active
1806
1808 // If no hidden SSIDs to try (selected_sta_index_ == -1), skip directly to rescan
1809 if (this->selected_sta_index_ >= 0) {
1810 if (this->num_retried_ + 1 < WIFI_RETRY_COUNT_PER_SSID) {
1811 return WiFiRetryPhase::RETRY_HIDDEN; // Keep retrying same SSID
1812 }
1813
1814 // Exhausted retries on current SSID - check if there are more potentially hidden SSIDs to try
1815 if (this->selected_sta_index_ < static_cast<int8_t>(this->sta_.size()) - 1) {
1816 // Check if find_next_hidden_sta_() would actually find another hidden SSID
1817 // as it might have been seen in the scan results and we want to skip those
1818 // otherwise we will get stuck in RETRY_HIDDEN phase
1819 if (this->find_next_hidden_sta_(this->selected_sta_index_) != -1) {
1820 // More hidden SSIDs available - stay in RETRY_HIDDEN, advance will happen in retry_connect()
1822 }
1823 }
1824 }
1825 // Exhausted all potentially hidden SSIDs - always go through RESTARTING_ADAPTER
1826 // This ensures num_retried_ gets reset and a fresh scan is triggered
1827 // The actual adapter restart will be skipped if captive portal/improv is active
1829
1831 // After restart, go back to explicit hidden if we went through it initially
1834 }
1835 // Skip scanning when captive portal/improv is active to avoid disrupting AP,
1836 // BUT only if we've already completed at least one scan AFTER the portal started.
1837 // When captive portal first starts, scan results may be filtered/stale, so we need
1838 // to do one full scan to populate available networks for the captive portal UI.
1839 //
1840 // WHY SCANNING DISRUPTS AP MODE:
1841 // WiFi scanning requires the radio to leave the AP's channel and hop through
1842 // other channels to listen for beacons. During this time (even for passive scans),
1843 // the AP cannot service connected clients - they experience disconnections or
1844 // timeouts. On ESP32, even passive scans cause brief but noticeable disruptions
1845 // that break captive portal HTTP requests and DNS lookups.
1846 //
1847 // BLIND RETRY MODE:
1848 // When captive portal/improv is active, we use RETRY_HIDDEN as a "try all networks
1849 // blindly" mode. Since retry_hidden_mode_ is set to BLIND_RETRY (in RESTARTING_ADAPTER
1850 // transition), find_next_hidden_sta_() will treat ALL configured networks as
1851 // candidates, cycling through them without requiring scan results.
1852 //
1853 // This allows users to configure WiFi via captive portal while the device keeps
1854 // attempting to connect to all configured networks in sequence.
1855 // Captive portal needs scan results to show available networks.
1856 // If captive portal is active, only skip scanning if we've done a scan after it started.
1857 // If only improv is active (no captive portal), skip scanning since improv doesn't need results.
1858 if (this->is_captive_portal_active_()) {
1861 }
1862 // Need to scan for captive portal
1863 } else if (this->is_esp32_improv_active_()) {
1864 // Improv doesn't need scan results
1866 }
1868 }
1869
1870 // Should never reach here
1872}
1873
1884 WiFiRetryPhase old_phase = this->retry_phase_;
1885
1886 // No-op if staying in same phase
1887 if (old_phase == new_phase) {
1888 return false;
1889 }
1890
1891 ESP_LOGD(TAG, "Retry phase: %s → %s", LOG_STR_ARG(retry_phase_to_log_string(old_phase)),
1892 LOG_STR_ARG(retry_phase_to_log_string(new_phase)));
1893
1894 this->retry_phase_ = new_phase;
1895 this->num_retried_ = 0; // Reset retry counter on phase change
1896
1897 // Phase-specific setup
1898 switch (new_phase) {
1899#ifdef USE_WIFI_FAST_CONNECT
1901 // Move to next configured AP - clear old scan data so new AP is tried with config only
1902 this->selected_sta_index_++;
1903 ScanResultsLock lock(this);
1904 this->scan_result_.clear();
1905 break;
1906 }
1907#endif
1908
1910 // Starting explicit hidden phase - reset to first network
1911 this->selected_sta_index_ = 0;
1912 break;
1913
1915 // Transitioning to scan-based connection
1916#ifdef USE_WIFI_FAST_CONNECT
1918 ESP_LOGI(TAG, "Fast connect exhausted, falling back to scan");
1919 }
1920#endif
1921 // Trigger scan if we don't have scan results OR if transitioning from phases that need fresh scan
1922 if (this->scan_result_.empty() || old_phase == WiFiRetryPhase::EXPLICIT_HIDDEN ||
1924 this->selected_sta_index_ = -1; // Will be set after scan completes
1925 this->start_scanning();
1926 return true; // Started scan, wait for completion
1927 }
1928 // Already have scan results - selected_sta_index_ should already be synchronized
1929 // (set in check_scanning_finished() when scan completed)
1930 // No need to reset it here
1931 break;
1932
1934 // Always reset to first candidate when entering this phase.
1935 // This phase can be entered from:
1936 // - SCAN_CONNECTING: normal flow, find_next_hidden_sta_() skips networks visible in scan
1937 // - RESTARTING_ADAPTER: captive portal active, find_next_hidden_sta_() tries ALL networks
1938 //
1939 // The retry_hidden_mode_ controls the behavior:
1940 // - SCAN_BASED: scan_result_ is checked, visible networks are skipped
1941 // - BLIND_RETRY: scan_result_ is ignored, all networks become candidates
1942 // We don't clear scan_result_ here - the mode controls whether it's consulted.
1944
1945 if (this->selected_sta_index_ == -1) {
1946 ESP_LOGD(TAG, "All SSIDs visible or already tried, skipping hidden mode");
1947 }
1948 break;
1949
1951 // Skip actual adapter restart if captive portal/improv is active
1952 // This allows state machine to reset num_retried_ and trigger fresh scan
1953 // without disrupting the captive portal/improv connection
1954 if (!this->is_captive_portal_active_() && !this->is_esp32_improv_active_()) {
1955 this->restart_adapter();
1956 } else {
1957 // Even when skipping full restart, disconnect to clear driver state
1958 // Without this, platforms like LibreTiny may think we're still connecting
1959 this->wifi_disconnect_();
1960 }
1961 // Clear scan flag - we're starting a new retry cycle
1962 // This is critical for captive portal/improv flow: when determine_next_phase_()
1963 // returns RETRY_HIDDEN (because scanning is skipped), find_next_hidden_sta_()
1964 // will see BLIND_RETRY mode and treat ALL networks as candidates,
1965 // effectively cycling through all configured networks without scan results.
1967 // Always enter cooldown after restart (or skip-restart) to allow stabilization
1968 // Use extended cooldown when AP is active to avoid constant scanning that blocks DNS
1970 this->action_started_ = millis();
1971 // Return true to indicate we should wait (go to COOLDOWN) instead of immediately connecting
1972 return true;
1973
1974 default:
1975 break;
1976 }
1977
1978 return false; // Did not start scan, can proceed with connection
1979}
1980
1982 if (!this->sta_priorities_.empty()) {
1983 decltype(this->sta_priorities_)().swap(this->sta_priorities_);
1984 }
1985}
1986
1991 if (this->sta_priorities_.empty()) {
1992 return;
1993 }
1994
1995 int8_t first_priority = this->sta_priorities_[0].priority;
1996
1997 // Only clear if all priorities have been decremented to the minimum value
1998 // At this point, all BSSIDs have been equally penalized and priority info is useless
1999 if (first_priority != std::numeric_limits<int8_t>::min()) {
2000 return;
2001 }
2002
2003 for (const auto &pri : this->sta_priorities_) {
2004 if (pri.priority != first_priority) {
2005 return; // Not all same, nothing to do
2006 }
2007 }
2008
2009 // All priorities are at minimum - clear the vector to save memory and reset
2010 ESP_LOGD(TAG, "Clearing BSSID priorities (all at minimum)");
2012}
2013
2033 // Determine which BSSID we tried to connect to
2034 optional<bssid_t> failed_bssid;
2035
2036 if (this->retry_phase_ == WiFiRetryPhase::SCAN_CONNECTING && !this->scan_result_.empty()) {
2037 // Scan-based phase: always use best result (index 0)
2038 failed_bssid = this->scan_result_[0].get_bssid();
2039 } else if (const WiFiAP *config = this->get_selected_sta_(); config && config->has_bssid()) {
2040 // Config has specific BSSID (fast_connect or user-specified)
2041 failed_bssid = config->get_bssid();
2042 }
2043
2044 if (!failed_bssid.has_value()) {
2045 return; // No BSSID to penalize
2046 }
2047
2048 // Get SSID for logging (use pointer to avoid copy)
2049 const char *ssid = nullptr;
2050 if (this->retry_phase_ == WiFiRetryPhase::SCAN_CONNECTING && !this->scan_result_.empty()) {
2051 ssid = this->scan_result_[0].ssid_.c_str();
2052 } else if (const WiFiAP *config = this->get_selected_sta_()) {
2053 ssid = config->ssid_.c_str();
2054 }
2055
2056 // Only decrease priority on the last attempt for this phase
2057 // This prevents false positives from transient WiFi stack issues
2058 uint8_t max_retries = get_max_retries_for_phase(this->retry_phase_);
2059 bool is_last_attempt = (this->num_retried_ + 1 >= max_retries);
2060
2061 // Decrease priority only on last attempt to avoid false positives from transient failures
2062 int8_t old_priority = this->get_sta_priority(failed_bssid.value());
2063 int8_t new_priority = old_priority;
2064
2065 if (is_last_attempt) {
2066 // Decrease priority, but clamp to int8_t::min to prevent overflow
2067 new_priority =
2068 (old_priority > std::numeric_limits<int8_t>::min()) ? (old_priority - 1) : std::numeric_limits<int8_t>::min();
2069 this->set_sta_priority(failed_bssid.value(), new_priority);
2070 }
2071 char bssid_s[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
2072 format_mac_addr_upper(failed_bssid.value().data(), bssid_s);
2073 ESP_LOGD(TAG, "Failed " LOG_SECRET("'%s'") " " LOG_SECRET("(%s)") ", priority %d → %d", ssid != nullptr ? ssid : "",
2074 bssid_s, old_priority, new_priority);
2075
2076 // After adjusting priority, check if all priorities are now at minimum
2077 // If so, clear the vector to save memory and reset for fresh start
2079}
2080
2092 WiFiRetryPhase current_phase = this->retry_phase_;
2093
2094 // Check if we need to advance to next AP/SSID within the same phase
2095#ifdef USE_WIFI_FAST_CONNECT
2096 if (current_phase == WiFiRetryPhase::FAST_CONNECT_CYCLING_APS) {
2097 // Fast connect: always advance to next AP (no retries per AP)
2098 this->selected_sta_index_++;
2099 this->num_retried_ = 0;
2100 ESP_LOGD(TAG, "Next AP in %s", LOG_STR_ARG(retry_phase_to_log_string(this->retry_phase_)));
2101 return;
2102 }
2103#endif
2104
2105 if (current_phase == WiFiRetryPhase::EXPLICIT_HIDDEN && this->num_retried_ + 1 >= WIFI_RETRY_COUNT_PER_SSID) {
2106 // Explicit hidden: exhausted retries on current SSID, find next explicitly hidden network
2107 // Stop when we reach a visible network (proceed to scanning)
2108 size_t next_index = this->selected_sta_index_ + 1;
2109 if (next_index < this->sta_.size() && this->sta_[next_index].get_hidden()) {
2110 this->selected_sta_index_ = static_cast<int8_t>(next_index);
2111 this->num_retried_ = 0;
2112 ESP_LOGD(TAG, "Next explicit hidden network at index %d", static_cast<int>(next_index));
2113 return;
2114 }
2115 // No more consecutive explicit hidden networks found - fall through to trigger phase change
2116 }
2117
2118 if (current_phase == WiFiRetryPhase::RETRY_HIDDEN && this->num_retried_ + 1 >= WIFI_RETRY_COUNT_PER_SSID) {
2119 // Hidden mode: exhausted retries on current SSID, find next potentially hidden SSID
2120 // If first network is marked hidden, we went through EXPLICIT_HIDDEN phase
2121 // In that case, skip networks marked hidden:true (already tried)
2122 // Otherwise, include them (they haven't been tried yet)
2123 int8_t next_index = this->find_next_hidden_sta_(this->selected_sta_index_);
2124 if (next_index != -1) {
2125 // Found another potentially hidden SSID
2126 this->selected_sta_index_ = next_index;
2127 this->num_retried_ = 0;
2128 return;
2129 }
2130 // No more potentially hidden SSIDs - set selected_sta_index_ to -1 to trigger phase change
2131 // This ensures determine_next_phase_() will skip the RETRY_HIDDEN logic and transition out
2132 this->selected_sta_index_ = -1;
2133 // Return early - phase change will happen on next wifi_loop() iteration
2134 return;
2135 }
2136
2137 // Don't increment retry counter if we're in a scan phase with no valid targets
2138 if (this->needs_scan_results_()) {
2139 return;
2140 }
2141
2142 // Increment retry counter to try the same target again
2143 this->num_retried_++;
2144 ESP_LOGD(TAG, "Retry attempt %u/%u in phase %s", this->num_retried_ + 1,
2145 get_max_retries_for_phase(this->retry_phase_), LOG_STR_ARG(retry_phase_to_log_string(this->retry_phase_)));
2146}
2147
2149 // Handle roaming state transitions - preserve attempts counter to prevent ping-pong
2150 // to unreachable APs after ROAMING_MAX_ATTEMPTS failures
2152 // Roam connection failed - transition to reconnecting
2153 ESP_LOGD(TAG, "Roam failed, reconnecting (attempt %u/%u)", this->roaming_attempts_, ROAMING_MAX_ATTEMPTS);
2155 } else if (this->is_roaming_scan_active()) {
2156 // Disconnected during roam scan - transition to RECONNECTING so the attempts
2157 // counter is preserved when reconnection succeeds (IDLE would reset it)
2158 ESP_LOGD(TAG, "Disconnected during roam scan (attempt %u/%u)", this->roaming_attempts_, ROAMING_MAX_ATTEMPTS);
2160 } else if (this->roaming_state_ == RoamingState::IDLE) {
2161 // Check if a roaming scan recently completed - on ESP8266, going off-channel
2162 // during scan can cause a delayed Beacon Timeout 8-20 seconds after scan finishes.
2163 // Transition to RECONNECTING so the attempts counter is preserved on reconnect.
2165 ESP_LOGD(TAG, "Disconnect after roam scan (attempt %u/%u)", this->roaming_attempts_, ROAMING_MAX_ATTEMPTS);
2167 } else {
2168 // Not a roaming-triggered reconnect, reset state
2169 this->clear_roaming_state_();
2170 }
2171 }
2172 // RECONNECTING: keep state and counter, still trying to reconnect
2173
2175
2176 // Determine next retry phase based on current state
2177 WiFiRetryPhase current_phase = this->retry_phase_;
2178 WiFiRetryPhase next_phase = this->determine_next_phase_();
2179
2180 // Handle phase transitions (transition_to_phase_ handles same-phase no-op internally)
2181 if (this->transition_to_phase_(next_phase)) {
2182 return; // Scan started or adapter restarted (which sets its own state)
2183 }
2184
2185 if (next_phase == current_phase) {
2187 }
2188
2189 yield();
2190 // Check if we have a valid target before building params
2191 // After exhausting all networks in a phase, selected_sta_index_ may be -1
2192 // In that case, skip connection and let next wifi_loop() handle phase transition
2193 if (this->selected_sta_index_ >= 0) {
2194 WiFiAP params = this->build_params_for_current_phase_();
2195 this->start_connecting(params);
2196 }
2197}
2198
2199void WiFiComponent::set_reboot_timeout(uint32_t reboot_timeout) { this->reboot_timeout_ = reboot_timeout; }
2201 this->power_save_ = power_save;
2202#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
2203 this->configured_power_save_ = power_save;
2204#endif
2205}
2206
2207void WiFiComponent::set_passive_scan(bool passive) { this->passive_scan_ = passive; }
2208
2210#ifdef USE_CAPTIVE_PORTAL
2212#else
2213 return false;
2214#endif
2215}
2217#ifdef USE_IMPROV
2219#else
2220 return false;
2221#endif
2222}
2223
2224#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
2226 // Already configured for high performance - request satisfied
2228 return true;
2229 }
2230
2231 // Semaphore initialization failed
2232 if (this->high_performance_semaphore_ == nullptr) {
2233 return false;
2234 }
2235
2236 // Give the semaphore (non-blocking). This increments the count.
2237 bool success = xSemaphoreGive(this->high_performance_semaphore_) == pdTRUE;
2238
2239 // Wake the main loop so the switch to high-performance mode is applied on the
2240 // next tick instead of waiting up to loop_interval.
2241 if (success) {
2243 }
2244
2245 return success;
2246}
2247
2249 // Already configured for high performance - nothing to release
2251 return true;
2252 }
2253
2254 // Semaphore initialization failed
2255 if (this->high_performance_semaphore_ == nullptr) {
2256 return false;
2257 }
2258
2259 // Take the semaphore (non-blocking). This decrements the count.
2260 return xSemaphoreTake(this->high_performance_semaphore_, 0) == pdTRUE;
2261}
2262#endif // USE_ESP32 && USE_WIFI_RUNTIME_POWER_SAVE
2263
2264#ifdef USE_WIFI_FAST_CONNECT
2266 SavedWifiFastConnectSettings fast_connect_save{};
2267
2268 if (this->fast_connect_pref_.load(&fast_connect_save)) {
2269 // Validate saved AP index
2270 if (fast_connect_save.ap_index < 0 || static_cast<size_t>(fast_connect_save.ap_index) >= this->sta_.size()) {
2271 ESP_LOGW(TAG, "AP index out of bounds");
2272 return false;
2273 }
2274
2275 // Set selected index for future operations (save, retry, etc)
2276 this->selected_sta_index_ = fast_connect_save.ap_index;
2277
2278 // Copy entire config, then override with fast connect data
2279 params = this->sta_[fast_connect_save.ap_index];
2280
2281 // Override with saved BSSID/channel from fast connect (SSID/password/etc already copied from config)
2282 bssid_t bssid{};
2283 std::copy(fast_connect_save.bssid, fast_connect_save.bssid + 6, bssid.begin());
2284 params.set_bssid(bssid);
2285 params.set_channel(fast_connect_save.channel);
2286 // Fast connect uses specific BSSID+channel, not hidden network probe (even if config has hidden: true)
2287 params.set_hidden(false);
2288
2289 ESP_LOGD(TAG, "Loaded fast_connect settings");
2290#if defined(USE_ESP32) && defined(SOC_WIFI_SUPPORT_5G)
2291 if ((this->band_mode_ == WIFI_BAND_MODE_5G_ONLY && fast_connect_save.channel < FIRST_5GHZ_CHANNEL) ||
2292 (this->band_mode_ == WIFI_BAND_MODE_2G_ONLY && fast_connect_save.channel >= FIRST_5GHZ_CHANNEL)) {
2293 ESP_LOGW(TAG, "Saved channel %u not allowed by band mode, ignoring fast_connect", fast_connect_save.channel);
2294 this->selected_sta_index_ = -1;
2295 return false;
2296 }
2297#endif
2298 return true;
2299 }
2300
2301 return false;
2302}
2303
2304void WiFiComponent::save_fast_connect_settings_(const bssid_t &bssid, uint8_t channel) {
2305 // selected_sta_index_ is always valid here (called only after successful connection)
2306 // Fallback to 0 is defensive programming for robustness
2307 int8_t ap_index = this->selected_sta_index_ >= 0 ? this->selected_sta_index_ : 0;
2308
2309 // Skip save if settings haven't changed (compare with previously saved settings to reduce flash wear)
2310 SavedWifiFastConnectSettings previous_save{};
2311 if (this->fast_connect_pref_.load(&previous_save) && memcmp(previous_save.bssid, bssid.data(), 6) == 0 &&
2312 previous_save.channel == channel && previous_save.ap_index == ap_index) {
2313 return; // No change, nothing to save
2314 }
2315
2316 SavedWifiFastConnectSettings fast_connect_save{};
2317 memcpy(fast_connect_save.bssid, bssid.data(), 6);
2318 fast_connect_save.channel = channel;
2319 fast_connect_save.ap_index = ap_index;
2320
2321 this->fast_connect_pref_.save(&fast_connect_save);
2322
2323 ESP_LOGD(TAG, "Saved fast_connect settings");
2324}
2325#endif
2326
2327void WiFiAP::set_ssid(const std::string &ssid) { this->ssid_ = CompactString(ssid.c_str(), ssid.size()); }
2328void WiFiAP::set_ssid(const char *ssid) { this->ssid_ = CompactString(ssid, strlen(ssid)); }
2329void WiFiAP::set_bssid(const bssid_t &bssid) { this->bssid_ = bssid; }
2330void WiFiAP::clear_bssid() { this->bssid_ = {}; }
2331void WiFiAP::set_password(const std::string &password) {
2332 this->password_ = CompactString(password.c_str(), password.size());
2333}
2334void WiFiAP::set_password(const char *password) { this->password_ = CompactString(password, strlen(password)); }
2335#ifdef USE_WIFI_WPA2_EAP
2336void WiFiAP::set_eap(optional<EAPAuth> eap_auth) { this->eap_ = std::move(eap_auth); }
2337#endif
2338void WiFiAP::set_channel(uint8_t channel) { this->channel_ = channel; }
2339void WiFiAP::clear_channel() { this->channel_ = 0; }
2340#ifdef USE_WIFI_MANUAL_IP
2341void WiFiAP::set_manual_ip(optional<ManualIP> manual_ip) { this->manual_ip_ = manual_ip; }
2342#endif
2343void WiFiAP::set_hidden(bool hidden) { this->hidden_ = hidden; }
2344const bssid_t &WiFiAP::get_bssid() const { return this->bssid_; }
2345bool WiFiAP::has_bssid() const { return this->bssid_ != bssid_t{}; }
2346#ifdef USE_WIFI_WPA2_EAP
2347const optional<EAPAuth> &WiFiAP::get_eap() const { return this->eap_; }
2348#endif
2349#ifdef USE_WIFI_MANUAL_IP
2350const optional<ManualIP> &WiFiAP::get_manual_ip() const { return this->manual_ip_; }
2351#endif
2352bool WiFiAP::get_hidden() const { return this->hidden_; }
2353
2354WiFiScanResult::WiFiScanResult(const bssid_t &bssid, const char *ssid, size_t ssid_len, uint8_t channel, int8_t rssi,
2355 bool with_auth, bool is_hidden)
2356 : bssid_(bssid),
2357 channel_(channel),
2358 rssi_(rssi),
2359 ssid_(ssid, ssid_len),
2360 with_auth_(with_auth),
2361 is_hidden_(is_hidden) {}
2362bool WiFiScanResult::matches(const WiFiAP &config) const {
2363 if (config.get_hidden()) {
2364 // User configured a hidden network, only match actually hidden networks
2365 // don't match SSID
2366 if (!this->is_hidden_)
2367 return false;
2368 } else if (!config.ssid_.empty()) {
2369 // check if SSID matches
2370 if (this->ssid_ != config.ssid_)
2371 return false;
2372 } else {
2373 // network is configured without SSID - match other settings
2374 }
2375 // If BSSID configured, only match for correct BSSIDs
2376 if (config.has_bssid() && config.get_bssid() != this->bssid_)
2377 return false;
2378
2379#ifdef USE_WIFI_WPA2_EAP
2380 // BSSID requires auth but no PSK or EAP credentials given
2381 if (this->with_auth_ && (config.password_.empty() && !config.get_eap().has_value()))
2382 return false;
2383
2384 // BSSID does not require auth, but PSK or EAP credentials given
2385 if (!this->with_auth_ && (!config.password_.empty() || config.get_eap().has_value()))
2386 return false;
2387#else
2388 // If PSK given, only match for networks with auth (and vice versa)
2389 if (config.password_.empty() == this->with_auth_)
2390 return false;
2391#endif
2392
2393 // If channel configured, only match networks on that channel.
2394 if (config.has_channel() && config.get_channel() != this->channel_) {
2395 return false;
2396 }
2397 return true;
2398}
2399bool WiFiScanResult::get_matches() const { return this->matches_; }
2400void WiFiScanResult::set_matches(bool matches) { this->matches_ = matches; }
2401const bssid_t &WiFiScanResult::get_bssid() const { return this->bssid_; }
2402uint8_t WiFiScanResult::get_channel() const { return this->channel_; }
2403int8_t WiFiScanResult::get_rssi() const { return this->rssi_; }
2404bool WiFiScanResult::get_with_auth() const { return this->with_auth_; }
2405bool WiFiScanResult::get_is_hidden() const { return this->is_hidden_; }
2406
2407bool WiFiScanResult::operator==(const WiFiScanResult &rhs) const { return this->bssid_ == rhs.bssid_; }
2408
2410 this->roaming_attempts_ = 0;
2411 this->roaming_last_check_ = 0;
2412 this->roaming_scan_end_ = 0;
2413 this->roaming_target_bssid_ = {};
2415}
2416
2417#ifdef USE_ESP32
2418void WiFiComponent::handle_driver_roam_(const bssid_t &bssid, uint8_t channel) {
2419 // A driver-initiated roam (e.g. 802.11v BTM) re-associates without the state
2420 // machine ever leaving STA_CONNECTED, so check_connecting_finished() never runs.
2421 // Redo its post-connect bookkeeping here. roaming_state_ is deliberately left
2422 // untouched so an in-flight roaming scan is not orphaned. The BSSID and
2423 // channel both come from the connected event so the saved pair is consistent:
2424 // the radio may be off-channel during a roaming scan, and a later queued
2425 // event may have moved the driver on again by the time this one is processed.
2427 this->roaming_attempts_ = 0;
2428 this->roaming_scan_end_ = 0;
2430#ifdef USE_WIFI_FAST_CONNECT
2431 this->save_fast_connect_settings_(bssid, channel);
2432#endif
2433}
2434#endif
2435
2437 if (!this->keep_scan_results_) {
2438 ScanResultsLock lock(this);
2439#if defined(USE_RP2) || defined(USE_ESP32)
2440 // std::vector - use swap trick since shrink_to_fit is non-binding
2441 decltype(this->scan_result_)().swap(this->scan_result_);
2442#else
2443 // FixedVector::release() frees all memory
2444 this->scan_result_.release();
2445#endif
2446 }
2447}
2448
2449#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
2451 if (!this->pending_.connect_state)
2452 return;
2453 this->pending_.connect_state = false;
2454 // Get current SSID and BSSID from the WiFi driver
2455 char ssid_buf[SSID_BUFFER_SIZE];
2456 const char *ssid = this->wifi_ssid_to(ssid_buf);
2457 bssid_t bssid = this->wifi_bssid();
2458 for (auto *listener : this->connect_state_listeners_) {
2459 listener->on_wifi_connect_state(StringRef(ssid, strlen(ssid)), bssid);
2460 }
2461}
2462
2464 constexpr uint8_t empty_bssid[6] = {};
2465 for (auto *listener : this->connect_state_listeners_) {
2466 listener->on_wifi_connect_state(StringRef(), empty_bssid);
2467 }
2468}
2469#endif // USE_WIFI_CONNECT_STATE_LISTENERS
2470
2471#ifdef USE_WIFI_IP_STATE_LISTENERS
2473 for (auto *listener : this->ip_state_listeners_) {
2474 listener->on_ip_state(this->wifi_sta_ip_addresses(), this->get_dns_address(0), this->get_dns_address(1));
2475 }
2476}
2477#endif // USE_WIFI_IP_STATE_LISTENERS
2478
2479#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
2481 for (auto *listener : this->scan_results_listeners_) {
2482 listener->on_wifi_scan_results(this->scan_result_);
2483 }
2484}
2485#endif // USE_WIFI_SCAN_RESULTS_LISTENERS
2486
2488 // Guard: not for hidden networks (may not appear in scan)
2489 const WiFiAP *selected = this->get_selected_sta_();
2490 if (selected == nullptr || selected->get_hidden()) {
2491 this->roaming_attempts_ = ROAMING_MAX_ATTEMPTS; // Stop checking forever
2492 return;
2493 }
2494
2495 this->roaming_last_check_ = now;
2496 this->roaming_attempts_++;
2497
2498 // Guard: skip scan if signal is already good (no meaningful improvement possible)
2499 int8_t rssi = this->wifi_rssi();
2500 if (rssi > ROAMING_GOOD_RSSI) {
2501 ESP_LOGD(TAG, "Roam check skipped, signal good (%d dBm, attempt %u/%u)", rssi, this->roaming_attempts_,
2503 return;
2504 }
2505
2506 ESP_LOGD(TAG, "Roam scan (%d dBm, attempt %u/%u)", rssi, this->roaming_attempts_, ROAMING_MAX_ATTEMPTS);
2508 this->wifi_scan_start_(this->passive_scan_);
2509}
2510
2512 this->scan_done_ = false;
2513 // Default to IDLE - will be set to CONNECTING if we find a better AP
2515 // Record when scan completed so delayed disconnects (e.g., ESP8266 Beacon Timeout)
2516 // can be attributed to the scan and avoid resetting the attempts counter
2517 this->roaming_scan_end_ = millis();
2518
2519 // Get current connection info
2520 int8_t current_rssi = this->wifi_rssi();
2521 // Guard: must still be connected (RSSI may have become invalid during scan)
2522 if (current_rssi == WIFI_RSSI_DISCONNECTED) {
2523 this->release_scan_results_();
2524 return;
2525 }
2526
2527 char ssid_buf[SSID_BUFFER_SIZE];
2528 StringRef current_ssid(this->wifi_ssid_to(ssid_buf));
2529 bssid_t current_bssid = this->wifi_bssid();
2530
2531 // Find best candidate: same SSID, different BSSID
2532 const WiFiScanResult *best = nullptr;
2533 char bssid_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
2534
2535 for (const auto &result : this->scan_result_) {
2536 // Must be same SSID, different BSSID
2537 if (result.ssid_ != current_ssid || result.get_bssid() == current_bssid)
2538 continue;
2539
2540#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
2541 format_mac_addr_upper(result.get_bssid().data(), bssid_buf);
2542 ESP_LOGV(TAG, "Roam candidate %s %d dBm", bssid_buf, result.get_rssi());
2543#endif
2544
2545 // Track the best candidate
2546 if (best == nullptr || result.get_rssi() > best->get_rssi()) {
2547 best = &result;
2548 }
2549 }
2550
2551 // Check if best candidate meets minimum improvement threshold
2552 const WiFiAP *selected = this->get_selected_sta_();
2553 int8_t improvement = (best == nullptr) ? 0 : best->get_rssi() - current_rssi;
2554 if (selected == nullptr || improvement < ROAMING_MIN_IMPROVEMENT) {
2555 ESP_LOGV(TAG, "Roam best %+d dB (need +%d), attempt %u/%u", improvement, ROAMING_MIN_IMPROVEMENT,
2557 this->release_scan_results_();
2558 return;
2559 }
2560
2561 format_mac_addr_upper(best->get_bssid().data(), bssid_buf);
2562 ESP_LOGI(TAG, "Roaming to %s (%+d dB)", bssid_buf, improvement);
2563
2564 WiFiAP roam_params = *selected;
2565 apply_scan_result_to_params(roam_params, *best);
2566
2567 // Mark as roaming attempt - affects retry behavior if connection fails
2569 this->roaming_target_bssid_ = best->get_bssid(); // Must read before releasing scan results
2570
2571 this->release_scan_results_();
2572
2573 // Connect directly - wifi_sta_connect_ handles disconnect internally
2574 this->start_connecting(roam_params);
2575}
2576
2577WiFiComponent *global_wifi_component; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
2578
2579} // namespace esphome::wifi
2580#endif
BedjetMode mode
BedJet operating mode.
uint8_t m
Definition bl0906.h:1
uint8_t status
Definition bl0942.h:8
const StringRef & get_name() const
Get the name of this Application set by pre_setup().
void wake_loop_threadsafe()
Wake the main event loop from another thread or callback.
bool is_name_add_mac_suffix_enabled() const
uint32_t get_config_version_hash()
Get the config hash extended with ESPHome version.
uint32_t IRAM_ATTR HOT get_loop_component_start_time() const
Get the cached time in milliseconds from when the current component started its loop execution.
void status_clear_warning()
Definition component.h:289
StringRef is a reference to a string owned by something else.
Definition string_ref.h:26
constexpr const char * c_str() const
Definition string_ref.h:73
constexpr size_type size() const
Definition string_ref.h:74
void trigger(const Ts &...x) ESPHOME_ALWAYS_INLINE
Inform the parent automation that the event has triggered.
Definition automation.h:461
20-byte string: 18 chars inline + null, heap for longer.
const char * data() const
CompactString & operator=(const CompactString &other)
bool operator==(const CompactString &other) const
static constexpr uint8_t INLINE_CAPACITY
const char * c_str() const
char storage_[INLINE_CAPACITY+1]
static constexpr uint8_t MAX_LENGTH
Guards WiFiComponent::scan_result_.
uint8_t get_channel() const
void set_ssid(const std::string &ssid)
const optional< EAPAuth > & get_eap() const
void set_bssid(const bssid_t &bssid)
void set_channel(uint8_t channel)
optional< EAPAuth > eap_
optional< ManualIP > manual_ip_
void set_eap(optional< EAPAuth > eap_auth)
void set_password(const std::string &password)
void set_manual_ip(optional< ManualIP > manual_ip)
const optional< ManualIP > & get_manual_ip() const
void set_hidden(bool hidden)
const bssid_t & get_bssid() const
This component is responsible for managing the ESP WiFi interface.
void notify_scan_results_listeners_()
Notify scan results listeners with current scan results.
void add_sta(const WiFiAP &ap)
bool load_fast_connect_settings_(WiFiAP &params)
void set_ap(const WiFiAP &ap)
Setup an Access Point that should be created if no connection to a station can be made.
bool request_high_performance()
Request high-performance mode (no power saving) for improved WiFi latency.
void set_sta(const WiFiAP &ap)
bool roaming_suppressed_() const
Returns true if a component has requested that roaming scans be suppressed (e.g. during audio playbac...
bool has_sta_priority(const bssid_t &bssid)
const WiFiAP * get_selected_sta_() const
WiFiSTAConnectStatus wifi_sta_connect_status_() const
int8_t get_sta_priority(const bssid_t bssid)
void log_and_adjust_priority_for_failed_connect_()
Log failed connection and decrease BSSID priority to avoid repeated attempts.
void save_wifi_sta(const std::string &ssid, const std::string &password)
void notify_connect_state_listeners_()
Notify connect state listeners (called after state machine reaches STA_CONNECTED)
wifi_scan_vector_t< WiFiScanResult > scan_result_
void save_fast_connect_settings_(const bssid_t &bssid, uint8_t channel)
WiFiPowerSaveMode configured_power_save_
void set_sta_priority(bssid_t bssid, int8_t priority)
StaticVector< WiFiScanResultsListener *, ESPHOME_WIFI_SCAN_RESULTS_LISTENERS > scan_results_listeners_
void loop() override
Reconnect WiFi if required.
void notify_ip_state_listeners_()
Notify IP state listeners with current addresses.
void start_connecting(const WiFiAP &ap)
void advance_to_next_target_or_increment_retry_()
Advance to next target (AP/SSID) within current phase, or increment retry counter Called when staying...
static constexpr uint32_t ROAMING_CHECK_INTERVAL
SemaphoreHandle_t high_performance_semaphore_
network::IPAddress get_dns_address(int num)
WiFiComponent()
Construct a WiFiComponent.
std::vector< WiFiSTAPriority > sta_priorities_
static constexpr int8_t ROAMING_GOOD_RSSI
void notify_disconnect_state_listeners_()
Notify connect state listeners of disconnection.
StaticVector< WiFiConnectStateListener *, ESPHOME_WIFI_CONNECT_STATE_LISTENERS > connect_state_listeners_
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.
static constexpr uint8_t ROAMING_MAX_ATTEMPTS
void set_passive_scan(bool passive)
void set_power_save_mode(WiFiPowerSaveMode power_save)
bool is_roaming_scan_active() const
True while a post-connect roaming scan holds the radio off-channel.
int8_t find_next_hidden_sta_(int8_t start_index)
Find next SSID that wasn't in scan results (might be hidden) Returns index of next potentially hidden...
ESPPreferenceObject fast_connect_pref_
void clear_priorities_if_all_min_()
Clear BSSID priority tracking if all priorities are at minimum (saves memory)
static constexpr uint32_t ROAMING_SCAN_GRACE_PERIOD
WiFiRetryPhase determine_next_phase_()
Determine next retry phase based on current state and failure conditions.
network::IPAddress wifi_dns_ip_(int num)
network::IPAddresses get_ip_addresses()
static constexpr int8_t ROAMING_MIN_IMPROVEMENT
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...
float get_setup_priority() const override
WIFI setup_priority.
StaticVector< WiFiIPStateListener *, ESPHOME_WIFI_IP_STATE_LISTENERS > ip_state_listeners_
FixedVector< WiFiAP > sta_
int8_t find_first_non_hidden_index_() const
Find the index of the first non-hidden network Returns where EXPLICIT_HIDDEN phase would have stopped...
void release_scan_results_()
Free scan results memory unless a component needs them.
bool needs_scan_results_() const
Check if we need valid scan results for the current phase but don't have any Returns true if the phas...
bool transition_to_phase_(WiFiRetryPhase new_phase)
Transition to a new retry phase with logging Returns true if a scan was started (caller should wait),...
bool needs_full_scan_results_() const
Check if full scan results are needed (captive portal active, improv, listeners)
static constexpr uint8_t FIRST_5GHZ_CHANNEL
bool release_high_performance()
Release a high-performance mode request.
bool wifi_apply_output_power_(float output_power)
bool went_through_explicit_hidden_phase_() const
Check if we went through EXPLICIT_HIDDEN phase (first network is marked hidden) Used in RETRY_HIDDEN ...
bool wifi_mode_(optional< bool > sta, optional< bool > ap)
void set_reboot_timeout(uint32_t reboot_timeout)
network::IPAddresses wifi_sta_ip_addresses()
void check_connecting_finished(uint32_t now)
void start_initial_connection_()
Start initial connection - either scan or connect directly to hidden networks.
bool ssid_was_seen_in_scan_(const CompactString &ssid) const
Check if an SSID was seen in the most recent scan results Used to skip hidden mode for SSIDs we know ...
void handle_driver_roam_(const bssid_t &bssid, uint8_t channel)
Redo post-connect bookkeeping after a driver-initiated roam (e.g.
void setup() override
Setup WiFi interface.
struct esphome::wifi::WiFiComponent::@193 pending_
void clear_all_bssid_priorities_()
Clear all BSSID priority penalties after successful connection (stale after disconnect)
WiFiScanResult(const bssid_t &bssid, const char *ssid, size_t ssid_len, uint8_t channel, int8_t rssi, bool with_auth, bool is_hidden)
const bssid_t & get_bssid() const
bool matches(const WiFiAP &config) const
bool operator==(const WiFiScanResult &rhs) const
struct @66::@67 __attribute__
Wake the main loop task from an ISR. ISR-safe.
Definition main_task.h:32
void yield(void)
uint16_t type
uint8_t priority
CaptivePortal * global_captive_portal
ESP32ImprovComponent * global_improv_component
ImprovSerialComponent * global_improv_serial_component
std::array< IPAddress, 5 > IPAddresses
Definition ip_address.h:299
ProvisioningManager * global_provisioning_manager
constexpr float WIFI
Definition component.h:50
const char *const TAG
Definition spi.cpp:7
std::array< uint8_t, 6 > bssid_t
const LogString * get_signal_bars(int8_t rssi)
@ BLIND_RETRY
Blind retry mode: scanning disabled (captive portal/improv active), try ALL configured networks seque...
@ SCAN_BASED
Normal mode: scan completed, only try networks NOT visible in scan results (truly hidden networks tha...
WiFiRetryPhase
Tracks the current retry strategy/phase for WiFi connection attempts.
@ RETRY_HIDDEN
Retry networks not found in scan (might be hidden)
@ RESTARTING_ADAPTER
Restarting WiFi adapter to clear stuck state.
@ INITIAL_CONNECT
Initial connection attempt (varies based on fast_connect setting)
@ EXPLICIT_HIDDEN
Explicitly hidden networks (user marked as hidden, try before scanning)
@ FAST_CONNECT_CYCLING_APS
Fast connect mode: cycling through configured APs (config-only, no scan)
@ SCAN_CONNECTING
Scan-based: connecting to best AP from scan results.
WiFiComponent * global_wifi_component
@ SCANNING
Scanning for better AP.
@ CONNECTING
Attempting to connect to better AP found in scan.
@ IDLE
Not roaming, waiting for next check interval.
@ RECONNECTING
Roam connection failed, reconnecting to any available AP.
@ WIFI_COMPONENT_STATE_DISABLED
WiFi is disabled.
@ WIFI_COMPONENT_STATE_AP
WiFi is in AP-only mode and internal AP is already enabled.
@ WIFI_COMPONENT_STATE_STA_CONNECTING
WiFi is in STA(+AP) mode and currently connecting to an AP.
@ WIFI_COMPONENT_STATE_OFF
Nothing has been initialized yet.
@ WIFI_COMPONENT_STATE_STA_SCANNING
WiFi is in STA-only mode and currently scanning for APs.
@ WIFI_COMPONENT_STATE_COOLDOWN
WiFi is in cooldown mode because something went wrong, scanning will begin after a short period of ti...
@ WIFI_COMPONENT_STATE_STA_CONNECTED
WiFi is in STA(+AP) mode and successfully connected.
uint16_t uint16_t size_t elem_size
Definition helpers.cpp:26
const void size_t len
Definition hal.h:64
uint16_t size
Definition helpers.cpp:25
ESPPreferences * global_preferences
const char * get_mac_address_pretty_into_buffer(std::span< char, MAC_ADDRESS_PRETTY_BUFFER_SIZE > buf)
Get the device MAC address into the given buffer, in colon-separated uppercase hex notation.
Definition helpers.cpp:816
uint32_t IRAM_ATTR HOT millis()
Definition hal.cpp:28
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:1493
static void uint32_t
ESPPreferenceObject make_preference(size_t, uint32_t, bool)
Definition preferences.h:24
bool sync()
Commit pending writes to flash.
Definition preferences.h:33
esp_eap_ttls_phase2_types ttls_phase_2
Struct for setting static IPs in WiFiComponent.
SemaphoreHandle_t lock