This component is responsible for managing the ESP WiFi interface. More...

#include <wifi_component.h>

Inheritance diagram for esphome::wifi::WiFiComponent:

Public Member Functions
	WiFiComponent ()
	Construct a WiFiComponent.

void	set_sta (const WiFiAP &ap)

WiFiAP	get_sta () const

void	init_sta (size_t count)

void	add_sta (const WiFiAP &ap)

void	clear_sta ()

void	set_ap (const WiFiAP &ap)
	Setup an Access Point that should be created if no connection to a station can be made.

WiFiAP	get_ap ()

void	set_ap_timeout (uint32_t ap_timeout)

void	enable ()

void	disable ()

bool	is_disabled ()

void	start_scanning ()

void	check_scanning_finished ()

void	start_connecting (const WiFiAP &ap)

void	start_connecting (const WiFiAP &ap, bool)

void	check_connecting_finished (uint32_t now)

void	retry_connect ()

void	set_reboot_timeout (uint32_t reboot_timeout)

bool	is_connected () const

bool	is_roaming_scan_active () const
	True while a post-connect roaming scan holds the radio off-channel.

bool	is_roaming () const
	True while a post-connect roam is in progress (scanning off-channel, reassociating, or recovering from a failed roam).

esp_netif_t *	get_esp_netif_sta ()
	esp_netif handle of the station interface, used by network for default-route arbitration.

void	set_power_save_mode (WiFiPowerSaveMode power_save)

void	set_min_auth_mode (WifiMinAuthMode min_auth_mode)

void	set_output_power (float output_power)

void	set_band_mode (wifi_band_mode_t band_mode)

void	set_phy_mode (WiFi8266PhyMode phy_mode)

void	set_passive_scan (bool passive)

void	save_wifi_sta (const std::string &ssid, const std::string &password)

void	save_wifi_sta (const char ssid, const char password)

void	save_wifi_sta (StringRef ssid, StringRef password)

void	setup () override
	Setup WiFi interface.

void	start ()

void	dump_config () override

void	restart_adapter ()

float	get_setup_priority () const override
	WIFI setup_priority.

void	loop () override
	Reconnect WiFi if required.

bool	has_sta () const

bool	has_ap () const

bool	is_ap_active () const

void	set_btm (bool btm)

void	set_rrm (bool rrm)

network::IPAddress	get_dns_address (int num)

network::IPAddresses	get_ip_addresses ()

const char *	get_use_address () const
	Returns nullptr when no explicit use_address is configured and the address is derived at runtime from the device name (see network::get_use_address_to()).

void	set_use_address (const char *use_address)

const wifi_scan_vector_t< WiFiScanResult > &	get_scan_result () const
	Main-loop callers may read this directly.

network::IPAddress	wifi_soft_ap_ip ()

bool	has_sta_priority (const bssid_t &bssid)

int8_t	get_sta_priority (const bssid_t bssid)

void	set_sta_priority (bssid_t bssid, int8_t priority)

network::IPAddresses	wifi_sta_ip_addresses ()

const char *	wifi_ssid_to (std::span< char, SSID_BUFFER_SIZE > buffer)
	Write SSID to buffer without heap allocation.

bssid_t	wifi_bssid ()

int8_t	wifi_rssi ()

void	set_enable_on_boot (bool enable_on_boot)

void	set_keep_scan_results (bool keep_scan_results)

void	set_post_connect_roaming (bool enabled)

void	force_roam_check ()
	Force an immediate post-connect roaming check, bypassing the periodic interval and the per-connection attempt limit.

Trigger *	get_connect_trigger ()

Trigger *	get_disconnect_trigger ()

int32_t	get_wifi_channel ()

void	add_ip_state_listener (WiFiIPStateListener *listener)
	Add a listener for IP state changes.

void	add_scan_results_listener (WiFiScanResultsListener *listener)
	Add a listener for WiFi scan results.

void	add_connect_state_listener (WiFiConnectStateListener *listener)
	Add a listener for WiFi connection state changes.

void	add_power_save_listener (WiFiPowerSaveListener *listener)
	Add a listener for WiFi power save mode changes.

bool	request_high_performance ()
	Request high-performance mode (no power saving) for improved WiFi latency.

bool	release_high_performance ()
	Release a high-performance mode request.

void	request_roaming_suppression ()
	Request that post-connect roaming scans be suppressed.

void	release_roaming_suppression ()
	Release a roaming suppression request.

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
void	setup_ap_config_ ()

void	print_connect_params_ ()

WiFiAP	build_params_for_current_phase_ ()

WiFiRetryPhase	determine_next_phase_ ()
	Determine next retry phase based on current state and failure conditions.

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), false otherwise.

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 phase requires scan results but they're missing or don't match.

bool	went_through_explicit_hidden_phase_ () const
	Check if we went through EXPLICIT_HIDDEN phase (first network is marked hidden) Used in RETRY_HIDDEN to determine whether to skip explicitly hidden networks.

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, or -1 if all networks are hidden.

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 are visible.

bool	needs_full_scan_results_ () const
	Check if full scan results are needed (captive portal active, improv, listeners)

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 configured, or by BSSID for BSSID-only configs.

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)

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 SSID, or -1 if none found.

void	log_and_adjust_priority_for_failed_connect_ ()
	Log failed connection and decrease BSSID priority to avoid repeated attempts.

void	clear_all_bssid_priorities_ ()
	Clear all BSSID priority penalties after successful connection (stale after disconnect)

void	clear_priorities_if_all_min_ ()
	Clear BSSID priority tracking if all priorities are at minimum (saves memory)

void	advance_to_next_target_or_increment_retry_ ()
	Advance to next target (AP/SSID) within current phase, or increment retry counter Called when staying in the same phase after a failed connection attempt.

void	start_initial_connection_ ()
	Start initial connection - either scan or connect directly to hidden networks.

const WiFiAP *	get_selected_sta_ () const

void	reset_selected_ap_to_first_if_invalid_ ()

bool	all_networks_hidden_ () const

void	connect_soon_ ()

bool	wifi_loop_ ()

void	process_pending_callbacks_ ()

bool	wifi_mode_ (optional< bool > sta, optional< bool > ap)

bool	wifi_sta_pre_setup_ ()

bool	wifi_apply_output_power_ (float output_power)

bool	wifi_apply_power_save_ ()

bool	wifi_apply_band_mode_ ()

bool	wifi_apply_phy_mode_ ()

bool	wifi_sta_ip_config_ (const optional< ManualIP > &manual_ip)

bool	wifi_apply_hostname_ ()

bool	wifi_sta_connect_ (const WiFiAP &ap)

void	wifi_pre_setup_ ()

void	wifi_lazy_init_ ()

WiFiSTAConnectStatus	wifi_sta_connect_status_ () const

bool	is_connected_ () const

void	update_connected_state_ ()

bool	wifi_scan_start_ (bool passive)

bool	wifi_ap_ip_config_ (const optional< ManualIP > &manual_ip)

bool	wifi_start_ap_ (const WiFiAP &ap)

bool	wifi_disconnect_ ()

network::IPAddress	wifi_subnet_mask_ ()

network::IPAddress	wifi_gateway_ip_ ()

network::IPAddress	wifi_dns_ip_ (int num)

bool	is_captive_portal_active_ ()

bool	is_esp32_improv_active_ ()

bool	load_fast_connect_settings_ (WiFiAP &params)

void	save_fast_connect_settings_ (const bssid_t &bssid, uint8_t channel)

void	check_roaming_ (uint32_t now)

void	process_roaming_scan_ ()

void	clear_roaming_state_ ()

void	handle_driver_roam_ (const bssid_t &bssid, uint8_t channel)
	Redo post-connect bookkeeping after a driver-initiated roam (e.g.

bool	roaming_suppressed_ () const
	Returns true if a component has requested that roaming scans be suppressed (e.g. during audio playback).

void	release_scan_results_ ()
	Free scan results memory unless a component needs them.

void	notify_connect_state_listeners_ ()
	Notify connect state listeners (called after state machine reaches STA_CONNECTED)

void	notify_disconnect_state_listeners_ ()
	Notify connect state listeners of disconnection.

void	notify_ip_state_listeners_ ()
	Notify IP state listeners with current addresses.

void	notify_scan_results_listeners_ ()
	Notify scan results listeners with current scan results.

void	wifi_scan_done_callback_ (void *arg, STATUS status)

void	wifi_process_event_ (IDFWiFiEvent *data)

void	wifi_scan_result_ (void env, const cyw43_ev_scan_result_t result)

void	wifi_event_callback_ (arduino_event_id_t event, arduino_event_info_t info)

void	wifi_process_event_ (LTWiFiEvent *event)

void	wifi_scan_done_callback_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Static Protected Member Functions
static void	wifi_event_callback (System_Event_t *event)

static void	s_wifi_scan_done_callback (void *arg, STATUS status)

static int	s_wifi_scan_result (void env, const cyw43_ev_scan_result_t result)

Protected Attributes
FixedVector< WiFiAP >	sta_

std::vector< WiFiSTAPriority >	sta_priorities_

wifi_scan_vector_t< WiFiScanResult >	scan_result_

Mutex	scan_result_lock_

WiFiAP	ap_

StaticVector< WiFiIPStateListener *, ESPHOME_WIFI_IP_STATE_LISTENERS >	ip_state_listeners_

StaticVector< WiFiScanResultsListener *, ESPHOME_WIFI_SCAN_RESULTS_LISTENERS >	scan_results_listeners_

StaticVector< WiFiConnectStateListener *, ESPHOME_WIFI_CONNECT_STATE_LISTENERS >	connect_state_listeners_

StaticVector< WiFiPowerSaveListener *, ESPHOME_WIFI_POWER_SAVE_LISTENERS >	power_save_listeners_

ESPPreferenceObject	pref_

ESPPreferenceObject	fast_connect_pref_

Trigger	connect_trigger_

Trigger	disconnect_trigger_

SemaphoreHandle_t	high_performance_semaphore_ {nullptr}

float	output_power_ {NAN}

uint32_t	action_started_

uint32_t	last_connected_ {0}

uint32_t	reboot_timeout_ {}

uint32_t	roaming_last_check_ {0}

uint32_t	roaming_scan_end_ {0}

uint32_t	ap_timeout_ {}

WiFiComponentState	state_ {WIFI_COMPONENT_STATE_OFF}

WiFiPowerSaveMode	power_save_ {WIFI_POWER_SAVE_NONE}

wifi_band_mode_t	band_mode_ {WIFI_BAND_MODE_AUTO}

WiFi8266PhyMode	phy_mode_ {WIFI_8266_PHY_MODE_AUTO}

WifiMinAuthMode	min_auth_mode_ {WIFI_MIN_AUTH_MODE_WPA2}

WiFiRetryPhase	retry_phase_ {WiFiRetryPhase::INITIAL_CONNECT}

uint8_t	num_retried_ {0}

int8_t	selected_sta_index_ {-1}

uint8_t	roaming_attempts_ {0}

std::atomic< uint8_t >	roaming_suppression_count_ {0}

uint8_t	num_ipv6_addresses_ {0}

bool	error_from_callback_ {false}

uint8_t	sta_state_ {0}

bool	lt_first_connect_attempt_ {true}

bool	lt_teardown_event_pending_ {false}

RetryHiddenMode	retry_hidden_mode_ {RetryHiddenMode::BLIND_RETRY}

RoamingState	roaming_state_ {RoamingState::IDLE}

bssid_t	roaming_target_bssid_ {}

WiFiPowerSaveMode	configured_power_save_ {WIFI_POWER_SAVE_NONE}

struct {

bool connect_state: 1

bool disconnect: 1

bool got_ip: 1

bool scan_complete: 1

}	pending_

bool	has_ap_ {false}

bool	handled_connected_state_ {false}

bool	scan_done_ {false}

bool	ap_setup_ {false}

bool	ap_started_ {false}

bool	passive_scan_ {false}

bool	has_saved_wifi_settings_ {false}

bool	btm_ {false}

bool	rrm_ {false}

bool	enable_on_boot_ {true}

bool	wifi_initialized_ {false}

bool	got_ipv4_address_ {false}

bool	keep_scan_results_ {false}

bool	has_completed_scan_after_captive_portal_start_

bool	skip_cooldown_next_cycle_ {false}

bool	connected_ {false}

bool	post_connect_roaming_ {true}

bool	is_high_performance_mode_ {false}

LockFreeQueue< IDFWiFiEvent, 17 >	event_queue_

LockFreeQueue< LTWiFiEvent, LT_EVENT_QUEUE_SIZE+1 >	event_queue_

FreeRTOSQueue< LTWiFiEvent, LT_EVENT_QUEUE_SIZE >	event_queue_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Static Protected Attributes
static constexpr uint8_t	FIRST_5GHZ_CHANNEL = 36

static constexpr uint32_t	ROAMING_CHECK_INTERVAL = 5 * 60 * 1000

static constexpr int8_t	ROAMING_MIN_IMPROVEMENT = 10

static constexpr int8_t	ROAMING_GOOD_RSSI = -49

static constexpr uint8_t	ROAMING_MAX_ATTEMPTS = 3

static constexpr uint32_t	ROAMING_SCAN_GRACE_PERIOD = 30 * 1000

static constexpr uint8_t	LT_EVENT_QUEUE_SIZE = 16

Detailed Description

This component is responsible for managing the ESP WiFi interface.

Definition at line 433 of file wifi_component.h.

Constructor & Destructor Documentation

◆ WiFiComponent()

esphome::wifi::WiFiComponent::WiFiComponent ( )

Construct a WiFiComponent.

Definition at line 954 of file wifi_component.cpp.

Member Function Documentation

◆ add_connect_state_listener()

void esphome::wifi::WiFiComponent::add_connect_state_listener ( WiFiConnectStateListener * listener )

inline

Add a listener for WiFi connection state changes.

Listener receives: SSID, BSSID

Definition at line 599 of file wifi_component.h.

◆ add_ip_state_listener()

void esphome::wifi::WiFiComponent::add_ip_state_listener ( WiFiIPStateListener * listener )

inline

Add a listener for IP state changes.

Listener receives: IP addresses, DNS address 1, DNS address 2

Definition at line 587 of file wifi_component.h.

◆ add_power_save_listener()

void esphome::wifi::WiFiComponent::add_power_save_listener ( WiFiPowerSaveListener * listener )

inline

Add a listener for WiFi power save mode changes.

Listener receives: WiFiPowerSaveMode

Definition at line 607 of file wifi_component.h.

◆ add_scan_results_listener()

void esphome::wifi::WiFiComponent::add_scan_results_listener ( WiFiScanResultsListener * listener )

inline

Add a listener for WiFi scan results.

Definition at line 591 of file wifi_component.h.

◆ add_sta()

void esphome::wifi::WiFiComponent::add_sta ( const WiFiAP & ap )

Definition at line 1045 of file wifi_component.cpp.

◆ advance_to_next_target_or_increment_retry_()

void esphome::wifi::WiFiComponent::advance_to_next_target_or_increment_retry_ ( )

protected

Advance to next target (AP/SSID) within current phase, or increment retry counter Called when staying in the same phase after a failed connection attempt.

Handle target advancement or retry counter increment when staying in the same phase This function is called when a connection attempt fails and determine_next_phase_() indicates we should stay in the current phase.

It decides whether to:

Advance to the next target (AP in fast_connect, SSID in hidden mode)
Or increment the retry counter to try the same target again

Phase-specific behavior:

FAST_CONNECT_CYCLING_APS: Always advance to next AP (no retries per AP)
RETRY_HIDDEN: Advance to next SSID after exhausting retries on current SSID
Other phases: Increment retry counter (will retry same target)

Definition at line 2109 of file wifi_component.cpp.

◆ all_networks_hidden_()

bool esphome::wifi::WiFiComponent::all_networks_hidden_ ( ) const

inlineprotected

Definition at line 744 of file wifi_component.h.

◆ build_params_for_current_phase_()

WiFiAP esphome::wifi::WiFiComponent::build_params_for_current_phase_ ( )

protected

Definition at line 1061 of file wifi_component.cpp.

◆ check_connecting_finished()

void esphome::wifi::WiFiComponent::check_connecting_finished ( uint32_t now )

Definition at line 1616 of file wifi_component.cpp.

◆ check_roaming_()

void esphome::wifi::WiFiComponent::check_roaming_ ( uint32_t now )

protected

Definition at line 2478 of file wifi_component.cpp.

◆ check_scanning_finished()

void esphome::wifi::WiFiComponent::check_scanning_finished ( )

Definition at line 1493 of file wifi_component.cpp.

◆ clear_all_bssid_priorities_()

void esphome::wifi::WiFiComponent::clear_all_bssid_priorities_ ( )

protected

Clear all BSSID priority penalties after successful connection (stale after disconnect)

Definition at line 1999 of file wifi_component.cpp.

◆ clear_priorities_if_all_min_()

void esphome::wifi::WiFiComponent::clear_priorities_if_all_min_ ( )

protected

Clear BSSID priority tracking if all priorities are at minimum (saves memory)

Clear BSSID priority tracking if all priorities are at minimum (saves memory) At minimum priority, all BSSIDs are equally bad, so priority tracking is useless Called after failed connection attempts.

Definition at line 2008 of file wifi_component.cpp.

◆ clear_roaming_state_()

void esphome::wifi::WiFiComponent::clear_roaming_state_ ( )

protected

Definition at line 2389 of file wifi_component.cpp.

◆ clear_sta()

void esphome::wifi::WiFiComponent::clear_sta ( )

Definition at line 1046 of file wifi_component.cpp.

◆ connect_soon_()

void esphome::wifi::WiFiComponent::connect_soon_ ( )

protected

Definition at line 1128 of file wifi_component.cpp.

◆ determine_next_phase_()

WiFiRetryPhase esphome::wifi::WiFiComponent::determine_next_phase_ ( )

protected

Determine next retry phase based on current state and failure conditions.

Determine the next retry phase based on current state and failure conditions This function examines the current retry phase, number of retries, and failure reasons to decide what phase to move to next.

It does not modify any state - it only returns the recommended next phase.

Returns: The next WiFiRetryPhase to transition to (may be same as current phase if should retry)

Definition at line 1762 of file wifi_component.cpp.

◆ disable()

void esphome::wifi::WiFiComponent::disable ( )

Definition at line 1340 of file wifi_component.cpp.

◆ dump_config()

void esphome::wifi::WiFiComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 1581 of file wifi_component.cpp.

◆ enable()

void esphome::wifi::WiFiComponent::enable ( )

Definition at line 1326 of file wifi_component.cpp.

◆ find_first_non_hidden_index_()

int8_t esphome::wifi::WiFiComponent::find_first_non_hidden_index_ ( ) const

protected

Find the index of the first non-hidden network Returns where EXPLICIT_HIDDEN phase would have stopped, or -1 if all networks are hidden.

Definition at line 354 of file wifi_component.cpp.

◆ find_next_hidden_sta_()

int8_t esphome::wifi::WiFiComponent::find_next_hidden_sta_ ( int8_t start_index )

protected

Find next SSID that wasn't in scan results (might be hidden) Returns index of next potentially hidden SSID, or -1 if none found.

Parameters

start_index Start searching from index after this (-1 to start from beginning)

Definition at line 542 of file wifi_component.cpp.

◆ force_roam_check()

void esphome::wifi::WiFiComponent::force_roam_check ( )

Force an immediate post-connect roaming check, bypassing the periodic interval and the per-connection attempt limit.

Does nothing (besides a debug log) if not connected, if a roam scan or connect is already in progress, or if roaming is currently suppressed.

Definition at line 2467 of file wifi_component.cpp.

◆ get_ap()

WiFiAP esphome::wifi::WiFiComponent::get_ap ( )

inline

Definition at line 455 of file wifi_component.h.

◆ get_connect_trigger()

Trigger * esphome::wifi::WiFiComponent::get_connect_trigger ( )

inline

Definition at line 575 of file wifi_component.h.

◆ get_disconnect_trigger()

Trigger * esphome::wifi::WiFiComponent::get_disconnect_trigger ( )

inline

Definition at line 578 of file wifi_component.h.

◆ get_dns_address()

network::IPAddress esphome::wifi::WiFiComponent::get_dns_address ( int num )

Definition at line 967 of file wifi_component.cpp.

◆ get_esp_netif_sta()

esp_netif_t * esphome::wifi::WiFiComponent::get_esp_netif_sta ( )

esp_netif handle of the station interface, used by network for default-route arbitration.

nullptr until wifi_lazy_init_() has run.

◆ get_ip_addresses()

network::IPAddresses esphome::wifi::WiFiComponent::get_ip_addresses ( )

Definition at line 956 of file wifi_component.cpp.

◆ get_scan_result()

const wifi_scan_vector_t< WiFiScanResult > & esphome::wifi::WiFiComponent::get_scan_result ( ) const

inline

Main-loop callers may read this directly.

Callers on any other task must hold a ScanResultsLock for the whole iteration and must call wifi.request_wifi_scan_results_lock() from their code generation.

Definition at line 536 of file wifi_component.h.

◆ get_selected_sta_()

const WiFiAP * esphome::wifi::WiFiComponent::get_selected_sta_ ( ) const

inlineprotected

Definition at line 731 of file wifi_component.h.

◆ get_setup_priority()

float esphome::wifi::WiFiComponent::get_setup_priority ( ) const

inlineoverridevirtual

WIFI setup_priority.

Reimplemented from esphome::Component.

Definition at line 513 of file wifi_component.h.

◆ get_sta()

WiFiAP esphome::wifi::WiFiComponent::get_sta ( ) const

Definition at line 1104 of file wifi_component.cpp.

◆ get_sta_priority()

int8_t esphome::wifi::WiFiComponent::get_sta_priority ( const bssid_t bssid )

inline

Definition at line 547 of file wifi_component.h.

◆ get_use_address()

const char * esphome::wifi::WiFiComponent::get_use_address ( ) const

inline

Returns nullptr when no explicit use_address is configured and the address is derived at runtime from the device name (see network::get_use_address_to()).

Definition at line 530 of file wifi_component.h.

◆ get_wifi_channel()

int32_t esphome::wifi::WiFiComponent::get_wifi_channel ( )

Definition at line 958 of file wifi_component_esp8266.cpp.

◆ handle_driver_roam_()

void esphome::wifi::WiFiComponent::handle_driver_roam_	(	const bssid_t &	bssid,
		uint8_t	channel )

protected

Redo post-connect bookkeeping after a driver-initiated roam (e.g.

802.11v BTM)

Parameters

bssid	The new AP's BSSID, taken from the connected event
channel	The new AP's channel, taken from the connected event

Definition at line 2398 of file wifi_component.cpp.

◆ has_ap()

bool esphome::wifi::WiFiComponent::has_ap ( ) const

inline

Definition at line 518 of file wifi_component.h.

◆ has_sta()

bool esphome::wifi::WiFiComponent::has_sta ( ) const

inline

Definition at line 517 of file wifi_component.h.

◆ has_sta_priority()

bool esphome::wifi::WiFiComponent::has_sta_priority ( const bssid_t & bssid )

inline

Definition at line 540 of file wifi_component.h.

◆ init_sta()

void esphome::wifi::WiFiComponent::init_sta ( size_t count )

Definition at line 1044 of file wifi_component.cpp.

◆ is_ap_active()

bool esphome::wifi::WiFiComponent::is_ap_active ( ) const

inline

Definition at line 519 of file wifi_component.h.

◆ is_captive_portal_active_()

bool esphome::wifi::WiFiComponent::is_captive_portal_active_ ( )

protected

Definition at line 2224 of file wifi_component.cpp.

◆ is_connected()

bool esphome::wifi::WiFiComponent::is_connected ( ) const

inline

Definition at line 474 of file wifi_component.h.

◆ is_connected_()

bool esphome::wifi::WiFiComponent::is_connected_ ( ) const

inlineprotected

Definition at line 781 of file wifi_component.h.

◆ is_disabled()

bool esphome::wifi::WiFiComponent::is_disabled ( )

inline

Definition at line 461 of file wifi_component.h.

◆ is_esp32_improv_active_()

bool esphome::wifi::WiFiComponent::is_esp32_improv_active_ ( )

protected

Definition at line 2231 of file wifi_component.cpp.

◆ is_roaming()

bool esphome::wifi::WiFiComponent::is_roaming ( ) const

inline

True while a post-connect roam is in progress (scanning off-channel, reassociating, or recovering from a failed roam).

Definition at line 481 of file wifi_component.h.

◆ is_roaming_scan_active()

bool esphome::wifi::WiFiComponent::is_roaming_scan_active ( ) const

inline

True while a post-connect roaming scan holds the radio off-channel.

Definition at line 477 of file wifi_component.h.

◆ load_fast_connect_settings_()

bool esphome::wifi::WiFiComponent::load_fast_connect_settings_ ( WiFiAP & params )

protected

Definition at line 2280 of file wifi_component.cpp.

◆ log_and_adjust_priority_for_failed_connect_()

void esphome::wifi::WiFiComponent::log_and_adjust_priority_for_failed_connect_ ( )

protected

Log failed connection and decrease BSSID priority to avoid repeated attempts.

Log failed connection attempt and decrease BSSID priority to avoid repeated failures This function identifies which BSSID was attempted (from scan results or config), decreases its priority by 1.0 to discourage future attempts, and logs the change.

The priority degradation system ensures that failed BSSIDs are automatically sorted lower in subsequent scans, naturally cycling through different APs without explicit BSSID tracking within a scan cycle.

Priority sources:

SCAN_CONNECTING phase: Uses BSSID from scan_result_[0] (best match after sorting)
Other phases: Uses BSSID from config if explicitly specified by user or fast_connect

If no BSSID is available (SSID-only connection), priority adjustment is skipped.

IMPORTANT: Priority is only decreased on the LAST attempt for a BSSID in SCAN_CONNECTING phase. This prevents false positives from transient WiFi stack state issues after scanning. Single failures don't necessarily mean the AP is bad - two genuine failures provide higher confidence before degrading priority and skipping the BSSID in future scans.

Definition at line 2050 of file wifi_component.cpp.

◆ log_discarded_scan_result_()

void esphome::wifi::WiFiComponent::log_discarded_scan_result_	(	const char *	ssid,
		const uint8_t *	bssid,
		int8_t	rssi,
		uint8_t	channel )

protected

Log a discarded scan result at VERBOSE level (skipped during roaming scans to avoid log overflow)

Definition at line 529 of file wifi_component.cpp.

◆ loop()

void esphome::wifi::WiFiComponent::loop ( )

overridevirtual

Reconnect WiFi if required.

Reimplemented from esphome::Component.

Definition at line 769 of file wifi_component.cpp.

◆ matches_configured_network_()

bool esphome::wifi::WiFiComponent::matches_configured_network_	(	const char *	ssid,
		const uint8_t *	bssid ) const

protected

Check if network matches any configured network (for scan result filtering) Matches by SSID when configured, or by BSSID for BSSID-only configs.

Definition at line 491 of file wifi_component.cpp.

◆ needs_full_scan_results_()

bool esphome::wifi::WiFiComponent::needs_full_scan_results_ ( ) const

protected

Check if full scan results are needed (captive portal active, improv, listeners)

Definition at line 460 of file wifi_component.cpp.

◆ needs_scan_results_()

bool esphome::wifi::WiFiComponent::needs_scan_results_ ( ) const

protected

Check if we need valid scan results for the current phase but don't have any Returns true if the phase requires scan results but they're missing or don't match.

Definition at line 433 of file wifi_component.cpp.

◆ notify_connect_state_listeners_()

void esphome::wifi::WiFiComponent::notify_connect_state_listeners_ ( )

protected

Notify connect state listeners (called after state machine reaches STA_CONNECTED)

Definition at line 2430 of file wifi_component.cpp.

◆ notify_disconnect_state_listeners_()

void esphome::wifi::WiFiComponent::notify_disconnect_state_listeners_ ( )

protected

Notify connect state listeners of disconnection.

Definition at line 2443 of file wifi_component.cpp.

◆ notify_ip_state_listeners_()

void esphome::wifi::WiFiComponent::notify_ip_state_listeners_ ( )

protected

Notify IP state listeners with current addresses.

Definition at line 2452 of file wifi_component.cpp.

◆ notify_scan_results_listeners_()

void esphome::wifi::WiFiComponent::notify_scan_results_listeners_ ( )

protected

Notify scan results listeners with current scan results.

Definition at line 2460 of file wifi_component.cpp.

◆ print_connect_params_()

void esphome::wifi::WiFiComponent::print_connect_params_ ( )

protected

Definition at line 1279 of file wifi_component.cpp.

◆ process_pending_callbacks_()

void esphome::wifi::WiFiComponent::process_pending_callbacks_ ( )

protected

Definition at line 975 of file wifi_component_esp8266.cpp.

◆ process_roaming_scan_()

void esphome::wifi::WiFiComponent::process_roaming_scan_ ( )

protected

Definition at line 2506 of file wifi_component.cpp.

◆ release_high_performance()

bool esphome::wifi::WiFiComponent::release_high_performance ( )

Release a high-performance mode request.

Should be called when a component no longer needs maximum WiFi latency. When all requests are released (semaphore count reaches zero), WiFi power saving is restored to the YAML-configured mode.

Note: Only supported on ESP32.

Returns: true if release was successful (or already in high-performance config), false if operation failed (semaphore error)

Definition at line 2263 of file wifi_component.cpp.

◆ release_roaming_suppression()

void esphome::wifi::WiFiComponent::release_roaming_suppression ( )

inline

Release a roaming suppression request.

Must be paired with a prior request_roaming_suppression() call. When all requests are released (count reaches zero), post-connect roaming resumes. A release with no outstanding request is ignored rather than underflowing the counter.

Thread-safe: may be called from any task.

Definition at line 674 of file wifi_component.h.

◆ release_scan_results_()

void esphome::wifi::WiFiComponent::release_scan_results_ ( )

protected

Free scan results memory unless a component needs them.

Definition at line 2416 of file wifi_component.cpp.

◆ request_high_performance()

bool esphome::wifi::WiFiComponent::request_high_performance ( )

Request high-performance mode (no power saving) for improved WiFi latency.

Components that need maximum WiFi performance (e.g., audio streaming, large data transfers) can call this method to temporarily disable WiFi power saving. Multiple components can request high performance simultaneously using a counting semaphore.

Power saving will be restored to the YAML-configured mode when all components have called release_high_performance().

Note: Only supported on ESP32.

Returns: true if request was satisfied (high-performance mode active or already configured), false if operation failed (semaphore error)

Definition at line 2240 of file wifi_component.cpp.

◆ request_roaming_suppression()

void esphome::wifi::WiFiComponent::request_roaming_suppression ( )

inline

Request that post-connect roaming scans be suppressed.

Components that are disrupted by the radio briefly going off-channel during a scan (e.g., audio playback) can call this to pause periodic roaming scans while active. Multiple components can request suppression simultaneously; roaming resumes once every requester has called release_roaming_suppression().

A roaming scan already in progress is allowed to finish; this only prevents new roaming scans from starting. The roaming interval timer is not reset, so roaming resumes on the next loop once suppression is released (and the interval elapsed).

Note: Only supported on ESP32.

Thread-safe: may be called from any task.

Definition at line 657 of file wifi_component.h.

◆ reset_selected_ap_to_first_if_invalid_()

void esphome::wifi::WiFiComponent::reset_selected_ap_to_first_if_invalid_ ( )

inlineprotected

Definition at line 738 of file wifi_component.h.

◆ restart_adapter()

void esphome::wifi::WiFiComponent::restart_adapter ( )

Definition at line 758 of file wifi_component.cpp.

◆ retry_connect()

void esphome::wifi::WiFiComponent::retry_connect ( )

Definition at line 2166 of file wifi_component.cpp.

◆ roaming_suppressed_()

bool esphome::wifi::WiFiComponent::roaming_suppressed_ ( ) const

inlineprotected

Returns true if a component has requested that roaming scans be suppressed (e.g. during audio playback).

Definition at line 819 of file wifi_component.h.

◆ s_wifi_scan_done_callback()

void esphome::wifi::WiFiComponent::s_wifi_scan_done_callback	(	void *	arg,
		STATUS	status )

staticprotected

Definition at line 744 of file wifi_component_esp8266.cpp.

◆ s_wifi_scan_result()

int esphome::wifi::WiFiComponent::s_wifi_scan_result	(	void *	env,
		const cyw43_ev_scan_result_t *	result )

staticprotected

Definition at line 168 of file wifi_component_pico_w.cpp.

◆ save_fast_connect_settings_()

void esphome::wifi::WiFiComponent::save_fast_connect_settings_	(	const bssid_t &	bssid,
		uint8_t	channel )

protected

Definition at line 2319 of file wifi_component.cpp.

◆ save_wifi_sta() [1/3]

void esphome::wifi::WiFiComponent::save_wifi_sta	(	const char *	ssid,
		const char *	password )

Definition at line 1111 of file wifi_component.cpp.

◆ save_wifi_sta() [2/3]

void esphome::wifi::WiFiComponent::save_wifi_sta	(	const std::string &	ssid,
		const std::string &	password )

Definition at line 1108 of file wifi_component.cpp.

◆ save_wifi_sta() [3/3]

void esphome::wifi::WiFiComponent::save_wifi_sta	(	StringRef	ssid,
		StringRef	password )

inline

Definition at line 503 of file wifi_component.h.

◆ set_ap()

void esphome::wifi::WiFiComponent::set_ap ( const WiFiAP & ap )

Setup an Access Point that should be created if no connection to a station can be made.

This can also be used without set_sta(). Then the AP will always be active.

If both STA and AP are defined, then both will be enabled at startup, but if a connection to a station can be made, the AP will be turned off again.

Definition at line 1038 of file wifi_component.cpp.

◆ set_ap_timeout()

void esphome::wifi::WiFiComponent::set_ap_timeout ( uint32_t ap_timeout )

inline

Definition at line 456 of file wifi_component.h.

◆ set_band_mode()

void esphome::wifi::WiFiComponent::set_band_mode ( wifi_band_mode_t band_mode )

inline

Definition at line 493 of file wifi_component.h.

◆ set_btm()

void esphome::wifi::WiFiComponent::set_btm ( bool btm )

inline

Definition at line 522 of file wifi_component.h.

◆ set_enable_on_boot()

void esphome::wifi::WiFiComponent::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 564 of file wifi_component.h.

◆ set_keep_scan_results()

void esphome::wifi::WiFiComponent::set_keep_scan_results ( bool keep_scan_results )

inline

Definition at line 565 of file wifi_component.h.

◆ set_min_auth_mode()

void esphome::wifi::WiFiComponent::set_min_auth_mode ( WifiMinAuthMode min_auth_mode )

inline

Definition at line 490 of file wifi_component.h.

◆ set_output_power()

void esphome::wifi::WiFiComponent::set_output_power ( float output_power )

inline

Definition at line 491 of file wifi_component.h.

◆ set_passive_scan()

void esphome::wifi::WiFiComponent::set_passive_scan ( bool passive )

inline

Definition at line 499 of file wifi_component.h.

◆ set_phy_mode()

void esphome::wifi::WiFiComponent::set_phy_mode ( WiFi8266PhyMode phy_mode )

inline

Definition at line 496 of file wifi_component.h.

◆ set_post_connect_roaming()

void esphome::wifi::WiFiComponent::set_post_connect_roaming ( bool enabled )

inline

Definition at line 566 of file wifi_component.h.

◆ set_power_save_mode()

void esphome::wifi::WiFiComponent::set_power_save_mode ( WiFiPowerSaveMode power_save )

Definition at line 2217 of file wifi_component.cpp.

◆ set_reboot_timeout()

void esphome::wifi::WiFiComponent::set_reboot_timeout ( uint32_t reboot_timeout )

inline

Definition at line 472 of file wifi_component.h.

◆ set_rrm()

void esphome::wifi::WiFiComponent::set_rrm ( bool rrm )

inline

Definition at line 523 of file wifi_component.h.

◆ set_sta()

void esphome::wifi::WiFiComponent::set_sta ( const WiFiAP & ap )

Definition at line 1052 of file wifi_component.cpp.

◆ set_sta_priority()

void esphome::wifi::WiFiComponent::set_sta_priority	(	bssid_t	bssid,
		int8_t	priority )

◆ set_use_address()

void esphome::wifi::WiFiComponent::set_use_address ( const char * use_address )

inline

Definition at line 531 of file wifi_component.h.

◆ setup()

void esphome::wifi::WiFiComponent::setup ( )

overridevirtual

Setup WiFi interface.

Reimplemented from esphome::Component.

Definition at line 621 of file wifi_component.cpp.

◆ setup_ap_config_()

void esphome::wifi::WiFiComponent::setup_ap_config_ ( )

protected

Definition at line 974 of file wifi_component.cpp.

◆ ssid_was_seen_in_scan_()

bool esphome::wifi::WiFiComponent::ssid_was_seen_in_scan_ ( const CompactString & ssid ) const

protected

Check if an SSID was seen in the most recent scan results Used to skip hidden mode for SSIDs we know are visible.

Definition at line 442 of file wifi_component.cpp.

◆ start()

void esphome::wifi::WiFiComponent::start ( )

Definition at line 661 of file wifi_component.cpp.

◆ start_connecting() [1/2]

void esphome::wifi::WiFiComponent::start_connecting ( const WiFiAP & ap )

Definition at line 1136 of file wifi_component.cpp.

◆ start_connecting() [2/2]

void esphome::wifi::WiFiComponent::start_connecting	(	const WiFiAP &	ap,
		bool	)

inline

Definition at line 466 of file wifi_component.h.

◆ start_initial_connection_()

void esphome::wifi::WiFiComponent::start_initial_connection_ ( )

protected

Start initial connection - either scan or connect directly to hidden networks.

Definition at line 588 of file wifi_component.cpp.

◆ start_scanning()

void esphome::wifi::WiFiComponent::start_scanning ( )

Definition at line 1350 of file wifi_component.cpp.

◆ transition_to_phase_()

bool esphome::wifi::WiFiComponent::transition_to_phase_ ( WiFiRetryPhase new_phase )

protected

Transition to a new retry phase with logging Returns true if a scan was started (caller should wait), false otherwise.

Transition from current retry phase to a new phase with logging and phase-specific setup This function handles the actual state change, including:

Logging the phase transition
Resetting the retry counter
Performing phase-specific initialization (e.g., advancing AP index, starting scans)

Parameters

new_phase The phase we're transitioning TO

Returns: true if connection attempt should be skipped (scan started or no networks to try) false if caller can proceed with connection attempt

Definition at line 1901 of file wifi_component.cpp.

◆ update_connected_state_()

void esphome::wifi::WiFiComponent::update_connected_state_ ( )

inlineprotected

Definition at line 785 of file wifi_component.h.

◆ went_through_explicit_hidden_phase_()

bool esphome::wifi::WiFiComponent::went_through_explicit_hidden_phase_ ( ) const

protected

Check if we went through EXPLICIT_HIDDEN phase (first network is marked hidden) Used in RETRY_HIDDEN to determine whether to skip explicitly hidden networks.

Definition at line 348 of file wifi_component.cpp.

◆ wifi_ap_ip_config_()

bool esphome::wifi::WiFiComponent::wifi_ap_ip_config_ ( const optional< ManualIP > & manual_ip )

protected

Definition at line 798 of file wifi_component_esp8266.cpp.

◆ wifi_apply_band_mode_()

bool esphome::wifi::WiFiComponent::wifi_apply_band_mode_ ( )

protected

◆ wifi_apply_hostname_()

bool esphome::wifi::WiFiComponent::wifi_apply_hostname_ ( )

protected

Definition at line 245 of file wifi_component_esp8266.cpp.

◆ wifi_apply_output_power_()

bool esphome::wifi::WiFiComponent::wifi_apply_output_power_ ( float output_power )

protected

Definition at line 625 of file wifi_component_esp8266.cpp.

◆ wifi_apply_phy_mode_()

bool esphome::wifi::WiFiComponent::wifi_apply_phy_mode_ ( )

protected

Definition at line 655 of file wifi_component_esp8266.cpp.

◆ wifi_apply_power_save_()

bool esphome::wifi::WiFiComponent::wifi_apply_power_save_ ( )

protected

Definition at line 95 of file wifi_component_esp8266.cpp.

◆ wifi_bssid()

bssid_t esphome::wifi::WiFiComponent::wifi_bssid ( )

Definition at line 931 of file wifi_component_esp8266.cpp.

◆ wifi_disconnect_()

bool esphome::wifi::WiFiComponent::wifi_disconnect_ ( )

protected

Definition at line 728 of file wifi_component_esp8266.cpp.

◆ wifi_dns_ip_()

network::IPAddress esphome::wifi::WiFiComponent::wifi_dns_ip_ ( int num )

protected

Definition at line 969 of file wifi_component_esp8266.cpp.

◆ wifi_event_callback()

void esphome::wifi::WiFiComponent::wifi_event_callback ( System_Event_t * event )

staticprotected

Definition at line 501 of file wifi_component_esp8266.cpp.

◆ wifi_event_callback_()

void esphome::wifi::WiFiComponent::wifi_event_callback_	(	arduino_event_id_t	event,
		arduino_event_info_t	info )

protected

Definition at line 369 of file wifi_component_libretiny.cpp.

◆ wifi_gateway_ip_()

network::IPAddress esphome::wifi::WiFiComponent::wifi_gateway_ip_ ( )

protected

Definition at line 964 of file wifi_component_esp8266.cpp.

◆ wifi_lazy_init_()

void esphome::wifi::WiFiComponent::wifi_lazy_init_ ( )

protected

◆ wifi_loop_()

bool esphome::wifi::WiFiComponent::wifi_loop_ ( )

protected

Definition at line 970 of file wifi_component_esp8266.cpp.

◆ wifi_mode_()

bool esphome::wifi::WiFiComponent::wifi_mode_	(	optional< bool >	sta,
		optional< bool >	ap )

protected

Definition at line 54 of file wifi_component_esp8266.cpp.

◆ wifi_pre_setup_()

void esphome::wifi::WiFiComponent::wifi_pre_setup_ ( )

protected

Definition at line 663 of file wifi_component_esp8266.cpp.

◆ wifi_process_event_() [1/2]

void esphome::wifi::WiFiComponent::wifi_process_event_ ( IDFWiFiEvent * data )

protected

◆ wifi_process_event_() [2/2]

void esphome::wifi::WiFiComponent::wifi_process_event_ ( LTWiFiEvent * event )

protected

Definition at line 451 of file wifi_component_libretiny.cpp.

◆ wifi_rssi()

int8_t esphome::wifi::WiFiComponent::wifi_rssi ( )

Definition at line 951 of file wifi_component_esp8266.cpp.

◆ wifi_scan_done_callback_() [1/2]

void esphome::wifi::WiFiComponent::wifi_scan_done_callback_ ( )

protected

Definition at line 686 of file wifi_component_libretiny.cpp.

◆ wifi_scan_done_callback_() [2/2]

void esphome::wifi::WiFiComponent::wifi_scan_done_callback_	(	void *	arg,
		STATUS	status )

protected

Definition at line 748 of file wifi_component_esp8266.cpp.

◆ wifi_scan_result_()

void esphome::wifi::WiFiComponent::wifi_scan_result_	(	void *	env,
		const cyw43_ev_scan_result_t *	result )

protected

Definition at line 173 of file wifi_component_pico_w.cpp.

◆ wifi_scan_start_()

bool esphome::wifi::WiFiComponent::wifi_scan_start_ ( bool passive )

protected

Definition at line 687 of file wifi_component_esp8266.cpp.

◆ wifi_soft_ap_ip()

network::IPAddress esphome::wifi::WiFiComponent::wifi_soft_ap_ip ( )

Definition at line 924 of file wifi_component_esp8266.cpp.

◆ wifi_ssid_to()

const char * esphome::wifi::WiFiComponent::wifi_ssid_to ( std::span< char, SSID_BUFFER_SIZE > buffer )

Write SSID to buffer without heap allocation.

Returns pointer to buffer, or empty string if not connected.

Definition at line 939 of file wifi_component_esp8266.cpp.

◆ wifi_sta_connect_()

bool esphome::wifi::WiFiComponent::wifi_sta_connect_ ( const WiFiAP & ap )

protected

Definition at line 267 of file wifi_component_esp8266.cpp.

◆ wifi_sta_connect_status_()

WiFiSTAConnectStatus esphome::wifi::WiFiComponent::wifi_sta_connect_status_ ( ) const

protected

Definition at line 670 of file wifi_component_esp8266.cpp.

◆ wifi_sta_ip_addresses()

network::IPAddresses esphome::wifi::WiFiComponent::wifi_sta_ip_addresses ( )

Definition at line 225 of file wifi_component_esp8266.cpp.

◆ wifi_sta_ip_config_()

bool esphome::wifi::WiFiComponent::wifi_sta_ip_config_ ( const optional< ManualIP > & manual_ip )

protected

Definition at line 154 of file wifi_component_esp8266.cpp.

◆ wifi_sta_pre_setup_()

bool esphome::wifi::WiFiComponent::wifi_sta_pre_setup_ ( )

protected

Definition at line 630 of file wifi_component_esp8266.cpp.

◆ wifi_start_ap_()

bool esphome::wifi::WiFiComponent::wifi_start_ap_ ( const WiFiAP & ap )

protected

Definition at line 871 of file wifi_component_esp8266.cpp.

◆ wifi_subnet_mask_()

network::IPAddress esphome::wifi::WiFiComponent::wifi_subnet_mask_ ( )

protected

Definition at line 959 of file wifi_component_esp8266.cpp.

Field Documentation

◆ action_started_

uint32_t esphome::wifi::WiFiComponent::action_started_

protected

Definition at line 920 of file wifi_component.h.

◆ ap_

WiFiAP esphome::wifi::WiFiComponent::ap_

protected

Definition at line 878 of file wifi_component.h.

◆ ap_setup_

bool esphome::wifi::WiFiComponent::ap_setup_ {false}

protected

Definition at line 1002 of file wifi_component.h.

◆ ap_started_

bool esphome::wifi::WiFiComponent::ap_started_ {false}

protected

Definition at line 1003 of file wifi_component.h.

◆ ap_timeout_

uint32_t esphome::wifi::WiFiComponent::ap_timeout_ {}

protected

Definition at line 926 of file wifi_component.h.

◆ band_mode_

wifi_band_mode_t esphome::wifi::WiFiComponent::band_mode_ {WIFI_BAND_MODE_AUTO}

protected

Definition at line 933 of file wifi_component.h.

◆ btm_

bool esphome::wifi::WiFiComponent::btm_ {false}

protected

Definition at line 1007 of file wifi_component.h.

◆ configured_power_save_

WiFiPowerSaveMode esphome::wifi::WiFiComponent::configured_power_save_ {WIFI_POWER_SAVE_NONE}

protected

Definition at line 975 of file wifi_component.h.

◆ connect_state

bool esphome::wifi::WiFiComponent::connect_state

Definition at line 984 of file wifi_component.h.

◆ connect_state_listeners_

StaticVector<WiFiConnectStateListener *, ESPHOME_WIFI_CONNECT_STATE_LISTENERS> esphome::wifi::WiFiComponent::connect_state_listeners_

protected

Definition at line 887 of file wifi_component.h.

◆ connect_trigger_

Trigger esphome::wifi::WiFiComponent::connect_trigger_

protected

Definition at line 897 of file wifi_component.h.

◆ connected_

bool esphome::wifi::WiFiComponent::connected_ {false}

protected

Definition at line 1022 of file wifi_component.h.

◆ disconnect

bool esphome::wifi::WiFiComponent::disconnect

Definition at line 987 of file wifi_component.h.

◆ disconnect_trigger_

Trigger esphome::wifi::WiFiComponent::disconnect_trigger_

protected

Definition at line 900 of file wifi_component.h.

◆ enable_on_boot_

bool esphome::wifi::WiFiComponent::enable_on_boot_ {true}

protected

Definition at line 1010 of file wifi_component.h.

◆ error_from_callback_

bool esphome::wifi::WiFiComponent::error_from_callback_ {false}

protected

Definition at line 956 of file wifi_component.h.

◆ event_queue_ [1/3]

LockFreeQueue<IDFWiFiEvent, 17> esphome::wifi::WiFiComponent::event_queue_

protected

Definition at line 1032 of file wifi_component.h.

◆ event_queue_ [2/3]

LockFreeQueue<LTWiFiEvent, LT_EVENT_QUEUE_SIZE + 1> esphome::wifi::WiFiComponent::event_queue_

protected

Definition at line 1042 of file wifi_component.h.

◆ event_queue_ [3/3]

FreeRTOSQueue<LTWiFiEvent, LT_EVENT_QUEUE_SIZE> esphome::wifi::WiFiComponent::event_queue_

protected

Definition at line 1044 of file wifi_component.h.

◆ fast_connect_pref_

ESPPreferenceObject esphome::wifi::WiFiComponent::fast_connect_pref_

protected

Definition at line 894 of file wifi_component.h.

◆ FIRST_5GHZ_CHANNEL

uint8_t esphome::wifi::WiFiComponent::FIRST_5GHZ_CHANNEL = 36

staticconstexprprotected

Definition at line 906 of file wifi_component.h.

◆ got_ip

bool esphome::wifi::WiFiComponent::got_ip

Definition at line 991 of file wifi_component.h.

◆ got_ipv4_address_

bool esphome::wifi::WiFiComponent::got_ipv4_address_ {false}

protected

Definition at line 1017 of file wifi_component.h.

◆ handled_connected_state_

bool esphome::wifi::WiFiComponent::handled_connected_state_ {false}

protected

Definition at line 999 of file wifi_component.h.

◆ has_ap_

bool esphome::wifi::WiFiComponent::has_ap_ {false}

protected

Definition at line 997 of file wifi_component.h.

◆ has_completed_scan_after_captive_portal_start_

bool esphome::wifi::WiFiComponent::has_completed_scan_after_captive_portal_start_

protected

Initial value:

{

false}

Definition at line 1019 of file wifi_component.h.

◆ has_saved_wifi_settings_

bool esphome::wifi::WiFiComponent::has_saved_wifi_settings_ {false}

protected

Definition at line 1005 of file wifi_component.h.

◆ high_performance_semaphore_

SemaphoreHandle_t esphome::wifi::WiFiComponent::high_performance_semaphore_ {nullptr}

protected

Definition at line 903 of file wifi_component.h.

◆ ip_state_listeners_

StaticVector<WiFiIPStateListener *, ESPHOME_WIFI_IP_STATE_LISTENERS> esphome::wifi::WiFiComponent::ip_state_listeners_

protected

Definition at line 881 of file wifi_component.h.

◆ is_high_performance_mode_

bool esphome::wifi::WiFiComponent::is_high_performance_mode_ {false}

protected

Definition at line 1025 of file wifi_component.h.

◆ keep_scan_results_

bool esphome::wifi::WiFiComponent::keep_scan_results_ {false}

protected

Definition at line 1018 of file wifi_component.h.

◆ last_connected_

uint32_t esphome::wifi::WiFiComponent::last_connected_ {0}

protected

Definition at line 921 of file wifi_component.h.

◆ LT_EVENT_QUEUE_SIZE

uint8_t esphome::wifi::WiFiComponent::LT_EVENT_QUEUE_SIZE = 16

staticconstexprprotected

Definition at line 1039 of file wifi_component.h.

◆ lt_first_connect_attempt_

bool esphome::wifi::WiFiComponent::lt_first_connect_attempt_ {true}

protected

Definition at line 966 of file wifi_component.h.

◆ lt_teardown_event_pending_

bool esphome::wifi::WiFiComponent::lt_teardown_event_pending_ {false}

protected

Definition at line 969 of file wifi_component.h.

◆ min_auth_mode_

WifiMinAuthMode esphome::wifi::WiFiComponent::min_auth_mode_ {WIFI_MIN_AUTH_MODE_WPA2}

protected

Definition at line 938 of file wifi_component.h.

◆ num_ipv6_addresses_

uint8_t esphome::wifi::WiFiComponent::num_ipv6_addresses_ {0}

protected

Definition at line 954 of file wifi_component.h.

◆ num_retried_

uint8_t esphome::wifi::WiFiComponent::num_retried_ {0}

protected

Definition at line 940 of file wifi_component.h.

◆ output_power_

float esphome::wifi::WiFiComponent::output_power_ {NAN}

protected

Definition at line 919 of file wifi_component.h.

◆ passive_scan_

bool esphome::wifi::WiFiComponent::passive_scan_ {false}

protected

Definition at line 1004 of file wifi_component.h.

◆ [struct]

struct { ... } esphome::wifi::WiFiComponent::pending_

◆ phy_mode_

WiFi8266PhyMode esphome::wifi::WiFiComponent::phy_mode_ {WIFI_8266_PHY_MODE_AUTO}

protected

Definition at line 936 of file wifi_component.h.

◆ post_connect_roaming_

bool esphome::wifi::WiFiComponent::post_connect_roaming_ {true}

protected

Definition at line 1023 of file wifi_component.h.

◆ power_save_

WiFiPowerSaveMode esphome::wifi::WiFiComponent::power_save_ {WIFI_POWER_SAVE_NONE}

protected

Definition at line 931 of file wifi_component.h.

◆ power_save_listeners_

StaticVector<WiFiPowerSaveListener *, ESPHOME_WIFI_POWER_SAVE_LISTENERS> esphome::wifi::WiFiComponent::power_save_listeners_

protected

Definition at line 890 of file wifi_component.h.

◆ pref_

ESPPreferenceObject esphome::wifi::WiFiComponent::pref_

protected

Definition at line 892 of file wifi_component.h.

◆ reboot_timeout_

uint32_t esphome::wifi::WiFiComponent::reboot_timeout_ {}

protected

Definition at line 922 of file wifi_component.h.

◆ retry_hidden_mode_

RetryHiddenMode esphome::wifi::WiFiComponent::retry_hidden_mode_ {RetryHiddenMode::BLIND_RETRY}

protected

Definition at line 971 of file wifi_component.h.

◆ retry_phase_

WiFiRetryPhase esphome::wifi::WiFiComponent::retry_phase_ {WiFiRetryPhase::INITIAL_CONNECT}

protected

Definition at line 939 of file wifi_component.h.

◆ roaming_attempts_

uint8_t esphome::wifi::WiFiComponent::roaming_attempts_ {0}

protected

Definition at line 945 of file wifi_component.h.

◆ ROAMING_CHECK_INTERVAL

uint32_t esphome::wifi::WiFiComponent::ROAMING_CHECK_INTERVAL = 5 * 60 * 1000

staticconstexprprotected

Definition at line 909 of file wifi_component.h.

◆ ROAMING_GOOD_RSSI

int8_t esphome::wifi::WiFiComponent::ROAMING_GOOD_RSSI = -49

staticconstexprprotected

Definition at line 911 of file wifi_component.h.

◆ roaming_last_check_

uint32_t esphome::wifi::WiFiComponent::roaming_last_check_ {0}

protected

Definition at line 923 of file wifi_component.h.

◆ ROAMING_MAX_ATTEMPTS

uint8_t esphome::wifi::WiFiComponent::ROAMING_MAX_ATTEMPTS = 3

staticconstexprprotected

Definition at line 912 of file wifi_component.h.

◆ ROAMING_MIN_IMPROVEMENT

int8_t esphome::wifi::WiFiComponent::ROAMING_MIN_IMPROVEMENT = 10

staticconstexprprotected

Definition at line 910 of file wifi_component.h.

◆ roaming_scan_end_

uint32_t esphome::wifi::WiFiComponent::roaming_scan_end_ {0}

protected

Definition at line 924 of file wifi_component.h.

◆ ROAMING_SCAN_GRACE_PERIOD

uint32_t esphome::wifi::WiFiComponent::ROAMING_SCAN_GRACE_PERIOD = 30 * 1000

staticconstexprprotected

Definition at line 916 of file wifi_component.h.

◆ roaming_state_

RoamingState esphome::wifi::WiFiComponent::roaming_state_ {RoamingState::IDLE}

protected

Definition at line 972 of file wifi_component.h.

◆ roaming_suppression_count_

std::atomic<uint8_t> esphome::wifi::WiFiComponent::roaming_suppression_count_ {0}

protected

Definition at line 951 of file wifi_component.h.

◆ roaming_target_bssid_

bssid_t esphome::wifi::WiFiComponent::roaming_target_bssid_ {}

protected

Definition at line 973 of file wifi_component.h.

◆ rrm_

bool esphome::wifi::WiFiComponent::rrm_ {false}

protected

Definition at line 1008 of file wifi_component.h.

◆ scan_complete

bool esphome::wifi::WiFiComponent::scan_complete

Definition at line 994 of file wifi_component.h.

◆ scan_done_

bool esphome::wifi::WiFiComponent::scan_done_ {false}

protected

Definition at line 1001 of file wifi_component.h.

◆ scan_result_

wifi_scan_vector_t<WiFiScanResult> esphome::wifi::WiFiComponent::scan_result_

protected

Definition at line 873 of file wifi_component.h.

◆ scan_result_lock_

Mutex esphome::wifi::WiFiComponent::scan_result_lock_

protected

Definition at line 875 of file wifi_component.h.

◆ scan_results_listeners_

StaticVector<WiFiScanResultsListener *, ESPHOME_WIFI_SCAN_RESULTS_LISTENERS> esphome::wifi::WiFiComponent::scan_results_listeners_

protected

Definition at line 884 of file wifi_component.h.

◆ selected_sta_index_

int8_t esphome::wifi::WiFiComponent::selected_sta_index_ {-1}

protected

Definition at line 944 of file wifi_component.h.

◆ skip_cooldown_next_cycle_

bool esphome::wifi::WiFiComponent::skip_cooldown_next_cycle_ {false}

protected

Definition at line 1021 of file wifi_component.h.

◆ sta_

FixedVector<WiFiAP> esphome::wifi::WiFiComponent::sta_

protected

Definition at line 870 of file wifi_component.h.

◆ sta_priorities_

std::vector<WiFiSTAPriority> esphome::wifi::WiFiComponent::sta_priorities_

protected

Definition at line 871 of file wifi_component.h.

◆ sta_state_

uint8_t esphome::wifi::WiFiComponent::sta_state_ {0}

protected

Definition at line 961 of file wifi_component.h.

◆ state_

WiFiComponentState esphome::wifi::WiFiComponent::state_ {WIFI_COMPONENT_STATE_OFF}

protected

Definition at line 930 of file wifi_component.h.

◆ wifi_initialized_

bool esphome::wifi::WiFiComponent::wifi_initialized_ {false}

protected

Definition at line 1015 of file wifi_component.h.

The documentation for this class was generated from the following files:

esphome/components/wifi/wifi_component.h
esphome/components/wifi/wifi_component.cpp
esphome/components/wifi/wifi_component_esp8266.cpp
esphome/components/wifi/wifi_component_libretiny.cpp
esphome/components/wifi/wifi_component_pico_w.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WiFiComponent()

Member Function Documentation

◆ add_connect_state_listener()

◆ add_ip_state_listener()

◆ add_power_save_listener()

◆ add_scan_results_listener()

◆ add_sta()

◆ advance_to_next_target_or_increment_retry_()

◆ all_networks_hidden_()

◆ build_params_for_current_phase_()

◆ check_connecting_finished()

◆ check_roaming_()

◆ check_scanning_finished()

◆ clear_all_bssid_priorities_()

◆ clear_priorities_if_all_min_()

◆ clear_roaming_state_()

◆ clear_sta()

◆ connect_soon_()

◆ determine_next_phase_()

◆ disable()

◆ dump_config()

◆ enable()

◆ find_first_non_hidden_index_()

◆ find_next_hidden_sta_()

◆ force_roam_check()

◆ get_ap()

◆ get_connect_trigger()

◆ get_disconnect_trigger()

◆ get_dns_address()

◆ get_esp_netif_sta()

◆ get_ip_addresses()

◆ get_scan_result()

◆ get_selected_sta_()

◆ get_setup_priority()

◆ get_sta()

◆ get_sta_priority()

◆ get_use_address()

◆ get_wifi_channel()

◆ handle_driver_roam_()

◆ has_ap()

◆ has_sta()

◆ has_sta_priority()

◆ init_sta()

◆ is_ap_active()

◆ is_captive_portal_active_()

◆ is_connected()

◆ is_connected_()

◆ is_disabled()

◆ is_esp32_improv_active_()

◆ is_roaming()

◆ is_roaming_scan_active()

◆ load_fast_connect_settings_()

◆ log_and_adjust_priority_for_failed_connect_()

◆ log_discarded_scan_result_()

◆ loop()

◆ matches_configured_network_()

◆ needs_full_scan_results_()

◆ needs_scan_results_()

◆ notify_connect_state_listeners_()

◆ notify_disconnect_state_listeners_()

◆ notify_ip_state_listeners_()

◆ notify_scan_results_listeners_()

◆ print_connect_params_()

◆ process_pending_callbacks_()

◆ process_roaming_scan_()

◆ release_high_performance()

◆ release_roaming_suppression()

◆ release_scan_results_()

◆ request_high_performance()

◆ request_roaming_suppression()

◆ reset_selected_ap_to_first_if_invalid_()

◆ restart_adapter()

◆ retry_connect()