Ethernet support

Author: mathieucarbou

.github/workflows/ci.yml

@@ -75,7 +75,7 @@ jobs:
         run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/mathieucarbou/esphome-AsyncTCP#v2.1.1
 
       - name: Install ESP Async WebServer
-        run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/mathieucarbou/ESPAsyncWebServer
+        run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/mathieucarbou/ESPAsyncWebServer#v2.7.0
 
       - name: Build BlockingCaptivePortal
         run: arduino-cli compile --library . --warnings all -b ${{ matrix.board }} "examples/BlockingCaptivePortal/BlockingCaptivePortal.ino"
@@ -98,6 +98,10 @@ jobs:
             board: esp32dev
             eeprom: true
             softwareserial: false
+          - platform: espressif32
+            board: wt32-eth01
+            eeprom: true
+            softwareserial: false
 
     steps:
       - name: Checkout

README.md

@@ -4,13 +4,13 @@
 [![Continuous Integration](https://github.com/mathieucarbou/MycilaESPConnect/actions/workflows/ci.yml/badge.svg)](https://github.com/mathieucarbou/MycilaESPConnect/actions/workflows/ci.yml)
 [![PlatformIO Registry](https://badges.registry.platformio.org/packages/mathieucarbou/library/MycilaESPConnect.svg)](https://registry.platformio.org/libraries/mathieucarbou/MycilaESPConnect)
 
------
+---
 
 Simple & Easy WiFi Manager with Captive Portal for ESP32
 
 A simplistic approach to a WiFi Manager on ESP32 MCUs. Comes with captive portal to configure modules without any hassle.
 
------
+---
 
 > This fork is based on [https://github.com/ayushsharma82/ESPConnect](https://github.com/ayushsharma82/ESPConnect).
 > I highly recommend looking at all OSS projects (and products) from [@ayushsharma82](https://github.com/ayushsharma82).
@@ -34,4 +34,26 @@ A simplistic approach to a WiFi Manager on ESP32 MCUs. Comes with captive portal
 
 - **mDNS / DNS Support**
 
-See the examples and API for more !
+- **Ethernet support**
+
+## Ethernet Support
+
+Compile with `-D CONFIG_ETH_ENABLED` ([ref](https://community.platformio.org/t/please-help-me-fix-error-wifi-h-when-build-project-ethernet-testing-use-esp32-eth01/37573/3))
+
+For wt32-eth01, alo use the following flags:
+
+```cpp
+  -D ESPCONNECT_ETH_RESET_ON_START
+  -D ETH_PHY_TYPE=ETH_PHY_LAN8720
+  -D ETH_PHY_ADDR=1
+  -D ETH_PHY_MDC=23
+  -D ETH_PHY_MDIO=18
+  -D ETH_CLK_MODE=ETH_CLOCK_GPIO0_IN
+  -D ETH_PHY_POWER=16
+```
+
+In your application, if Ethernet is allowed, call `ESPConnect.allowEthernet()`.
+
+- Ethernet takes precedence over WiFi, but you can have both connected at the same time
+- Ethernet takes precedence over Captive Portal: if it is running and you connect an Ethernet cable, the Captive Portal will be closed
+- Ethernet _does not_ take precedence over AP Mode: if AP mode is configured, then Ethernet won't be started even if a cable is connected

docs/index.md

@@ -4,13 +4,13 @@
 [![Continuous Integration](https://github.com/mathieucarbou/MycilaESPConnect/actions/workflows/ci.yml/badge.svg)](https://github.com/mathieucarbou/MycilaESPConnect/actions/workflows/ci.yml)
 [![PlatformIO Registry](https://badges.registry.platformio.org/packages/mathieucarbou/library/MycilaESPConnect.svg)](https://registry.platformio.org/libraries/mathieucarbou/MycilaESPConnect)
 
------
+---
 
 Simple & Easy WiFi Manager with Captive Portal for ESP32
 
 A simplistic approach to a WiFi Manager on ESP32 MCUs. Comes with captive portal to configure modules without any hassle.
 
------
+---
 
 > This fork is based on [https://github.com/ayushsharma82/ESPConnect](https://github.com/ayushsharma82/ESPConnect).
 > I highly recommend looking at all OSS projects (and products) from [@ayushsharma82](https://github.com/ayushsharma82).
@@ -34,4 +34,26 @@ A simplistic approach to a WiFi Manager on ESP32 MCUs. Comes with captive portal
 
 - **mDNS / DNS Support**
 
-See the examples and API for more !
+- **Ethernet support**
+
+## Ethernet Support
+
+Compile with `-D CONFIG_ETH_ENABLED` ([ref](https://community.platformio.org/t/please-help-me-fix-error-wifi-h-when-build-project-ethernet-testing-use-esp32-eth01/37573/3))
+
+For wt32-eth01, alo use the following flags:
+
+```cpp
+  -D ESPCONNECT_ETH_RESET_ON_START
+  -D ETH_PHY_TYPE=ETH_PHY_LAN8720
+  -D ETH_PHY_ADDR=1
+  -D ETH_PHY_MDC=23
+  -D ETH_PHY_MDIO=18
+  -D ETH_CLK_MODE=ETH_CLOCK_GPIO0_IN
+  -D ETH_PHY_POWER=16
+```
+
+In your application, if Ethernet is allowed, call `ESPConnect.allowEthernet()`.
+
+- Ethernet takes precedence over WiFi, but you can have both connected at the same time
+- Ethernet takes precedence over Captive Portal: if it is running and you connect an Ethernet cable, the Captive Portal will be closed
+- Ethernet _does not_ take precedence over AP Mode: if AP mode is configured, then Ethernet won't be started even if a cable is connected

examples/AdvancedCaptivePortal/AdvancedCaptivePortal.ino

@@ -37,33 +37,31 @@ void setup() {
 
   // network state listener is required here in async mode
   ESPConnect.listen([](ESPConnectState previous, ESPConnectState state) {
-    Serial.printf("NetworkState: %s => %s\n", ESPConnect.getStateName(previous), ESPConnect.getStateName(state));
-
     JsonDocument doc;
     ESPConnect.toJson(doc.to<JsonObject>());
-    serializeJson(doc, Serial);
+    serializeJsonPretty(doc, Serial);
     Serial.println();
 
     switch (state) {
-      case ESPConnectState::STA_CONNECTED:
-      case ESPConnectState::AP_CONNECTED:
+      case ESPConnectState::NETWORK_CONNECTED:
+      case ESPConnectState::AP_STARTED:
         server.begin();
         MDNS.addService("http", "tcp", 80);
         break;
 
-      case ESPConnectState::STA_DISCONNECTED:
+      case ESPConnectState::NETWORK_DISCONNECTED:
         server.end();
         mdns_service_remove("_http", "_tcp");
         break;
 
       case ESPConnectState::PORTAL_COMPLETE:
-        config.apMode = ESPConnect.isAPMode();
+        config.apMode = ESPConnect.hasConfiguredAPMode();
         if (config.apMode) {
           Serial.println("====> Captive Portal: Access Point configured");
         } else {
           Serial.println("====> Captive Portal: WiFi configured");
-          config.wifiSSID = ESPConnect.getWiFiSSIDConfigured();
-          config.wifiPassword = ESPConnect.getWiFiPassword();
+          config.wifiSSID = ESPConnect.getConfiguredWiFiSSID();
+          config.wifiPassword = ESPConnect.getConfiguredWiFiPassword();
         }
         // SAVE config somewhere
         break;
@@ -73,10 +71,11 @@ void setup() {
     }
   });
 
+  ESPConnect.allowEthernet();
   ESPConnect.setAutoRestart(true);
   ESPConnect.setBlocking(false);
   ESPConnect.setCaptivePortalTimeout(180);
-  ESPConnect.setWiFiConnectTimeout(10);
+  ESPConnect.setConnectTimeout(10);
 
   Serial.println("====> Load config from elsewhere...");
   config.wifiSSID = "arduino";

examples/BlockingCaptivePortal/BlockingCaptivePortal.ino

@@ -1,6 +1,7 @@
 #include <MycilaESPConnect.h>
 
 AsyncWebServer server(80);
+uint32_t lastLog = 0;
 
 void setup() {
   Serial.begin(115200);
@@ -32,17 +33,17 @@ void setup() {
 
   // network state listener
   ESPConnect.listen([](ESPConnectState previous, ESPConnectState state) {
-    Serial.printf("NetworkState: %s => %s\n", ESPConnect.getStateName(previous), ESPConnect.getStateName(state));
     JsonDocument doc;
     ESPConnect.toJson(doc.to<JsonObject>());
-    serializeJson(doc, Serial);
+    serializeJsonPretty(doc, Serial);
     Serial.println();
   });
 
+  ESPConnect.allowEthernet();
   ESPConnect.setAutoRestart(true);
   ESPConnect.setBlocking(true);
   ESPConnect.setCaptivePortalTimeout(180);
-  ESPConnect.setWiFiConnectTimeout(10);
+  ESPConnect.setConnectTimeout(10);
 
   Serial.println("Trying to connect to saved WiFi or will start portal...");
 
@@ -55,4 +56,12 @@ void setup() {
 
 void loop() {
   ESPConnect.loop();
+
+  if (millis() - lastLog > 5000) {
+    JsonDocument doc;
+    ESPConnect.toJson(doc.to<JsonObject>());
+    serializeJson(doc, Serial);
+    Serial.println();
+    lastLog = millis();
+  }
 }

examples/NonBlockingCaptivePortal/NonBlockingCaptivePortal.ino

@@ -2,6 +2,7 @@
 #include <MycilaESPConnect.h>
 
 AsyncWebServer server(80);
+uint32_t lastLog = 0;
 
 void setup() {
   Serial.begin(115200);
@@ -34,32 +35,31 @@ void setup() {
 
   // network state listener is required here in async mode
   ESPConnect.listen([](ESPConnectState previous, ESPConnectState state) {
-    Serial.printf("NetworkState: %s => %s\n", ESPConnect.getStateName(previous), ESPConnect.getStateName(state));
     JsonDocument doc;
     ESPConnect.toJson(doc.to<JsonObject>());
-    serializeJson(doc, Serial);
+    serializeJsonPretty(doc, Serial);
     Serial.println();
 
     switch (state) {
-      case ESPConnectState::STA_CONNECTED:
-      case ESPConnectState::AP_CONNECTED:
+      case ESPConnectState::NETWORK_CONNECTED:
+      case ESPConnectState::AP_STARTED:
         server.begin();
         MDNS.addService("http", "tcp", 80);
         break;
 
-      case ESPConnectState::STA_DISCONNECTED:
+      case ESPConnectState::NETWORK_DISCONNECTED:
         server.end();
         mdns_service_remove("_http", "_tcp");
-
       default:
         break;
     }
   });
 
+  ESPConnect.allowEthernet();
   ESPConnect.setAutoRestart(true);
   ESPConnect.setBlocking(false);
   ESPConnect.setCaptivePortalTimeout(180);
-  ESPConnect.setWiFiConnectTimeout(10);
+  ESPConnect.setConnectTimeout(10);
 
   Serial.println("====> Trying to connect to saved WiFi or will start portal in the background...");
 
@@ -70,4 +70,12 @@ void setup() {
 
 void loop() {
   ESPConnect.loop();
+
+  if (millis() - lastLog > 5000) {
+    JsonDocument doc;
+    ESPConnect.toJson(doc.to<JsonObject>());
+    serializeJson(doc, Serial);
+    Serial.println();
+    lastLog = millis();
+  }
 }

library.json

@@ -29,13 +29,13 @@
     {
       "owner": "mathieucarbou",
       "name": "ESP Async WebServer",
-      "version": "^2.4.4",
+      "version": "^2.7.0",
       "platforms": "espressif32"
     },
     {
       "owner": "bblanchon",
       "name": "ArduinoJson",
-      "version": "^7.0.2",
+      "version": "^7.0.3",
       "platforms": [
         "espressif32"
       ]

platformio.ini

@@ -1,25 +1,44 @@
+
 [env]
+platform = [email protected]
+framework = arduino
+
 lib_deps = 
-  bblanchon/ArduinoJson @ 7.0.2
+  bblanchon/ArduinoJson @ 7.0.3
   mathieucarbou/ESP Async WebServer @ 2.4.4
 
-build_flags = -Wall -Wextra
+build_flags =
+  -Wall
+  -Wextra
+  -D CONFIG_ARDUHAL_LOG_COLORS
+  -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG
 
 upload_protocol = esptool
-upload_port = /dev/cu.usbserial-0001
+; upload_port = /dev/cu.usbserial-0001
+; upload_port = /dev/cu.usbserial-10
 
-monitor_port = /dev/cu.usbserial-0001
+; monitor_port = /dev/cu.usbserial-0001
+; monitor_port = /dev/cu.usbserial-10
 monitor_speed = 115200
 monitor_filters = esp32_exception_decoder, log2file
 
 [platformio]
+default_envs = wt32-eth01
 lib_dir = .
-; src_dir = examples/BlockingCaptivePortal
+src_dir = examples/BlockingCaptivePortal
 ; src_dir = examples/NonBlockingCaptivePortal
-src_dir = examples/AdvancedCaptivePortal
-
+; src_dir = examples/AdvancedCaptivePortal
 
 [env:esp32]
-platform = [email protected]
 board = esp32dev
-framework = arduino
+
+[env:wt32-eth01]
+board = wt32-eth01
+build_flags = ${env.build_flags}
+  -D ESPCONNECT_ETH_RESET_ON_START
+  -D ETH_PHY_TYPE=ETH_PHY_LAN8720
+  -D ETH_PHY_ADDR=1
+  -D ETH_PHY_MDC=23
+  -D ETH_PHY_MDIO=18
+  -D ETH_CLK_MODE=ETH_CLOCK_GPIO0_IN
+  -D ETH_PHY_POWER=16