ESPHome  2023.5.5
wifi_component.h
Go to the documentation of this file.
1 #pragma once
2 
4 #include "esphome/core/defines.h"
6 #include "esphome/core/helpers.h"
8 
9 #include <string>
10 #include <vector>
11 
12 #ifdef USE_ESP32_FRAMEWORK_ARDUINO
13 #include <esp_wifi.h>
14 #include <WiFiType.h>
15 #include <WiFi.h>
16 #endif
17 
18 #ifdef USE_ESP8266
19 #include <ESP8266WiFi.h>
20 #include <ESP8266WiFiType.h>
21 
22 #if defined(USE_ESP8266) && USE_ARDUINO_VERSION_CODE < VERSION_CODE(2, 4, 0)
23 extern "C" {
24 #include <user_interface.h>
25 };
26 #endif
27 #endif
28 
29 #ifdef USE_RP2040
30 extern "C" {
31 #include "cyw43.h"
32 #include "cyw43_country.h"
33 #include "pico/cyw43_arch.h"
34 }
35 
36 #include <WiFi.h>
37 #endif
38 
39 namespace esphome {
40 namespace wifi {
41 
43  char ssid[33];
44  char password[65];
45 } PACKED; // NOLINT
46 
66 };
67 
68 enum class WiFiSTAConnectStatus : int {
69  IDLE,
70  CONNECTING,
71  CONNECTED,
74 };
75 
77 struct ManualIP {
83 };
84 
85 #ifdef USE_WIFI_WPA2_EAP
86 struct EAPAuth {
87  std::string identity; // required for all auth types
88  std::string username;
89  std::string password;
90  const char *ca_cert; // optionally verify authentication server
91  // used for EAP-TLS
92  const char *client_cert;
93  const char *client_key;
94 };
95 #endif // USE_WIFI_WPA2_EAP
96 
97 using bssid_t = std::array<uint8_t, 6>;
98 
99 class WiFiAP {
100  public:
101  void set_ssid(const std::string &ssid);
102  void set_bssid(bssid_t bssid);
103  void set_bssid(optional<bssid_t> bssid);
104  void set_password(const std::string &password);
105 #ifdef USE_WIFI_WPA2_EAP
106  void set_eap(optional<EAPAuth> eap_auth);
107 #endif // USE_WIFI_WPA2_EAP
108  void set_channel(optional<uint8_t> channel);
109  void set_priority(float priority) { priority_ = priority; }
110  void set_manual_ip(optional<ManualIP> manual_ip);
111  void set_hidden(bool hidden);
112  const std::string &get_ssid() const;
113  const optional<bssid_t> &get_bssid() const;
114  const std::string &get_password() const;
115 #ifdef USE_WIFI_WPA2_EAP
116  const optional<EAPAuth> &get_eap() const;
117 #endif // USE_WIFI_WPA2_EAP
118  const optional<uint8_t> &get_channel() const;
119  float get_priority() const { return priority_; }
120  const optional<ManualIP> &get_manual_ip() const;
121  bool get_hidden() const;
122 
123  protected:
124  std::string ssid_;
126  std::string password_;
127 #ifdef USE_WIFI_WPA2_EAP
129 #endif // USE_WIFI_WPA2_EAP
131  float priority_{0};
133  bool hidden_{false};
134 };
135 
137  public:
138  WiFiScanResult(const bssid_t &bssid, std::string ssid, uint8_t channel, int8_t rssi, bool with_auth, bool is_hidden);
139 
140  bool matches(const WiFiAP &config);
141 
142  bool get_matches() const;
143  void set_matches(bool matches);
144  const bssid_t &get_bssid() const;
145  const std::string &get_ssid() const;
146  uint8_t get_channel() const;
147  int8_t get_rssi() const;
148  bool get_with_auth() const;
149  bool get_is_hidden() const;
150  float get_priority() const { return priority_; }
151  void set_priority(float priority) { priority_ = priority; }
152 
153  bool operator==(const WiFiScanResult &rhs) const;
154 
155  protected:
156  bool matches_{false};
158  std::string ssid_;
159  uint8_t channel_;
160  int8_t rssi_;
163  float priority_{0.0f};
164 };
165 
168  float priority;
169 };
170 
175 };
176 
177 #ifdef USE_ESP_IDF
178 struct IDFWiFiEvent;
179 #endif
180 
182 class WiFiComponent : public Component {
183  public:
185  WiFiComponent();
186 
187  void set_sta(const WiFiAP &ap);
188  void add_sta(const WiFiAP &ap);
189  void clear_sta();
190 
198  void set_ap(const WiFiAP &ap);
199  WiFiAP get_ap() { return this->ap_; }
200 
201  void start_scanning();
202  void check_scanning_finished();
203  void start_connecting(const WiFiAP &ap, bool two);
204  void set_fast_connect(bool fast_connect);
205  void set_ap_timeout(uint32_t ap_timeout) { ap_timeout_ = ap_timeout; }
206 
207  void check_connecting_finished();
208 
209  void retry_connect();
210 
211  bool can_proceed() override;
212 
213  void set_reboot_timeout(uint32_t reboot_timeout);
214 
215  bool is_connected();
216 
217  void set_power_save_mode(WiFiPowerSaveMode power_save);
218  void set_output_power(float output_power) { output_power_ = output_power; }
219 
220  void set_passive_scan(bool passive);
221 
222  void save_wifi_sta(const std::string &ssid, const std::string &password);
223  // ========== INTERNAL METHODS ==========
224  // (In most use cases you won't need these)
226  void setup() override;
227  void dump_config() override;
229  float get_setup_priority() const override;
230  float get_loop_priority() const override;
231 
233  void loop() override;
234 
235  bool has_sta() const;
236  bool has_ap() const;
237 
238 #ifdef USE_WIFI_11KV_SUPPORT
239  void set_btm(bool btm);
240  void set_rrm(bool rrm);
241 #endif
242 
244  std::string get_use_address() const;
245  void set_use_address(const std::string &use_address);
246 
247  const std::vector<WiFiScanResult> &get_scan_result() const { return scan_result_; }
248 
249  network::IPAddress wifi_soft_ap_ip();
250 
251  bool has_sta_priority(const bssid_t &bssid) {
252  for (auto &it : this->sta_priorities_) {
253  if (it.bssid == bssid)
254  return true;
255  }
256  return false;
257  }
258  float get_sta_priority(const bssid_t bssid) {
259  for (auto &it : this->sta_priorities_) {
260  if (it.bssid == bssid)
261  return it.priority;
262  }
263  return 0.0f;
264  }
265  void set_sta_priority(const bssid_t bssid, float priority) {
266  for (auto &it : this->sta_priorities_) {
267  if (it.bssid == bssid) {
268  it.priority = priority;
269  return;
270  }
271  }
272  this->sta_priorities_.push_back(WiFiSTAPriority{
273  .bssid = bssid,
274  .priority = priority,
275  });
276  }
277 
278  network::IPAddress wifi_sta_ip();
279  std::string wifi_ssid();
280  bssid_t wifi_bssid();
281 
282  int8_t wifi_rssi();
283 
284  protected:
285  static std::string format_mac_addr(const uint8_t mac[6]);
286  void setup_ap_config_();
287  void print_connect_params_();
288 
289  void wifi_loop_();
290  bool wifi_mode_(optional<bool> sta, optional<bool> ap);
291  bool wifi_sta_pre_setup_();
292  bool wifi_apply_output_power_(float output_power);
293  bool wifi_apply_power_save_();
294  bool wifi_sta_ip_config_(optional<ManualIP> manual_ip);
295  bool wifi_apply_hostname_();
296  bool wifi_sta_connect_(const WiFiAP &ap);
297  void wifi_pre_setup_();
298  WiFiSTAConnectStatus wifi_sta_connect_status_();
299  bool wifi_scan_start_(bool passive);
300  bool wifi_ap_ip_config_(optional<ManualIP> manual_ip);
301  bool wifi_start_ap_(const WiFiAP &ap);
302  bool wifi_disconnect_();
303  int32_t wifi_channel_();
304  network::IPAddress wifi_subnet_mask_();
305  network::IPAddress wifi_gateway_ip_();
306  network::IPAddress wifi_dns_ip_(int num);
307 
308  bool is_captive_portal_active_();
309  bool is_esp32_improv_active_();
310 
311 #ifdef USE_ESP8266
312  static void wifi_event_callback(System_Event_t *event);
313  void wifi_scan_done_callback_(void *arg, STATUS status);
314  static void s_wifi_scan_done_callback(void *arg, STATUS status);
315 #endif
316 
317 #ifdef USE_ESP32_FRAMEWORK_ARDUINO
318 #if ESP_IDF_VERSION_MAJOR >= 4
319  void wifi_event_callback_(arduino_event_id_t event, arduino_event_info_t info);
320 #else
321  void wifi_event_callback_(system_event_id_t event, system_event_info_t info);
322 #endif
323  void wifi_scan_done_callback_();
324 #endif
325 #ifdef USE_ESP_IDF
326  void wifi_process_event_(IDFWiFiEvent *data);
327 #endif
328 
329 #ifdef USE_RP2040
330  static int s_wifi_scan_result(void *env, const cyw43_ev_scan_result_t *result);
331  void wifi_scan_result(void *env, const cyw43_ev_scan_result_t *result);
332 #endif
333 
334  std::string use_address_;
335  std::vector<WiFiAP> sta_;
336  std::vector<WiFiSTAPriority> sta_priorities_;
338  bool fast_connect_{false};
339 
340  bool has_ap_{false};
343  uint32_t action_started_;
344  uint8_t num_retried_{0};
345  uint32_t last_connected_{0};
346  uint32_t reboot_timeout_{};
347  uint32_t ap_timeout_{};
349  bool error_from_callback_{false};
350  std::vector<WiFiScanResult> scan_result_;
351  bool scan_done_{false};
352  bool ap_setup_{false};
354  bool passive_scan_{false};
356  bool has_saved_wifi_settings_{false};
357 #ifdef USE_WIFI_11KV_SUPPORT
358  bool btm_{false};
359  bool rrm_{false};
360 #endif
361 };
362 
363 extern WiFiComponent *global_wifi_component; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
364 
365 template<typename... Ts> class WiFiConnectedCondition : public Condition<Ts...> {
366  public:
367  bool check(Ts... x) override;
368 };
369 
370 template<typename... Ts> bool WiFiConnectedCondition<Ts...>::check(Ts... x) {
371  return global_wifi_component->is_connected();
372 }
373 
374 } // namespace wifi
375 } // namespace esphome
void setup()
Nothing has been initialized yet.
void loop()
This component is responsible for managing the ESP WiFi interface.
void set_priority(float priority)
std::array< uint8_t, 6 > bssid_t
std::string get_use_address()
Get the active network hostname.
Definition: util.cpp:44
float get_priority() const
void set_output_power(float output_power)
const std::vector< WiFiScanResult > & get_scan_result() const
void set_sta_priority(const bssid_t bssid, float priority)
optional< ManualIP > manual_ip_
struct esphome::wifi::SavedWifiSettings PACKED
WiFi is in STA(+AP) mode and currently connecting to an AP a second time.
WiFi is in STA(+AP) mode and successfully connected.
void set_priority(float priority)
network::IPAddress static_ip
bool is_connected()
Return whether the node is connected to the network (through wifi, eth, ...)
Definition: util.cpp:15
network::IPAddress gateway
void set_ap_timeout(uint32_t ap_timeout)
std::vector< WiFiScanResult > scan_result_
WiFi is in STA-only mode and currently scanning for APs.
Struct for setting static IPs in WiFiComponent.
network::IPAddress dns1
The first DNS server. 0.0.0.0 for default.
Base class for all automation conditions.
Definition: automation.h:74
WiFi is in STA(+AP) mode and currently connecting to an AP.
bool has_sta_priority(const bssid_t &bssid)
WiFi is in cooldown mode because something went wrong, scanning will begin after a short period of ti...
optional< bssid_t > bssid_
WiFiComponent * global_wifi_component
optional< uint8_t > channel_
uint8_t priority
uint8_t status
Definition: bl0942.h:23
ESPPreferenceObject pref_
network::IPAddress dns2
The second DNS server. 0.0.0.0 for default.
const char * client_cert
std::vector< WiFiSTAPriority > sta_priorities_
bool operator==(optional< T > const &x, optional< U > const &y)
Definition: optional.h:114
std::vector< WiFiAP > sta_
optional< float > output_power_
network::IPAddress subnet
Definition: a4988.cpp:4
float get_sta_priority(const bssid_t bssid)
optional< EAPAuth > eap_
WiFi is in AP-only mode and internal AP is already enabled.
network::IPAddress get_ip_address()
Definition: util.cpp:32