Fixing IPv6 support to correctly support link-local and global IPv6 addresses

Author: mathieucarbou

examples/NonBlockingCaptivePortal/NonBlockingCaptivePortal.ino

@@ -44,8 +44,9 @@ void setup() {
       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; });
+                return request->send(200, "text/plain", "Hello World!");
+              })
+          .setFilter([](__unused AsyncWebServerRequest* request) { return espConnect.getState() != Mycila::ESPConnect::State::PORTAL_STARTED; });
         server.begin();
         break;
 
@@ -58,7 +59,7 @@ void setup() {
     }
   });
 
-  espConnect.setConnectTimeout(20); // 20 seconds
+  espConnect.setConnectTimeout(20);       // 20 seconds
   espConnect.setCaptivePortalTimeout(40); // 30 seconds
   espConnect.setAutoRestart(true);
   espConnect.setBlocking(false);
@@ -70,6 +71,16 @@ void setup() {
   Serial.println("====> setup() completed...");
 }
 
+uint32_t last = 0;
+
 void loop() {
   espConnect.loop();
+
+  if (millis() - last > 5000) {
+    last = millis();
+    JsonDocument doc;
+    espConnect.toJson(doc.to<JsonObject>());
+    serializeJsonPretty(doc, Serial);
+    Serial.println();
+  }
 }

src/MycilaESPConnect.cpp

@@ -219,7 +219,27 @@ IPAddress Mycila::ESPConnect::getIPAddress(Mycila::ESPConnect::Mode mode) const
   }
 }
 
-IPAddress Mycila::ESPConnect::getIPv6Address(Mycila::ESPConnect::Mode mode) const {
+IPAddress Mycila::ESPConnect::getLinkLocalIPv6Address(Mycila::ESPConnect::Mode mode) const {
+#ifndef ESP8266
+  const wifi_mode_t wifiMode = WiFi.getMode();
+  switch (mode) {
+    case Mycila::ESPConnect::Mode::AP:
+      return IN6ADDR_ANY;
+    case Mycila::ESPConnect::Mode::STA:
+      return wifiMode == WIFI_MODE_STA ? WiFi.linkLocalIPv6() : IN6ADDR_ANY;
+  #ifdef ESPCONNECT_ETH_SUPPORT
+    case Mycila::ESPConnect::Mode::ETH:
+      return ETH.linkUp() ? ETH.linkLocalIPv6() : IN6ADDR_ANY;
+  #endif
+    default:
+      return IN6ADDR_ANY;
+  }
+#else
+  return IPAddress();
+#endif
+}
+
+IPAddress Mycila::ESPConnect::getGlobalIPv6Address(Mycila::ESPConnect::Mode mode) const {
 #ifndef ESP8266
   const wifi_mode_t wifiMode = WiFi.getMode();
   switch (mode) {
@@ -507,8 +527,12 @@ void Mycila::ESPConnect::clearConfiguration() {
 void Mycila::ESPConnect::toJson(const JsonObject& root) const {
   root["ip_address"] = getIPAddress().toString();
   root["ip_address_ap"] = getIPAddress(Mycila::ESPConnect::Mode::AP).toString();
-  root["ip_address_eth"] = getIPAddress(Mycila::ESPConnect::Mode::ETH).toString();
-  root["ip_address_sta"] = getIPAddress(Mycila::ESPConnect::Mode::STA).toString();
+  root["ip_address_eth_v4"] = getIPAddress(Mycila::ESPConnect::Mode::ETH).toString();
+  root["ip_address_sta_v4"] = getIPAddress(Mycila::ESPConnect::Mode::STA).toString();
+  root["ip_address_eth_v6_local"] = getLinkLocalIPv6Address(Mycila::ESPConnect::Mode::ETH).toString();
+  root["ip_address_sta_v6_local"] = getLinkLocalIPv6Address(Mycila::ESPConnect::Mode::STA).toString();
+  root["ip_address_eth_v6_global"] = getGlobalIPv6Address(Mycila::ESPConnect::Mode::ETH).toString();
+  root["ip_address_sta_v6_global"] = getGlobalIPv6Address(Mycila::ESPConnect::Mode::STA).toString();
   root["hostname"] = _config.hostname.c_str();
   root["mac_address"] = getMACAddress();
   root["mac_address_ap"] = getMACAddress(Mycila::ESPConnect::Mode::AP);
@@ -875,8 +899,12 @@ void Mycila::ESPConnect::_onWiFiEvent(WiFiEvent_t event) {
 
 #ifndef ESP8266
     case ARDUINO_EVENT_WIFI_STA_GOT_IP6:
-      if (WiFi.globalIPv6() != IN6ADDR_ANY) {
-        LOGD(TAG, "[%s] WiFiEvent: ARDUINO_EVENT_WIFI_STA_GOT_IP6: %s", getStateName(), WiFi.globalIPv6().toString().c_str());
+      if (WiFi.linkLocalIPv6() != IN6ADDR_ANY) {
+        if (WiFi.globalIPv6() == IN6ADDR_ANY) {
+          LOGD(TAG, "[%s] WiFiEvent: ARDUINO_EVENT_WIFI_STA_GOT_IP6: Link-local: %s, global: <empty>", getStateName(), WiFi.linkLocalIPv6().toString().c_str());
+        } else {
+          LOGD(TAG, "[%s] WiFiEvent: ARDUINO_EVENT_WIFI_STA_GOT_IP6: Link-local: %s, global: %s", getStateName(), WiFi.linkLocalIPv6().toString().c_str(), WiFi.globalIPv6().toString().c_str());
+        }
         if (_state == Mycila::ESPConnect::State::NETWORK_CONNECTING || _state == Mycila::ESPConnect::State::NETWORK_RECONNECTING) {
           _lastTime = -1;
           _setState(Mycila::ESPConnect::State::NETWORK_CONNECTED);

src/MycilaESPConnect.h

@@ -172,8 +172,11 @@ namespace Mycila {
       IPAddress getIPAddress() const { return getIPAddress(getMode()); }
       IPAddress getIPAddress(Mode mode) const;
 
-      IPAddress getIPv6Address() const { return getIPv6Address(getMode()); }
-      IPAddress getIPv6Address(Mode mode) const;
+      IPAddress getLinkLocalIPv6Address() const { return getLinkLocalIPv6Address(getMode()); }
+      IPAddress getLinkLocalIPv6Address(Mode mode) const;
+
+      IPAddress getGlobalIPv6Address() const { return getGlobalIPv6Address(getMode()); }
+      IPAddress getGlobalIPv6Address(Mode mode) const;
 
       // Returns the configured WiFi SSID or the configured SSID of the AP or captive portal, or empty if not available, depending on the current mode
       ESPCONNECT_STRING getWiFiSSID() const;