Merge branch 'feat/debug_mode' into 'master'

feat: add debug mode

See merge request speech-recognition-framework/esp-sr!173

.gitlab-ci.yml

@@ -143,7 +143,7 @@ build_esp_sr:
     - .rules:build:test_esp_sr
   parallel:
     matrix:
-      - IMAGE: [espressif/idf:release-v5.4, espressif/idf:latest]
+      - IMAGE: [espressif/idf:v5.4.1, espressif/idf:latest]
         EXAMPLES_PATH: "test_apps/esp-sr"
 
 
@@ -153,7 +153,7 @@ build_esp_tts:
     - .rules:build:test_esp_tts
   parallel:
     matrix:
-      - IMAGE: [espressif/idf:release-v5.4, espressif/idf:latest]
+      - IMAGE: [espressif/idf:v5.4.1, espressif/idf:latest]
         EXAMPLES_PATH: "test_apps/esp-tts"
 
 build_esp32c5:
@@ -162,7 +162,7 @@ build_esp32c5:
     - .rules:build:test_esp32c5
   parallel:
     matrix:
-      - IMAGE: [espressif/idf:release-v5.4, espressif/idf:latest]
+      - IMAGE: [espressif/idf:v5.4.1, espressif/idf:latest]
         EXAMPLES_PATH: "test_apps/esp32c5"
 
 .test_template: &test_template

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log for esp-sr
 
+## 2.1.2
+- Add debug mode
+- Update wakenet trigget to v4
+
 ## 2.1.1
 - Add 8KHz AEC for VoIP
 - Add more wakenet9 models

CMakeLists.txt

@@ -7,6 +7,7 @@ if((${IDF_TARGET} STREQUAL "esp32s3") OR (${IDF_TARGET} STREQUAL "esp32p4") OR (
         
     set(srcs
         "src/model_path.c"
+        "src/esp_sr_debug.c"
         "src/esp_mn_speech_commands.c"
         "src/esp_process_sdkconfig.c"
         )

idf_component.yml

@@ -1,4 +1,4 @@
-version: "2.1.1"
+version: "2.1.2"
 description: esp_sr provides basic algorithms for Speech Recognition applications
 url: https://github.com/espressif/esp-sr
 dependencies:

src/esp_sr_debug.c

@@ -0,0 +1,12 @@
+// debug.c
+#include "esp_sr_debug.h"
+
+static int debug_enabled = 0;
+
+void esp_sr_set_debug_mode(int enabled) {
+    debug_enabled = enabled ? 1 : 0;
+}
+
+int esp_sr_get_debug_mode(void) {
+    return debug_enabled;
+}

src/include/esp_sr_debug.h

@@ -0,0 +1,26 @@
+#pragma once
+
+
+/**
+ * @brief Set the debug mode for esp-sr component.
+ * 
+ * @param enabled   Flag to control debug mode: 
+ *                  - 1: Enable debug mode (output debug information)
+ *                  - 0: Disable debug mode
+ * 
+ * @note This setting affects the verbosity of debug output from the esp-sr component.
+ *       Debug information may include processing details, intermediate results, etc.
+ */
+void esp_sr_set_debug_mode(int enabled);
+
+/**
+ * @brief Get the current debug mode status of esp-sr component.
+ * 
+ * @return Current debug mode status:
+ *         - 1: Debug mode is enabled
+ *         - 0: Debug mode is disabled
+ * 
+ * @note This function can be used to check whether debug output is currently active
+ *       before performing potentially expensive debug logging operations.
+ */
+int esp_sr_get_debug_mode(void);