Merge pull request #4907 from uwekaditz/P016]-PullRequest

[P016] DecodeType UNKNOWN was not on the web interface (decodetypes UNKNOWN and UNUSED were mixed up!)

Author: TD-er

src/CustomIR-sample.h

@@ -24,6 +24,9 @@
 // Set flags to enable (1) or disable (0) the DECODE_ and/or SEND_ feature for a specific IR device
 // To limit ESPEasy build-size you can disable DECODE_ or SEND_ flags for devices not needed
 
+// Decode any arbitrary IR message into a 32-bit code value:
+// #define DECODE_HASH 0 // Instead of decoding using a standard encoding scheme, This will give a unique value for each different code (probably), for most code systems
+
 // SEND-ONLY protocols:
 // #define SEND_GLOBALCACHE 0 // Is used by many sending protocols, so should probably be left to default
 // #define SEND_PRONTO 0
@@ -34,6 +37,7 @@
 // Standard: Use defaults for up to library version 2.8.2
 // Change as desired after copying CustomIR-sample.h to CustomIR.h
 
+// #define DECODE_HASH 0
 // #define DECODE_RC5 0
 // #define SEND_RC5 0
 // #define DECODE_RC6 0

src/_P016_IR.ino

@@ -23,6 +23,17 @@
 // IRSENDAC,'{"protocol":"COOLIX","power":"on","mode":"dry","fanspeed":"auto","temp":22,"swingv":"max","swingh":"off"}'
 
 /** Changelog:
+ * 2024-01-26 uwekaditz:  Decode type UNKNOWN was not added to the web settings
+ *                        Decode types UNKNOWN and UNUSED were mixed up
+ *                        Workaround for decode type UNKNOWN is not necessary
+ *                        Initalisation of the variables with decode type UNUSED
+ * 2024-01-23 uwekaditz:  Use the new property addToQueue in ExecuteCommand_all() due to the lack of resources
+ *                        Using strformat() for the debug messages
+ *                        Heap and memory can be reported (P016_CHECK_HEAP)
+ * 2023-12-11 uwekaditz:  Add protocol RAW to UI if 'Accept DecodeType UNKNOWN' is set
+ *                        Note: for decoding a RAW message DECODE_HASH must be set
+ *                        uint64ToString() in debug message in PLUGIN_TEN_PER_SECOND can not handle decode_type_t::UNKNOWN (-1),
+ *                        changed to ll2String()
  * 2022-08-08 tonhuisman: Optionally (compile-time) disable command handling by setting #define P016_FEATURE_COMMAND_HDNLING 0
  *                        Make reserved buffer size for receiver configurable 100..1024 uint16_t = 200-2048 bytes
  *                        Change UI to show buffer size in bytes instead of 'units' to avoid confusion.
@@ -42,6 +53,9 @@
 # ifdef P016_P035_Extended_AC
 #  include <IRac.h>
 # endif // ifdef P016_P035_Extended_AC
+# ifdef P016_CHECK_HEAP
+#  include "src/Helpers/Memory.h"
+# endif // ifdef P016_CHECK_HEAP
 
 # define PLUGIN_016
 # define PLUGIN_ID_016 16
@@ -56,6 +70,14 @@
 # endif // ifndef P016_SEND_IR_TO_CONTROLLER
 
 // History
+// @uwekaditz: 2024-01-23
+// CHG: Use the new property addToQueue in ExecuteCommand_all() due to the lack of resources
+// NEW: Heap and memory can be reported (P016_CHECK_HEAP)
+// MSG: Using strformat() for the debug messages
+// @uwekaditz: 2023-12-11
+// NEW: Add protocol RAW to UI if 'Accept DecodeType UNKNOWN' is set
+// MSG: for decoding a RAW message DECODE_HASH must be set
+// FIX: uint64ToString() in debug message in PLUGIN_TEN_PER_SECOND can not handle decode_type_t::UNKNOWN (-1), changed to ll2String()
 // @tonhuisman: 2022-08-08
 // FIX: Resolve high memory use bu having the default buffer size reduced from 1024 to 100, and make that a setting
 // @tonhuisman: 2021-08-05
@@ -145,6 +167,12 @@ const uint16_t kMinUnknownSize = 12;
 
 IRrecv *irReceiver          = nullptr;
 bool    bEnableIRcodeAdding = false;
+
+# ifdef P016_CHECK_HEAP
+uint32_t fMem       = 0;
+uint32_t fFreeStack = 0;
+# endif // ifdef P016_CHECK_HEAP
+
 # ifdef P016_P035_USE_RAW_RAW2
 
 /* *INDENT-OFF* */
@@ -155,17 +183,9 @@ boolean displayRawToReadableB32Hex(String& outputStr, decode_results results);
 # ifdef PLUGIN_016_DEBUG
 void P016_infoLogMemory(const __FlashStringHelper *text) {
   if (loglevelActiveFor(LOG_LEVEL_INFO)) {
-    String log;
-
-    if (log.reserve(40 + strlen_P((PGM_P)text))) {
-      log += F("P016: Free memory ");
-      log += text;
-      log += F(": ");
-      log += FreeMem();
-      log += F(" stack: ");
-      log += getCurrentFreeStack();
-      addLogMove(LOG_LEVEL_INFO, log);
-    }
+    addLogMove(LOG_LEVEL_INFO, strformat(
+                 F("P016: %s FreeMem: %d FreeStack:%d"),
+                 text, FreeMem(), getCurrentFreeStack()));
   }
 }
 
@@ -181,11 +201,11 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
     {
       Device[++deviceCount].Number = PLUGIN_ID_016;
       Device[deviceCount].Type     = DEVICE_TYPE_SINGLE;
-#if P016_SEND_IR_TO_CONTROLLER
-        Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_STRING;
-#else
-        Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_ULONG;
-#endif
+      # if P016_SEND_IR_TO_CONTROLLER
+      Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_STRING;
+      # else // if P016_SEND_IR_TO_CONTROLLER
+      Device[deviceCount].VType = Sensor_VType::SENSOR_TYPE_ULONG;
+      # endif // if P016_SEND_IR_TO_CONTROLLER
       Device[deviceCount].Ports              = 0;
       Device[deviceCount].PullUpOption       = true;
       Device[deviceCount].InverseLogicOption = true;
@@ -357,8 +377,12 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
 
           int protocolCount = 0;
 
-          for (int i = 0; i < size; i++) {
-            const String protocol = typeToString(static_cast<decode_type_t>(i), false);
+          for (int i = static_cast<int>(decode_type_t::UNKNOWN); i < size; i++) {
+              const String protocol = typeToString(static_cast<decode_type_t>(i), false);
+
+            if ((!bAcceptUnknownType) && (static_cast<decode_type_t>(i) == UNKNOWN)) {
+              continue;
+            }
 
             if (protocol.length() > 1) {
               decodeTypeOptions.push_back(i);
@@ -371,13 +395,7 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
           }
 
           if (loglevelActiveFor(LOG_LEVEL_INFO)) {
-            String log; // Log this always
-
-            if (log.reserve(30)) {
-              log += F("IR: available decodetypes: ");
-              log += protocolCount;
-              addLogMove(LOG_LEVEL_INFO, log);
-            }
+            addLogMove(LOG_LEVEL_INFO, strformat(F("IR: available decodetypes: %d"), protocolCount));
           }
 
           const String P016_HEX_INPUT_PATTERN = F("(0x)?[0-9a-fA-F]{0,16}"); // 16 nibbles = 64 bit, 0x prefix is allowed but not added by
@@ -391,7 +409,7 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
           html_table_header(F("Alt. Decode type"));
           html_table_header(F("Repeat"));
           html_table_header(F("Alt. Code [Hex]"));
-          html_TR(); //added to make "tworow" work
+          html_TR(); // added to make "tworow" work
 
           int rowCnt = 0;
 
@@ -597,8 +615,14 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
     {
       decode_results results;
 
+      # ifdef P016_CHECK_HEAP
+      fMem       = FreeMem();
+      fFreeStack = getCurrentFreeStack();
+      # endif // ifdef P016_CHECK_HEAP
+
       if (irReceiver->decode(&results))
       {
+        success = true;
         yield(); // Feed the WDT after a time expensive decoding procedure
 
         if (results.overflow)
@@ -612,34 +636,29 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
         if ((results.decode_type != decode_type_t::UNKNOWN) || (bitRead(PCONFIG_LONG(0), P016_BitAcceptUnknownType)))
         {
           {
-            String output;
-            output.reserve(100); // Length of expected string, needed for strings > 11 chars
             // String output = String(F("IRSEND,")) + typeToString(results.decode_type, results.repeat) + ',' +
             // resultToHexidecimal(&results)
             // + ',' + uint64ToString(results.bits);
             // addLog(LOG_LEVEL_INFO, output); //Show the appropriate command to the user, so he can replay the message via P035 // Old
             // style
             // command
-            output += F("{\"protocol\":\"");
-            output += typeToString(results.decode_type, results.repeat);
-            output += F("\",\"data\":\"");
-            output += resultToHexidecimal(&results);
-            output += F("\",\"bits\":");
-            output += uint64ToString(results.bits);
-            output += '}';
+            event->String2 = strformat(
+              F("{\"protocol\":\"%s\",\"data\":\"%s\",\"bits\":%s}"),
+              typeToString(results.decode_type, results.repeat).c_str(),
+              resultToHexidecimal(&results).c_str(),
+              uint64ToString(results.bits).c_str());
 
             if (loglevelActiveFor(LOG_LEVEL_INFO)) {
               String Log;
 
-              if (Log.reserve(output.length() + 22)) {
+              if (Log.reserve(event->String2.length() + 22)) {
                 Log += F("IRSEND,\'");
-                Log += output;
-                Log += F("\' type: 0x");
-                Log += uint64ToString(results.decode_type);
+                Log += event->String2;
+                Log += F("\' type as int: ");
+                Log += ll2String(results.decode_type);
                 addLogMove(LOG_LEVEL_INFO, Log); // JSON representation of the command
               }
             }
-            event->String2 = std::move(output);
           }
 
           # if P016_FEATURE_COMMAND_HANDLING
@@ -659,17 +678,22 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
             if (strCode.length() <= P16_Cchars) {
               iCode += hexToULL(strCode);
 
-              if (iCodeDecodeType == decode_type_t::UNKNOWN) {
-                // set iCodeDecodeType UNKNOWN to RAW, otherwise AddCode() or ExecuteCode() will fail
-                iCodeDecodeType = decode_type_t::RAW;
-              }
-
               if (bitRead(PCONFIG_LONG(0), P016_BitAddNewCode) && bEnableIRcodeAdding) {
                 P016_data->AddCode(iCode, iCodeDecodeType, iCodeFlags); // add code if not saved so far
               }
 
+              #  ifdef P016_CHECK_HEAP
+
+              if (loglevelActiveFor(LOG_LEVEL_INFO)) {
+                addLogMove(LOG_LEVEL_INFO, strformat(
+                             F("Before decode: FreeMem: %d  FreeStack:%d / After: FreeMem: %d  FreeStack:%d"),
+                             fMem, fFreeStack,
+                             FreeMem(), getCurrentFreeStack()));
+              }
+              #  endif // ifdef P016_CHECK_HEAP
+
               if (bitRead(PCONFIG_LONG(0), P016_BitExecuteCmd)) {
-                P016_data->ExecuteCode(iCode, iCodeDecodeType, iCodeFlags); // execute command for code if available
+                success = P016_data->ExecuteCode(iCode, iCodeDecodeType, iCodeFlags); // execute command for code if available
               }
             }
           }
@@ -725,18 +749,12 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
         state.sleep    = -1;
         state.clock    = -1;
 
-        String description = IRAcUtils::resultAcToString(&results);
+        if (loglevelActiveFor(LOG_LEVEL_INFO)) {
+          String description = IRAcUtils::resultAcToString(&results);
 
-        if (!description.isEmpty()) {
-          if (loglevelActiveFor(LOG_LEVEL_INFO)) {
+          if (!description.isEmpty()) {
             // If we got a human-readable description of the message, display it.
-            String log;
-
-            if (log.reserve(10 + description.length())) {
-              log += F("AC State: ");
-              log += description;
-              addLogMove(LOG_LEVEL_INFO, log);
-            }
+            addLogMove(LOG_LEVEL_INFO, strformat(F("AC State: %s"), description.c_str()));
           }
         }
 
@@ -824,16 +842,15 @@ boolean Plugin_016(uint8_t function, struct EventStruct *event, String& string)
         }
         # endif // P016_P035_Extended_AC
 
-#if !P016_SEND_IR_TO_CONTROLLER
+        # if !P016_SEND_IR_TO_CONTROLLER
         {
           unsigned long IRcode = results.value;
           UserVar.setSensorTypeLong(event->TaskIndex, IRcode);
         }
-#endif
+        # endif // if !P016_SEND_IR_TO_CONTROLLER
         sendData(event);
+        break;
       }
-      success = true;
-      break;
     }
   }
   return success;
@@ -1041,7 +1058,7 @@ unsigned int storeB32Hex(char out[], unsigned int iOut, unsigned int val)
 
 void enableIR_RX(boolean enable)
 {
-#ifdef PLUGIN_016
+  #ifdef PLUGIN_016
 
   if (irReceiver == 0) { return; }
 
@@ -1050,5 +1067,5 @@ void enableIR_RX(boolean enable)
   } else {
     irReceiver->disableIRIn(); // Stop the receiver
   }
-#endif // PLUGIN_016
+  #endif // PLUGIN_016
 }

src/src/Helpers/StringConverter.cpp

@@ -117,7 +117,7 @@ String strformat(const String& format, ...)
   {
     va_list arg;
     va_start(arg, format); // variable args start after parameter 'format'
-    char temp[64];
+    static char temp[64];
     char* buffer = temp;
     int len = vsnprintf_P(temp, sizeof(temp), format.c_str(), arg);
     va_end(arg);
@@ -147,7 +147,7 @@ String strformat(const __FlashStringHelper * format, ...)
   {
     va_list arg;
     va_start(arg, format); // variable args start after parameter 'format'
-    char temp[64];
+    static char temp[64];
     char* buffer = temp;
     int len = vsnprintf_P(temp, sizeof(temp), (PGM_P)format, arg);
     va_end(arg);