v10.8.3

Author: s60sc

README.md

@@ -29,15 +29,15 @@ The ESP32 cannot support all of the features as it will run out of heap space. F
 ***This is a complex app and some users are raising issues when the app reports a warning, but this is the app notifying the user that there is an problem with their setup, which only the user can fix. Be aware that some clone boards have different specs to the original, eg PSRAM size. Please only raise issues for actual bugs (ERR messages, unhandled library error or crash). Thanks.  
 To suggest an improvement or enhancement use Discussions.*** 
 
-Changes for version 10.8.2:
+Changes for version 10.8.3:
 * Addition of [Ethernet](#configuration-web-page) network selection instead of Wifi
 * Pins added for [`CAMERA_MODEL_Waveshare_ESP32_S3_ETH`](https://www.waveshare.com/wiki/ESP32-S3-ETH)
 * Define pins for external W5500 Ethernet controller
 * Fix for issue [#650](https://github.com/s60sc/ESP32-CAM_MJPEG2SD/issues/650)
 
 ## Purpose
 
-The application enables video capture of motion detection or continuous recording. Examples include security cameras, wildlife monitoring, rocket flight monitoring, FPV vehicle control.  This [instructable](https://www.instructables.com/How-to-Make-a-WiFi-Security-Camera-ESP32-CAM-DIY-R/) by [Max Imagination](https://www.instructables.com/member/Max+Imagination/) shows how to build a WiFi Security Camera using an earlier version of this code, plus a later video on how to [install and use](https://www.youtube.com/watch?v=k_PJLkfqDuI&t=247s) the app.
+The application enables video capture of motion detection or continuous recording. Examples include security cameras, wildlife monitoring, rocket flight monitoring, FPV vehicle control.
 
 Saving a set of JPEGs as a single file is faster than as individual files and is easier to manage, particularly for small image sizes. Actual rate depends on quality and size of SD card and complexity and quality of images. A no-name 4GB SDHC labelled as Class 6 was 3 times slower than a genuine Sandisk 4GB SDHC Class 2. The following recording rates were achieved on a freshly formatted Sandisk 4GB SDHC Class 2 on a AI Thinker OV2640 board, set to maximum JPEG quality and clock rate of 20MHz. With a clock rate of 24Mhz on ESP32S3, the maximum frame rates can increase 50->60, 25->30 but it may be necessary to reduce JPEG quality.
 

appGlobals.h

@@ -28,8 +28,8 @@
 
 // User's ESP32S3 cam board
 #elif defined(CONFIG_IDF_TARGET_ESP32S3)
-#define CAMERA_MODEL_FREENOVE_ESP32S3_CAM
-//#define CAMERA_MODEL_ESP32_S3_CAM
+#define CAMERA_MODEL_ESP32_S3_CAM
+//#define CAMERA_MODEL_FREENOVE_ESP32S3_CAM
 //#define CAMERA_MODEL_XIAO_ESP32S3
 //#define CAMERA_MODEL_NEW_ESPS3_RE1_0
 //#define CAMERA_MODEL_M5STACK_CAMS3_UNIT
@@ -105,7 +105,7 @@
 #define USE_IP6 false // if true use IPv6 when available, else use IPv4
 
 
-/*********************** Fixed defines leave as is ***********************/ 
+/*********************** Fixed defines leave as is ************************/ 
 /** Do not change anything below here unless you know what you are doing **/
 
 #ifndef AUXILIARY
@@ -121,7 +121,7 @@
 #define DOT_MAX 50
 #define HOSTNAME_GRP 99
 
-#define APP_VER "10.8.2"
+#define APP_VER "10.8.3"
 
 #if defined(AUXILIARY)
 #define APP_NAME "ESP-CAM_AUX" // max 15 chars
@@ -162,7 +162,7 @@
 #define ISCAM // cam specific code in generic cpp files
 
 // to determine if newer data files need to be loaded
-#define CFG_VER 32
+#define CFG_VER 33
 
 #define AVI_EXT "avi"
 #define CSV_EXT "csv"

camera_pins.h

@@ -374,7 +374,7 @@
 #define SD_MMC_CLK 39 
 #define SD_MMC_CMD 38
 #define SD_MMC_D0 40
-#if defined(CAMERA_MODEL_PCBFUN_ESP32S3_CAM)
+#if defined(CAMERA_MODEL_ESP32_S3_CAM)
 // uncomment following pins for SD MMC 4 bit mode
 //#define SD_MMC_D1 41
 //#define SD_MMC_D2 14

globals.h

@@ -97,6 +97,8 @@
 #define USECS 1000000
 #define MAGIC_NUM 987654321
 #define MAX_FAIL 5
+#define SSESEP "\r\n\r\n" // SSE event separator
+#define PANIC_DELAY 5 // seconds before restart after panic
 
 // global mandatory app specific functions, in appSpecific.cpp 
 bool appDataFiles();
@@ -108,7 +110,8 @@ void appSpecificTelegramTask(void* p);
 void buildAppJsonString(bool filter);
 bool updateAppStatus(const char* variable, const char* value, bool fromUser = true);
 
-// global general utility functions in utils.cpp / utilsFS.cpp / peripherals.cpp    
+// global general utility functions in utils.cpp / utilsFS.cpp / peripherals.cpp etc
+void appPanicHandler(arduino_panic_info_t *info, void *arg);
 void buildJsonString(uint8_t filter);
 bool calcProgress(int progressVal, int totalVal, int percentReport, uint8_t &pcProgress);
 bool changeExtension(char* fileName, const char* newExt);
@@ -184,6 +187,7 @@ void resetWatchDog(int wdIndex, uint32_t wdTimeout = 1);
 bool retrieveConfigVal(const char* variable, char* value);
 void runTaskStats();
 esp_err_t sendChunks(File df, httpd_req_t *req, bool endChunking = true);
+void sendSSE(const char* statusData);
 void setFolderName(const char* fname, char* fileName);
 void setPeripheralResponse(const byte pinNum, const uint32_t responseData);
 void setupADC();
@@ -330,7 +334,6 @@ extern uint8_t alarmHour;
 extern char* jsonBuff; 
 extern bool dbgVerbose;
 extern bool sdLog;
-extern char alertMsg[];
 extern int logType;
 extern char messageLog[];
 extern uint16_t mlogEnd;

prefs.cpp

@@ -412,8 +412,6 @@ void buildJsonString(uint8_t filter) {
     buildAppJsonString((bool)filter);
     p += strlen(jsonBuff) - 1;
     p += sprintf(p, "\"cfgGroup\":\"-1\",");
-    p += sprintf(p, "\"alertMsg\":\"%s\",", alertMsg); 
-    alertMsg[0] = 0;
     // generic footer
     currEpoch = getEpoch(); 
     p += sprintf(p, "\"clockUTC\":\"%lu\",", (uint32_t)currEpoch); 

utils.cpp

@@ -903,6 +903,11 @@ static uint32_t counter_write = 0;
 // RAM memory based logging in RTC slow memory (cannot init)
 RTC_NOINIT_ATTR char messageLog[RAM_LOG_LEN];
 RTC_NOINIT_ATTR uint16_t mlogEnd;
+static RTC_NOINIT_ATTR uint32_t backtrace[60]; // backtrace addresses array
+static RTC_NOINIT_ATTR size_t btLen;
+static RTC_NOINIT_ATTR char btReason[50];
+static RTC_NOINIT_ATTR int btCore;
+static RTC_NOINIT_ATTR uint32_t haveTrace;
 
 static void ramLogClear() {
   mlogEnd = 0;
@@ -990,10 +995,11 @@ void logPrint(const char *format, ...) {
     // output to monitor console if attached
     size_t msgLen = strlen(outBuf);
     if (outBuf[msgLen - 2] == '~') {
-      // set up alert message for browser
-      outBuf[msgLen - 2] = ' ';
-      strncpy(alertMsg, outBuf, MAX_OUT - 1);
-      alertMsg[msgLen - 2] = 0;
+      // set up alert message for browser using SSE
+      outBuf[msgLen - 2] = ' '; // remove '~'
+      snprintf(alertMsg, MAX_OUT - 1, "event: alert\ndata: %s%s", outBuf, SSESEP); 
+      sendSSE(alertMsg);
+      alertMsg[0] = 0;
     }
     ramLogStore(msgLen); // store in rtc ram 
     if (monitorOpen) Serial.print(outBuf); 
@@ -1029,6 +1035,7 @@ int vprintfRedirect(const char* format, va_list args) {
 
 void logSetup() {
   // prep logging environment
+  set_arduino_panic_handler(appPanicHandler, NULL);
   Serial.begin(115200);
   Serial.setDebugOutput(DBG_ON);
   printf("\n\n");
@@ -1044,8 +1051,8 @@ void logSetup() {
   xSemaphoreGive(logMutex);
   xTaskCreate(logTask, "logTask", LOG_STACK_SIZE, NULL, LOG_PRI, &logHandle);
   if (mlogEnd >= RAM_LOG_LEN) ramLogClear(); // init
-  LOG_INF("Setup RAM based log, size %u, starting from %u\n\n", RAM_LOG_LEN, mlogEnd);
-  LOG_INF("=============== %s %s ===============", APP_NAME, APP_VER);
+  logPrint("\n\n=============== %s %s ===============\n", APP_NAME, APP_VER);
+  LOG_INF("Setup RAM based log, size %u, starting from %u", RAM_LOG_LEN, mlogEnd);
   initBrownout();
   prepInternalTemp();
   boardInfo();
@@ -1261,7 +1268,7 @@ static void printGpioInfo() {
 }
 
 
-/****************** send device to sleep (light or deep) & watchdog ******************/
+/****************** send device to sleep (light or deep), watchdog, panics ******************/
 
 #include <esp_wifi.h>
 #include <driver/gpio.h>
@@ -1281,6 +1288,32 @@ static esp_sleep_wakeup_cause_t printWakeupReason() {
   return wakeup_reason;
 }
 
+void appPanicHandler(arduino_panic_info_t *info, void *arg) {
+  // store crash backtrace and delay reboot to avoid thrashing
+  // https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-misc.c
+  strncpy(btReason, info->reason, sizeof(btReason) - 1);
+  btCore = info->core;
+  btLen = info->backtrace_len;
+  for (int i = 0; i < info->backtrace_len; i++) backtrace[i] = info->backtrace[i];
+  haveTrace = MAGIC_NUM; // flag that backtrace available
+  esp_rom_delay_us(PANIC_DELAY * 1000 * 1000);
+}
+
+static void showBacktrace() {
+  // display backtrace following a panic
+  if (haveTrace == MAGIC_NUM) {
+    haveTrace = 0;
+    char bt[220];
+    sprintf(bt, "%s on core %d", btReason, btCore);
+    LOG_WRN("%s", bt);
+    bt[0] = 0;
+    for (int i = 0; i < btLen; i++) { 
+      snprintf(bt + strlen(bt), sizeof(bt) - strlen(bt) - 11, "0x%08x ", (unsigned int)backtrace[i]); // 11 is size of new trace hex
+    }
+    LOG_WRN("Paste backtrace below into Arduino Exception Decoder:\n");
+    logPrint("Backtrace: %s\n\n", bt);
+  }
+}
 
 static esp_reset_reason_t printResetReason() {
   esp_reset_reason_t bootReason = esp_reset_reason();
@@ -1303,6 +1336,7 @@ static esp_reset_reason_t printResetReason() {
     case ESP_RST_SDIO: LOG_INF("Reset over SDIO"); break;
     default: LOG_WRN("Unhandled reset reason"); break;
   }
+  showBacktrace();
   return bootReason;
 }
 

webServer.cpp

@@ -14,6 +14,8 @@ int refreshVal = 5000; // msecs
 
 static httpd_handle_t httpServer = NULL; // web server port
 static int fdWs = -1; // websocket sockfd
+static httpd_handle_t sseSocketHD; // SSE support
+static int sseSocketFD;
 bool useHttps = false;
 bool useSecure = false;
 bool heartBeatDone = false;
@@ -37,6 +39,7 @@ esp_err_t sendChunks(File df, httpd_req_t *req, bool endChunking) {
   if (res != ESP_OK) {
     snprintf(startupFailure, SF_LEN, "Failed to send to browser: %s, err %s", inFileName, espErrMsg(res));
     LOG_WRN("%s", startupFailure);
+    checkMemory();
     OTAprereq(); // free up memory
   } 
   return res;
@@ -110,7 +113,7 @@ static esp_err_t indexHandler(httpd_req_t* req) {
   httpd_resp_set_hdr(req, "Access-Control-Allow-Origin", "*");
   // first check if a startup failure needs to be reported
   if (strlen(startupFailure)) {
-    httpd_resp_set_type(req, "text/html");                   
+    httpd_resp_set_type(req, "text/html");
     httpd_resp_sendstr_chunk(req, failPageS_html);
     httpd_resp_sendstr_chunk(req, startupFailure);
     httpd_resp_sendstr_chunk(req, failPageE_html);
@@ -257,6 +260,28 @@ bool parseJson(int rxSize) {
   return retAction;
 }
 
+static esp_err_t sseHandler(httpd_req_t *req) {
+  // enable Server Sent Events
+  const char* sseHeader = "HTTP/1.1 200 OK\r\n"
+                          "Cache-Control: no-store\r\n"
+                          "Connection: keep-alive\r\n"
+                          "Content-Type: text/event-stream\r\n\r\n";
+  sseSocketHD = req->handle;
+  sseSocketFD = httpd_req_to_sockfd(req);
+  httpd_socket_send(sseSocketHD, sseSocketFD, sseHeader, strlen(sseHeader), 0); 
+  sendSSE("event: open\ndata: opened" SSESEP);
+  return ESP_OK;
+}
+
+void sendSSE(const char* statusData) {
+  // send statusData to browser
+  if (sseSocketFD > 0) {
+    int res = httpd_socket_send(sseSocketHD, sseSocketFD, statusData, strlen(statusData), 0);
+    if (res == HTTPD_SOCK_ERR_TIMEOUT) LOG_WRN("Timeout/interrupted while using socket");
+    if (res == HTTPD_SOCK_ERR_FAIL) LOG_WRN("Unrecoverable error while using socket");
+  } else LOG_WRN("SSE not initiated");
+}
+
 static esp_err_t updateHandler(httpd_req_t *req) {
   // bulk update of config, extract key pairs from received json string
   size_t rxSize = min(req->content_len, (size_t)JSON_BUFF_LEN);
@@ -546,6 +571,7 @@ void startWebServer() {
   httpd_uri_t statusUri = {.uri = "/status", .method = HTTP_GET, .handler = statusHandler, .user_ctx = NULL};
   httpd_uri_t uploadUri = {.uri = "/upload", .method = HTTP_POST, .handler = uploadHandler, .user_ctx = NULL};
   httpd_uri_t wifiUri = {.uri = "/wifi", .method = HTTP_GET, .handler = setupHandler, .user_ctx = NULL};
+  httpd_uri_t sseUri = {.uri = "/sse", .method = HTTP_GET, .handler = sseHandler, .user_ctx = NULL};
   httpd_uri_t wsUri = {.uri = "/ws", .method = HTTP_GET, .handler = wsHandler, .user_ctx = NULL, .is_websocket = true};
   httpd_uri_t sustainUri = {.uri = "/sustain", .method = HTTP_GET, .handler = appSpecificSustainHandler, .user_ctx = NULL};
   httpd_uri_t checkUri = {.uri = "/sustain", .method = HTTP_HEAD, .handler = appSpecificSustainHandler, .user_ctx = NULL};
@@ -557,6 +583,7 @@ void startWebServer() {
     httpd_register_uri_handler(httpServer, &updateUri);
     httpd_register_uri_handler(httpServer, &statusUri);
     httpd_register_uri_handler(httpServer, &uploadUri);
+    httpd_register_uri_handler(httpServer, &sseUri);
     httpd_register_uri_handler(httpServer, &wifiUri);
     httpd_register_uri_handler(httpServer, &wsUri);
     httpd_register_uri_handler(httpServer, &sustainUri);