init captive portal

dberschauer · dberschauer · commit ce21dabeb56f · 2023-09-01T15:47:24.000+02:00
diff --git a/Firmware/RTK_Surveyor/Form.ino b/Firmware/RTK_Surveyor/Form.ino
@@ -11,6 +11,36 @@ Form.ino
 
 bool websocketConnected = false;
 
+class CaptiveRequestHandler : public AsyncWebHandler {
+public:
+  //https://en.wikipedia.org/wiki/Captive_portal
+  String urls[5] = {"/hotspot-detect.html", "/library/test/success.html", "/generate_204", "/ncsi.txt", "/check_network_status.txt"};
+  CaptiveRequestHandler() {}
+  virtual ~CaptiveRequestHandler() {}
+
+  bool canHandle(AsyncWebServerRequest *request){
+    for(int i = 0; i<5; i++){
+      if(request->url().equals(urls[i]))
+        return true;
+    }
+    return false;
+  }
+
+  //Provide a custom small site for redirecting the user to the config site
+  //HTTP redirect does not work and the relative links on the default config site do not work, because the phone is requesting a different server
+  void handleRequest(AsyncWebServerRequest *request) {
+    String logmessage = "Captive Portal Client:" + request->client()->remoteIP().toString() + " " + request->url();
+    systemPrintln(logmessage);
+    AsyncResponseStream *response = request->beginResponseStream("text/html");
+    response->print("<!DOCTYPE html><html><head><title>RTK Config</title></head><body>");
+    response->print("<div class='container'>");
+    response->printf("<div align='center' class='col-sm-12'><img src='http://%s/src/rtk-setup.png' alt='SparkFun RTK WiFi Setup'></div>", WiFi.softAPIP().toString().c_str());
+    response->printf("<div align='center'><h3>Configure your RTK receiver <a href='http://%s/'>here</a></h3></div>", WiFi.softAPIP().toString().c_str());
+    response->print("</div></body></html>");
+    request->send(response);
+  }
+};
+
 // Start webserver in AP mode
 bool startWebServer(bool startWiFi = true, int httpPort = 80)
 {
@@ -62,6 +92,7 @@ bool startWebServer(bool startWiFi = true, int httpPort = 80)
         }
 
         websocket->onEvent(onWsEvent);
+        webserver->addHandler(new CaptiveRequestHandler()).setFilter(ON_AP_FILTER);//only when requested from AP
         webserver->addHandler(websocket);
 
         // * index.html (not gz'd)
diff --git a/Firmware/RTK_Surveyor/RTK_Surveyor.ino b/Firmware/RTK_Surveyor/RTK_Surveyor.ino
@@ -221,6 +221,7 @@ unsigned int binBytesSent = 0;         // Tracks firmware bytes sent over WiFi O
 #include <WiFi.h>             //Built-in.
 #include <WiFiClientSecure.h> //Built-in.
 #include <WiFiMulti.h>        //Built-in.
+#include <DNSServer.h>        //Built-in.
 
 #include "esp_wifi.h" //Needed for esp_wifi_set_protocol()
 
diff --git a/Firmware/RTK_Surveyor/WiFi.ino b/Firmware/RTK_Surveyor/WiFi.ino
@@ -60,6 +60,10 @@ static unsigned long wifiDisplayTimer;
 // Last time the WiFi state was displayed
 static uint32_t lastWifiState;
 
+//DNS server for Captive Portal
+static DNSServer dnsServer;
+
+
 //----------------------------------------
 // WiFi Routines
 //----------------------------------------
@@ -242,6 +246,12 @@ bool wifiStartAP()
         }
         systemPrint("WiFi AP Started with IP: ");
         systemPrintln(WiFi.softAPIP());
+        
+        // Start DNS Server
+        if(dnsServer.start(53, "*", WiFi.softAPIP()) == false){
+            systemPrintln("WiFi DNS Server failed to start");
+            return (false);
+        };
     }
     else
     {
@@ -355,6 +365,9 @@ void wifiUpdate()
             wifiStop();
         break;
     }
+    //Process the next DNS request
+    dnsServer.processNextRequest();
+
 }
 
 // Starts the WiFi connection state machine (moves from WIFI_OFF to WIFI_CONNECTING)
@@ -407,6 +420,9 @@ void wifiStop()
         systemPrintln("TCP Server offline");
     }
 
+    //Stop the DNS server
+    dnsServer.stop();
+
     // Stop the other network clients and then WiFi
     networkStop(NETWORK_TYPE_WIFI);
 }

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,10 @@ static unsigned long wifiDisplayTimer;`
`60`	`60`	`// Last time the WiFi state was displayed`
`61`	`61`	`static uint32_t lastWifiState;`
`62`	`62`
	`63`	`+//DNS server for Captive Portal`
	`64`	`+static DNSServer dnsServer;`
	`65`	`+`
	`66`	`+`
`63`	`67`	`//----------------------------------------`
`64`	`68`	`// WiFi Routines`
`65`	`69`	`//----------------------------------------`
`@@ -242,6 +246,12 @@ bool wifiStartAP()`
`242`	`246`	`}`
`243`	`247`	`systemPrint("WiFi AP Started with IP: ");`
`244`	`248`	`systemPrintln(WiFi.softAPIP());`
	`249`	`+`
	`250`	`+ // Start DNS Server`
	`251`	`+ if(dnsServer.start(53, "*", WiFi.softAPIP()) == false){`
	`252`	`+ systemPrintln("WiFi DNS Server failed to start");`
	`253`	`+ return (false);`
	`254`	`+ };`
`245`	`255`	`}`
`246`	`256`	`else`
`247`	`257`	`{`
`@@ -355,6 +365,9 @@ void wifiUpdate()`
`355`	`365`	`wifiStop();`
`356`	`366`	`break;`
`357`	`367`	`}`
	`368`	`+ //Process the next DNS request`
	`369`	`+ dnsServer.processNextRequest();`
	`370`	`+`
`358`	`371`	`}`
`359`	`372`
`360`	`373`	`// Starts the WiFi connection state machine (moves from WIFI_OFF to WIFI_CONNECTING)`
`@@ -407,6 +420,9 @@ void wifiStop()`
`407`	`420`	`systemPrintln("TCP Server offline");`
`408`	`421`	`}`
`409`	`422`
	`423`	`+ //Stop the DNS server`
	`424`	`+ dnsServer.stop();`
	`425`	`+`
`410`	`426`	`// Stop the other network clients and then WiFi`
`411`	`427`	`networkStop(NETWORK_TYPE_WIFI);`
`412`	`428`	`}`