7#if (ESP_IDF_VERSION_MAJOR >= 5 && ESP_IDF_VERSION_MINOR >= 1)
8#include <esp_eap_client.h>
14#if defined(USE_ESP32) || defined(USE_ESP_IDF)
18#include <user_interface.h>
32#ifdef USE_CAPTIVE_PORTAL
43static const char *
const TAG =
"wifi";
48 ESP_LOGCONFIG(TAG,
"Running setup");
76 ESP_LOGD(TAG,
"Loaded saved settings: %s", save.ssid);
80 sta.set_password(save.password);
87 ESP_LOGV(TAG,
"Setting Output Power Option failed!");
91 ESP_LOGV(TAG,
"Setting Power Save Option failed!");
102 }
else if (this->
has_ap()) {
105 ESP_LOGV(TAG,
"Setting Output Power Option failed!");
107#ifdef USE_CAPTIVE_PORTAL
165 ESP_LOGW(TAG,
"Connection lost; reconnecting");
184 ESP_LOGI(TAG,
"Starting fallback AP!");
186#ifdef USE_CAPTIVE_PORTAL
206 ESP_LOGE(TAG,
"Can't connect; rebooting");
218#ifdef USE_WIFI_11KV_SUPPORT
255 if (name.length() > 32) {
257 name.erase(name.begin() + 25, name.end() - 7);
259 name = name.substr(0, 32);
265 ESP_LOGCONFIG(TAG,
"Setting up AP");
269 " AP Password: '%s'",
270 this->
ap_.
get_ssid().c_str(), this->ap_.get_password().c_str());
274 " AP Static IP: '%s'\n"
275 " AP Gateway: '%s'\n"
277 manual.static_ip.str().c_str(), manual.gateway.str().c_str(), manual.subnet.str().c_str());
281 ESP_LOGCONFIG(TAG,
" IP Address: %s", this->
wifi_soft_ap_ip().str().c_str());
306 snprintf(save.ssid,
sizeof(save.ssid),
"%s", ssid.c_str());
307 snprintf(save.password,
sizeof(save.password),
"%s", password.c_str());
314 sta.set_password(password);
319 ESP_LOGI(TAG,
"Connecting to '%s'", ap.
get_ssid().c_str());
320#ifdef ESPHOME_LOG_HAS_VERBOSE
321 ESP_LOGV(TAG,
"Connection Params:");
322 ESP_LOGV(TAG,
" SSID: '%s'", ap.
get_ssid().c_str());
325 ESP_LOGV(TAG,
" BSSID: %02X:%02X:%02X:%02X:%02X:%02X", b[0], b[1], b[2], b[3], b[4], b[5]);
327 ESP_LOGV(TAG,
" BSSID: Not Set");
330#ifdef USE_WIFI_WPA2_EAP
331 if (ap.
get_eap().has_value()) {
332 ESP_LOGV(TAG,
" WPA2 Enterprise authentication configured:");
334 ESP_LOGV(TAG,
" Identity: " LOG_SECRET(
"'%s'"), eap_config.
identity.c_str());
335 ESP_LOGV(TAG,
" Username: " LOG_SECRET(
"'%s'"), eap_config.
username.c_str());
336 ESP_LOGV(TAG,
" Password: " LOG_SECRET(
"'%s'"), eap_config.
password.c_str());
338#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
339 std::map<esp_eap_ttls_phase2_types, std::string> phase2types = {{ESP_EAP_TTLS_PHASE2_PAP,
"pap"},
340 {ESP_EAP_TTLS_PHASE2_CHAP,
"chap"},
341 {ESP_EAP_TTLS_PHASE2_MSCHAP,
"mschap"},
342 {ESP_EAP_TTLS_PHASE2_MSCHAPV2,
"mschapv2"},
343 {ESP_EAP_TTLS_PHASE2_EAP,
"eap"}};
344 ESP_LOGV(TAG,
" TTLS Phase 2: " LOG_SECRET(
"'%s'"), phase2types[eap_config.
ttls_phase_2].c_str());
347 bool ca_cert_present = eap_config.
ca_cert !=
nullptr && strlen(eap_config.
ca_cert);
350 ESP_LOGV(TAG,
" CA Cert: %s", ca_cert_present ?
"present" :
"not present");
351 ESP_LOGV(TAG,
" Client Cert: %s", client_cert_present ?
"present" :
"not present");
352 ESP_LOGV(TAG,
" Client Key: %s", client_key_present ?
"present" :
"not present");
355 ESP_LOGV(TAG,
" Password: " LOG_SECRET(
"'%s'"), ap.
get_password().c_str());
356#ifdef USE_WIFI_WPA2_EAP
362 ESP_LOGV(TAG,
" Channel: Not Set");
366 ESP_LOGV(TAG,
" Manual IP: Static IP=%s Gateway=%s Subnet=%s DNS1=%s DNS2=%s",
m.static_ip.str().c_str(),
367 m.gateway.str().c_str(),
m.subnet.str().c_str(),
m.dns1.str().c_str(),
m.dns2.str().c_str());
369 ESP_LOGV(TAG,
" Using DHCP IP");
371 ESP_LOGV(TAG,
" Hidden: %s", YESNO(ap.
get_hidden()));
375 ESP_LOGE(TAG,
"wifi_sta_connect_ failed!");
398 return LOG_STR(
"\033[0;32m"
404 }
else if (rssi >= -65) {
405 return LOG_STR(
"\033[0;33m"
412 }
else if (rssi >= -85) {
413 return LOG_STR(
"\033[0;33m"
421 return LOG_STR(
"\033[0;31m"
436 ESP_LOGCONFIG(TAG,
" Disabled");
439 ESP_LOGCONFIG(TAG,
" SSID: " LOG_SECRET(
"'%s'"),
wifi_ssid().c_str());
442 ESP_LOGCONFIG(TAG,
" IP Address: %s", ip.str().c_str());
447 " BSSID: " LOG_SECRET(
"%02X:%02X:%02X:%02X:%02X:%02X")
"\n"
449 " Signal strength: %d dB %s",
450 bssid[0], bssid[1], bssid[2], bssid[3], bssid[4], bssid[5],
App.
get_name().c_str(), rssi,
456 " Channel: %" PRId32
"\n"
463#ifdef USE_WIFI_11KV_SUPPORT
467 this->
btm_ ?
"enabled" :
"disabled", this->
rrm_ ?
"enabled" :
"disabled");
475 ESP_LOGD(TAG,
"Enabling");
485 ESP_LOGD(TAG,
"Disabling");
495 ESP_LOGD(TAG,
"Starting scan");
503 ESP_LOGE(TAG,
"Scan timeout!");
510 ESP_LOGD(TAG,
"Found networks:");
512 ESP_LOGD(TAG,
" No network found!");
518 for (
auto &ap : this->
sta_) {
519 if (res.matches(ap)) {
520 res.set_matches(
true);
530 std::stable_sort(this->scan_result_.begin(), this->scan_result_.end(),
533 if (a.get_matches() && !b.get_matches())
535 if (!a.get_matches() && b.get_matches())
538 if (a.get_matches() && b.get_matches()) {
540 if (a.get_priority() != b.get_priority())
541 return a.get_priority() > b.get_priority();
547 for (
auto &res : this->scan_result_) {
549 auto bssid = res.get_bssid();
550 sprintf(bssid_s,
"%02X:%02X:%02X:%02X:%02X:%02X", bssid[0], bssid[1], bssid[2], bssid[3], bssid[4], bssid[5]);
552 if (res.get_matches()) {
553 ESP_LOGI(TAG,
"- '%s' %s" LOG_SECRET(
"(%s) ")
"%s", res.get_ssid().c_str(),
554 res.get_is_hidden() ?
"(HIDDEN) " :
"", bssid_s, LOG_STR_ARG(
get_signal_bars(res.get_rssi())));
555 ESP_LOGD(TAG,
" Channel: %u", res.get_channel());
556 ESP_LOGD(TAG,
" RSSI: %d dB", res.get_rssi());
558 ESP_LOGD(TAG,
"- " LOG_SECRET(
"'%s'")
" " LOG_SECRET(
"(%s) ")
"%s", res.get_ssid().c_str(), bssid_s,
563 if (!this->scan_result_[0].get_matches()) {
564 ESP_LOGW(TAG,
"No matching network found!");
565 this->retry_connect();
569 WiFiAP connect_params;
570 WiFiScanResult scan_res = this->scan_result_[0];
571 for (
auto &config : this->sta_) {
573 if (!scan_res.matches(config)) {
577 if (config.get_hidden()) {
579 connect_params.set_hidden(
true);
580 connect_params.set_ssid(config.get_ssid());
587 connect_params.set_hidden(
false);
588 connect_params.set_ssid(scan_res.get_ssid());
589 connect_params.set_channel(scan_res.get_channel());
590 connect_params.set_bssid(scan_res.get_bssid());
593 connect_params.set_manual_ip(config.get_manual_ip());
595#ifdef USE_WIFI_WPA2_EAP
597 connect_params.set_eap(config.get_eap());
601 connect_params.set_password(config.get_password());
608 this->selected_ap_ = connect_params;
609 this->start_connecting(connect_params,
false);
612void WiFiComponent::dump_config() {
613 ESP_LOGCONFIG(TAG,
"WiFi:");
614 this->print_connect_params_();
617void WiFiComponent::check_connecting_finished() {
618 auto status = this->wifi_sta_connect_status_();
620 if (
status == WiFiSTAConnectStatus::CONNECTED) {
621 if (wifi_ssid().empty()) {
622 ESP_LOGW(TAG,
"Incomplete connection.");
623 this->retry_connect();
628 this->retry_hidden_ =
false;
630 ESP_LOGI(TAG,
"Connected");
631 this->print_connect_params_();
633 if (this->has_ap()) {
634#ifdef USE_CAPTIVE_PORTAL
635 if (this->is_captive_portal_active_()) {
639 ESP_LOGD(TAG,
"Disabling AP");
640 this->wifi_mode_({},
false);
643 if (this->is_esp32_improv_active_()) {
649 this->num_retried_ = 0;
651 if (this->fast_connect_) {
652 this->save_fast_connect_settings_();
659 if (now - this->action_started_ > 30000) {
660 ESP_LOGW(TAG,
"Connection timeout");
661 this->retry_connect();
665 if (this->error_from_callback_) {
666 ESP_LOGW(TAG,
"Error while connecting to network.");
667 this->retry_connect();
671 if (
status == WiFiSTAConnectStatus::CONNECTING) {
675 if (
status == WiFiSTAConnectStatus::ERROR_NETWORK_NOT_FOUND) {
676 ESP_LOGW(TAG,
"Network no longer found");
677 this->retry_connect();
681 if (
status == WiFiSTAConnectStatus::ERROR_CONNECT_FAILED) {
682 ESP_LOGW(TAG,
"Connection failed. Check credentials");
683 this->retry_connect();
687 ESP_LOGW(TAG,
"Unknown connection status %d", (
int)
status);
688 this->retry_connect();
691void WiFiComponent::retry_connect() {
692 if (this->selected_ap_.get_bssid()) {
693 auto bssid = *this->selected_ap_.get_bssid();
694 float priority = this->get_sta_priority(bssid);
695 this->set_sta_priority(bssid,
priority - 1.0f);
699 if (!this->is_captive_portal_active_() && !this->is_esp32_improv_active_() &&
700 (this->num_retried_ > 3 || this->error_from_callback_)) {
701 if (this->num_retried_ > 5) {
703 ESP_LOGW(TAG,
"Restarting WiFi adapter");
704 this->wifi_mode_(
false, {});
706 this->num_retried_ = 0;
707 this->retry_hidden_ =
false;
710 ESP_LOGD(TAG,
"Retrying with hidden networks");
711 this->retry_hidden_ =
true;
712 this->num_retried_++;
715 this->num_retried_++;
717 this->error_from_callback_ =
false;
721 this->start_connecting(this->selected_ap_,
true);
726 this->action_started_ =
millis();
729bool WiFiComponent::can_proceed() {
733 return this->is_connected();
735void WiFiComponent::set_reboot_timeout(uint32_t reboot_timeout) { this->reboot_timeout_ = reboot_timeout; }
736bool WiFiComponent::is_connected() {
738 this->wifi_sta_connect_status_() == WiFiSTAConnectStatus::CONNECTED && !this->error_from_callback_;
740void WiFiComponent::set_power_save_mode(
WiFiPowerSaveMode power_save) { this->power_save_ = power_save; }
742void WiFiComponent::set_passive_scan(
bool passive) { this->passive_scan_ = passive; }
744std::string WiFiComponent::format_mac_addr(
const uint8_t *mac) {
746 sprintf(buf,
"%02X:%02X:%02X:%02X:%02X:%02X", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
749bool WiFiComponent::is_captive_portal_active_() {
750#ifdef USE_CAPTIVE_PORTAL
756bool WiFiComponent::is_esp32_improv_active_() {
764void WiFiComponent::load_fast_connect_settings_() {
767 if (this->fast_connect_pref_.load(&fast_connect_save)) {
769 std::copy(fast_connect_save.bssid, fast_connect_save.bssid + 6, bssid.begin());
770 this->selected_ap_.set_bssid(bssid);
771 this->selected_ap_.set_channel(fast_connect_save.channel);
773 ESP_LOGD(TAG,
"Loaded saved fast_connect wifi settings");
777void WiFiComponent::save_fast_connect_settings_() {
779 uint8_t channel = get_wifi_channel();
781 if (bssid != this->selected_ap_.get_bssid() || channel != this->selected_ap_.get_channel()) {
784 memcpy(fast_connect_save.bssid, bssid.data(), 6);
785 fast_connect_save.channel = channel;
787 this->fast_connect_pref_.save(&fast_connect_save);
789 ESP_LOGD(TAG,
"Saved fast_connect wifi settings");
793void WiFiAP::set_ssid(
const std::string &ssid) { this->ssid_ = ssid; }
794void WiFiAP::set_bssid(
bssid_t bssid) { this->bssid_ = bssid; }
796void WiFiAP::set_password(
const std::string &password) { this->password_ = password; }
797#ifdef USE_WIFI_WPA2_EAP
802void WiFiAP::set_hidden(
bool hidden) { this->hidden_ = hidden; }
803const std::string &WiFiAP::get_ssid()
const {
return this->ssid_; }
805const std::string &WiFiAP::get_password()
const {
return this->password_; }
806#ifdef USE_WIFI_WPA2_EAP
811bool WiFiAP::get_hidden()
const {
return this->hidden_; }
813WiFiScanResult::WiFiScanResult(
const bssid_t &bssid, std::string ssid, uint8_t channel, int8_t rssi,
bool with_auth,
816 ssid_(std::move(ssid)),
819 with_auth_(with_auth),
820 is_hidden_(is_hidden) {}
827 }
else if (!config.
get_ssid().empty()) {
829 if (config.
get_ssid() != this->ssid_)
838#ifdef USE_WIFI_WPA2_EAP
std::string get_compilation_time() const
bool is_name_add_mac_suffix_enabled() const
const std::string & get_name() const
Get the name of this Application set by pre_setup().
uint32_t IRAM_ATTR HOT get_loop_component_start_time() const
Get the cached time in milliseconds from when the current component started its loop execution.
void status_set_warning(const char *message="unspecified")
void status_clear_warning()
virtual bool sync()=0
Commit pending writes to flash.
virtual ESPPreferenceObject make_preference(size_t length, uint32_t type, bool in_flash)=0
void trigger(Ts... x)
Inform the parent automation that the event has triggered.
const optional< bssid_t > & get_bssid() const
const std::string & get_ssid() const
void set_ssid(const std::string &ssid)
const optional< uint8_t > & get_channel() const
const optional< EAPAuth > & get_eap() const
const std::string & get_password() const
const optional< ManualIP > & get_manual_ip() const
This component is responsible for managing the ESP WiFi interface.
bool error_from_callback_
void add_sta(const WiFiAP &ap)
bool wifi_apply_power_save_()
void set_ap(const WiFiAP &ap)
Setup an Access Point that should be created if no connection to a station can be made.
ESPPreferenceObject pref_
void set_sta(const WiFiAP &ap)
bool has_sta_priority(const bssid_t &bssid)
std::string get_use_address() const
void check_connecting_finished()
void save_wifi_sta(const std::string &ssid, const std::string &password)
void load_fast_connect_settings_()
WiFiComponentState state_
void print_connect_params_()
void loop() override
Reconnect WiFi if required.
void check_scanning_finished()
float get_sta_priority(const bssid_t bssid)
network::IPAddress get_dns_address(int num)
WiFiComponent()
Construct a WiFiComponent.
std::vector< WiFiScanResult > scan_result_
bool wifi_start_ap_(const WiFiAP &ap)
int32_t get_wifi_channel()
void start_connecting(const WiFiAP &ap, bool two)
network::IPAddress wifi_subnet_mask_()
network::IPAddress wifi_soft_ap_ip()
network::IPAddress wifi_gateway_ip_()
Trigger * connect_trigger_
void set_use_address(const std::string &use_address)
ESPPreferenceObject fast_connect_pref_
network::IPAddress wifi_dns_ip_(int num)
float get_loop_priority() const override
bool wifi_apply_hostname_()
bool wifi_sta_pre_setup_()
network::IPAddresses get_ip_addresses()
Trigger * disconnect_trigger_
std::vector< WiFiAP > sta_
float get_setup_priority() const override
WIFI setup_priority.
optional< float > output_power_
void set_sta_priority(const bssid_t bssid, float priority)
void set_fast_connect(bool fast_connect)
bool wifi_sta_connect_(const WiFiAP &ap)
bool wifi_mode_(optional< bool > sta, optional< bool > ap)
network::IPAddresses wifi_sta_ip_addresses()
bool wifi_scan_start_(bool passive)
bool handled_connected_state_
void setup() override
Setup WiFi interface.
const std::string & get_ssid() const
uint8_t get_channel() const
bool get_with_auth() const
const bssid_t & get_bssid() const
void set_matches(bool matches)
bool matches(const WiFiAP &config)
bool get_is_hidden() const
bool operator==(const WiFiScanResult &rhs) const
CaptivePortal * global_captive_portal
ESP32ImprovComponent * global_improv_component
std::array< IPAddress, 5 > IPAddresses
std::array< uint8_t, 6 > bssid_t
const LogString * get_signal_bars(int8_t rssi)
@ 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_STA_CONNECTING_2
WiFi is in STA(+AP) mode and currently connecting to an AP a second time.
@ 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.
WiFiComponent * global_wifi_component
Providing packet encoding functions for exchanging data with a remote host.
uint32_t fnv1_hash(const std::string &str)
Calculate a FNV-1 hash of str.
ESPPreferences * global_preferences
std::string get_mac_address_pretty()
Get the device MAC address as a string, in colon-separated uppercase hex notation.
void IRAM_ATTR HOT yield()
void IRAM_ATTR HOT delay(uint32_t ms)
uint32_t IRAM_ATTR HOT millis()
Application App
Global storage of Application pointer - only one Application can exist.
esp_eap_ttls_phase2_types ttls_phase_2
Struct for setting static IPs in WiFiComponent.