Consolidated OTA updates, fixed webserver restarting commands

Author: TheLogicMaster

README.md

@@ -1,5 +1,5 @@
 # ESP LED Matrix Display
-
+![GitHub](https://img.shields.io/github/license/TheLogicMaster/ESP-LED-Matrix-Display)
 ## About
 This project is intended to provide an graphically customizeable and functional firmware to drive LED Matrix panels using 
 ESP8266 based microcontrollers. It's powered by the [PxMatrix](https://github.com/2dom/PxMatrix) driver and is
@@ -18,20 +18,22 @@ is a placeholder until something clever comes along.
 * OTA Updating
 * Raw configuration editor
 * YouTube subscriber counter
+* Tetris Animation font
 
 ## Demo
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/TheLogicMaster/ESP-LED-Matrix-Display/Build%20Demo)
+
 A demo of the web dashboard is available [Here](https://thelogicmaster.github.io/ESP-LED-Matrix-Display/). Example data 
 is provided in place of the normal display API calls. Aside from configuration and image saving, the dashboard should
 be fully functional.
 
 ## Hardware
-ESP32 and ESP8266 are now fully supported, though the sunrise/weather features aren't availible to ESP32 yet, since the 
-WeatherStation library isn't ESP32 friendly at the moment. 4MB of RAM is required to use both the web dashboard
+ESP32 and ESP8266 are now fully supported. 4MB of RAM is required to use both the web dashboard
 and OTA updates. This was developed primarily on a P3 32x64 panel, but other sizes should be supported. Wiring is required to
 be like [this](https://github.com/2dom/PxMatrix#set-up-and-cabling). A photoresistor/resistor is supported on pin 
 A0 in [this](https://www.instructables.com/id/NodeMCU-With-LDR/) configuration to control the display brightness. There 
 are pre-configured Platformio environments for Wemos D1 Mini, NodeMCU V2, NodeMCU 32S, and the Wemos D1 Mini Lite. Pre-built update
-binaries are availible for D1 Mini and NodeMCU V2. The D1 Mini Lite has 1MB of flash memory, so OTA updates are not 
+binaries are availible for D1 Mini, NodeMCU 32S, and NodeMCU V2. The D1 Mini Lite has 1MB of flash memory, so OTA updates are not 
 supported and features like HTTPS and built-in images are disabled.
 
 ## Installation

led-matrix-dashboard/src/components/Controls.vue

@@ -24,7 +24,8 @@ export default {
       'Restart Display': {url: '/restart', tooltip: 'Restart the display'},
       'Delete all Images': {url: '/deleteAllImages', tooltip: 'Delete all custom images'},
       'Reset Display Configuration': {url: '/resetConfiguration', tooltip: 'Reset display configuration file'},
-      'Factory Reset Display': {url: '/factoryReset', tooltip: 'Reset display configuration and erase custom images'}
+      'Factory Reset Display': {url: '/factoryReset', tooltip: 'Reset display configuration and erase custom images'},
+      'Format Filesystem': {url: '/formatFilesystem', tooltip: 'Format display filesystem'}
     }
   }),
   methods: {

led-matrix-dashboard/src/components/OTAUpdate.vue

@@ -75,15 +75,6 @@ export default {
       if (files.length > 0)
         this.binary = files[0]
     },
-    async abortUpdate() {
-      try {
-        this.$axios.get('/abortUpdate').then()
-        return true
-      } catch (error) {
-        console.error(error)
-        return false
-      }
-    },
     async update() {
       this.updateDialog = false
       let binary = this.binary
@@ -128,8 +119,6 @@ export default {
       }
 
       try {
-        await this.$axios.post('/beginUpdate')
-        await this.sleep(1000)
         let form = new FormData()
         form.append(this.selected, binary, this.selected)
         this.progress = 0
@@ -144,15 +133,12 @@ export default {
         if (response.data.includes('OK')) {
           this.info('Success', 'Successfully updated display', true)
           this.waitForPromiseSuccess(this.getStats).then()
-        } else {
+        } else
           this.error('Error', 'Failed to update display: ' + response.data)
-          await this.waitForPromiseSuccess(this.abortUpdate)
-        }
       } catch (error) {
         this.error('Error', 'Failed to update display: ' + error)
         this.progress = -1;
         console.error(error)
-        await this.waitForPromiseSuccess(this.abortUpdate)
       }
     },
     onUploadProgress(event) {

led-matrix-display/main.cpp

@@ -42,7 +42,7 @@
 #define SHAPE_CIRCLE 2
 #define SHAPE_PIXEL 3
 #define STATE_NORMAL 0
-#define STATE_UPDATING 1
+#define STATE_DISABLED 1
 
 // Configuration
 #define ROUNDED_RECT_RADIUS 3 // The radius to use for rounded rectangles
@@ -161,8 +161,6 @@
 #include <WiFiClientSecure.h>
 #include <HTTPClient.h>
 #include <WiFiMulti.h>
-//#define sint16_t signed short
-//#define sint32_t signed long
 #else // ESP8266 Specific
 #include <ESPAsyncTCP.h>
 #include <LittleFS.h>
@@ -187,7 +185,7 @@
 #include "TinyIcons.h"
 #endif
 #if USE_SUNRISE
-#include <SunMoonCalc.h>
+#include "SunMoonCalc.h"
 #endif
 #if USE_TETRIS
 #include <TetrisMatrixDraw.h>
@@ -321,6 +319,8 @@ bool needsConfig; // If a configuration is needed
 bool needsUpdate; // If a full update is needed
 bool needsRestart; // If a system reboot is needed
 bool needsTimezone; // If the timezone needs to be set still
+bool needsFormat; // If a FS format is needed
+bool needsFactoryReset; // If a factory reset is needed
 uint8_t theHour12;
 uint8_t theHour;
 uint8_t theMinute;
@@ -335,6 +335,7 @@ time_t sunSetTime;
 uint8_t scanPattern;
 uint8_t muxPattern;
 uint8_t muxDelay;
+AsyncClient* finalClient; // Client to wait for closing before restart
 
 #ifdef ESP32
 #define P_LAT 22
@@ -433,6 +434,7 @@ uint16_t parseHexColorString(std::string s) {
 }
 
 void closeFiles() {
+    DEBUG("Closing widget files\n");
     for (uint i = 0; i < widgets.size(); i++)
         widgets[i].file.close();
 }
@@ -650,12 +652,22 @@ bool getConfig() {
 
 #pragma region Web Server
 
+void restartAfterDisconnect(AsyncWebServerRequest *request) {
+    needsRestart = true;
+    finalClient = request->client();
+}
+
 void closeConnection(AsyncWebServerRequest *request) {
     AsyncWebServerResponse *response = request->beginResponse(200);
     response->addHeader("Connection", "close");
     request->send(response);
 }
 
+void closeAndRestart(AsyncWebServerRequest *request) {
+    closeConnection(request);
+    restartAfterDisconnect(request);
+}
+
 void onStartAccessPoint(AsyncWiFiManager *wiFiManager) {
     Serial.println(F("Entering AP config mode"));
     display.fillScreen(BLUE);
@@ -681,15 +693,6 @@ String getContentType(String filename) {
     return F("text/plain");
 }
 
-int getHeaderCacheVersion(AsyncWebServerRequest *request) {
-    if (!request->hasHeader(F("If-None-Match")))
-        return -1;
-    for (int i = 0; i < request->headers(); i++ )
-        if (request->headerName(i).equals(F("If-None-Match")))
-            return request->header(i).toInt();
-    return -1;
-}
-
 bool sendFile(AsyncWebServerRequest *request, String path, bool cache = true) {
     if (path.endsWith(F("/")))
         return false;
@@ -794,24 +797,7 @@ void serveNotFound(AsyncWebServerRequest *request) {
 }
 
 void serveRestart(AsyncWebServerRequest *request) {
-    closeConnection(request);
-    needsRestart = true;
-}
-
-// Todo: Replace start and abort OTA functions with direct update functions
-void startOTA(AsyncWebServerRequest *request) {
-    state = STATE_UPDATING;
-    disableDisplay = true;
-    LittleFS.end();
-    request->send(200);
-}
-
-void abortOTA(AsyncWebServerRequest *request) {
-    state = STATE_NORMAL;
-    disableDisplay = false;
-    LittleFS.begin();
-    request->send(200);
-    needsUpdate = true;
+    closeAndRestart(request);
 }
 
 void serveStats(AsyncWebServerRequest *request) {
@@ -977,8 +963,7 @@ void serveImageData(AsyncWebServerRequest *request) {
 }
 
 void serveUploadImage(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) {
-    for (uint i = 0; i < widgets.size(); i++)
-        widgets[i].file.close();
+    closeFiles();
     String imageFilename = "/images/" + request->arg("name");
 
     if (!index) {
@@ -1027,6 +1012,7 @@ void serveImage(AsyncWebServerRequest *request) {
 }
 
 void serveRenameImage(AsyncWebServerRequest *request) {
+    closeFiles();
     String name = request->arg(F("name"));
     String newName = request->arg(F("newName"));
     if (!LittleFS.exists("/images/" + name)) {
@@ -1045,8 +1031,7 @@ void serveRenameImage(AsyncWebServerRequest *request) {
 }
 
 void serveDeleteImage(AsyncWebServerRequest *request) {
-    for (uint i = 0; i < widgets.size(); i++)
-        widgets[i].file.close();
+    closeFiles();
     std::string name = request->arg(F("name")).c_str();
     std::map <std::string, FSImage> fsImageData = getFSImageData();
     fsImageData.erase(name);
@@ -1058,8 +1043,8 @@ void serveDeleteImage(AsyncWebServerRequest *request) {
 }
 
 void deleteAllImages() {
-    for (uint i = 0; i < widgets.size(); i++)
-        widgets[i].file.close();
+    DEBUG("Deleting all custom images\n");
+    closeFiles();
     writeDefaultImageData();
     Dir dir = getImageDir();
     LittleFS.rmdir(F("/images"));
@@ -1081,33 +1066,43 @@ void serveDeleteAllImages(AsyncWebServerRequest *request) {
 }
 
 void serveResetConfiguration(AsyncWebServerRequest *request) {
+    closeFiles();
     writeDefaultConfig();
-    closeConnection(request);
-    needsRestart = true;
+    closeAndRestart(request);
 }
 
 void serveOK(AsyncWebServerRequest *request) {
     request->send(200);
 }
 
 void serveFactoryReset(AsyncWebServerRequest *request) {
-    writeDefaultConfig();
-    deleteAllImages();
-    AsyncWiFiManager wifiManager(&server, &dnsServer);
-    wifiManager.resetSettings();
-    needsRestart = true;
-    closeConnection(request);
+    needsFactoryReset = true;
+    closeAndRestart(request);
+}
+
+void serveFormatFilesystem(AsyncWebServerRequest *request) {
+    needsFormat = true;
+    closeAndRestart(request);
 }
 
 void serveOTA(AsyncWebServerRequest *request) {
-    needsRestart = !Update.hasError();
-    AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", needsRestart ? "OK" : String(Update.getError(), 10));
+    bool success = !Update.hasError();
+    if (!success) {
+        state = STATE_NORMAL;
+        disableDisplay = false;
+        LittleFS.begin();
+        needsUpdate = true;
+    } else
+        restartAfterDisconnect(request);
+    AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", success ? "OK" : String(Update.getError(), 10));
     response->addHeader("Connection", "close");
     request->send(response);
 }
 
 void serveOTAUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) {
     if (!index) {
+        state = STATE_DISABLED;
+        disableDisplay = true;
 #ifdef ESP8266
         Update.runAsync(true);
 #endif
@@ -1130,7 +1125,7 @@ void serveOTAUpload(AsyncWebServerRequest *request, String filename, size_t inde
       Update.printError(Serial);
     if (final) {
       if(Update.end(true))
-        Serial.printf("Update Success: %uB\n", index+len);
+        Serial.printf("Update Success: %uB\n", index + len);
       else
         Update.printError(Serial);
     }
@@ -1170,8 +1165,6 @@ void setupWebserver() {
     server.addHandler(new AsyncCallbackJsonWebHandler("/config", serveSaveConfig, MAX_CONFIG_FILE_SIZE));
     server.on("/update", HTTP_POST, serveOTA, serveOTAUpload);
     server.on("/recovery", HTTP_GET, serveRecovery);
-    server.on("/abortUpdate", abortOTA);
-    server.on("/beginUpdate", startOTA);
     server.on("/fullRefresh", serveFullUpdate);
     server.on("/forceUpdate", serveForceUpdate);
     server.on("/refreshWeather", serveWeatherUpdate);
@@ -1187,6 +1180,7 @@ void setupWebserver() {
     server.on("/deleteAllImages", serveDeleteAllImages);
     server.on("/renameImage", serveRenameImage);
     server.on("/factoryReset", serveFactoryReset);
+    server.on("/formatFilesystem", serveFormatFilesystem);
     server.on("/resetConfiguration", serveResetConfiguration);
     server.serveStatic("/", LittleFS, "/", CACHE_DASHBOARD ? "no-cache" : NULL);
     server.onNotFound(serveNotFound);
@@ -2026,6 +2020,29 @@ void updateArduinoOTA() {
 #endif
 }
 
+void updateRestartFlags() {
+    if (needsRestart && (!finalClient || finalClient->disconnected())) {
+        if (needsFormat) {
+            closeFiles();
+            LittleFS.end();
+            state = STATE_DISABLED;
+            disableDisplay = true;
+            DEBUG("Formatting filesystem\n");
+            LittleFS.format();
+        }
+
+        if (needsFactoryReset) {
+            writeDefaultConfig();
+            deleteAllImages();
+            DEBUG("Erasing WiFi settings\n");
+            AsyncWiFiManager wifiManager(&server, &dnsServer);
+            wifiManager.resetSettings();
+        }
+        
+        ESP.restart();
+    }
+}
+
 void setup() {
     Serial.begin(115200);
     Serial.println();
@@ -2124,6 +2141,7 @@ void setup() {
         display.showBuffer();
         needsConfig = true;
         while (needsConfig) {
+            updateRestartFlags();
             updateArduinoOTA();
             updateTime();
             yield();
@@ -2139,13 +2157,12 @@ void setup() {
 }
 
 void loop() {
-    if (needsRestart)
-        ESP.restart();
+    updateRestartFlags();
 
     switch (state) {
         default:
             Serial.printf("Unknown state: %i/n", state);
-        case STATE_UPDATING:
+        case STATE_DISABLED:
             break;
         case STATE_NORMAL:
             updateTime();