doc: updated example

README.md

@@ -60,7 +60,7 @@ One expander on bus. All GPIO's as output (except P0 - input). Interrupt is enab
 i2c_master_bus_handle_t i2c_bus_handle = NULL;
 zh_pcf8574_handle_t pcf8574_handle = {0};
 
-void zh_pcf8574_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data); // Required only if used input GPIO interrupts.
+void zh_pcf8574_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data);
 
 void print_gpio_status(const char *message, uint8_t reg)
 {
@@ -86,23 +86,23 @@ void app_main(void)
         .flags.enable_internal_pullup = true,
     };
     i2c_new_master_bus(&i2c_bus_config, &i2c_bus_handle);
-    esp_event_loop_create_default();                                                                          // Required only if used input GPIO interrupts.
-    esp_event_handler_instance_register(ZH_PCF8574, ESP_EVENT_ANY_ID, &zh_pcf8574_event_handler, NULL, NULL); // Required only if used input GPIO interrupts.
-    zh_pcf8574_init_config_t config = ZH_PCF8574_INIT_CONFIG_DEFAULT();
-    config.i2c_handle = i2c_bus_handle;
-    config.i2c_address = 0x38;
-    config.p0_gpio_work_mode = true;     // Required only for input GPIO.
-    config.interrupt_gpio = GPIO_NUM_14; // Required only if used input GPIO interrupts.
-    zh_pcf8574_init(&config, &pcf8574_handle);
+    esp_event_loop_create_default();
+    esp_event_handler_instance_register(ZH_PCF8574, ESP_EVENT_ANY_ID, &zh_pcf8574_event_handler, NULL, NULL);
+    zh_pcf8574_init_config_t pcf8574_init_config = ZH_PCF8574_INIT_CONFIG_DEFAULT();
+    pcf8574_init_config.i2c_handle = i2c_bus_handle;
+    pcf8574_init_config.i2c_address = 0x38;
+    pcf8574_init_config.p0_gpio_work_mode = true;
+    pcf8574_init_config.interrupt_gpio = GPIO_NUM_14;
+    zh_pcf8574_init(&pcf8574_init_config, &pcf8574_handle);
     uint8_t reg = 0;
     zh_pcf8574_read(&pcf8574_handle, &reg);
     print_gpio_status("GPIO status: ", reg);
     printf("Set P7 to 1, P1 to 1 and P0 to 0.\n");
-    zh_pcf8574_write(&pcf8574_handle, 0b10000010); // GPIO P0 will not be changed because it is operating in input mode.
+    zh_pcf8574_write(&pcf8574_handle, 0b10000010);
     zh_pcf8574_read(&pcf8574_handle, &reg);
     print_gpio_status("GPIO status: ", reg);
     printf("Sets P0 to 0.\n");
-    zh_pcf8574_write_gpio(&pcf8574_handle, 0, false); // GPIO P0 will not be changed because it is operating in input mode.
+    zh_pcf8574_write_gpio(&pcf8574_handle, 0, false);
     bool gpio = 0;
     zh_pcf8574_read_gpio(&pcf8574_handle, 0, &gpio);
     printf("P0 status: %d.\n", gpio);
@@ -116,9 +116,19 @@ void app_main(void)
     zh_pcf8574_reset(&pcf8574_handle);
     zh_pcf8574_read(&pcf8574_handle, &reg);
     print_gpio_status("GPIO status: ", reg);
+    for (;;)
+    {
+        const zh_pcf8574_stats_t *stats = zh_pcf8574_get_stats();
+        printf("Number of i2c driver error: %ld.\n", stats->i2c_driver_error);
+        printf("Number of event post error: %ld.\n", stats->event_post_error);
+        printf("Number of vector error: %ld.\n", stats->vector_error);
+        printf("Number of queue overflow error: %ld.\n", stats->queue_overflow_error);
+        printf("Minimum free stack size: %ld.\n", stats->min_stack_size);
+        vTaskDelay(60000 / portTICK_PERIOD_MS);
+    }
 }
 
-void zh_pcf8574_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data) // Required only if used input GPIO interrupts.
+void zh_pcf8574_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data)
 {
     zh_pcf8574_event_on_isr_t *event = event_data;
     printf("Interrupt happened on device address 0x%02X on GPIO number %d at level %d.\n", event->i2c_address, event->gpio_number, event->gpio_level);

include/zh_pcf8574.h

@@ -70,6 +70,18 @@ extern "C"
         void *system;                       /*!< System pointer for use in another components. */
     } zh_pcf8574_handle_t;
 
+    /**
+     * @brief Structure for error statistics storage.
+     */
+    typedef struct
+    {
+        uint32_t i2c_driver_error;     /*!< Number of i2c driver error. */
+        uint32_t event_post_error;     /*!< Number of event post error. */
+        uint32_t vector_error;         /*!< Number of vector error. */
+        uint32_t queue_overflow_error; /*!< Number of queue overflow error. */
+        uint32_t min_stack_size;       /*!< Minimum free stack size. */
+    } zh_pcf8574_stats_t;
+
     ESP_EVENT_DECLARE_BASE(ZH_PCF8574);
 
     /**
@@ -100,6 +112,15 @@ extern "C"
      */
     esp_err_t zh_pcf8574_init(const zh_pcf8574_init_config_t *config, zh_pcf8574_handle_t *handle);
 
+    /**
+     * @brief Deinitialize PCF8574 expander.
+     *
+     * @param[in] handle Pointer to unique PCF8574 handle.
+     *
+     * @return ESP_OK if success or an error code otherwise.
+     */
+    esp_err_t zh_pcf8574_deinit(zh_pcf8574_handle_t *handle);
+    
     /**
      * @brief Read PCF8574 all GPIO's status.
      *
@@ -159,6 +180,18 @@ extern "C"
      */
     esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool status);
 
+    /**
+     * @brief Get error statistics.
+     *
+     * @return Pointer to the statistics structure.
+     */
+    const zh_pcf8574_stats_t *zh_pcf8574_get_stats(void);
+
+    /**
+     * @brief Reset error statistics.
+     */
+    void zh_pcf8574_reset_stats(void);
+
 #ifdef __cplusplus
 }
 #endif

version.txt

@@ -1 +1 @@
-2.1.0
+2.3.2

zh_pcf8574.c

@@ -19,6 +19,7 @@ static SemaphoreHandle_t _interrupt_semaphore = NULL;
 static uint8_t _interrupt_gpio = GPIO_NUM_MAX;
 static const uint8_t _gpio_matrix[8] = {0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80};
 static bool _is_prev_gpio_isr_service = false;
+static zh_pcf8574_stats_t _stats = {0};
 
 static zh_vector_t _vector = {0};
 
@@ -77,6 +78,42 @@ esp_err_t zh_pcf8574_init(const zh_pcf8574_init_config_t *config, zh_pcf8574_han
     return ESP_OK;
 }
 
+esp_err_t zh_pcf8574_deinit(zh_pcf8574_handle_t *handle)
+{
+    ZH_LOGI("PCF8574 deinitialization started.");
+    ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "PCF8574 deinitialization failed. Invalid argument.");
+    ZH_ERROR_CHECK(handle->is_initialized == true, ESP_ERR_INVALID_STATE, NULL, "PCF8574 deinitialization failed. PCF8574 not initialized.");
+    if (_interrupt_gpio < GPIO_NUM_MAX && handle->gpio_work_mode != 0)
+    {
+        for (uint16_t i = 0; i < zh_vector_get_size(&_vector); ++i)
+        {
+            zh_pcf8574_handle_t *temp_handle = zh_vector_get_item(&_vector, i);
+            if (handle->i2c_address == temp_handle->i2c_address)
+            {
+                zh_vector_delete_item(&_vector, i);
+                break;
+            }
+        }
+        if (zh_vector_get_size(&_vector) == 0)
+        {
+            gpio_isr_handler_remove((gpio_num_t)_interrupt_gpio);
+            gpio_reset_pin((gpio_num_t)_interrupt_gpio);
+            zh_vector_free(&_vector);
+            vSemaphoreDelete(_interrupt_semaphore);
+            vTaskDelete(zh_pcf8574);
+            if (_is_prev_gpio_isr_service == false)
+            {
+                gpio_uninstall_isr_service();
+            }
+            _interrupt_gpio = GPIO_NUM_MAX;
+        }
+    }
+    i2c_master_bus_rm_device(handle->dev_handle);
+    handle->is_initialized = false;
+    ZH_LOGI("PCF8574 deinitialization completed successfully.");
+    return ESP_OK;
+}
+
 esp_err_t zh_pcf8574_read(zh_pcf8574_handle_t *handle, uint8_t *reg)
 {
     ZH_LOGI("PCF8574 read register started.");
@@ -146,12 +183,28 @@ esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool
     return ESP_OK;
 }
 
+const zh_pcf8574_stats_t *zh_pcf8574_get_stats(void)
+{
+    return &_stats;
+}
+
+void zh_pcf8574_reset_stats(void)
+{
+    ZH_LOGI("Error statistic reset started.");
+    _stats.i2c_driver_error = 0;
+    _stats.event_post_error = 0;
+    _stats.vector_error = 0;
+    _stats.queue_overflow_error = 0;
+    _stats.min_stack_size = 0;
+    ZH_LOGI("Error statistic reset successfully.");
+}
+
 static esp_err_t _zh_pcf8574_validate_config(const zh_pcf8574_init_config_t *config) // -V2008
 {
     ZH_ERROR_CHECK(config != NULL, ESP_ERR_INVALID_ARG, NULL, "Initial config is NULL.");
     ZH_ERROR_CHECK((config->i2c_address >= 0x20 && config->i2c_address <= 0x27) || (config->i2c_address >= 0x38 && config->i2c_address <= 0x3F), ESP_ERR_INVALID_ARG, NULL, "Invalid I2C address.");
     ZH_ERROR_CHECK(config->task_priority >= 10 && config->stack_size >= 2048, ESP_ERR_INVALID_ARG, NULL, "Invalid task settings.");
-    ZH_ERROR_CHECK(config->interrupt_gpio >= GPIO_NUM_0 && config->interrupt_gpio <= GPIO_NUM_MAX, ESP_ERR_INVALID_ARG, NULL, "Invalid GPIO number.");
+    ZH_ERROR_CHECK(config->interrupt_gpio <= GPIO_NUM_MAX, ESP_ERR_INVALID_ARG, NULL, "Invalid GPIO number.");
     ZH_ERROR_CHECK(config->i2c_handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Invalid I2C handle.");
     return ESP_OK;
 }
@@ -234,7 +287,10 @@ static esp_err_t _zh_pcf8574_task_init(const zh_pcf8574_init_config_t *config)
 static void IRAM_ATTR _zh_pcf8574_isr_handler(void *arg)
 {
     BaseType_t xHigherPriorityTaskWoken = pdFALSE;
-    xSemaphoreGiveFromISR(_interrupt_semaphore, &xHigherPriorityTaskWoken);
+    if (xSemaphoreGiveFromISR(_interrupt_semaphore, &xHigherPriorityTaskWoken) != pdTRUE)
+    {
+        ++_stats.queue_overflow_error;
+    }
     if (xHigherPriorityTaskWoken == pdTRUE)
     {
         portYIELD_FROM_ISR();
@@ -251,6 +307,7 @@ static void IRAM_ATTR _zh_pcf8574_isr_processing_task(void *pvParameter)
             zh_pcf8574_handle_t *handle = zh_vector_get_item(&_vector, i);
             if (handle == NULL)
             {
+                ++_stats.vector_error;
                 ZH_LOGE("PCF8574 isr processing failed. Failed to get vector item data.", ESP_FAIL);
                 continue;
             }
@@ -281,11 +338,13 @@ static void IRAM_ATTR _zh_pcf8574_isr_processing_task(void *pvParameter)
                 err = esp_event_post(ZH_PCF8574, 0, &event, sizeof(event), 1000 / portTICK_PERIOD_MS);
                 if (err != ESP_OK)
                 {
+                    ++_stats.event_post_error;
                     ZH_LOGE("PCF8574 isr processing failed. Failed to post interrupt event.", err);
                     continue;
                 }
             }
         }
+        _stats.min_stack_size = (uint32_t)uxTaskGetStackHighWaterMark(NULL);
     }
     vTaskDelete(NULL);
 }
@@ -293,7 +352,7 @@ static void IRAM_ATTR _zh_pcf8574_isr_processing_task(void *pvParameter)
 static esp_err_t _zh_pcf8574_read_register(zh_pcf8574_handle_t *handle, uint8_t *reg)
 {
     esp_err_t err = i2c_master_receive(handle->dev_handle, &handle->gpio_status, sizeof(handle->gpio_status), 1000 / portTICK_PERIOD_MS);
-    ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "I2C driver error.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, ++_stats.i2c_driver_error, "I2C driver error.");
     *reg = handle->gpio_status;
     return ESP_OK;
 }
@@ -301,7 +360,7 @@ static esp_err_t _zh_pcf8574_read_register(zh_pcf8574_handle_t *handle, uint8_t
 static esp_err_t _zh_pcf8574_write_register(zh_pcf8574_handle_t *handle, uint8_t reg)
 {
     esp_err_t err = i2c_master_transmit(handle->dev_handle, &reg, sizeof(reg), 1000 / portTICK_PERIOD_MS);
-    ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "I2C driver error.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, ++_stats.i2c_driver_error, "I2C driver error.");
     handle->gpio_status = reg;
     return ESP_OK;
 }