disable OTA status updates

Author: theelims

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.3.1] - Work in Progress
+## [0.4.0] - Work in Progress
 
 This minor upgrade might require one minor change as `MqttPubSub.h` and its class had been renamed to `MqttEndpoint.h`. However, it is strongly advised, that you change all existing WebSocketServer endpoints to the new event socket system.
 
@@ -40,6 +40,7 @@ The new Event Socket system is likely to change with coming updates.
 - Duplicate method in FeatureService [#18](https://github.com/theelims/ESP32-sveltekit/pull/18)
 - Duplicate lines in Systems Settings view.
 - Removes duplicate begin [#36](https://github.com/theelims/ESP32-sveltekit/pull/36)
+- Temporary disabled OTA progress update due to crash with PsychicHttp [#32](https://github.com/theelims/ESP32-sveltekit/issues/32) until a fix is found.
 
 ## [0.3.0] - 2023-02-05
 

interface/src/routes/+layout.svelte

@@ -44,7 +44,7 @@
 		socket.on('errorToast', handleErrorToast);
 		if ($page.data.features.analytics) socket.on('analytics', handleAnalytics);
 		if ($page.data.features.battery) socket.on('battery', handleBattery);
-		if ($page.data.features.download_firmware) socket.on('download_ota', handleOAT);
+		if ($page.data.features.download_firmware) socket.on('otastatus', handleOAT);
 	};
 
 	const removeEventListeners = () => {
@@ -57,7 +57,7 @@
 		socket.off('warningToast', handleWarningToast);
 		socket.off('errorToast', handleErrorToast);
 		socket.off('battery', handleBattery);
-		socket.off('download_ota', handleOAT);
+		socket.off('otastatus', handleOAT);
 	};
 
 	async function validateUser(userdata: userProfile) {

lib/framework/AnalyticsService.h

@@ -19,6 +19,7 @@
 #include <EventSocket.h>
 
 #define MAX_ESP_ANALYTICS_SIZE 1024
+#define EVENT_ANALYTICS "analytics"
 #define ANALYTICS_INTERVAL 2000
 
 class AnalyticsService
@@ -28,7 +29,7 @@ class AnalyticsService
 
     void begin()
     {
-        _socket->registerEvent("analytics");
+        _socket->registerEvent(EVENT_ANALYTICS);
 
         xTaskCreatePinnedToCore(
             this->_loopImpl,            // Function that should be called
@@ -63,7 +64,7 @@ class AnalyticsService
             doc["core_temp"] = temperatureRead();
 
             serializeJson(doc, message);
-            _socket->emit("analytics", message);
+            _socket->emit(EVENT_ANALYTICS, message);
 
             vTaskDelayUntil(&xLastWakeTime, ANALYTICS_INTERVAL / portTICK_PERIOD_MS);
         }

lib/framework/BatteryService.cpp

@@ -19,7 +19,7 @@ BatteryService::BatteryService(EventSocket *socket) : _socket(socket)
 
 void BatteryService::begin()
 {
-    _socket->registerEvent("battery");
+    _socket->registerEvent(EVENT_BATTERY);
 }
 
 void BatteryService::batteryEvent()
@@ -29,5 +29,5 @@ void BatteryService::batteryEvent()
     doc["soc"] = _lastSOC;
     doc["charging"] = _isCharging;
     serializeJson(doc, message);
-    _socket->emit("battery", message);
+    _socket->emit(EVENT_BATTERY, message);
 }

lib/framework/BatteryService.h

@@ -16,6 +16,8 @@
 #include <EventSocket.h>
 #include <JsonUtils.h>
 
+#define EVENT_BATTERY "battery"
+
 class BatteryService
 {
 public:

lib/framework/DownloadFirmwareService.cpp

@@ -24,7 +24,7 @@ void update_started()
     String output;
     doc["status"] = "preparing";
     serializeJson(doc, output);
-    _socket->emit("download_ota", output.c_str());
+    _socket->emit(EVENT_DOWNLOAD_OTA, output.c_str());
 }
 
 void update_progress(int currentBytes, int totalBytes)
@@ -35,7 +35,7 @@ void update_progress(int currentBytes, int totalBytes)
     if (progress > previousProgress)
     {
         doc["progress"] = progress;
-        _socket->emit("download_ota", output.c_str());
+        _socket->emit(EVENT_DOWNLOAD_OTA, output.c_str());
         ESP_LOGV("Download OTA", "HTTP update process at %d of %d bytes... (%d %%)", currentBytes, totalBytes, progress);
     }
     previousProgress = progress;
@@ -46,7 +46,7 @@ void update_finished()
     String output;
     doc["status"] = "finished";
     serializeJson(doc, output);
-    _socket->emit("download_ota", output.c_str());
+    _socket->emit(EVENT_DOWNLOAD_OTA, output.c_str());
 
     // delay to allow the event to be sent out
     vTaskDelay(100 / portTICK_PERIOD_MS);
@@ -63,9 +63,9 @@ void updateTask(void *param)
 
     String url = *((String *)param);
     String output;
-    httpUpdate.onStart(update_started);
-    httpUpdate.onProgress(update_progress);
-    httpUpdate.onEnd(update_finished);
+    // httpUpdate.onStart(update_started);
+    // httpUpdate.onProgress(update_progress);
+    // httpUpdate.onEnd(update_finished);
 
     t_httpUpdate_return ret = httpUpdate.update(client, url.c_str());
 
@@ -76,7 +76,7 @@ void updateTask(void *param)
         doc["status"] = "error";
         doc["error"] = httpUpdate.getLastErrorString().c_str();
         serializeJson(doc, output);
-        _socket->emit("download_ota", output.c_str());
+        _socket->emit(EVENT_DOWNLOAD_OTA, output.c_str());
 
         ESP_LOGE("Download OTA", "HTTP Update failed with error (%d): %s", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str());
 #ifdef SERIAL_INFO
@@ -88,7 +88,7 @@ void updateTask(void *param)
         doc["status"] = "error";
         doc["error"] = "Update failed, has same firmware version";
         serializeJson(doc, output);
-        _socket->emit("download_ota", output.c_str());
+        _socket->emit(EVENT_DOWNLOAD_OTA, output.c_str());
 
         ESP_LOGE("Download OTA", "HTTP Update failed, has same firmware version");
 #ifdef SERIAL_INFO
@@ -115,7 +115,7 @@ DownloadFirmwareService::DownloadFirmwareService(PsychicHttpServer *server,
 
 void DownloadFirmwareService::begin()
 {
-    _socket->registerEvent("download_ota");
+    _socket->registerEvent(EVENT_DOWNLOAD_OTA);
 
     _server->on(GITHUB_FIRMWARE_PATH,
                 HTTP_POST,
@@ -146,7 +146,7 @@ esp_err_t DownloadFirmwareService::downloadUpdate(PsychicRequest *request, JsonV
     String output;
     serializeJson(doc, output);
 
-    _socket->emit("download_ota", output.c_str());
+    _socket->emit(EVENT_DOWNLOAD_OTA, output.c_str());
 
     if (xTaskCreatePinnedToCore(
             &updateTask,                // Function that should be called

lib/framework/DownloadFirmwareService.h

@@ -27,6 +27,7 @@
 // #include <SSLCertBundle.h>
 
 #define GITHUB_FIRMWARE_PATH "/rest/downloadUpdate"
+#define EVENT_DOWNLOAD_OTA "otastatus"
 #define OTA_TASK_STACK_SIZE 9216
 
 class DownloadFirmwareService

lib/framework/WiFiSettingsService.cpp

@@ -49,7 +49,7 @@ void WiFiSettingsService::initWiFi()
 
 void WiFiSettingsService::begin()
 {
-    _socket->registerEvent("rssi");
+    _socket->registerEvent(EVENT_RSSI);
 
     _httpEndpoint.begin();
 }
@@ -216,7 +216,7 @@ void WiFiSettingsService::updateRSSI()
 {
     char buffer[16];
     snprintf(buffer, sizeof(buffer), WiFi.isConnected() ? "%d" : "disconnected", WiFi.RSSI());
-    _socket->emit("rssi", buffer);
+    _socket->emit(EVENT_RSSI, buffer);
 }
 
 void WiFiSettingsService::onStationModeDisconnected(WiFiEvent_t event, WiFiEventInfo_t info)

lib/framework/WiFiSettingsService.h

@@ -51,6 +51,8 @@
 
 #define WIFI_SETTINGS_BUFFER_SIZE 2048
 
+#define EVENT_RSSI "rssi"
+
 // Struct defining the wifi settings
 typedef struct
 {

platformio.ini

@@ -24,7 +24,7 @@ build_flags =
 	${features.build_flags}
     -D BUILD_TARGET=\"$PIOENV\"
     -D APP_NAME=\"ESP32-Sveltekit\" ; Must only contain characters from [a-zA-Z0-9-_] as this is converted into a filename
-    -D APP_VERSION=\"0.3.1\" ; semver compatible version string
+    -D APP_VERSION=\"0.4.0\" ; semver compatible version string
 	; Uncomment to receive log messages from the ESP Arduino Core
 	-D CORE_DEBUG_LEVEL=4
     ; Move all networking stuff to the protocol core 0 and leave business logic on application core 1
@@ -95,4 +95,3 @@ build_flags =
     ${env.build_flags}
     -D LED_BUILTIN=2
     -D KEY_BUILTIN=0
-