feat: added encoder number duplicate check

README.md

@@ -15,6 +15,11 @@
 ## Attention
 
 1. If the button is not used, specify any free GPIO in the initial configuration.
+2. For correct operation, please enable the following settings in the menuconfig:
+
+```text
+GPIO_CTRL_FUNC_IN_IRAM
+```
 
 ## Using
 

include/zh_encoder.h

@@ -39,16 +39,16 @@ extern "C"
      */
     typedef struct
     {
-        double encoder_step;       /*!< Encoder step. @note Must be greater than 0. */
+        double encoder_step;      /*!< Encoder step. @note Must be greater than 0. */
         double encoder_min_value; /*!< Encoder min value. @note Must be less than encoder_max_value. */
         double encoder_max_value; /*!< Encoder max value. @note Must be greater than encoder_min_value. */
-        uint8_t task_priority;     /*!< Task priority for the encoder isr processing. @note Minimum value is 1. */
-        uint8_t queue_size;        /*!< Queue size for task for the encoder processing. @note Minimum value is 1. */
-        uint8_t a_gpio_number;     /*!< Encoder A GPIO number. */
-        uint8_t b_gpio_number;     /*!< Encoder B GPIO number. */
-        uint8_t s_gpio_number;     /*!< Encoder button GPIO number. */
-        uint8_t encoder_number;    /*!< Unique encoder number. */
-        uint16_t stack_size;       /*!< Stack size for task for the encoder isr processing processing. @note The minimum size is configMINIMAL_STACK_SIZE. */
+        uint8_t task_priority;    /*!< Task priority for the encoder isr processing. @note Minimum value is 1. */
+        uint8_t queue_size;       /*!< Queue size for task for the encoder processing. @note Minimum value is 1. */
+        uint8_t a_gpio_number;    /*!< Encoder A GPIO number. */
+        uint8_t b_gpio_number;    /*!< Encoder B GPIO number. */
+        uint8_t s_gpio_number;    /*!< Encoder button GPIO number. */
+        uint8_t encoder_number;   /*!< Unique encoder number. @note Must be greater than 0. */
+        uint16_t stack_size;      /*!< Stack size for task for the encoder isr processing processing. @note The minimum size is configMINIMAL_STACK_SIZE. */
     } zh_encoder_init_config_t;
 
     /**
@@ -56,17 +56,17 @@ extern "C"
      */
     typedef struct // -V802
     {
-        double encoder_step;       /*!< Encoder step. */
-        double encoder_position;   /*!< Encoder position. */
+        double encoder_step;      /*!< Encoder step. */
+        double encoder_position;  /*!< Encoder position. */
         double encoder_min_value; /*!< Encoder min value. */
         double encoder_max_value; /*!< Encoder max value. */
-        uint8_t a_gpio_number;     /*!< Encoder A GPIO number. */
-        uint8_t b_gpio_number;     /*!< Encoder B GPIO number. */
-        uint8_t s_gpio_number;     /*!< Encoder button GPIO number. */
-        uint8_t encoder_number;    /*!< Encoder unique number. */
-        uint8_t encoder_state;     /*!< Encoder internal state. */
-        bool button_status;        /*!< Encoder button status. */
-        bool is_initialized;       /*!< Encoder initialization flag. */
+        uint8_t a_gpio_number;    /*!< Encoder A GPIO number. */
+        uint8_t b_gpio_number;    /*!< Encoder B GPIO number. */
+        uint8_t s_gpio_number;    /*!< Encoder button GPIO number. */
+        uint8_t encoder_number;   /*!< Encoder unique number. */
+        uint8_t encoder_state;    /*!< Encoder internal state. */
+        bool button_status;       /*!< Encoder button status. */
+        bool is_initialized;      /*!< Encoder initialization flag. */
     } zh_encoder_handle_t;
 
     /**
@@ -116,6 +116,20 @@ extern "C"
      */
     esp_err_t zh_encoder_deinit(zh_encoder_handle_t *handle);
 
+    /**
+     * @brief Reinitialize encoder (change min, max and step values).
+     *
+     * @note The encoder will be set to the position (encoder_min_value + encoder_max_value)/2.
+     *
+     * @param[in, out] handle Pointer to unique encoder handle.
+     * @param[in] min Encoder min value. @note Must be less than encoder_max_value.
+     * @param[in] max Encoder max value. @note Must be greater than encoder_min_value.
+     * @param[in] step Encoder step. @note Must be greater than 0.
+     *
+     * @return ESP_OK if success or an error code otherwise.
+     */
+    esp_err_t zh_encoder_reinit(zh_encoder_handle_t *handle, double min, double max, double step);
+
     /**
      * @brief Set encoder position.
      *

version.txt

@@ -1 +1 @@
-1.3.0
+1.5.0

zh_encoder.c

@@ -29,11 +29,13 @@ static const uint8_t _encoder_matrix[7][4] = {
 
 TaskHandle_t zh_encoder = NULL;
 static QueueHandle_t _queue_handle = NULL;
+static portMUX_TYPE _spinlock = portMUX_INITIALIZER_UNLOCKED;
 
 static volatile uint64_t _prev_us = 0;
 static uint8_t _encoder_counter = 0;
 static bool _is_prev_gpio_isr_handler = false;
 static zh_encoder_stats_t _stats = {0};
+static uint8_t _encoder_number_matrix[10] = {0};
 
 static esp_err_t _zh_encoder_validate_config(const zh_encoder_init_config_t *config);
 static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
@@ -101,6 +103,14 @@ esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_han
     handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
     handle->is_initialized = true;
     ++_encoder_counter;
+    for (uint8_t i = 0; i < sizeof(_encoder_number_matrix); ++i)
+    {
+        if (_encoder_number_matrix[i] == 0)
+        {
+            _encoder_number_matrix[i] = handle->encoder_number;
+            break;
+        }
+    }
     ZH_LOGI("Encoder initialization completed successfully.");
     return ESP_OK;
 }
@@ -127,17 +137,44 @@ esp_err_t zh_encoder_deinit(zh_encoder_handle_t *handle)
     }
     handle->is_initialized = false;
     --_encoder_counter;
+    for (uint8_t i = 0; i < sizeof(_encoder_number_matrix); ++i)
+    {
+        if (_encoder_number_matrix[i] == handle->encoder_number)
+        {
+            _encoder_number_matrix[i] = 0;
+            break;
+        }
+    }
     ZH_LOGI("Encoder deinitialization completed successfully.");
     return ESP_OK;
 }
 
+esp_err_t zh_encoder_reinit(zh_encoder_handle_t *handle, double min, double max, double step) // -V2008
+{
+    ZH_LOGI("Encoder reinitialization started.");
+    ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder reinitialization failed. Invalid argument.");
+    ZH_ERROR_CHECK(handle->is_initialized == true, ESP_FAIL, NULL, "Encoder reinitialization failed. Encoder not initialized.");
+    ZH_ERROR_CHECK(max > min, ESP_ERR_INVALID_ARG, NULL, "Encoder reinitialization failed. Invalid encoder min/max value.");
+    ZH_ERROR_CHECK(step > 0, ESP_ERR_INVALID_ARG, NULL, "Encoder reinitialization failed. Invalid encoder step.");
+    taskENTER_CRITICAL(&_spinlock);
+    handle->encoder_min_value = min;
+    handle->encoder_max_value = max;
+    handle->encoder_step = step;
+    handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
+    taskEXIT_CRITICAL(&_spinlock);
+    ZH_LOGI("Encoder reinitialization completed successfully.");
+    return ESP_OK;
+}
+
 esp_err_t zh_encoder_set(zh_encoder_handle_t *handle, double position)
 {
     ZH_LOGI("Encoder set position started.");
     ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder set position failed. Invalid argument.");
     ZH_ERROR_CHECK(handle->is_initialized == true, ESP_FAIL, NULL, "Encoder set position failed. Encoder not initialized.");
     ZH_ERROR_CHECK(position <= handle->encoder_max_value && position >= handle->encoder_min_value, ESP_ERR_INVALID_ARG, NULL, "Encoder set position failed. Invalid argument.");
+    taskENTER_CRITICAL(&_spinlock);
     handle->encoder_position = position;
+    taskEXIT_CRITICAL(&_spinlock);
     ZH_LOGI("Encoder set position completed successfully.");
     return ESP_OK;
 }
@@ -157,7 +194,9 @@ esp_err_t zh_encoder_reset(zh_encoder_handle_t *handle)
     ZH_LOGI("Encoder reset started.");
     ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder reset failed. Invalid argument.");
     ZH_ERROR_CHECK(handle->is_initialized == true, ESP_FAIL, NULL, "Encoder reset failed. Encoder not initialized.");
+    taskENTER_CRITICAL(&_spinlock);
     handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
+    taskEXIT_CRITICAL(&_spinlock);
     ZH_LOGI("Encoder reset completed successfully.");
     return ESP_OK;
 }
@@ -176,13 +215,18 @@ void zh_encoder_reset_stats(void)
     ZH_LOGI("Error statistic reset successfully.");
 }
 
-static esp_err_t _zh_encoder_validate_config(const zh_encoder_init_config_t *config)
+static esp_err_t _zh_encoder_validate_config(const zh_encoder_init_config_t *config) // -V2008
 {
     ZH_ERROR_CHECK(config != NULL, ESP_ERR_INVALID_ARG, NULL, "Invalid configuration.");
     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->queue_size >= 1, ESP_ERR_INVALID_ARG, NULL, "Invalid queue size.");
     ZH_ERROR_CHECK(config->encoder_max_value > config->encoder_min_value, ESP_ERR_INVALID_ARG, NULL, "Invalid encoder min/max value.");
     ZH_ERROR_CHECK(config->encoder_step > 0, ESP_ERR_INVALID_ARG, NULL, "Invalid encoder step.");
+    ZH_ERROR_CHECK(config->encoder_number > 0, ESP_ERR_INVALID_ARG, NULL, "Invalid encoder number.");
+    for (uint8_t i = 0; i < sizeof(_encoder_number_matrix); ++i)
+    {
+        ZH_ERROR_CHECK(config->encoder_number != _encoder_number_matrix[i], ESP_ERR_INVALID_ARG, NULL, "Encoder number already present.");
+    }
     return ESP_OK;
 }