doc: updated example

README.md

@@ -1,25 +1,20 @@
-# ESP32 ESP-IDF and ESP8266 RTOS SDK component for rotary encoder
+# ESP32 ESP-IDF component for rotary encoder
 
 ## Tested on
 
-1. [ESP8266 RTOS_SDK v3.4](https://docs.espressif.com/projects/esp8266-rtos-sdk/en/latest/index.html#)
-2. [ESP32 ESP-IDF v5.4](https://docs.espressif.com/projects/esp-idf/en/release-v5.4/esp32/index.html)
+1. [ESP32 ESP-IDF v5.5.1](https://docs.espressif.com/projects/esp-idf/en/v5.5.1/esp32/index.html)
 
 ## Features
 
 1. Support some encoders on one device.
 
-## Note
-
-1. Encoder pins must be pull up to the VCC via 0.1 µf capacitors.
-
 ## Using
 
 In an existing project, run the following command to install the components:
 
 ```text
 cd ../your_project/components
-git clone http://git.zh.com.ru/alexey.zholtikov/zh_encoder
+git clone http://git.zh.com.ru/esp_components/zh_encoder
 ```
 
 In the application, add the component:
@@ -41,39 +36,38 @@ void zh_encoder_event_handler(void *arg, esp_event_base_t event_base, int32_t ev
 
 void app_main(void)
 {
-    esp_log_level_set("zh_encoder", ESP_LOG_NONE); // For ESP8266 first enable "Component config -> Log output -> Enable log set level" via menuconfig.
+    esp_log_level_set("zh_encoder", ESP_LOG_ERROR);
     esp_event_loop_create_default();
-#ifdef CONFIG_IDF_TARGET_ESP8266
-    esp_event_handler_register(ZH_ENCODER, ESP_EVENT_ANY_ID, &zh_encoder_event_handler, NULL);
-#else
     esp_event_handler_instance_register(ZH_ENCODER, ESP_EVENT_ANY_ID, &zh_encoder_event_handler, NULL, NULL);
-#endif
     zh_encoder_init_config_t encoder_init_config = ZH_ENCODER_INIT_CONFIG_DEFAULT();
+    encoder_init_config.task_priority = 5;
+    encoder_init_config.stack_size = configMINIMAL_STACK_SIZE;
+    encoder_init_config.queue_size = 3;
     encoder_init_config.a_gpio_number = GPIO_NUM_27;
     encoder_init_config.b_gpio_number = GPIO_NUM_26;
-    // encoder_init_config.encoder_min_value = -10; // Just for example.
-    // encoder_init_config.encoder_max_value = 20;  // Just for example.
-    // encoder_init_config.encoder_step = 0.1;      // Just for example.
+    encoder_init_config.encoder_min_value = -10;
+    encoder_init_config.encoder_max_value = 20;
+    encoder_init_config.encoder_step = 0.1;
     encoder_init_config.encoder_number = 1;
     zh_encoder_init(&encoder_init_config, &encoder_handle);
     double position = 0;
     zh_encoder_get(&encoder_handle, &position);
-    printf("Encoder position %0.2f.\n", position); // For ESP8266 first disable "Component config -> Newlib -> Enable ‘nano’ formatting options for printf/scanf family" via menuconfig.
-    // zh_encoder_set(&encoder_handle, 5); // Just for example.
-    // zh_encoder_reset(&encoder_handle);  // Just for example.
+    printf("Encoder position %0.2f.\n", position);
+    zh_encoder_set(&encoder_handle, 5);
+    zh_encoder_reset(&encoder_handle);
     for (;;)
     {
         const zh_encoder_stats_t *stats = zh_encoder_get_stats();
         printf("Number of event post error: %ld.\n", stats->event_post_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(10000 / portTICK_PERIOD_MS);
+        vTaskDelay(60000 / portTICK_PERIOD_MS);
     }
 }
 
 void zh_encoder_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data)
 {
     zh_encoder_event_on_isr_t *event = event_data;
-    printf("Encoder number %d position %0.2f.\n", event->encoder_number, event->encoder_position); // For ESP8266 first disable "Component config -> Newlib -> Enable ‘nano’ formatting options for printf/scanf family" via menuconfig.
+    printf("Encoder number %d position %0.2f.\n", event->encoder_number, event->encoder_position);
 }
 ```

include/zh_encoder.h

@@ -13,16 +13,16 @@
 /**
  * @brief Encoder initial default values.
  */
-#define ZH_ENCODER_INIT_CONFIG_DEFAULT() \
-    {                                    \
-        .task_priority = 10,             \
-        .stack_size = 3072,              \
-        .queue_size = 10,                \
-        .a_gpio_number = 0,              \
-        .b_gpio_number = 0,              \
-        .encoder_min_value = -100,       \
-        .encoder_max_value = 100,        \
-        .encoder_step = 1,               \
+#define ZH_ENCODER_INIT_CONFIG_DEFAULT()        \
+    {                                           \
+        .task_priority = 1,                     \
+        .stack_size = configMINIMAL_STACK_SIZE, \
+        .queue_size = 1,                        \
+        .a_gpio_number = GPIO_NUM_MAX,          \
+        .b_gpio_number = GPIO_NUM_MAX,          \
+        .encoder_min_value = -100,              \
+        .encoder_max_value = 100,               \
+        .encoder_step = 1,                      \
         .encoder_number = 0}
 
 #ifdef __cplusplus
@@ -37,9 +37,9 @@ extern "C"
      */
     typedef struct
     {
-        uint8_t task_priority;     /*!< Task priority for the encoder isr processing. @note It is not recommended to set a value less than 10. */
-        uint16_t stack_size;       /*!< Stack size for task for the encoder isr processing processing. @note The minimum size is 3072 bytes. */
-        uint8_t queue_size;        /*!< Queue size for task for the encoder processing. @note It is not recommended to set a value less than 10. */
+        uint8_t task_priority;     /*!< Task priority for the encoder isr processing. @note Minimum value is 1. */
+        uint16_t stack_size;       /*!< Stack size for task for the encoder isr processing processing. @note The minimum size is configMINIMAL_STACK_SIZE. */
+        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. */
         int32_t encoder_min_value; /*!< Encoder min value. @note Must be less than encoder_max_value. */
@@ -103,6 +103,13 @@ extern "C"
      */
     esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
 
+    /**
+     * @brief Deinitialize encoder.
+     *
+     * @return ESP_OK if success or an error code otherwise.
+     */
+    esp_err_t zh_encoder_deinit(zh_encoder_handle_t *handle);
+
     /**
      * @brief Set encoder position.
      *

version.txt

@@ -1 +1 @@
-1.1.0
+1.2.0

zh_encoder.c

@@ -27,7 +27,7 @@ static const uint8_t _encoder_matrix[7][4] = {
 
 TaskHandle_t zh_encoder = NULL;
 static QueueHandle_t _queue_handle = NULL;
-static bool _is_initialized = false;
+static uint8_t _encoder_counter = 0;
 static bool _is_prev_gpio_isr_handler = false;
 static zh_encoder_stats_t _stats = {0};
 
@@ -43,6 +43,7 @@ ESP_EVENT_DEFINE_BASE(ZH_ENCODER);
 esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle)
 {
     ZH_LOGI("Encoder initialization started.");
+    ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder initialization failed. Invalid argument.");
     esp_err_t err = _zh_encoder_validate_config(config);
     ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Encoder initialization failed. Initial configuration check failed.");
     err = _zh_encoder_gpio_init(config, handle);
@@ -77,14 +78,39 @@ esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_han
     handle->encoder_step = config->encoder_step;
     handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
     handle->is_initialized = true;
-    _is_initialized = true;
+    ++_encoder_counter;
     ZH_LOGI("Encoder initialization completed successfully.");
     return ESP_OK;
 }
 
+esp_err_t zh_encoder_deinit(zh_encoder_handle_t *handle)
+{
+    ZH_LOGI("Encoder deinitialization started.");
+    ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder deinitialization failed. Invalid argument.");
+    ZH_ERROR_CHECK(handle->is_initialized == true, ESP_FAIL, NULL, "Encoder deinitialization failed. Encoder not initialized.");
+    gpio_isr_handler_remove((gpio_num_t)handle->a_gpio_number);
+    gpio_isr_handler_remove((gpio_num_t)handle->b_gpio_number);
+    gpio_reset_pin((gpio_num_t)handle->a_gpio_number);
+    gpio_reset_pin((gpio_num_t)handle->b_gpio_number);
+    if (_encoder_counter == 1)
+    {
+        vQueueDelete(_queue_handle);
+        vTaskDelete(zh_encoder);
+        if (_is_prev_gpio_isr_handler == false)
+        {
+            gpio_uninstall_isr_service();
+        }
+    }
+    handle->is_initialized = false;
+    --_encoder_counter;
+    ZH_LOGI("Encoder deinitialization 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.");
     handle->encoder_position = position;
@@ -95,6 +121,7 @@ esp_err_t zh_encoder_set(zh_encoder_handle_t *handle, double position)
 esp_err_t zh_encoder_get(const zh_encoder_handle_t *handle, double *position)
 {
     ZH_LOGI("Encoder get position started.");
+    ZH_ERROR_CHECK(handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder get position failed. Invalid argument.");
     ZH_ERROR_CHECK(handle->is_initialized == true, ESP_FAIL, NULL, "Encoder get position failed. Encoder not initialized.");
     *position = handle->encoder_position;
     ZH_LOGI("Encoder get position completed successfully.");
@@ -104,6 +131,7 @@ esp_err_t zh_encoder_get(const zh_encoder_handle_t *handle, double *position)
 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.");
     handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
     ZH_LOGI("Encoder reset completed successfully.");
@@ -127,8 +155,8 @@ void zh_encoder_reset_stats(void)
 static esp_err_t _zh_encoder_validate_config(const zh_encoder_init_config_t *config)
 {
     ZH_ERROR_CHECK(config != NULL, ESP_ERR_INVALID_ARG, NULL, "Invalid configuration.");
-    ZH_ERROR_CHECK(config->task_priority >= 10 && config->stack_size >= 3072, ESP_ERR_INVALID_ARG, NULL, "Invalid task settings.");
-    ZH_ERROR_CHECK(config->queue_size >= 10, ESP_ERR_INVALID_ARG, NULL, "Invalid queue size.");
+    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.");
     return ESP_OK;
@@ -145,7 +173,7 @@ static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, z
         .intr_type = GPIO_INTR_ANYEDGE};
     esp_err_t err = gpio_config(&pin_config);
     ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "GPIO initialization failed.");
-    if (_is_initialized == false)
+    if (_encoder_counter == 0)
     {
         err = gpio_install_isr_service(ESP_INTR_FLAG_LOWMED);
         ZH_ERROR_CHECK(err == ESP_OK || err == ESP_ERR_INVALID_STATE, err, gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Failed install isr service.");
@@ -170,7 +198,7 @@ static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, z
 
 static esp_err_t _zh_encoder_resources_init(const zh_encoder_init_config_t *config)
 {
-    if (_is_initialized == false)
+    if (_encoder_counter == 0)
     {
         _queue_handle = xQueueCreate(config->queue_size, sizeof(zh_encoder_handle_t));
         ZH_ERROR_CHECK(_queue_handle != NULL, ESP_FAIL, NULL, "Failed to create queue.");
@@ -180,7 +208,7 @@ static esp_err_t _zh_encoder_resources_init(const zh_encoder_init_config_t *conf
 
 static esp_err_t _zh_encoder_task_init(const zh_encoder_init_config_t *config)
 {
-    if (_is_initialized == false)
+    if (_encoder_counter == 0)
     {
         BaseType_t err = xTaskCreatePinnedToCore(&_zh_encoder_isr_processing_task, "zh_encoder_isr_processing", config->stack_size, NULL, config->task_priority, &zh_encoder, tskNO_AFFINITY);
         ZH_ERROR_CHECK(err == pdPASS, ESP_FAIL, NULL, "Failed to create isr processing task.");