mathieucarbou · mathieucarbou · Aug 11, 2024 · Aug 11, 2024
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ He is making great Arduino libraries.
 - **Ethernet support**
 - **Ready for Arduino 3 (ESP-IDF 5.1)**
 - **ESP8266 support** (except for Ethernet)
+- **Supports Static IP configuration**
 
 ## Usage
 
@@ -92,6 +93,19 @@ void loop() {
 }
 ```
 
+### Set static IP
+
+```cpp
+Mycila::ESPConnect::IPConfig ipConfig;
+
+ipConfig.ip.fromString("192.168.125.99");
+ipConfig.gateway.fromString("192.168.125.1");
+ipConfig.subnet.fromString("255.255.255.0");
+ipConfig.dns.fromString("192.168.125.1");
+
+espConnect.setIPConfig(ipConfig);
+```
+
 ### Use an external configuration system
 
 ```cpp

diff --git a/docs/index.md b/docs/index.md
@@ -34,6 +34,7 @@ He is making great Arduino libraries.
 - **Ethernet support**
 - **Ready for Arduino 3 (ESP-IDF 5.1)**
 - **ESP8266 support** (except for Ethernet)
+- **Supports Static IP configuration**
 
 ## Usage
 
@@ -92,6 +93,19 @@ void loop() {
 }
 ```
 
+### Set static IP
+
+```cpp
+Mycila::ESPConnect::IPConfig ipConfig;
+
+ipConfig.ip.fromString("192.168.125.99");
+ipConfig.gateway.fromString("192.168.125.1");
+ipConfig.subnet.fromString("255.255.255.0");
+ipConfig.dns.fromString("192.168.125.1");
+
+espConnect.setIPConfig(ipConfig);
+```
+
 ### Use an external configuration system
 
 ```cpp

diff --git a/examples/AdvancedCaptivePortal/AdvancedCaptivePortal.ino b/examples/AdvancedCaptivePortal/AdvancedCaptivePortal.ino
@@ -94,5 +94,4 @@ void setup() {
 
 void loop() {
   espConnect.loop();
-  delay(100);
 }
diff --git a/examples/WiFiStaticIP/WiFiStaticIP.ino b/examples/WiFiStaticIP/WiFiStaticIP.ino
@@ -0,0 +1,84 @@
+#include <MycilaESPConnect.h>
+
+AsyncWebServer server(80);
+Mycila::ESPConnect espConnect(server);
+uint32_t lastLog = 0;
+uint32_t lastChange = 0;
+String hostname = "arduino-1";
+
+void setup() {
+  Serial.begin(115200);
+  while (!Serial)
+    continue;
+
+  server.on("/clear", HTTP_GET, [&](AsyncWebServerRequest* request) {
+    Serial.println("Clearing configuration...");
+    espConnect.clearConfiguration();
+    request->send(200);
+    ESP.restart();
+  });
+
+  // network state listener is required here in async mode
+  espConnect.listen([](__unused Mycila::ESPConnect::State previous, Mycila::ESPConnect::State state) {
+    JsonDocument doc;
+    espConnect.toJson(doc.to<JsonObject>());
+    serializeJson(doc, Serial);
+    Serial.println();
+
+    switch (state) {
+      case Mycila::ESPConnect::State::NETWORK_CONNECTED:
+      case Mycila::ESPConnect::State::AP_STARTED:
+        // serve your home page here
+        server.on("/", HTTP_GET, [&](AsyncWebServerRequest* request) {
+                return request->send(200, "text/plain", "Hello World!");
+              })
+          .setFilter([](__unused AsyncWebServerRequest* request) { return espConnect.getState() != Mycila::ESPConnect::State::PORTAL_STARTED; });
+        server.begin();
+        break;
+
+      case Mycila::ESPConnect::State::NETWORK_DISCONNECTED:
+        server.end();
+        break;
+
+      default:
+        break;
+    }
+  });
+
+  espConnect.setAutoRestart(true);
+  espConnect.setBlocking(false);
+
+  Serial.println("====> Trying to connect to saved WiFi or will start portal in the background...");
+
+  espConnect.begin(hostname.c_str(), "Captive Portal SSID");
+
+  Serial.println("====> setup() completed...");
+}
+
+void loop() {
+  espConnect.loop();
+
+  uint32_t now = millis();
+
+  if (now - lastLog > 3000) {
+    JsonDocument doc;
+    espConnect.toJson(doc.to<JsonObject>());
+    serializeJson(doc, Serial);
+    Serial.println();
+    lastLog = millis();
+  }
+
+  if (now - lastChange > 10000) {
+    if (espConnect.getIPConfig().ip == INADDR_NONE) {
+      Mycila::ESPConnect::IPConfig ipConfig;
+      ipConfig.ip.fromString("192.168.125.99");
+      ipConfig.gateway.fromString("192.168.125.1");
+      ipConfig.subnet.fromString("255.255.255.0");
+      ipConfig.dns.fromString("192.168.125.1");
+      espConnect.setIPConfig(ipConfig);
+    } else {
+      espConnect.setIPConfig(Mycila::ESPConnect::IPConfig());
+    }
+    lastChange = millis();
+  }
+}
diff --git a/platformio.ini b/platformio.ini
@@ -20,9 +20,10 @@ monitor_filters = esp32_exception_decoder, log2file
 [platformio]
 lib_dir = .
 ; src_dir = examples/BlockingCaptivePortal
-src_dir = examples/NonBlockingCaptivePortal
+; src_dir = examples/NonBlockingCaptivePortal
 ; src_dir = examples/AdvancedCaptivePortal
 ; src_dir = examples/TestWiFi8266
+src_dir = examples/WiFiStaticIP
 
 ; esp8266
 

diff --git a/src/MycilaESPConnect.cpp b/src/MycilaESPConnect.cpp
@@ -219,9 +219,9 @@ const String Mycila::ESPConnect::getWiFiSSID() const {
   switch (WiFi.getMode()) {
     case WIFI_MODE_AP:
     case WIFI_MODE_APSTA:
-      return WiFi.softAPSSID();
+      return _apSSID;
     case WIFI_MODE_STA:
-      return WiFi.SSID();
+      return _config.wifiSSID;
     default:
       return emptyString;
   }
@@ -386,6 +386,18 @@ void Mycila::ESPConnect::loop() {
   }
 }
 
+void Mycila::ESPConnect::setIPConfig(const IPConfig& ipConfig) {
+  _ipConfig = ipConfig;
+
+#ifdef ESPCONNECT_ETH_SUPPORT
+  LOGI(TAG, "Changing Ethernet IP Configuration...");
+  ETH.config(_ipConfig.ip, _ipConfig.gateway, _ipConfig.subnet, _ipConfig.dns);
+#else
+  LOGI(TAG, "Changing WiFi IP Configuration...");
+  WiFi.config(_ipConfig.ip, _ipConfig.gateway, _ipConfig.subnet, _ipConfig.dns);
+#endif
+}
+
 void Mycila::ESPConnect::clearConfiguration() {
   Preferences preferences;
   preferences.begin("espconnect", false);
@@ -454,27 +466,28 @@ void Mycila::ESPConnect::_startEthernet() {
   #endif
 
   LOGI(TAG, "Starting Ethernet...");
+  bool success = true;
+
   #if defined(ESPCONNECT_ETH_SPI_SUPPORT)
     #if ESP_IDF_VERSION_MAJOR >= 5
   // https://github.com/espressif/arduino-esp32/tree/master/libraries/Ethernet/examples
   SPI.begin(ETH_PHY_SPI_SCK, ETH_PHY_SPI_MISO, ETH_PHY_SPI_MOSI);
-  if (!ETH.begin(ETH_PHY_TYPE, ETH_PHY_ADDR, ETH_PHY_CS, ETH_PHY_IRQ, ETH_PHY_RST, SPI)) {
-    LOGE(TAG, "ETH failed to start!");
-  }
+  success = ETH.begin(ETH_PHY_TYPE, ETH_PHY_ADDR, ETH_PHY_CS, ETH_PHY_IRQ, ETH_PHY_RST, SPI);
     #else
-  if (!ETH.beginSPI(ETH_PHY_SPI_MISO, ETH_PHY_SPI_MOSI, ETH_PHY_SPI_SCK, ETH_PHY_CS, ETH_PHY_RST, ETH_PHY_IRQ)) {
-    LOGE(TAG, "ETH failed to start!");
-  }
+  success = ETH.beginSPI(ETH_PHY_SPI_MISO, ETH_PHY_SPI_MOSI, ETH_PHY_SPI_SCK, ETH_PHY_CS, ETH_PHY_RST, ETH_PHY_IRQ);
     #endif
   #else
-  if (!ETH.begin()) {
+  success = ETH.begin();
+  #endif
+
+  if (success) {
+    LOGD(TAG, "ETH started.");
+    ETH.config(_ipConfig.ip, _ipConfig.gateway, _ipConfig.subnet, _ipConfig.dns);
+  } else {
     LOGE(TAG, "ETH failed to start!");
   }
-  #endif
 
   _lastTime = millis();
-
-  LOGD(TAG, "ETH started.");
 }
 #endif
 
@@ -489,6 +502,10 @@ void Mycila::ESPConnect::_startSTA() {
   WiFi.setAutoReconnect(true);
   WiFi.mode(WIFI_STA);
 
+#ifndef ESPCONNECT_ETH_SUPPORT
+  WiFi.config(_ipConfig.ip, _ipConfig.gateway, _ipConfig.subnet, _ipConfig.dns);
+#endif
+
   LOGD(TAG, "Connecting to SSID: %s...", _config.wifiSSID.c_str());
   WiFi.begin(_config.wifiSSID, _config.wifiPassword);
 
@@ -633,7 +650,7 @@ void Mycila::ESPConnect::_enableCaptivePortal() {
 
   if (_homeHandler == nullptr) {
     _homeHandler = &_httpd->on("/", HTTP_GET, [](AsyncWebServerRequest* request) {
-      AsyncWebServerResponse *response = request->beginResponse(200, "text/html", ESPCONNECT_HTML, sizeof(ESPCONNECT_HTML));
+      AsyncWebServerResponse* response = request->beginResponse(200, "text/html", ESPCONNECT_HTML, sizeof(ESPCONNECT_HTML));
       response->addHeader("Content-Encoding", "gzip");
       return request->send(response);
     });

diff --git a/src/MycilaESPConnect.h b/src/MycilaESPConnect.h
@@ -81,6 +81,16 @@ namespace Mycila {
 
       typedef std::function<void(State previous, State state)> StateCallback;
 
+      typedef struct {
+          // Static IP address to use when connecting to WiFi (STA mode) or Ethernet
+          // If not set, DHCP will be used
+          IPAddress ip = INADDR_NONE;
+          // Subnet mask: 255.255.255.0
+          IPAddress subnet = INADDR_NONE;
+          IPAddress gateway = INADDR_NONE;
+          IPAddress dns = INADDR_NONE;
+      } IPConfig;
+
       typedef struct {
           // SSID name to connect to, loaded from config or set from begin(), or from the captive portal
           String wifiSSID;
@@ -166,6 +176,12 @@ namespace Mycila {
       // whether we need to set the ESP to stay in AP mode or not, loaded from config, begin(), or from captive portal
       bool hasConfiguredAPMode() const { return _config.apMode; }
 
+      // IP configuration used for WiFi or ETH
+      const IPConfig& getIPConfig() const { return _ipConfig; }
+      // Static IP configuration: by default, DHCP is used
+      // The static IP configuration applies to the WiFi STA connection, except if ETH is used for ETH board, then it applies only to the Ethernet connection.
+      void setIPConfig(const IPConfig& ipConfig);
+
       // Maximum duration that the captive portal will be active before closing
       uint32_t getCaptivePortalTimeout() const { return _portalTimeout; }
       // Maximum duration that the captive portal will be active before closing
@@ -205,6 +221,7 @@ namespace Mycila {
       uint32_t _scanStart = 0;
       uint32_t _scanTimeout = ESPCONNECT_PORTAL_SCAN_TIMEOUT;
       Config _config;
+      IPConfig _ipConfig;
 #ifndef ESP8266
       WiFiEventId_t _wifiEventListenerId = 0;
 #endif