v2.5

Author: s60sc

appGlobals.h

@@ -15,7 +15,6 @@
 /*********************** Fixed defines leave as is ***********************/ 
 /** Do not change anything below here unless you know what you are doing **/
 
-//#define DEV_ONLY // leave commented out
 #define STATIC_IP_OCTAL "168" // dev only
 #define DEBUG_MEM false // leave as false
 #define FLUSH_DELAY 0 // for debugging crashes
@@ -25,7 +24,7 @@
 #define USE_IP6 false
 
 #define APP_NAME "ESP32_AdBlocker" // max 15 chars
-#define APP_VER "2.4"
+#define APP_VER "2.5"
 
 #define HTTP_CLIENTS 2 // http, ws
 #define MAX_STREAMS 0
@@ -53,9 +52,6 @@
 #define INCLUDE_CERTS false   // certificates.cpp (https and server certificate checking)
 #define INCLUDE_WEBDAV true   // webDav.cpp (WebDAV protocol)
 
-#define IS_IO_EXTENDER false // must be false except for IO_Extender
-#define EXTPIN 100
-
 // to determine if newer data files need to be loaded
 #define CFG_VER 3
 
@@ -88,7 +84,6 @@
 #define LOG_PRI 1
 #define UART_PRI 1
 #define BATT_PRI 1
-#define IDLEMON_PRI 5
 
 /******************** Function declarations *******************/
 

appSpecific.cpp

@@ -33,7 +33,7 @@ struct {
   char* lastDomain;
   bool lastResult;
 } lastCheck;
-                                                                                                      
+
 static void dnsTask(void* parameter) {
   // higher priority than loop()
   while (true) dnsServer.processNextRequest();
@@ -133,7 +133,7 @@ static void extractBlocklist() {
 static bool downloadBlockList() {
   // download blocklist file from web
   bool res = false;
-  WiFiClientSecure wclient;
+  NetworkClientSecure wclient;
   if (remoteServerConnect(wclient, GITHUB_HOST, HTTPS_PORT, git_rootCACertificate, BLOCKLIST)) {
     HTTPClient https;
     size_t downloadSize = 0;
@@ -323,7 +323,7 @@ void buildAppJsonString(bool filter) {
 }
 
 esp_err_t appSpecificWebHandler(httpd_req_t *req, const char* variable, const char* value) {
-  return ESP_OK;
+  return ESP_FAIL;
 }
 
 esp_err_t appSpecificSustainHandler(httpd_req_t* req) {

globals.h

@@ -3,18 +3,26 @@
 // s60sc 2021, 2022
 
 #include "esp_arduino_version.h"
+
+#if ESP_ARDUINO_VERSION < ESP_ARDUINO_VERSION_VAL(3, 1, 1)
+#error Must be compiled with arduino-esp32 core v3.1.1 or higher
+#endif
+
 #pragma once
+
+//#define DEV_ONLY // leave commented out
+#ifdef DEV_ONLY
 // to compile with -Wall -Werror=all -Wextra
+#pragma GCC diagnostic error "-Wformat=2"
+#pragma GCC diagnostic ignored "-Wformat-truncation"
+#pragma GCC diagnostic ignored "-Wformat-y2k"
 #pragma GCC diagnostic ignored "-Wunused-function"
 #pragma GCC diagnostic ignored "-Wmissing-field-initializers"
 //#pragma GCC diagnostic ignored "-Wunused-variable"
 //#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
 //#pragma GCC diagnostic ignored "-Wignored-qualifiers"
 //#pragma GCC diagnostic ignored "-Wclass-memaccess"
-#if (ESP_ARDUINO_VERSION_MAJOR >= 3)
 #pragma GCC diagnostic ignored "-Wvolatile"
-#else
-#pragma GCC diagnostic ignored "-Wformat"
 #endif
 
 /******************** Libraries *******************/
@@ -26,18 +34,16 @@
 #include "ping/ping_sock.h"
 #include <Preferences.h>
 #include <regex>
-#if !CONFIG_IDF_TARGET_ESP32C3
+#if (!CONFIG_IDF_TARGET_ESP32C3 && !CONFIG_IDF_TARGET_ESP32S2)
 #include <SD_MMC.h>
 #endif
 #include <LittleFS.h>
 #include <sstream>
 #include <Update.h>
 #include <WiFi.h>
 #include <HTTPClient.h>
-////#include <NetworkClient.h> // v3.x only
-////#include <NetworkClientSecure.h> // v3.x only
-#include <WiFiClient.h>
-#include <WiFiClientSecure.h>
+#include <NetworkClient.h> 
+#include <NetworkClientSecure.h> 
 #include <esp_http_server.h>
 #include <esp_https_server.h>
 
@@ -81,7 +87,7 @@
 #define RAM_LOG_LEN (1024 * 7) // size of system message log in bytes stored in slow RTC ram (max 8KB - vars)
 #define MIN_STACK_FREE 512
 #define STARTUP_FAIL "Startup Failure: "
-#define MAX_PAYLOAD_LEN 256 // set bigger than any websocket payload
+#define MAX_PAYLOAD_LEN 672 // set bigger than any incoming websocket payload (20ms audio)
 #define NULL_TEMP -127
 #define OneMHz 1000000
 #define USECS 1000000
@@ -103,8 +109,10 @@ void buildJsonString(uint8_t filter);
 bool calcProgress(int progressVal, int totalVal, int percentReport, uint8_t &pcProgress);
 bool changeExtension(char* fileName, const char* newExt);
 bool checkAlarm();
+bool checkAuth(httpd_req_t* req);
 bool checkDataFiles();
 bool checkFreeStorage();
+bool checkI2Cdevice(const char* devName);
 void checkMemory(const char* source = "");
 uint32_t checkStackUse(TaskHandle_t thisTask, int taskIdx);
 void debugMemory(const char* caller);
@@ -128,11 +136,13 @@ char* fmtSize (uint64_t sizeVal);
 void forceCrash();
 void formatElapsedTime(char* timeStr, uint32_t timeVal, bool noDays = false);
 void formatHex(const char* inData, size_t inLen);
+bool formatSDcard();
 bool fsStartTransfer(const char* fileFolder);
 const char* getEncType(int ssidIndex);
 void getExtIP();
 time_t getEpoch();
 size_t getFreeStorage();
+uint32_t getFrequency();
 bool getLocalNTP();
 float getNTCcelsius(uint16_t resistance, float oldTemp);
 void goToSleep(int wakeupPin, bool deepSleep);
@@ -147,24 +157,27 @@ void logPrint(const char *fmtStr, ...);
 void logSetup();
 void OTAprereq();
 bool parseJson(int rxSize);
+bool prepFreq(int maxFreq, int sampleInterval);
+bool prepI2C();
 void prepPeripherals();
 void prepSMTP();
 bool prepTelegram();
 void prepTemperature();
-void prepUart();
 void prepUpload();
 void reloadConfigs();
+float readInternalTemp();
 float readTemperature(bool isCelsius, bool onlyDS18 = false);
 float readVoltage();
 void remote_log_init();
-void remoteServerClose(WiFiClientSecure& sclient);
-bool remoteServerConnect(WiFiClientSecure& sclient, const char* serverName, uint16_t serverPort, const char* serverCert, uint8_t connIdx);
+void remoteServerClose(NetworkClientSecure& sclient);
+bool remoteServerConnect(NetworkClientSecure& sclient, const char* serverName, uint16_t serverPort, const char* serverCert, uint8_t connIdx);
 void remoteServerReset();
 void removeChar(char* s, char c);
 void replaceChar(char* s, char c, char r);
 void reset_log();
 void resetWatchDog();
 bool retrieveConfigVal(const char* variable, char* value);
+void runTaskStats();
 esp_err_t sendChunks(File df, httpd_req_t *req, bool endChunking = true);
 void setFolderName(const char* fname, char* fileName);
 void setPeripheralResponse(const byte pinNum, const uint32_t responseData);
@@ -187,12 +200,13 @@ void urlDecode(char* inVal);
 bool urlEncode(const char* inVal, char* encoded, size_t maxSize);
 uint32_t usePeripheral(const byte pinNum, const uint32_t receivedData);
 esp_sleep_wakeup_cause_t wakeupResetReason();
-void wsAsyncSend(const char* wsData);
+void wsAsyncSendBinary(uint8_t* data, size_t len);
+bool wsAsyncSendText(const char* wsData);
 // mqtt.cpp
 void startMqttClient();  
 void stopMqttClient();  
 void mqttPublish(const char* payload);
-void mqttPublishPath(const char* suffix, const char* payload);
+void mqttPublishPath(const char* suffix, const char* payload, const char *device = "sensor");
 // telegram.cpp
 bool getTgramUpdate(char* response);
 bool sendTgramMessage(const char* info, const char* item, const char* parseMode);
@@ -238,6 +252,8 @@ extern bool doGetExtIP;
 extern bool usePing; // set to false if problems related to this issue occur: https://github.com/s60sc/ESP32-CAM_MJPEG2SD/issues/221
 extern bool wsLog;
 extern uint16_t sustainId;
+extern bool heartBeatDone;
+extern TaskHandle_t heartBeatHandle;
 
 // remote file server
 extern char fsServer[];
@@ -300,11 +316,14 @@ extern char messageLog[];
 extern uint16_t mlogEnd;
 extern bool timeSynchronized;
 extern bool monitorOpen; 
-extern const char* setupPage_html;
+extern const uint8_t setupPage_html_gz[];
+extern const size_t setupPage_html_gz_len;
 extern const char* otaPage_html;
-extern SemaphoreHandle_t wsSendMutex;
+extern const char* failPageS_html;
+extern const char* failPageE_html;
 extern char startupFailure[];
 extern time_t currEpoch;
+extern bool RCactive;
 
 extern UBaseType_t uxHighWaterMarkArr[];
 
@@ -313,6 +332,10 @@ extern int sdMinCardFreeSpace; // Minimum amount of card free Megabytes before f
 extern int sdFreeSpaceMode; // 0 - No Check, 1 - Delete oldest dir, 2 - Upload to ftp and then delete folder on SD 
 extern bool formatIfMountFailed ; // Auto format the file system if mount failed. Set to false to not auto format.
 
+// I2C pins
+extern int I2Csda;
+extern int I2Cscl;
+
 #define HTTP_METHOD_STRING(method) \
   (method == HTTP_DELETE) ? "DELETE" : \
   (method == HTTP_GET) ? "GET" : \
@@ -354,15 +377,18 @@ enum RemoteFail {SETASSIST, GETEXTIP, TGRAMCONN, FSFTP, EMAILCONN, EXTERNALHB, B
 /*********************** Log formatting ************************/
 
 //#define USE_LOG_COLORS  // uncomment to colorise log messages (eg if using idf.py, but not arduino)
-#ifdef USE_LOG_COLORS
+#ifdef USE_LOG_COLORS 
+// ANSI color codes
 #define LOG_COLOR_ERR  "\033[0;31m" // red
 #define LOG_COLOR_WRN  "\033[0;33m" // yellow
 #define LOG_COLOR_VRB  "\033[0;36m" // cyan
-#define LOG_NO_COLOR   "\033[0m"
+#define LOG_COLOR_DBG  "\033[0;34m" // blue
+#define LOG_NO_COLOR   
 #else
 #define LOG_COLOR_ERR
 #define LOG_COLOR_WRN
 #define LOG_COLOR_VRB
+#define LOG_COLOR_DBG
 #define LOG_NO_COLOR
 #endif 
 
@@ -375,6 +401,6 @@ enum RemoteFail {SETASSIST, GETEXTIP, TGRAMCONN, FSFTP, EMAILCONN, EXTERNALHB, B
 #define LOG_ERR(format, ...) logPrint(ERR_FORMAT(format "~"), ##__VA_ARGS__)
 #define VRB_FORMAT(format) LOG_COLOR_VRB "[%s VERBOSE @ %s:%u] " format LOG_NO_COLOR "\n", esp_log_system_timestamp(), pathToFileName(__FILE__), __LINE__
 #define LOG_VRB(format, ...) if (dbgVerbose) logPrint(VRB_FORMAT(format), ##__VA_ARGS__)
-#define DBG_FORMAT(format) LOG_COLOR_ERR "[###### DBG @ %s:%u] " format LOG_NO_COLOR "\n", pathToFileName(__FILE__), __LINE__
+#define DBG_FORMAT(format) LOG_COLOR_DBG "[%s ### DEBUG @ %s:%u] " format LOG_NO_COLOR "\n", esp_log_system_timestamp(), pathToFileName(__FILE__), __LINE__
 #define LOG_DBG(format, ...) do { logPrint(DBG_FORMAT(format), ##__VA_ARGS__); delay(FLUSH_DELAY); } while (0)
 #define LOG_PRT(buff, bufflen) log_print_buf((const uint8_t*)buff, bufflen)

prefs.cpp

@@ -30,7 +30,6 @@
 static fs::FS fp = STORAGE;
 static std::vector<std::vector<std::string>> configs;
 static Preferences prefs; 
-char* jsonBuff = NULL;
 static char appId[16];
 static char variable[FILE_NAME_LEN] = {0};
 static char value[IN_FILE_NAME_LEN] = {0};
@@ -64,7 +63,7 @@ void reloadConfigs() {
 #if INCLUDE_MQTT
   if (mqtt_active) {
     buildJsonString(1);
-    mqttPublishPath("config", jsonBuff);
+    mqttPublishPath("status", jsonBuff);
   }
 #endif
 }
@@ -192,6 +191,9 @@ static bool savePrefs(bool retain = true) {
 #endif
 #if INCLUDE_MQTT
   prefs.putString("mqtt_user_Pass", mqtt_user_Pass);
+#endif
+#if INCLUDE_RTSP
+  prefs.putString("RTSP_Pass", RTSP_Pass);
 #endif
   prefs.end();
   LOG_INF("Saved preferences");
@@ -222,6 +224,9 @@ static bool loadPrefs() {
 #endif
 #if INCLUDE_MQTT
   prefs.getString("mqtt_user_Pass", mqtt_user_Pass, MAX_PWD_LEN);
+#endif
+#if INCLUDE_RTSP
+  prefs.getString("RTSP_Pass", RTSP_Pass, MAX_PWD_LEN);
 #endif
   prefs.end();
   return true;
@@ -237,7 +242,7 @@ void updateStatus(const char* variable, const char* _value, bool fromUser) {
   if (mqtt_active) {
     char buff[(IN_FILE_NAME_LEN * 2)];
     snprintf(buff, IN_FILE_NAME_LEN * 2, "%s=%s", variable, value);
-    mqttPublish(buff);
+    mqttPublishPath("state", buff);
   }
 #endif
 
@@ -315,7 +320,20 @@ void updateStatus(const char* variable, const char* _value, bool fromUser) {
   else if (!strcmp(variable, "mqtt_user_Pass") && value[0] != '*') strncpy(mqtt_user_Pass, value, MAX_PWD_LEN-1);
   else if (!strcmp(variable, "mqtt_topic_prefix")) strncpy(mqtt_topic_prefix, value, (FILE_NAME_LEN/2)-1);
 #endif
-
+#if INCLUDE_RTSP
+  else if (!strcmp(variable, "RTSP_Name")) strncpy(RTSP_Name, value, MAX_HOST_LEN-1);
+  else if (!strcmp(variable, "RTSP_Pass")  && value[0] != '*')strncpy(RTSP_Pass, value, MAX_PWD_LEN-1);
+  else if (!strcmp(variable, "rtsp00Video")) rtspVideo = streamVid = (bool)intVal;
+  else if (!strcmp(variable, "rtsp01Audio")) rtspAudio = streamAud = (bool)intVal;
+  else if (!strcmp(variable, "rtsp02Subtitles")) rtspSubtitles = streamSrt = (bool)intVal;
+  else if (!strcmp(variable, "rtsp03Port")) rtspPort = intVal;
+  else if (!strcmp(variable, "rtsp04VideoPort")) rtpVideoPort = intVal;
+  else if (!strcmp(variable, "rtsp05AudioPort")) rtpAudioPort = intVal;
+  else if (!strcmp(variable, "rtsp06SubtitlesPort")) rtpSubtitlesPort = intVal;
+  else if (!strcmp(variable, "rtsp07Ip")) strncpy(RTP_ip, value, MAX_IP_LEN-1);
+  else if (!strcmp(variable, "rtsp08MaxC")) rtspMaxClients = intVal;
+  else if (!strcmp(variable, "rtsp09TTL")) rtpTTL = intVal;
+#endif
   // Other settings
   else if (!strcmp(variable, "clockUTC")) syncToBrowser((uint32_t)intVal);      
   else if (!strcmp(variable, "timezone")) strncpy(timezone, value, FILE_NAME_LEN-1);
@@ -359,7 +377,10 @@ void updateStatus(const char* variable, const char* _value, bool fromUser) {
     saveConfigVect();
   } else {
     res = updateAppStatus(variable, value, fromUser);
-    if (!res) LOG_VRB("Unrecognised config: %s", variable);
+    if (!res) {
+      if (fromUser) LOG_WRN("Unable to config %s as required cpp file not included", variable);
+      else LOG_VRB("Unrecognised config: %s", variable);
+    }
   }
   if (res) updateConfigVect(variable, value);  
 }
@@ -381,7 +402,7 @@ void buildJsonString(uint8_t filter) {
     char timeBuff[20];
     strftime(timeBuff, 20, "%Y-%m-%d %H:%M:%S", localtime(&currEpoch));
     p += sprintf(p, "\"clock\":\"%s\",", timeBuff);
-    formatElapsedTime(timeBuff, millis());
+    formatElapsedTime(timeBuff, millis()); // rolls over after 49.7 days due to max uint32
     p += sprintf(p, "\"up_time\":\"%s\",", timeBuff);   
     p += sprintf(p, "\"free_heap\":\"%s\",", fmtSize(ESP.getFreeHeap()));    
     p += sprintf(p, "\"wifi_rssi\":\"%i dBm\",", WiFi.RSSI() );  
@@ -408,6 +429,9 @@ void buildJsonString(uint8_t filter) {
 #endif
 #if INCLUDE_MQTT
       p += sprintf(p, "\"mqtt_user_Pass\":\"%.*s\",", strlen(mqtt_user_Pass), FILLSTAR);
+#endif
+#if INCLUDE_RTSP
+      p += sprintf(p, "\"RTSP_Pass\":\"%.*s\",", strlen(RTSP_Pass), FILLSTAR);
 #endif
     }
   } else {
@@ -504,9 +528,6 @@ static bool checkConfigFile() {
 bool loadConfig() {
   // called on startup
   LOG_INF("Load config");
-  if (jsonBuff == NULL) {
-    jsonBuff = psramFound() ? (char*)ps_malloc(JSON_BUFF_LEN) : (char*)malloc(JSON_BUFF_LEN); 
-  }
   bool res = checkConfigFile();
   if (!res) res = checkConfigFile(); // to recreate file if deleted on first call
   if (res) {