refactor: logging refactoring

include/zh_espnow.h

@@ -187,6 +187,18 @@ extern "C"
      */
     esp_err_t zh_espnow_get_mac(uint8_t *mac_addr);
 
+    /**
+     * @brief Get the number of available places in the queue.
+     *
+     * @return Number of available places.
+     */
+    uint8_t zh_espnow_get_queue_space(void);
+
+    /**
+     * @brief Clean up the message queue.
+     */
+    void zh_espnow_clear_queue(void);
+
 #ifdef __cplusplus
 }
 #endif

version.txt

@@ -1 +1 @@
-1.7.0
+1.8.0

zh_espnow.c

@@ -14,6 +14,13 @@ static const char *TAG = "zh_espnow";
         return err;                          \
     }
 
+#define ZH_ESPNOW_CHECK_GOTO(cond, err, tag, msg, ...) \
+    if (!(cond))                                       \
+    {                                                  \
+        ZH_ESPNOW_LOGE_ERR(msg, err);                  \
+        goto tag;                                      \
+    }
+
 #define DATA_SEND_SUCCESS BIT0
 #define DATA_SEND_FAIL BIT1
 #define WAIT_CONFIRM_MAX_TIME 50
@@ -51,9 +58,9 @@ static void _zh_espnow_process_send(_queue_t *queue);
 static void _zh_espnow_process_recv(_queue_t *queue);
 static void _zh_espnow_processing(void *pvParameter);
 
-static EventGroupHandle_t _event_group_handle = {0};
-static QueueHandle_t _queue_handle = {0};
-static TaskHandle_t _processing_task_handle = {0};
+static EventGroupHandle_t _event_group_handle = NULL;
+static QueueHandle_t _queue_handle = NULL;
+static TaskHandle_t _processing_task_handle = NULL;
 static zh_espnow_init_config_t _init_config = {0};
 static zh_espnow_stats_t _stats = {0};
 static bool _is_initialized = false;
@@ -73,66 +80,24 @@ esp_err_t zh_espnow_init(const zh_espnow_init_config_t *config)
         return ESP_OK;
     }
     esp_err_t err = _zh_espnow_validate_config(config);
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE("ESP-NOW initialization failed. Initial configuration check failed.");
-        return err;
-    }
-    else
-    {
-        ZH_ESPNOW_LOGI("ESP-NOW initial configuration check completed successfully.");
-    }
+    ZH_ESPNOW_CHECK(err == ESP_OK, err, "ESP-NOW initialization failed. Initial configuration check failed.");
+    ZH_ESPNOW_LOGI("ESP-NOW initial configuration check completed successfully.");
     _init_config = *config;
     err = _zh_espnow_init_wifi(config);
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE("ESP-NOW initialization failed. WiFi initialization failed.");
-        return err;
-    }
-    else
-    {
-        ZH_ESPNOW_LOGI("WiFi initialization completed successfully.");
-    }
+    ZH_ESPNOW_CHECK(err == ESP_OK, err, "ESP-NOW initialization failed. WiFi initialization failed.");
+    ZH_ESPNOW_LOGI("WiFi initialization completed successfully.");
     err = _zh_espnow_init_resources(config);
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE("ESP-NOW initialization failed. Resources initialization failed.");
-        goto CLEANUP;
-    }
-    else
-    {
-        ZH_ESPNOW_LOGI("ESP-NOW resources initialization completed successfully.");
-    }
+    ZH_ESPNOW_CHECK_GOTO(err == ESP_OK, err, CLEANUP, "ESP-NOW initialization failed. Resources initialization failed.");
+    ZH_ESPNOW_LOGI("ESP-NOW resources initialization completed successfully.");
     err = esp_now_init();
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE_ERR("ESP-NOW initialization failed. ESP-NOW driver initialization failed.", err);
-        goto CLEANUP;
-    }
-    else
-    {
-        ZH_ESPNOW_LOGI("ESP-NOW driver initialization completed successfully.");
-    }
+    ZH_ESPNOW_CHECK_GOTO(err == ESP_OK, err, CLEANUP, "ESP-NOW initialization failed. ESP-NOW driver initialization failed.");
+    ZH_ESPNOW_LOGI("ESP-NOW driver initialization completed successfully.");
     err = _zh_espnow_register_callbacks(config->battery_mode);
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE("ESP-NOW initialization failed. ESP-NOW callbacks registration failed.");
-        goto CLEANUP;
-    }
-    else
-    {
-        ZH_ESPNOW_LOGI("ESP-NOW callbacks registered successfully.");
-    }
+    ZH_ESPNOW_CHECK_GOTO(err == ESP_OK, err, CLEANUP, "ESP-NOW initialization failed. ESP-NOW callbacks registration failed.");
+    ZH_ESPNOW_LOGI("ESP-NOW callbacks registered successfully.");
     err = _zh_espnow_create_task(config);
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE("ESP-NOW initialization failed. Processing task initialization failed.");
-        goto CLEANUP;
-    }
-    else
-    {
-        ZH_ESPNOW_LOGI("ESP-NOW processing task initialization completed successfully.");
-    }
+    ZH_ESPNOW_CHECK_GOTO(err == ESP_OK, err, CLEANUP, "ESP-NOW initialization failed. Processing task initialization failed.");
+    ZH_ESPNOW_LOGI("ESP-NOW processing task initialization completed successfully.");
     _is_initialized = true;
     ZH_ESPNOW_LOGI("ESP-NOW initialization completed successfully.");
     return ESP_OK;
@@ -272,7 +237,7 @@ static esp_err_t _zh_espnow_init_resources(const zh_espnow_init_config_t *config
     _event_group_handle = xEventGroupCreate();
     ZH_ESPNOW_CHECK(_event_group_handle != NULL, ESP_FAIL, "Event group creation failed.");
     _queue_handle = xQueueCreate(config->queue_size, sizeof(_queue_t));
-    ZH_ESPNOW_CHECK(_queue_handle != 0, ESP_FAIL, "Queue creation failed.");
+    ZH_ESPNOW_CHECK(_queue_handle != NULL, ESP_FAIL, "Queue creation failed.");
     return ESP_OK;
 }
 
@@ -562,11 +527,7 @@ esp_err_t zh_espnow_set_channel(uint8_t channel)
     ZH_ESPNOW_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, "ESP-NOW channel set failed. ESP-NOW is not initialized.");
     ZH_ESPNOW_CHECK(channel > 0 && channel < 15, ESP_ERR_INVALID_ARG, "ESP-NOW channel set failed. Invalid channel.");
     esp_err_t err = esp_wifi_set_channel(channel, WIFI_SECOND_CHAN_NONE);
-    if (err != ESP_OK)
-    {
-        ZH_ESPNOW_LOGE_ERR("ESP-NOW channel set failed.", err);
-        return err;
-    }
+    ZH_ESPNOW_CHECK(err == ESP_OK, err, "ESP-NOW channel set failed.");
     _init_config.wifi_channel = channel;
     ZH_ESPNOW_LOGI("ESP-NOW channel set successfully.");
     return err;
@@ -597,4 +558,29 @@ esp_err_t zh_espnow_set_battery_mode(bool battery_mode)
 esp_err_t zh_espnow_get_mac(uint8_t *mac_addr)
 {
     return esp_wifi_get_mac(_init_config.wifi_interface, mac_addr);
+}
+
+uint8_t zh_espnow_get_queue_space(void)
+{
+    if (_queue_handle == NULL)
+    {
+        return 0;
+    }
+    return uxQueueSpacesAvailable(_queue_handle);
+}
+
+void zh_espnow_clear_queue(void)
+{
+    if (_queue_handle != NULL)
+    {
+        _queue_t queue = {0};
+        while (xQueueReceive(_queue_handle, &queue, 0) == pdTRUE)
+        {
+            if (queue.data.payload != NULL)
+            {
+                heap_caps_free(queue.data.payload);
+            }
+        }
+        ZH_ESPNOW_LOGI("Queue clear completed successfully.");
+    }
 }