ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
wifi_component.h
Go to the documentation of this file.
1#pragma once
2
4#ifdef USE_WIFI
10
11#include <span>
12#include <string>
13#include <type_traits>
14#include <vector>
15
16#ifdef USE_LIBRETINY
17#include <WiFi.h>
18#endif
19
20#if defined(USE_ESP32) && defined(USE_WIFI_WPA2_EAP)
21#if (ESP_IDF_VERSION_MAJOR >= 5) && (ESP_IDF_VERSION_MINOR >= 1)
22#include <esp_eap_client.h>
23#else
24#include <esp_wpa2.h>
25#endif
26#endif
27
28#ifdef USE_ESP8266
29#include <ESP8266WiFi.h>
30#include <ESP8266WiFiType.h>
31
32#if defined(USE_ESP8266) && USE_ARDUINO_VERSION_CODE < VERSION_CODE(2, 4, 0)
33extern "C" {
34#include <user_interface.h>
35};
36#endif
37#endif
38
39#ifdef USE_RP2040
40extern "C" {
41#include "cyw43.h"
42#include "cyw43_country.h"
43#include "pico/cyw43_arch.h"
44}
45
46#include <WiFi.h>
47#endif
48
49#if defined(USE_ESP32) && defined(SOC_WIFI_SUPPORT_5G)
50#include <esp_wifi_types.h>
51#endif
52
53#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
54#include <freertos/FreeRTOS.h>
55#include <freertos/semphr.h>
56#endif
57
58namespace esphome::wifi {
59
61static constexpr int8_t WIFI_RSSI_DISCONNECTED = -127;
62
64static constexpr size_t SSID_BUFFER_SIZE = 33;
65
67 char ssid[33];
68 char password[65];
69} PACKED; // NOLINT
70
72 uint8_t bssid[6];
73 uint8_t channel;
74 int8_t ap_index;
75} PACKED; // NOLINT
76
93
101
103enum class WiFiRetryPhase : uint8_t {
106#ifdef USE_WIFI_FAST_CONNECT
109#endif
118};
119
121enum class RoamingState : uint8_t {
123 IDLE,
125 SCANNING,
130};
131
133enum class RetryHiddenMode : uint8_t {
140};
141
150
151#ifdef USE_WIFI_WPA2_EAP
152struct EAPAuth {
153 std::string identity; // required for all auth types
154 std::string username;
155 std::string password;
156 const char *ca_cert; // optionally verify authentication server
157 // used for EAP-TLS
158 const char *client_cert;
159 const char *client_key;
160// used for EAP-TTLS
161#ifdef USE_ESP32
162 esp_eap_ttls_phase2_types ttls_phase_2;
163#endif
164};
165#endif // USE_WIFI_WPA2_EAP
166
167using bssid_t = std::array<uint8_t, 6>;
168
170static constexpr size_t WIFI_SCAN_RESULT_FILTERED_RESERVE = 8;
171
172// Use std::vector for RP2040 (callback-based) and ESP32 (destructive scan API)
173// Use FixedVector for ESP8266 and LibreTiny where two-pass exact allocation is possible
174#if defined(USE_RP2040) || defined(USE_ESP32)
175template<typename T> using wifi_scan_vector_t = std::vector<T>;
176#else
177template<typename T> using wifi_scan_vector_t = FixedVector<T>;
178#endif
179
183 public:
184 static constexpr uint8_t MAX_LENGTH = 127;
185 static constexpr uint8_t INLINE_CAPACITY = 18; // 18 chars + null terminator fits in 19 bytes
186
187 CompactString() : length_(0), is_heap_(0) { this->storage_[0] = '\0'; }
188 CompactString(const char *str, size_t len);
189 CompactString(const CompactString &other);
190 CompactString(CompactString &&other) noexcept;
192 CompactString &operator=(CompactString &&other) noexcept;
194
195 const char *data() const { return this->is_heap_ ? this->get_heap_ptr_() : this->storage_; }
196 const char *c_str() const { return this->data(); } // Always null-terminated
197 size_t size() const { return this->length_; }
198 bool empty() const { return this->length_ == 0; }
199
201 StringRef ref() const { return StringRef(this->data(), this->size()); }
202
203 bool operator==(const CompactString &other) const;
204 bool operator!=(const CompactString &other) const { return !(*this == other); }
205 bool operator==(const StringRef &other) const;
206 bool operator!=(const StringRef &other) const { return !(*this == other); }
207 bool operator==(const char *other) const { return *this == StringRef(other); }
208 bool operator!=(const char *other) const { return !(*this == other); }
209
210 protected:
211 char *get_heap_ptr_() const {
212 char *ptr;
213 std::memcpy(&ptr, this->storage_, sizeof(ptr));
214 return ptr;
215 }
216 void set_heap_ptr_(char *ptr) { std::memcpy(this->storage_, &ptr, sizeof(ptr)); }
217
218 // Storage for string data. When is_heap_=0, contains the string directly (null-terminated).
219 // When is_heap_=1, first sizeof(char*) bytes contain pointer to heap allocation.
220 char storage_[INLINE_CAPACITY + 1]; // 19 bytes: 18 chars + null terminator
221 uint8_t length_ : 7; // String length (0-127)
222 uint8_t is_heap_ : 1; // 1 if using heap pointer, 0 if using inline storage
223 // Total size: 20 bytes (19 bytes storage + 1 byte bitfields)
224};
225
226static_assert(sizeof(CompactString) == 20, "CompactString must be exactly 20 bytes");
227// CompactString is not trivially copyable (non-trivial destructor/copy for heap case).
228// However, its layout has no self-referential pointers: storage_[] contains either inline
229// data or an external heap pointer — never a pointer to itself. This is unlike libstdc++
230// std::string SSO where _M_p points to _M_local_buf within the same object.
231// This property allows memcpy-based permutation sorting where each element ends up in
232// exactly one slot (no ownership duplication). These asserts document that layout property.
233static_assert(std::is_standard_layout<CompactString>::value, "CompactString must be standard layout");
234static_assert(!std::is_polymorphic<CompactString>::value, "CompactString must not have vtable");
235
236class WiFiAP {
237 friend class WiFiComponent;
238 friend class WiFiScanResult;
239
240 public:
241 void set_ssid(const std::string &ssid);
242 void set_ssid(const char *ssid);
243 void set_ssid(StringRef ssid) { this->ssid_ = CompactString(ssid.c_str(), ssid.size()); }
244 void set_bssid(const bssid_t &bssid);
245 void clear_bssid();
246 void set_password(const std::string &password);
247 void set_password(const char *password);
248 void set_password(StringRef password) { this->password_ = CompactString(password.c_str(), password.size()); }
249#ifdef USE_WIFI_WPA2_EAP
250 void set_eap(optional<EAPAuth> eap_auth);
251#endif // USE_WIFI_WPA2_EAP
252 void set_channel(uint8_t channel);
253 void clear_channel();
255#ifdef USE_WIFI_MANUAL_IP
256 void set_manual_ip(optional<ManualIP> manual_ip);
257#endif
258 void set_hidden(bool hidden);
259 StringRef get_ssid() const { return this->ssid_.ref(); }
260 StringRef get_password() const { return this->password_.ref(); }
261 const bssid_t &get_bssid() const;
262 bool has_bssid() const;
263#ifdef USE_WIFI_WPA2_EAP
264 const optional<EAPAuth> &get_eap() const;
265#endif // USE_WIFI_WPA2_EAP
266 uint8_t get_channel() const;
267 bool has_channel() const;
268 int8_t get_priority() const { return priority_; }
269#ifdef USE_WIFI_MANUAL_IP
270 const optional<ManualIP> &get_manual_ip() const;
271#endif
272 bool get_hidden() const;
273
274 protected:
277#ifdef USE_WIFI_WPA2_EAP
279#endif // USE_WIFI_WPA2_EAP
280#ifdef USE_WIFI_MANUAL_IP
282#endif
283 // Group small types together to minimize padding
284 bssid_t bssid_{}; // 6 bytes, all zeros = any/not set
285 uint8_t channel_{0}; // 1 byte, 0 = auto/not set
286 int8_t priority_{0}; // 1 byte
287 bool hidden_{false}; // 1 byte (+ 3 bytes end padding to 4-byte align)
288};
289
291 friend class WiFiComponent;
292
293 public:
294 WiFiScanResult(const bssid_t &bssid, const char *ssid, size_t ssid_len, uint8_t channel, int8_t rssi, bool with_auth,
295 bool is_hidden);
296
297 bool matches(const WiFiAP &config) const;
298
299 bool get_matches() const;
300 void set_matches(bool matches);
301 const bssid_t &get_bssid() const;
302 StringRef get_ssid() const { return this->ssid_.ref(); }
303 uint8_t get_channel() const;
304 int8_t get_rssi() const;
305 bool get_with_auth() const;
306 bool get_is_hidden() const;
307 int8_t get_priority() const { return priority_; }
309
310 bool operator==(const WiFiScanResult &rhs) const;
311
312 protected:
314 uint8_t channel_;
315 int8_t rssi_;
317 int8_t priority_{0};
318 bool matches_{false};
321};
322
327
333
339
340#ifdef USE_ESP32
341struct IDFWiFiEvent;
342#endif
343
344#ifdef USE_LIBRETINY
345struct LTWiFiEvent;
346#endif
347
357 public:
358 virtual void on_ip_state(const network::IPAddresses &ips, const network::IPAddress &dns1,
359 const network::IPAddress &dns2) = 0;
360};
361
371 public:
373};
374
384 public:
385 virtual void on_wifi_connect_state(StringRef ssid, std::span<const uint8_t, 6> bssid) = 0;
386};
387
397 public:
399};
400
402class WiFiComponent : public Component {
403 public:
406
407 void set_sta(const WiFiAP &ap);
408 // Returns a copy of the currently selected AP configuration
409 WiFiAP get_sta() const;
410 void init_sta(size_t count);
411 void add_sta(const WiFiAP &ap);
412 void clear_sta();
413
414#ifdef USE_WIFI_AP
422 void set_ap(const WiFiAP &ap);
423 WiFiAP get_ap() { return this->ap_; }
424 void set_ap_timeout(uint32_t ap_timeout) { ap_timeout_ = ap_timeout; }
425#endif // USE_WIFI_AP
426
427 void enable();
428 void disable();
429 bool is_disabled();
430 void start_scanning();
432 void start_connecting(const WiFiAP &ap);
433 // Backward compatibility overload - ignores 'two' parameter
434 void start_connecting(const WiFiAP &ap, bool /* two */) { this->start_connecting(ap); }
435
436 void check_connecting_finished(uint32_t now);
437
438 void retry_connect();
439
440#ifdef USE_RP2040
441 bool can_proceed() override;
442#endif
443
444 void set_reboot_timeout(uint32_t reboot_timeout);
445
446 bool is_connected() const;
447
448 void set_power_save_mode(WiFiPowerSaveMode power_save);
449 void set_min_auth_mode(WifiMinAuthMode min_auth_mode) { min_auth_mode_ = min_auth_mode; }
450 void set_output_power(float output_power) { output_power_ = output_power; }
451#if defined(USE_ESP32) && defined(SOC_WIFI_SUPPORT_5G)
452 void set_band_mode(wifi_band_mode_t band_mode) { this->band_mode_ = band_mode; }
453#endif
454
455 void set_passive_scan(bool passive);
456
457 void save_wifi_sta(const std::string &ssid, const std::string &password);
458 void save_wifi_sta(const char *ssid, const char *password);
459 void save_wifi_sta(StringRef ssid, StringRef password) { this->save_wifi_sta(ssid.c_str(), password.c_str()); }
460
461 // ========== INTERNAL METHODS ==========
462 // (In most use cases you won't need these)
464 void setup() override;
465 void start();
466 void dump_config() override;
467 void restart_adapter();
469 float get_setup_priority() const override;
470#ifdef USE_LOOP_PRIORITY
471 float get_loop_priority() const override;
472#endif
473
475 void loop() override;
476
477 bool has_sta() const;
478 bool has_ap() const;
479 bool is_ap_active() const;
480
481#ifdef USE_WIFI_11KV_SUPPORT
482 void set_btm(bool btm);
483 void set_rrm(bool rrm);
484#endif
485
488 const char *get_use_address() const;
489 void set_use_address(const char *use_address);
490
492
494
495 bool has_sta_priority(const bssid_t &bssid) {
496 for (auto &it : this->sta_priorities_) {
497 if (it.bssid == bssid)
498 return true;
499 }
500 return false;
501 }
502 int8_t get_sta_priority(const bssid_t bssid) {
503 for (auto &it : this->sta_priorities_) {
504 if (it.bssid == bssid)
505 return it.priority;
506 }
507 return 0;
508 }
509 void set_sta_priority(bssid_t bssid, int8_t priority);
510
512 // Remove before 2026.9.0
513 ESPDEPRECATED("Use wifi_ssid_to() instead. Removed in 2026.9.0", "2026.3.0")
514 std::string wifi_ssid();
517 const char *wifi_ssid_to(std::span<char, SSID_BUFFER_SIZE> buffer);
519
520 int8_t wifi_rssi();
521
522 void set_enable_on_boot(bool enable_on_boot) { this->enable_on_boot_ = enable_on_boot; }
523 void set_keep_scan_results(bool keep_scan_results) { this->keep_scan_results_ = keep_scan_results; }
524 void set_post_connect_roaming(bool enabled) { this->post_connect_roaming_ = enabled; }
525
526#ifdef USE_WIFI_CONNECT_TRIGGER
528#endif
529#ifdef USE_WIFI_DISCONNECT_TRIGGER
531#endif
532
533 int32_t get_wifi_channel();
534
535#ifdef USE_WIFI_IP_STATE_LISTENERS
539 void add_ip_state_listener(WiFiIPStateListener *listener) { this->ip_state_listeners_.push_back(listener); }
540#endif // USE_WIFI_IP_STATE_LISTENERS
541#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
544 this->scan_results_listeners_.push_back(listener);
545 }
546#endif // USE_WIFI_SCAN_RESULTS_LISTENERS
547#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
552 this->connect_state_listeners_.push_back(listener);
553 }
554#endif // USE_WIFI_CONNECT_STATE_LISTENERS
555#ifdef USE_WIFI_POWER_SAVE_LISTENERS
559 void add_power_save_listener(WiFiPowerSaveListener *listener) { this->power_save_listeners_.push_back(listener); }
560#endif // USE_WIFI_POWER_SAVE_LISTENERS
561
562#ifdef USE_WIFI_RUNTIME_POWER_SAVE
578
591#endif // USE_WIFI_RUNTIME_POWER_SAVE
592
593 protected:
594#ifdef USE_WIFI_AP
595 void setup_ap_config_();
596#endif // USE_WIFI_AP
597
600
605 bool transition_to_phase_(WiFiRetryPhase new_phase);
608 bool needs_scan_results_() const;
614 int8_t find_first_non_hidden_index_() const;
617 bool ssid_was_seen_in_scan_(const CompactString &ssid) const;
619 bool needs_full_scan_results_() const;
622 bool matches_configured_network_(const char *ssid, const uint8_t *bssid) const;
624 void log_discarded_scan_result_(const char *ssid, const uint8_t *bssid, int8_t rssi, uint8_t channel);
628 int8_t find_next_hidden_sta_(int8_t start_index);
640 const WiFiAP *get_selected_sta_() const {
641 if (this->selected_sta_index_ >= 0 && static_cast<size_t>(this->selected_sta_index_) < this->sta_.size()) {
642 return &this->sta_[this->selected_sta_index_];
643 }
644 return nullptr;
645 }
646
648 if (this->selected_sta_index_ < 0 || static_cast<size_t>(this->selected_sta_index_) >= this->sta_.size()) {
649 this->selected_sta_index_ = this->sta_.empty() ? -1 : 0;
650 }
651 }
652
653 bool all_networks_hidden_() const {
654 if (this->sta_.empty())
655 return false;
656 for (const auto &ap : this->sta_) {
657 if (!ap.get_hidden())
658 return false;
659 }
660 return true;
661 }
662
663 void connect_soon_();
664
665 void wifi_loop_();
666#ifdef USE_ESP8266
668#endif
670 bool wifi_sta_pre_setup_();
671 bool wifi_apply_output_power_(float output_power);
673#if defined(USE_ESP32) && defined(SOC_WIFI_SUPPORT_5G)
675#endif
676 bool wifi_sta_ip_config_(const optional<ManualIP> &manual_ip);
678 bool wifi_sta_connect_(const WiFiAP &ap);
679 void wifi_pre_setup_();
681 bool wifi_scan_start_(bool passive);
682
683#ifdef USE_WIFI_AP
684 bool wifi_ap_ip_config_(const optional<ManualIP> &manual_ip);
685 bool wifi_start_ap_(const WiFiAP &ap);
686#endif // USE_WIFI_AP
687
688 bool wifi_disconnect_();
689
693
696
697#ifdef USE_WIFI_FAST_CONNECT
700#endif
701
702 // Post-connect roaming methods
703 void check_roaming_(uint32_t now);
706
709
710#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
715#endif
716#ifdef USE_WIFI_IP_STATE_LISTENERS
719#endif
720#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
723#endif
724
725#ifdef USE_ESP8266
726 static void wifi_event_callback(System_Event_t *event);
727 void wifi_scan_done_callback_(void *arg, STATUS status);
728 static void s_wifi_scan_done_callback(void *arg, STATUS status);
729#endif
730
731#ifdef USE_ESP32
732 void wifi_process_event_(IDFWiFiEvent *data);
733#endif
734
735#ifdef USE_RP2040
736 static int s_wifi_scan_result(void *env, const cyw43_ev_scan_result_t *result);
737 void wifi_scan_result(void *env, const cyw43_ev_scan_result_t *result);
738#endif
739
740#ifdef USE_LIBRETINY
741 void wifi_event_callback_(arduino_event_id_t event, arduino_event_info_t info);
742 void wifi_process_event_(LTWiFiEvent *event);
744#endif
745
746 // Large/pointer-aligned members first
748 std::vector<WiFiSTAPriority> sta_priorities_;
750#ifdef USE_WIFI_AP
752#endif
753#ifdef USE_WIFI_IP_STATE_LISTENERS
755#endif
756#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
758#endif
759#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
761#endif
762#ifdef USE_WIFI_POWER_SAVE_LISTENERS
764#endif
766#ifdef USE_WIFI_FAST_CONNECT
768#endif
769#ifdef USE_WIFI_CONNECT_TRIGGER
771#endif
772#ifdef USE_WIFI_DISCONNECT_TRIGGER
774#endif
775#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
776 SemaphoreHandle_t high_performance_semaphore_{nullptr};
777#endif
778
779 // Post-connect roaming constants
780 static constexpr uint32_t ROAMING_CHECK_INTERVAL = 5 * 60 * 1000; // 5 minutes
781 static constexpr int8_t ROAMING_MIN_IMPROVEMENT = 10; // dB
782 static constexpr int8_t ROAMING_GOOD_RSSI = -49; // Skip scan if signal is excellent
783 static constexpr uint8_t ROAMING_MAX_ATTEMPTS = 3;
784
785 // 4-byte members
786 float output_power_{NAN};
788 uint32_t last_connected_{0};
789 uint32_t reboot_timeout_{};
791#ifdef USE_WIFI_AP
792 uint32_t ap_timeout_{};
793#endif
794
795 // 1-byte enums and integers
798#if defined(USE_ESP32) && defined(SOC_WIFI_SUPPORT_5G)
799 wifi_band_mode_t band_mode_{WIFI_BAND_MODE_AUTO};
800#endif
803 uint8_t num_retried_{0};
804 // Index into sta_ array for the currently selected AP configuration (-1 = none selected)
805 // Used to access password, manual_ip, priority, EAP settings, and hidden flag
806 // int8_t limits to 127 APs (enforced in __init__.py via MAX_WIFI_NETWORKS)
809#if USE_NETWORK_IPV6
811#endif /* USE_NETWORK_IPV6 */
815#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
817#endif
818
819 // Bools and bitfields
820 // Pending listener callbacks deferred from platform callbacks to main loop.
821 struct {
822#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
823 // Deferred until state machine reaches STA_CONNECTED so wifi.connected
824 // condition returns true in listener automations.
826#ifdef USE_ESP8266
827 // ESP8266: also defer disconnect notification to main loop
828 bool disconnect : 1;
829#endif
830#endif
831#if defined(USE_ESP8266) && defined(USE_WIFI_IP_STATE_LISTENERS)
832 bool got_ip : 1;
833#endif
834#if defined(USE_ESP8266) && defined(USE_WIFI_SCAN_RESULTS_LISTENERS)
836#endif
838 bool has_ap_{false};
839#if defined(USE_WIFI_CONNECT_TRIGGER) || defined(USE_WIFI_DISCONNECT_TRIGGER)
841#endif
842 bool scan_done_{false};
843 bool ap_setup_{false};
844 bool ap_started_{false};
845 bool passive_scan_{false};
847#ifdef USE_WIFI_11KV_SUPPORT
848 bool btm_{false};
849 bool rrm_{false};
850#endif
851 bool enable_on_boot_{true};
852 bool got_ipv4_address_{false};
855 false}; // Tracks if we've completed a scan after captive portal started
857 bool post_connect_roaming_{true}; // Enabled by default
858#if defined(USE_ESP32) && defined(USE_WIFI_RUNTIME_POWER_SAVE)
860#endif
861
862 private:
863 // Stores a pointer to a string literal (static storage duration).
864 // ONLY set from Python-generated code with string literals - never dynamic strings.
865 const char *use_address_{""};
866};
867
868extern WiFiComponent *global_wifi_component; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
869
870} // namespace esphome::wifi
871#endif
BedjetMode mode
BedJet operating mode.
ESPDEPRECATED("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
Definition component.h:176
Fixed-capacity vector - allocates once at runtime, never reallocates This avoids std::vector template...
Definition helpers.h:299
Minimal static vector - saves memory by avoiding std::vector overhead.
Definition helpers.h:209
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
20-byte string: 18 chars inline + null, heap for longer.
const char * data() const
StringRef ref() const
Return a StringRef view of this string (zero-copy)
bool operator!=(const CompactString &other) const
CompactString & operator=(const CompactString &other)
bool operator==(const CompactString &other) const
static constexpr uint8_t INLINE_CAPACITY
bool operator==(const char *other) const
bool operator!=(const StringRef &other) const
const char * c_str() const
char storage_[INLINE_CAPACITY+1]
static constexpr uint8_t MAX_LENGTH
bool operator!=(const char *other) const
uint8_t get_channel() const
StringRef get_ssid() const
void set_ssid(const std::string &ssid)
const optional< EAPAuth > & get_eap() const
void set_ssid(StringRef ssid)
void set_bssid(const bssid_t &bssid)
void set_channel(uint8_t channel)
optional< EAPAuth > eap_
StringRef get_password() const
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
int8_t get_priority() const
void set_hidden(bool hidden)
const bssid_t & get_bssid() const
void set_priority(int8_t priority)
void set_password(StringRef password)
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 add_connect_state_listener(WiFiConnectStateListener *listener)
Add a listener for WiFi connection state changes.
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 has_sta_priority(const bssid_t &bssid)
const WiFiAP * get_selected_sta_() const
WiFiSTAConnectStatus wifi_sta_connect_status_() const
void set_band_mode(wifi_band_mode_t band_mode)
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)
struct esphome::wifi::WiFiComponent::@175 pending_
wifi_scan_vector_t< WiFiScanResult > scan_result_
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 set_enable_on_boot(bool enable_on_boot)
void advance_to_next_target_or_increment_retry_()
Advance to next target (AP/SSID) within current phase, or increment retry counter Called when staying...
void add_power_save_listener(WiFiPowerSaveListener *listener)
Add a listener for WiFi power save mode changes.
bool wifi_sta_ip_config_(const optional< ManualIP > &manual_ip)
static constexpr uint32_t ROAMING_CHECK_INTERVAL
static int s_wifi_scan_result(void *env, const cyw43_ev_scan_result_t *result)
SemaphoreHandle_t high_performance_semaphore_
network::IPAddress get_dns_address(int num)
static void wifi_event_callback(System_Event_t *event)
WiFiComponent()
Construct a WiFiComponent.
void wifi_process_event_(IDFWiFiEvent *data)
std::vector< WiFiSTAPriority > sta_priorities_
static constexpr int8_t ROAMING_GOOD_RSSI
void notify_disconnect_state_listeners_()
Notify connect state listeners of disconnection.
void set_min_auth_mode(WifiMinAuthMode min_auth_mode)
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.
void start_connecting(const WiFiAP &ap, bool)
static constexpr uint8_t ROAMING_MAX_ATTEMPTS
void set_passive_scan(bool passive)
void wifi_event_callback_(arduino_event_id_t event, arduino_event_info_t info)
static void s_wifi_scan_done_callback(void *arg, STATUS status)
void set_power_save_mode(WiFiPowerSaveMode power_save)
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...
void add_ip_state_listener(WiFiIPStateListener *listener)
Add a listener for IP state changes.
ESPPreferenceObject fast_connect_pref_
void clear_priorities_if_all_min_()
Clear BSSID priority tracking if all priorities are at minimum (saves memory)
void wifi_scan_result(void *env, const cyw43_ev_scan_result_t *result)
WiFiRetryPhase determine_next_phase_()
Determine next retry phase based on current state and failure conditions.
network::IPAddress wifi_dns_ip_(int num)
float get_loop_priority() const override
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.
void set_output_power(float output_power)
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 wifi_ap_ip_config_(const optional< ManualIP > &manual_ip)
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...
void add_scan_results_listener(WiFiScanResultsListener *listener)
Add a listener for WiFi scan results.
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)
void set_ap_timeout(uint32_t ap_timeout)
bool release_high_performance()
Release a high-performance mode request.
StaticVector< WiFiPowerSaveListener *, ESPHOME_WIFI_POWER_SAVE_LISTENERS > power_save_listeners_
bool wifi_apply_output_power_(float output_power)
void set_post_connect_roaming(bool enabled)
const char * get_use_address() const
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 set_keep_scan_results(bool keep_scan_results)
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 save_wifi_sta(StringRef ssid, StringRef password)
void setup() override
Setup WiFi interface.
void clear_all_bssid_priorities_()
Clear all BSSID priority penalties after successful connection (stale after disconnect)
void set_use_address(const char *use_address)
const wifi_scan_vector_t< WiFiScanResult > & get_scan_result() const
Listener interface for WiFi connection state changes.
virtual void on_wifi_connect_state(StringRef ssid, std::span< const uint8_t, 6 > bssid)=0
Listener interface for WiFi IP state changes.
virtual void on_ip_state(const network::IPAddresses &ips, const network::IPAddress &dns1, const network::IPAddress &dns2)=0
Listener interface for WiFi power save mode changes.
virtual void on_wifi_power_save(WiFiPowerSaveMode mode)=0
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
void set_priority(int8_t priority)
bool operator==(const WiFiScanResult &rhs) const
Listener interface for WiFi scan results.
virtual void on_wifi_scan_results(const wifi_scan_vector_t< WiFiScanResult > &results)=0
uint8_t priority
std::array< IPAddress, 5 > IPAddresses
Definition ip_address.h:187
std::array< uint8_t, 6 > bssid_t
RetryHiddenMode
Controls how RETRY_HIDDEN phase selects networks to try.
@ 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...
std::vector< T > wifi_scan_vector_t
struct esphome::wifi::SavedWifiSettings PACKED
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
RoamingState
Tracks post-connect roaming state machine.
@ SCANNING
Scanning for better AP.
@ 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.
std::string size_t len
Definition helpers.h:817
esp_eap_ttls_phase2_types ttls_phase_2
Struct for setting static IPs in WiFiComponent.
network::IPAddress static_ip
network::IPAddress dns1
The first DNS server. 0.0.0.0 for default.
network::IPAddress gateway
network::IPAddress dns2
The second DNS server. 0.0.0.0 for default.
network::IPAddress subnet