Merge branch 'task/idf-versions-cleanup' into 'main'

idf_version_compatibility: Remove code that was retained for idf versions < 5.1

See merge request app-frameworks/esp-insights!190

Author: shahpiyushv

.gitlab-ci.yml

@@ -139,12 +139,6 @@ before_script:
     - done
     - echo Build Complete for $APP_BUILD
 
-build_idf_v5.0:
-  extends: .build_template
-  image: espressif/idf:release-v5.0
-  variables:
-    EXAMPLE_TARGETS: "esp32 esp32s2 esp32c3 esp32s3"
-
 build_idf_v5.1:
   extends: .build_template
   image: espressif/idf:release-v5.1

CHANGELOG.md

@@ -1,3 +1,16 @@
+## 26-Aug-2025 (Stable Release)
+
+- With this release we drop the beta tag in README
+- Bug Fixes:
+  - WDT trigger on crash_dump cbor encoding
+  - Incorrect data_send timer reset causing data send stop
+  - Command Response: Critical crash fixed
+  - Fixed log wrap linking errors on latest ESP-IDFs
+  - Fixed latest changes in docs not built
+- Features/Support:
+  - Dropped IDF 4.x support from main branch (For IDF 4.x support you may refer to idf_4_x_compat branch)
+  - Configurable polling interval for Wi-Fi and heap metrics
+
 ## 24-Jul-2024 (Command Response Framework and Components update)
 - Added support for command response framework
   - To demonstrate this, a simple reboot command has been added. Admins can trigger this command from the Insights dashboard (under Node's Settings tab) to reboot the device.

README.md

@@ -1,4 +1,4 @@
-# ESP Insights (Beta)
+# ESP Insights
 
 ESP Insights is a remote diagnostics solution that allows users to remotely monitor the health of ESP devices in the field.
 

components/esp_diag_data_store/CMakeLists.txt

@@ -1,7 +1,5 @@
-# from IDF version 5.0, we need to explicitly specify requirements
-if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.0")
+# These components are available in ESP-IDF >= 5.1
 set(req esp_event esp_hw_support)
-endif()
 
 set(srcs "src/esp_diag_data_store.c")
 

components/esp_diag_data_store/idf_component.yml

@@ -1,8 +1,8 @@
-version: "1.0.2"
+version: "1.1.0"
 description: Simple APIs to use ESP Diagnostics data storage
 url: https://github.com/espressif/esp-insights/tree/main/components/esp_diag_data_store
 repository: https://github.com/espressif/esp-insights.git
 issues: https://github.com/espressif/esp-insights/issues
 dependencies:
   idf:
-    version: ">=4.1"
+    version: ">=5.1"

components/esp_diag_data_store/src/rtc_store/rtc_store.c

@@ -22,12 +22,8 @@
 #include "esp_idf_version.h"
 #endif
 
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
-#include <esp_random.h> // esp_system.h does not provice esp_random() API from IDF v5.0
+#include <esp_random.h> // esp_system.h does not provide esp_random() API from IDF v5.0
 #include <esp_app_desc.h> // for `esp_app_get_elf_sha256` API
-#else
-#include <esp_ota_ops.h>
-#endif
 
 #define TAG "RTC_STORE"
 #define INSIGHTS_NVS_NAMESPACE "storage"
@@ -505,16 +501,6 @@ static inline uint8_t to_int_digit(unsigned val)
     return (val <= '9') ? (val - '0') : (val - 'a' + 10);
 }
 
-#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
-static void hex_to_bytes(uint8_t *src, uint8_t *dst, int out_len)
-{
-    for (int i = 0; i < out_len; i++) {
-        uint8_t val0 = to_int_digit(src[2 * i]);
-        uint8_t val1 = to_int_digit(src[2 * i + 1]);
-        dst[i] = (val0 << 4) | (val1);
-    }
-}
-#endif
 
 static esp_err_t rtc_store_meta_hdr_init()
 {
@@ -558,13 +544,8 @@ static esp_err_t rtc_store_meta_hdr_init()
     s_priv_data.meta_hdr = &s_rtc_store.meta[s_rtc_store.meta_hdr_idx];
 
     // populate meta header
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
     const uint8_t* src = esp_app_get_description()->app_elf_sha256;
     memcpy((uint8_t *)s_priv_data.meta_hdr->sha_sum, src, RTC_STORE_SHA_SIZE);
-#else
-    esp_ota_get_app_elf_sha256(s_priv_data.sha_sum, sizeof(s_priv_data.sha_sum));
-    hex_to_bytes((uint8_t *) s_priv_data.sha_sum, (uint8_t *) s_priv_data.meta_hdr->sha_sum, RTC_STORE_SHA_SIZE);
-#endif
 
     s_priv_data.meta_hdr->gen_id = gen_id;
     s_priv_data.meta_hdr->boot_cnt = boot_cnt;

components/esp_diagnostics/CMakeLists.txt

@@ -18,17 +18,8 @@ if(CONFIG_DIAG_ENABLE_VARIABLES)
     endif()
 endif()
 
-set(priv_req freertos app_update rmaker_common)
-
-# esp_hw_support component was introduced in v4.3
-if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER "4.2")
-    list(APPEND priv_req esp_hw_support)
-endif()
-
-# from IDF version 5.0, we need to explicitly specify requirements
-if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.0")
-    list(APPEND priv_req  esp_wifi esp_event)
-endif()
+set(priv_req freertos app_update rmaker_common
+             esp_hw_support esp_wifi esp_event)
 
 idf_component_register(SRCS "${srcs}"
                     INCLUDE_DIRS "include"

components/esp_diagnostics/idf_component.yml

@@ -1,10 +1,10 @@
-version: "1.2.3"
+version: "1.3.0"
 description: Diagnostics component used in ESP Insights, which is a remote diagnostics solution to monitor the health of ESP devices in the field.
 url: https://github.com/espressif/esp-insights/tree/main/components/esp_diagnostics
 repository: https://github.com/espressif/esp-insights.git
 issues: https://github.com/espressif/esp-insights/issues
 dependencies:
   idf:
-    version: ">=4.1"
+    version: ">=5.1"
   espressif/rmaker_common:
-    version: "~1.4.0"
+    version: "~1.5.0"

components/esp_diagnostics/src/esp_diagnostics_heap_metrics.c

@@ -116,7 +116,6 @@ static void heap_timer_cb(TimerHandle_t handle)
     esp_rmaker_work_queue_add_task(heap_metrics_dump_cb, NULL);
 }
 
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 0)
 static void alloc_failed_hook(size_t size, uint32_t caps, const char *func)
 {
     esp_diag_heap_metrics_dump();
@@ -128,14 +127,12 @@ static void alloc_failed_hook(size_t size, uint32_t caps, const char *func)
 
     ESP_DIAG_EVENT(METRICS_TAG, KEY_ALLOC_FAIL " size:0x%x func:%s", size, func);
 }
-#endif
 
 esp_err_t esp_diag_heap_metrics_init(void)
 {
     if (s_priv_data.init) {
         return ESP_ERR_INVALID_STATE;
     }
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 0)
     esp_err_t err = heap_caps_register_failed_alloc_callback(alloc_failed_hook);
     if (err != ESP_OK) {
         return err;
@@ -146,7 +143,6 @@ esp_err_t esp_diag_heap_metrics_init(void)
 #else
     esp_diag_metrics_add_unit(KEY_ALLOC_FAIL, METRICS_UNIT);
 #endif
-#endif
 
 #ifdef CONFIG_ESP32_SPIRAM_SUPPORT
     esp_diag_metrics_register(METRICS_TAG, KEY_EXT_FREE, "External free heap", PATH_HEAP_EXTERNAL, ESP_DIAG_DATA_TYPE_UINT);
@@ -198,9 +194,7 @@ esp_err_t esp_diag_heap_metrics_deinit(void)
         ESP_LOGW(LOG_TAG, "Failed to delete heap metric timer");
     }
 #ifdef CONFIG_ESP_INSIGHTS_META_VERSION_10
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 0)
     esp_diag_metrics_unregister(KEY_ALLOC_FAIL);
-#endif
 #ifdef CONFIG_ESP32_SPIRAM_SUPPORT
     esp_diag_metrics_unregister(KEY_EXT_FREE);
     esp_diag_metrics_unregister(KEY_EXT_LFB);
@@ -210,9 +204,7 @@ esp_err_t esp_diag_heap_metrics_deinit(void)
     esp_diag_metrics_unregister(KEY_LFB);
     esp_diag_metrics_unregister(KEY_MIN_FREE);
 #else
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 0)
     esp_diag_metrics_unregister(METRICS_TAG, KEY_ALLOC_FAIL);
-#endif
 #ifdef CONFIG_ESP32_SPIRAM_SUPPORT
     esp_diag_metrics_unregister(METRICS_TAG, KEY_EXT_FREE);
     esp_diag_metrics_unregister(METRICS_TAG, KEY_EXT_LFB);

components/esp_diagnostics/src/esp_diagnostics_log_hook.c

@@ -13,17 +13,11 @@
 #include <freertos/FreeRTOS.h>
 #include <freertos/task.h>
 
-/* Onwards esp-idf v5.0 esp_cpu_process_stack_pc() is moved to
- * components/xtensa/include/esp_cpu_utils.h
- */
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
-    #if CONFIG_IDF_TARGET_ARCH_XTENSA
-        #include "esp_cpu_utils.h"
-    #else /* CONFIG_IDF_TARGET_ARCH_RISCV */
-        #define esp_cpu_process_stack_pc(x) (x)   // dummy definition to avoid compilation error
-    #endif
-#else // For esp-idf version <= v4.4
-    #include "soc/cpu.h"
+/* Available in ESP-IDF >= 5.1 */
+#if CONFIG_IDF_TARGET_ARCH_XTENSA
+    #include "esp_cpu_utils.h"
+#else /* CONFIG_IDF_TARGET_ARCH_RISCV */
+    #define esp_cpu_process_stack_pc(x) (x)   // dummy definition to avoid compilation error
 #endif
 
 #define IS_LOG_TYPE_ENABLED(type) (s_priv_data.init && (type & s_priv_data.enabled_log_type))
@@ -324,11 +318,7 @@ static esp_err_t diag_log_add(esp_diag_log_type_t type, uint32_t pc, const char
     log.msg_args_len = strlen((char *)log.msg_args);
 #endif
     va_end(ap);
-#if ESP_IDF_VERSION_MAJOR == 4 && ESP_IDF_VERSION_MINOR < 3
-    task_name = pcTaskGetTaskName(NULL);
-#else
     task_name = pcTaskGetName(NULL);
-#endif
     if (task_name) {
         strlcpy(log.task_name, task_name, sizeof(log.task_name));
     }