3.0.0 Network Refactoring (#8760)

* Create ESP_NetworkInterface class and have Ethernet extending it

* Update CMakeLists.txt

* Split networking from WiFi (H2 can now use Ethernet)

Now all libs have been checked yet. More to do on WiFi side

* Fix build errors

* Guard WiFi classes and fix RMII ETH examples

* Decouple network related libraries from WiFi

* Fix examples and WiFiUpdate

* Guard WiFiProv lib to compile only on WiFi chips

* Add periman string for network and "fix" mdns on the first ETH

* Revert back location of Client/Server/Udp in order to accept some PRs

* Fix periman

* Some fixes from merging master

* Fix web server missing fs.h

* Move Client, Server and Udp out of WiFi

* More fixes

* more fixes

* Fix CMakekLists and rework lib menu dependencies

* Fix CMake issues

* move back WiFiClient to rebase with master

* Update ETH_TLK110.ino

* Move back WiFiClient

* Update progress

* Update WiFiGeneric.cpp

* More fixes

* Switch AP to the new interface

* Cleanup

* Rename AP methods

* Add extra interface info for Printable

* Rename IPv6 getters to clarify that they are returning LinkLocal address

cc @sgryphon

* Rename network classes

cc @sgryphon

* Update NetworkManager.h

* Rename WiFi Server and UDP

* Rename WiFiClient and WiFiClientSecure

* Update CMakeLists.txt

* Update on-push.sh

* Rename Network library

* Remove unnecessary guard

* Get the correct interface MAC address for mDND Workstation service

* Apply suggestions from code review

Co-authored-by: Lucas Saavedra Vaz <[email protected]>

---------

Co-authored-by: Lucas Saavedra Vaz <[email protected]>

Author: me-no-dev

.github/scripts/on-push.sh

@@ -72,7 +72,7 @@ if [ "$BUILD_PIO" -eq 0 ]; then
     FQBN_ESP32H2="espressif:esp32:esp32h2:PartitionScheme=huge_app"
 
     SKETCHES_ESP32="\
-      $ARDUINO_ESP32_PATH/libraries/WiFiClientSecure/examples/WiFiClientSecure/WiFiClientSecure.ino\
+      $ARDUINO_ESP32_PATH/libraries/NetworkClientSecure/examples/WiFiClientSecure/WiFiClientSecure.ino\
       $ARDUINO_ESP32_PATH/libraries/BLE/examples/Server/Server.ino\
       $ARDUINO_ESP32_PATH/libraries/ESP32/examples/Camera/CameraWebServer/CameraWebServer.ino\
       $ARDUINO_ESP32_PATH/libraries/Insights/examples/MinimalDiagnostics/MinimalDiagnostics.ino\
@@ -90,7 +90,7 @@ else
     BOARD="esp32dev"
     OPTIONS="board_build.partitions = huge_app.csv"
     build_pio_sketch "$BOARD" "$OPTIONS" "$PLATFORMIO_ESP32_PATH/libraries/WiFi/examples/WiFiClient/WiFiClient.ino" && \
-    build_pio_sketch "$BOARD" "$OPTIONS" "$PLATFORMIO_ESP32_PATH/libraries/WiFiClientSecure/examples/WiFiClientSecure/WiFiClientSecure.ino" && \
+    build_pio_sketch "$BOARD" "$OPTIONS" "$PLATFORMIO_ESP32_PATH/libraries/NetworkClientSecure/examples/WiFiClientSecure/WiFiClientSecure.ino" && \
     build_pio_sketch "$BOARD" "$OPTIONS" "$PLATFORMIO_ESP32_PATH/libraries/BluetoothSerial/examples/SerialToSerialBT/SerialToSerialBT.ino" && \
     build_pio_sketch "$BOARD" "$OPTIONS" "$PLATFORMIO_ESP32_PATH/libraries/BLE/examples/Server/Server.ino" && \
     build_pio_sketch "$BOARD" "$OPTIONS" "$PLATFORMIO_ESP32_PATH/libraries/ESP32/examples/Camera/CameraWebServer/CameraWebServer.ino"

CMakeLists.txt

@@ -93,6 +93,7 @@ set(ARDUINO_ALL_LIBRARIES
   Insights
   LittleFS
   NetBIOS
+  Network
   Preferences
   RainMaker
   SD_MMC
@@ -104,7 +105,7 @@ set(ARDUINO_ALL_LIBRARIES
   Update
   USB
   WebServer
-  WiFiClientSecure
+  NetworkClientSecure
   WiFi
   WiFiProv
   Wire
@@ -198,20 +199,27 @@ set(ARDUINO_LIBRARY_WebServer_SRCS
   libraries/WebServer/src/Parsing.cpp
   libraries/WebServer/src/detail/mimetable.cpp)
 
-set(ARDUINO_LIBRARY_WiFiClientSecure_SRCS
-  libraries/WiFiClientSecure/src/ssl_client.cpp
-  libraries/WiFiClientSecure/src/WiFiClientSecure.cpp)
+set(ARDUINO_LIBRARY_NetworkClientSecure_SRCS
+  libraries/NetworkClientSecure/src/ssl_client.cpp
+  libraries/NetworkClientSecure/src/NetworkClientSecure.cpp)
+
+set(ARDUINO_LIBRARY_Network_SRCS
+  libraries/Network/src/NetworkInterface.cpp
+  libraries/Network/src/NetworkEvents.cpp
+  libraries/Network/src/NetworkManager.cpp
+  libraries/Network/src/NetworkClient.cpp
+  libraries/Network/src/NetworkServer.cpp
+  libraries/Network/src/NetworkUdp.cpp)
 
 set(ARDUINO_LIBRARY_WiFi_SRCS
   libraries/WiFi/src/WiFiAP.cpp
-  libraries/WiFi/src/WiFiClient.cpp
   libraries/WiFi/src/WiFi.cpp
   libraries/WiFi/src/WiFiGeneric.cpp
   libraries/WiFi/src/WiFiMulti.cpp
   libraries/WiFi/src/WiFiScan.cpp
-  libraries/WiFi/src/WiFiServer.cpp
   libraries/WiFi/src/WiFiSTA.cpp
-  libraries/WiFi/src/WiFiUdp.cpp)
+  libraries/WiFi/src/STA.cpp
+  libraries/WiFi/src/AP.cpp)
 
 set(ARDUINO_LIBRARY_WiFiProv_SRCS libraries/WiFiProv/src/WiFiProv.cpp)
 

Kconfig.projbuild

@@ -256,157 +256,138 @@ config ARDUINO_SELECTIVE_COMPILATION
     bool "Include only specific Arduino libraries"
     default n
 
-config ARDUINO_SELECTIVE_ArduinoOTA
-    bool "Enable ArduinoOTA"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
-    select ARDUINO_SELECTIVE_ESPmDNS
-    default y
-
-config ARDUINO_SELECTIVE_AsyncUDP
-    bool "Enable AsyncUDP"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    default y
-
-config ARDUINO_SELECTIVE_AzureIoT
-    bool "Enable AzureIoT"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_HTTPClient
-    default y
-
-config ARDUINO_SELECTIVE_BLE
-    bool "Enable BLE"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    default y
-
-config ARDUINO_SELECTIVE_BluetoothSerial
-    bool "Enable BluetoothSerial"
+config ARDUINO_SELECTIVE_SPI
+    bool "Enable SPI"
     depends on ARDUINO_SELECTIVE_COMPILATION
     default y
 
-config ARDUINO_SELECTIVE_DNSServer
-    bool "Enable DNSServer"
+config ARDUINO_SELECTIVE_Wire
+    bool "Enable Wire"
     depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
     default y
 
 config ARDUINO_SELECTIVE_EEPROM
     bool "Enable EEPROM"
     depends on ARDUINO_SELECTIVE_COMPILATION
     default y
 
-config ARDUINO_SELECTIVE_ESP32
-    bool "Enable ESP32"
+config ARDUINO_SELECTIVE_Preferences
+    bool "Enable Preferences"
     depends on ARDUINO_SELECTIVE_COMPILATION
     default y
 
-config ARDUINO_SELECTIVE_ESPmDNS
-    bool "Enable ESPmDNS"
+config ARDUINO_SELECTIVE_Ticker
+    bool "Enable Ticker"
     depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
     default y
 
-config ARDUINO_SELECTIVE_FFat
-    bool "Enable FFat"
+config ARDUINO_SELECTIVE_Update
+    bool "Enable Update"
     depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_FS
     default y
 
 config ARDUINO_SELECTIVE_FS
     bool "Enable FS"
     depends on ARDUINO_SELECTIVE_COMPILATION
     default y
 
-config ARDUINO_SELECTIVE_HTTPClient
-    bool "Enable HTTPClient"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
-    select ARDUINO_SELECTIVE_WiFiClientSecure
+config ARDUINO_SELECTIVE_SD
+    bool "Enable SD"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_FS
     default y
 
-config ARDUINO_SELECTIVE_LITTLEFS
-    bool "Enable LITTLEFS"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_FS
+config ARDUINO_SELECTIVE_SD_MMC
+    bool "Enable SD_MMC"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_FS
     default y
 
-config ARDUINO_SELECTIVE_NetBIOS
-    bool "Enable NetBIOS"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
+config ARDUINO_SELECTIVE_SPIFFS
+    bool "Enable SPIFFS"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_FS
     default y
 
-config ARDUINO_SELECTIVE_Preferences
-    bool "Enable Preferences"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+config ARDUINO_SELECTIVE_FFat
+    bool "Enable FFat"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_FS
     default y
 
-config ARDUINO_SELECTIVE_SD
-    bool "Enable SD"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_FS
+config ARDUINO_SELECTIVE_LITTLEFS
+    bool "Enable LITTLEFS"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_FS
     default y
 
-config ARDUINO_SELECTIVE_SD_MMC
-    bool "Enable SD_MMC"
+config ARDUINO_SELECTIVE_Networking
+    bool "Enable Networking"
     depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_FS
     default y
 
-config ARDUINO_SELECTIVE_SimpleBLE
-    bool "Enable SimpleBLE"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+config ARDUINO_SELECTIVE_ArduinoOTA
+    bool "Enable ArduinoOTA"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
+    select ARDUINO_SELECTIVE_ESPmDNS
     default y
 
-config ARDUINO_SELECTIVE_SPI
-    bool "Enable SPI"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+config ARDUINO_SELECTIVE_AsyncUDP
+    bool "Enable AsyncUDP"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
 
-config ARDUINO_SELECTIVE_SPIFFS
-    bool "Enable SPIFFS"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_FS
+config ARDUINO_SELECTIVE_DNSServer
+    bool "Enable DNSServer"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
 
-config ARDUINO_SELECTIVE_Ticker
-    bool "Enable Ticker"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+config ARDUINO_SELECTIVE_ESPmDNS
+    bool "Enable ESPmDNS"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
 
-config ARDUINO_SELECTIVE_Update
-    bool "Enable Update"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+config ARDUINO_SELECTIVE_HTTPClient
+    bool "Enable HTTPClient"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
+    select ARDUINO_SELECTIVE_WiFiClientSecure
+    default y
+
+config ARDUINO_SELECTIVE_NetBIOS
+    bool "Enable NetBIOS"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
 
 config ARDUINO_SELECTIVE_WebServer
     bool "Enable WebServer"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
     select ARDUINO_SELECTIVE_FS
 
 config ARDUINO_SELECTIVE_WiFi
     bool "Enable WiFi"
-    depends on ARDUINO_SELECTIVE_COMPILATION
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
 
 config ARDUINO_SELECTIVE_WiFiClientSecure
     bool "Enable WiFiClientSecure"
-    depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking
     default y
 
 config ARDUINO_SELECTIVE_WiFiProv
     bool "Enable WiFiProv"
+    depends on ARDUINO_SELECTIVE_COMPILATION && ARDUINO_SELECTIVE_Networking && ARDUINO_SELECTIVE_WiFi
+    default y
+
+config ARDUINO_SELECTIVE_BLE
+    bool "Enable BLE"
     depends on ARDUINO_SELECTIVE_COMPILATION
-    select ARDUINO_SELECTIVE_WiFi
     default y
 
-config ARDUINO_SELECTIVE_Wire
-    bool "Enable Wire"
+config ARDUINO_SELECTIVE_BluetoothSerial
+    bool "Enable BluetoothSerial"
     depends on ARDUINO_SELECTIVE_COMPILATION
     default y
 
+config ARDUINO_SELECTIVE_SimpleBLE
+    bool "Enable SimpleBLE"
+    depends on ARDUINO_SELECTIVE_COMPILATION
+    default y
 
 endmenu
 

docs/en/api/wifi.rst

@@ -345,7 +345,7 @@ Function to get the IPv6 address.
 
 .. code-block:: arduino
 
-    IPAddress softAPIPv6();
+    IPAddress softAPlinkLocalIPv6();
 
 The function will return the AP IPv6 address in ``IPAddress`` format.
 

libraries/ArduinoOTA/examples/BasicOTA/BasicOTA.ino

@@ -1,6 +1,6 @@
 #include <WiFi.h>
 #include <ESPmDNS.h>
-#include <WiFiUdp.h>
+#include <NetworkUdp.h>
 #include <ArduinoOTA.h>
 
 const char* ssid = "..........";

libraries/ArduinoOTA/src/ArduinoOTA.cpp

@@ -2,8 +2,8 @@
 #define LWIP_OPEN_SRC
 #endif
 #include <functional>
-#include <WiFiUdp.h>
 #include "ArduinoOTA.h"
+#include "NetworkClient.h"
 #include "ESPmDNS.h"
 #include "MD5Builder.h"
 #include "Update.h"
@@ -128,7 +128,7 @@ void ArduinoOTAClass::begin() {
     if (!_hostname.length()) {
         char tmp[20];
         uint8_t mac[6];
-        WiFi.macAddress(mac);
+        Network.macAddress(mac);
         sprintf(tmp, "esp32-%02x%02x%02x%02x%02x%02x", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
         _hostname = tmp;
     }
@@ -266,7 +266,7 @@ void ArduinoOTAClass::_runUpdate() {
         _progress_callback(0, _size);
     }
 
-    WiFiClient client;
+    NetworkClient client;
     if (!client.connect(_ota_ip, _ota_port)) {
         if (_error_callback) {
             _error_callback(OTA_CONNECT_ERROR);

libraries/ArduinoOTA/src/ArduinoOTA.h

@@ -1,9 +1,9 @@
 #ifndef __ARDUINO_OTA_H
 #define __ARDUINO_OTA_H
 
-#include <WiFi.h>
-#include <functional>
+#include "Network.h"
 #include "Update.h"
+#include <functional>
 
 #define INT_BUFFER_SIZE 16
 
@@ -86,7 +86,7 @@ class ArduinoOTAClass
     String _hostname;
     String _partition_label;
     String _nonce;
-    WiFiUDP _udp_ota;
+    NetworkUDP _udp_ota;
     bool _initialized;
     bool _rebootOnSuccess;
     bool _mdnsEnabled;

libraries/DNSServer/src/DNSServer.cpp

@@ -20,9 +20,13 @@ DNSServer::DNSServer(const String &domainName) : _port(DNS_DEFAULT_PORT), _ttl(h
 
 bool DNSServer::start(){
   if (_resolvedIP.operator uint32_t() == 0){    // no address is set, try to obtain AP interface's IP
+#if SOC_WIFI_SUPPORTED
     if (WiFi.getMode() & WIFI_AP){
       _resolvedIP = WiFi.softAPIP();
-    } else return false;              // won't run if WiFi is not in AP mode
+      return true;
+    }
+#endif
+    return false;              // won't run if WiFi is not in AP mode
   } 
 
   _udp.close();

libraries/ESP32/examples/Camera/CameraWebServer/app_httpd.cpp

@@ -26,13 +26,14 @@
 
 // Face Detection will not work on boards without (or with disabled) PSRAM
 #ifdef BOARD_HAS_PSRAM
-#define CONFIG_ESP_FACE_DETECT_ENABLED 1
 // Face Recognition takes upward from 15 seconds per frame on chips other than ESP32S3
 // Makes no sense to have it enabled for them
 #if CONFIG_IDF_TARGET_ESP32S3
 #define CONFIG_ESP_FACE_RECOGNITION_ENABLED 1
+#define CONFIG_ESP_FACE_DETECT_ENABLED 1
 #else
 #define CONFIG_ESP_FACE_RECOGNITION_ENABLED 0
+#define CONFIG_ESP_FACE_DETECT_ENABLED 0
 #endif
 #else
 #define CONFIG_ESP_FACE_DETECT_ENABLED 0