Add ESP8266 support

Should fully work except for IPv6 address printing.
Requires platformio/platform-espressif8266#267
to build.

Updating using OTA on ESP8266 causes an exception, but that seems to be
a general problem with mDNS.
It still works, it just spams the Serial console.

Author: ToMe25

README.md

@@ -1,5 +1,6 @@
 # ESP Wake on Lan
-ESP Wake on Lan is a simple web interface on an ESP32 to send Wake on Lan Magic Packets.  
+ESP Wake on Lan is a simple web interface on an ESP32/ESP8266 to send Wake on Lan Magic Packets.
+
 The MAC address of the device to wake up can be selected from a list of specified devices, or manually entered.  
 The default list of devices to wake up is an external file that is compiled into the project.  
 Manually entered MAC addresses are added to the dropdown, however they are lost when the ESP restarts.  
@@ -12,7 +13,7 @@ This is how the web interface looks:
 
 ## Requirements
  1. A system with a working [platform io](https://platformio.org/) installation.
- 2. A ESP32 board, tested only with the ESP32-devkitc, but should work with others.
+ 2. A ESP32 or ESP8266 board, tested only with the ESP32-DevKitC and ESP8266-DevKitC but should work with others.
 
 ## Installation
  * Create a file called `wifissid.txt` in the root folder of this project, containing your wifi ssid.
@@ -24,5 +25,5 @@ This is how the web interface looks:
  * An example can be seen in `devices.example`.
  * Empty lines in this file are ignored.
  * Attach your ESP to your PC.
- * Run `pio run -t upload -e esp32dev` to compile this project and flash it to your ESP.
- * To later update it over WiFi run `pio ron -t upload -e ota`.
+ * Run `pio run -t upload -e esp32dev` to compile this project and flash it to your ESP32 or `pio run -t upload -e esp_wroom_02` for ESP8266.
+ * To later update it over WiFi run `pio ron -t upload -e esp32dev_ota` for ESP32 or `pio run -t upload -e esp_wroom_02_ota` for ESP8266.

TODO.md

@@ -3,3 +3,4 @@
  * Add basic unit test(s)
  * Add persistent config
  * Ping device to check successful start?
+ * Make ESP8266 print ipv6 addr if supported

lib/WakeOnLanGenerator/WakeOnLanGenerator.h

@@ -12,8 +12,13 @@
 #define LIB_WAKEONLANGENERATOR_H_
 
 #include <regex>
+#ifdef ESP32
 #include <WiFi.h>
 #include <AsyncUDP.h>
+#elif defined(ESP8266)
+#include <ESP8266WiFi.h>
+#include <ESPAsyncUDP.h>
+#endif
 
 static const std::regex MAC_REGEX(
 		"[a-fA-F0-9]{2}:[a-fA-F0-9]{2}:[a-fA-F0-9]{2}:[a-fA-F0-9]{2}:[a-fA-F0-9]{2}:[a-fA-F0-9]{2}");

platformio.ini

@@ -8,14 +8,10 @@
 ; Please visit documentation for the other options and examples
 ; https://docs.platformio.org/page/projectconf.html
 
-[env:esp32dev]
-platform = espressif32
-board = esp32dev
+[env]
 framework = arduino
 monitor_speed = 115200
 upload_speed = 921600
-lib_deps = 
-	me-no-dev/ESP Async WebServer@^1.2.3
 board_build.embed_txtfiles = 
 	wifissid.txt
 	wifipass.txt
@@ -26,8 +22,27 @@ board_build.embed_txtfiles =
 	src/html/main.css
 	src/html/not_found.html
 
-[env:ota]
+[env:esp32dev]
+platform = espressif32
+board = esp32dev
+lib_deps = 
+	me-no-dev/ESP Async WebServer@^1.2.3
+
+[env:esp32dev_ota]
 extends = env:esp32dev
 upload_protocol = espota
 upload_port = esp-wol.local
 extra_scripts = post:read_ota_pass.py
+
+[env:esp_wroom_02]
+platform = espressif8266
+board = esp_wroom_02
+lib_deps = 
+	me-no-dev/ESPAsyncUDP
+	me-no-dev/ESP Async WebServer@^1.2.3
+
+[env:esp_wroom_02_ota]
+extends = env:esp_wroom_02
+upload_protocol = espota
+upload_port = esp-wol.local
+extra_scripts = post:read_ota_pass.py

read_ota_pass.py

@@ -14,6 +14,7 @@ def main():
     with open(input) as f:
         password = f.readline()
 
+    password = password.strip('\00')
     env.Append(UPLOADERFLAGS=["-a", password])
 
 main()

src/NetworkHandler.cpp

@@ -13,12 +13,14 @@
 #include <regex>
 #include <sstream>
 #include <ArduinoOTA.h>
+#ifdef ESP32
 #include <ESPmDNS.h>
+#elif defined(ESP8266)
+#include <ESP8266mDNS.h>
+#endif
 
-IPAddress NetworkHandler::localhost = IPADDR_NONE;
-IPv6Address NetworkHandler::localhost_ipv6;
+IPAddress NetworkHandler::localhost = IPADDR_ANY;
 AsyncWebServer NetworkHandler::webServer(WEBSERVER_PORT);
-std::string NetworkHandler::indexHtml = INDEX_HTML;
 std::vector<std::string> NetworkHandler::deviceMacs;
 IPAddress NetworkHandler::targetBroadcast = DEFAULT_TARGET_BROADCAST;
 AsyncUDP NetworkHandler::udp;
@@ -39,13 +41,18 @@ void NetworkHandler::setupWiFi() {
 		return;
 	}
 
+#ifdef ESP8266
+	WiFi.setHostname(HOSTNAME);
+#endif
+
 	WiFi.begin(WIFI_SSID, WIFI_PASS);
 }
 
 void NetworkHandler::loop() {
 	ArduinoOTA.handle();
 }
 
+#ifdef ESP32
 void NetworkHandler::onWiFiEvent(WiFiEvent_t event) {
 	switch (event) {
 	case SYSTEM_EVENT_STA_START:
@@ -57,7 +64,7 @@ void NetworkHandler::onWiFiEvent(WiFiEvent_t event) {
 		break;
 	case SYSTEM_EVENT_GOT_IP6:
 		Serial.print("STA IPv6: ");
-		Serial.println(localhost_ipv6 = WiFi.localIPv6());
+		Serial.println(WiFi.localIPv6());
 		break;
 	case SYSTEM_EVENT_STA_GOT_IP:
 		Serial.print("STA IP: ");
@@ -74,6 +81,28 @@ void NetworkHandler::onWiFiEvent(WiFiEvent_t event) {
 		break;
 	}
 }
+#elif defined(ESP8266)
+void NetworkHandler::onWiFiEvent(WiFiEvent_t event) {
+	switch (event) {
+	case WIFI_EVENT_STAMODE_CONNECTED:
+		Serial.println("WiFi connected.");
+		break;
+	case WIFI_EVENT_STAMODE_GOT_IP:
+		Serial.print("STA IP: ");
+		Serial.println(localhost = WiFi.localIP());
+
+		if (DEFAULT_TARGET_BROADCAST == IPAddress((uint32_t) 0)) {
+			targetBroadcast = WiFi.broadcastIP();
+		}
+		break;
+	case WIFI_EVENT_STAMODE_DISCONNECTED:
+		WiFi.reconnect();
+		break;
+	default:
+		break;
+	}
+}
+#endif
 
 void NetworkHandler::setupWebServer() {
 	std::string deviceMacs = DEVICE_MACS;
@@ -217,7 +246,7 @@ void NetworkHandler::onIndexPost(AsyncWebServerRequest *request) {
 }
 
 std::string NetworkHandler::prepareIndexResponse(const String device, const String target) {
-	std::string response = indexHtml;
+	std::string response = INDEX_HTML;
 
 	std::string devices = "\n";
 	for (std::string device : deviceMacs) {
@@ -233,7 +262,12 @@ std::string NetworkHandler::prepareIndexResponse(const String device, const Stri
 	std::vector<std::string> targetIPs;
 	targetIPs.reserve(4);
 	if (target.length() > 6) {
-		targetIPs.push_back(std::string(target.c_str()));
+#ifdef ESP8266
+		if (target == "255.255.255.255") {
+			targetIPs.push_back("(IP unset)");
+		} else
+#endif
+			targetIPs.push_back(std::string(target.c_str()));
 	}
 	std::string ip(targetBroadcast.toString().c_str());
 	if (std::count(targetIPs.begin(), targetIPs.end(), ip) == 0) {
@@ -259,6 +293,12 @@ std::string NetworkHandler::prepareIndexResponse(const String device, const Stri
 
 	std::string targets = "\n";
 	for (std::string target : targetIPs) {
+#ifdef ESP8266
+		if (target == "(IP unset)") {
+			target = "255.255.255.255";
+		}
+#endif
+
 		targets += "<option value=\"";
 		targets += target;
 		targets += "\">";

src/NetworkHandler.h

@@ -13,7 +13,11 @@
 
 #include <string>
 #include <ESPAsyncWebServer.h>
+#ifdef ESP32
 #include <AsyncUDP.h>
+#elif defined(ESP8266)
+#include <ESPAsyncUDP.h>
+#endif
 
 // Includes the content of the file "wifissid.txt" in the project root.
 // Make sure this file doesn't end with an empty line.
@@ -36,8 +40,8 @@ extern const char NOT_FOUND_HTML[] asm("_binary_src_html_not_found_html_start");
 
 // WiFi constants
 static const char HOSTNAME[] = "esp-wol";
-static const IPAddress GATEWAY(192, 168, 2, 1);
-static const IPAddress SUBNET = IPADDR_NONE;
+static const IPAddress GATEWAY = IPADDR_ANY;
+static const IPAddress SUBNET = IPADDR_ANY;
 
 // Web Server constants
 static const uint16_t WEBSERVER_PORT = 80;
@@ -57,11 +61,9 @@ class NetworkHandler {
 
 	// WiFi variables
 	static IPAddress localhost;
-	static IPv6Address localhost_ipv6;
 
 	// Web Server variables
 	static AsyncWebServer webServer;
-	static std::string indexHtml;
 	static std::vector<std::string> deviceMacs;
 	static IPAddress targetBroadcast;
 

src/main.h

@@ -11,8 +11,10 @@
 #ifndef SRC_MAIN_H_
 #define SRC_MAIN_H_
 
+#ifdef ESP32
 void setup();
 void loop();
+#endif
 
 class main {
 public: