feat: added i2c address duplicate check

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,29 +86,29 @@ 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.
+    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 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.
+    config.p0_gpio_work_mode = ZH_PCF8574_GPIO_INPUT;
+    config.interrupt_gpio = GPIO_NUM_14;
     zh_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, ZH_PCF8574_GPIO_NUM_P0, ZH_PCF8574_GPIO_LOW);
     bool gpio = 0;
-    zh_pcf8574_read_gpio(&pcf8574_handle, 0, &gpio);
+    zh_pcf8574_read_gpio(&pcf8574_handle, ZH_PCF8574_GPIO_NUM_P0, &gpio);
     printf("P0 status: %d.\n", gpio);
     printf("Set P1 to 0.\n");
-    zh_pcf8574_write_gpio(&pcf8574_handle, 1, false);
-    zh_pcf8574_read_gpio(&pcf8574_handle, 1, &gpio);
+    zh_pcf8574_write_gpio(&pcf8574_handle, ZH_PCF8574_GPIO_NUM_P1, ZH_PCF8574_GPIO_LOW);
+    zh_pcf8574_read_gpio(&pcf8574_handle, ZH_PCF8574_GPIO_NUM_P1, &gpio);
     printf("P1 status: %d.\n", gpio);
     zh_pcf8574_read(&pcf8574_handle, &reg);
     print_gpio_status("GPIO status: ", reg);
@@ -128,7 +128,7 @@ void app_main(void)
     }
 }
 
-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

@@ -12,22 +12,27 @@
 #include "esp_event.h"
 #include "zh_vector.h"
 
+#define ZH_PCF8574_GPIO_OUTPUT false
+#define ZH_PCF8574_GPIO_INPUT true
+#define ZH_PCF8574_GPIO_LOW false
+#define ZH_PCF8574_GPIO_HIGH true
+
 /**
  * @brief PCF8574 expander initial default values.
  */
-#define ZH_PCF8574_INIT_CONFIG_DEFAULT() \
-    {                                    \
-        .task_priority = 10,             \
-        .stack_size = 2048,              \
-        .i2c_address = 0xFF,             \
-        .p0_gpio_work_mode = 0,          \
-        .p1_gpio_work_mode = 0,          \
-        .p2_gpio_work_mode = 0,          \
-        .p3_gpio_work_mode = 0,          \
-        .p4_gpio_work_mode = 0,          \
-        .p5_gpio_work_mode = 0,          \
-        .p6_gpio_work_mode = 0,          \
-        .p7_gpio_work_mode = 0,          \
+#define ZH_PCF8574_INIT_CONFIG_DEFAULT()             \
+    {                                                \
+        .task_priority = 1,                          \
+        .stack_size = configMINIMAL_STACK_SIZE,      \
+        .i2c_address = 0xFF,                         \
+        .p0_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p1_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p2_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p3_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p4_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p5_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p6_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
+        .p7_gpio_work_mode = ZH_PCF8574_GPIO_OUTPUT, \
         .interrupt_gpio = GPIO_NUM_MAX}
 
 #ifdef __cplusplus
@@ -37,22 +42,38 @@ extern "C"
 
     extern TaskHandle_t zh_pcf8574; /*!< Unique task handle. */
 
+    /**
+     * @brief Enumeration of PCF8574 expander GPIO.
+     */
+    typedef enum
+    {
+        ZH_PCF8574_GPIO_NUM_P0 = 0,
+        ZH_PCF8574_GPIO_NUM_P1,
+        ZH_PCF8574_GPIO_NUM_P2,
+        ZH_PCF8574_GPIO_NUM_P3,
+        ZH_PCF8574_GPIO_NUM_P4,
+        ZH_PCF8574_GPIO_NUM_P5,
+        ZH_PCF8574_GPIO_NUM_P6,
+        ZH_PCF8574_GPIO_NUM_P7,
+        ZH_PCF8574_GPIO_NUM_MAX
+    } zh_pcf8574_gpio_num_t;
+
     /**
      * @brief Structure for initial initialization of PCF8574 expander.
      */
     typedef struct
     {
-        uint8_t task_priority;              /*!< Task priority for the PCF8574 expander isr processing. @note It is not recommended to set a value less than 10. */
-        uint16_t stack_size;                /*!< Stack size for task for the PCF8574 expander isr processing processing. @note The minimum size is 2048 bytes. */
+        uint8_t task_priority;              /*!< Task priority for the PCF8574 expander isr processing. @note Minimum value is 1. */
+        uint16_t stack_size;                /*!< Stack size for task for the PCF8574 expander isr processing processing. @note The minimum size is configMINIMAL_STACK_SIZE. */
         uint8_t i2c_address;                /*!< Expander I2C address. */
-        bool p0_gpio_work_mode;             /*!< Expander GPIO PO work mode. True for input, false for output. */
-        bool p1_gpio_work_mode;             /*!< Expander GPIO P1 work mode. True for input, false for output. */
-        bool p2_gpio_work_mode;             /*!< Expander GPIO P2 work mode. True for input, false for output. */
-        bool p3_gpio_work_mode;             /*!< Expander GPIO P3 work mode. True for input, false for output. */
-        bool p4_gpio_work_mode;             /*!< Expander GPIO P4 work mode. True for input, false for output. */
-        bool p5_gpio_work_mode;             /*!< Expander GPIO P5 work mode. True for input, false for output. */
-        bool p6_gpio_work_mode;             /*!< Expander GPIO P6 work mode. True for input, false for output. */
-        bool p7_gpio_work_mode;             /*!< Expander GPIO P7 work mode. True for input, false for output. */
+        bool p0_gpio_work_mode;             /*!< Expander GPIO PO work mode. */
+        bool p1_gpio_work_mode;             /*!< Expander GPIO P1 work mode. */
+        bool p2_gpio_work_mode;             /*!< Expander GPIO P2 work mode. */
+        bool p3_gpio_work_mode;             /*!< Expander GPIO P3 work mode. */
+        bool p4_gpio_work_mode;             /*!< Expander GPIO P4 work mode. */
+        bool p5_gpio_work_mode;             /*!< Expander GPIO P5 work mode. */
+        bool p6_gpio_work_mode;             /*!< Expander GPIO P6 work mode. */
+        bool p7_gpio_work_mode;             /*!< Expander GPIO P7 work mode. */
         uint8_t interrupt_gpio;             /*!< Interrupt GPIO. @attention Must be same for all PCF8574 expanders. */
         i2c_master_bus_handle_t i2c_handle; /*!< Unique I2C bus handle. @attention Must be same for all PCF8574 expanders. */
     } zh_pcf8574_init_config_t;
@@ -165,7 +186,7 @@ extern "C"
      *
      * @return ESP_OK if success or an error code otherwise.
      */
-    esp_err_t zh_pcf8574_read_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool *status);
+    esp_err_t zh_pcf8574_read_gpio(zh_pcf8574_handle_t *handle, zh_pcf8574_gpio_num_t gpio, bool *status);
 
     /**
      * @brief Set PCF8574 GPIO status.
@@ -178,7 +199,7 @@ extern "C"
      *
      * @return ESP_OK if success or an error code otherwise.
      */
-    esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool status);
+    esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, zh_pcf8574_gpio_num_t gpio, bool status);
 
     /**
      * @brief Get error statistics.

version.txt

@@ -1 +1 @@
-2.3.0
+2.4.0

zh_pcf8574.c

@@ -17,10 +17,10 @@ TaskHandle_t zh_pcf8574 = NULL;
 static SemaphoreHandle_t _interrupt_semaphore = NULL;
 
 static uint8_t _interrupt_gpio = GPIO_NUM_MAX;
+static uint8_t _i2c_matrix[16] = {0};
 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 uint8_t _expander_counter = 0;
 
 static zh_vector_t _vector = {0};
 
@@ -75,7 +75,14 @@ esp_err_t zh_pcf8574_init(const zh_pcf8574_init_config_t *config, zh_pcf8574_han
         }
     }
     handle->is_initialized = true;
-    ++_expander_counter;
+    for (uint8_t i = 0; i < sizeof(_i2c_matrix); ++i)
+    {
+        if (_i2c_matrix[i] == 0)
+        {
+            _i2c_matrix[i] = handle->i2c_address;
+            break;
+        }
+    }
     ZH_LOGI("PCF8574 initialization completed successfully.");
     return ESP_OK;
 }
@@ -101,7 +108,9 @@ esp_err_t zh_pcf8574_deinit(zh_pcf8574_handle_t *handle)
             gpio_isr_handler_remove((gpio_num_t)_interrupt_gpio);
             gpio_reset_pin((gpio_num_t)_interrupt_gpio);
             zh_vector_free(&_vector);
-            if (_is_prev_gpio_isr_service == true)
+            vSemaphoreDelete(_interrupt_semaphore);
+            vTaskDelete(zh_pcf8574);
+            if (_is_prev_gpio_isr_service == false)
             {
                 gpio_uninstall_isr_service();
             }
@@ -110,7 +119,14 @@ esp_err_t zh_pcf8574_deinit(zh_pcf8574_handle_t *handle)
     }
     i2c_master_bus_rm_device(handle->dev_handle);
     handle->is_initialized = false;
-    --_expander_counter;
+    for (uint8_t i = 0; i < sizeof(_i2c_matrix); ++i)
+    {
+        if (_i2c_matrix[i] == handle->i2c_address)
+        {
+            _i2c_matrix[i] = 0;
+            break;
+        }
+    }
     ZH_LOGI("PCF8574 deinitialization completed successfully.");
     return ESP_OK;
 }
@@ -148,11 +164,11 @@ esp_err_t zh_pcf8574_reset(zh_pcf8574_handle_t *handle)
     return ESP_OK;
 }
 
-esp_err_t zh_pcf8574_read_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool *status) // -V2008
+esp_err_t zh_pcf8574_read_gpio(zh_pcf8574_handle_t *handle, zh_pcf8574_gpio_num_t gpio, bool *status) // -V2008
 {
     ZH_LOGI("PCF8574 read GPIO started.");
     ZH_ERROR_CHECK(handle != NULL && status != NULL, ESP_ERR_INVALID_ARG, NULL, "PCF8574 read GPIO failed. Invalid argument.");
-    ZH_ERROR_CHECK(gpio <= 7, ESP_FAIL, NULL, "PCF8574 read GPIO failed. Invalid GPIO number.")
+    ZH_ERROR_CHECK(gpio >= ZH_PCF8574_GPIO_NUM_P0 && gpio < ZH_PCF8574_GPIO_NUM_MAX, ESP_FAIL, NULL, "PCF8574 read GPIO failed. Invalid GPIO number.")
     ZH_ERROR_CHECK(handle->is_initialized == true, ESP_ERR_NOT_FOUND, NULL, "PCF8574 read GPIO failed. PCF8574 not initialized.");
     uint8_t gpio_temp = _gpio_matrix[gpio];
     uint8_t reg_temp = 0;
@@ -163,11 +179,11 @@ esp_err_t zh_pcf8574_read_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool *
     return ESP_OK;
 }
 
-esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, uint8_t gpio, bool status) // -V2008
+esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, zh_pcf8574_gpio_num_t gpio, bool status) // -V2008
 {
     ZH_LOGI("PCF8574 write GPIO started.");
     ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "PCF8574 write GPIO failed. Invalid argument.");
-    ZH_ERROR_CHECK(gpio <= 7, ESP_FAIL, NULL, "PCF8574 write GPIO failed. Invalid GPIO number.")
+    ZH_ERROR_CHECK(gpio >= ZH_PCF8574_GPIO_NUM_P0 && gpio < ZH_PCF8574_GPIO_NUM_MAX, ESP_FAIL, NULL, "PCF8574 write GPIO failed. Invalid GPIO number.")
     ZH_ERROR_CHECK(handle->is_initialized == true, ESP_ERR_NOT_FOUND, NULL, "PCF8574 write GPIO failed. PCF8574 not initialized.");
     uint8_t gpio_temp = _gpio_matrix[gpio];
     esp_err_t err = ESP_OK;
@@ -204,9 +220,13 @@ static esp_err_t _zh_pcf8574_validate_config(const zh_pcf8574_init_config_t *con
 {
     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->task_priority >= 1 && config->stack_size >= configMINIMAL_STACK_SIZE, ESP_ERR_INVALID_ARG, NULL, "Invalid task settings.");
+    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.");
+    for (uint8_t i = 0; i < sizeof(_i2c_matrix); ++i)
+    {
+        ZH_ERROR_CHECK(config->i2c_address != _i2c_matrix[i], ESP_ERR_INVALID_ARG, NULL, "I2C address already present.");
+    }
     return ESP_OK;
 }