26 Commits

Author SHA1 Message Date
361d2f5fe9 fix: incorrect min_stack_size initial information 2026-02-02 13:24:04 +03:00
a0ecc5f3b8 feat: removed event with no changed value 2026-01-30 12:08:37 +03:00
36e200b972 refactor: refactored by pvs-studio 2026-01-28 19:32:05 +03:00
579af4f6fc perf: updated error checks 2026-01-28 19:31:56 +03:00
d6812c3fdb doc: updated example 2026-01-28 19:18:07 +03:00
9a716209b2 doc: updated descriptions 2026-01-27 13:30:23 +03:00
8b946d7576 feat!: changed encoder position to float 2026-01-27 12:26:28 +03:00
f2d1822ab4 doc: updated example 2026-01-27 10:27:10 +03:00
8e77720d7f feat: added gpio pullup on/off 2026-01-27 10:24:09 +03:00
121ba14a49 feat!: changed driver on pcnt 2026-01-24 10:17:43 +03:00
db86633155 perf: updated error checks 2026-01-02 13:32:10 +03:00
6787373e82 doc: updated connection schematic 2025-12-31 11:01:55 +03:00
fca6da29cc doc: added connection schematic 2025-12-31 10:09:42 +03:00
624a6b4661 feat: added encoder number duplicate check 2025-12-30 12:03:05 +03:00
020194431b doc: updated readme 2025-12-28 20:10:12 +03:00
4efbe96de1 perf: updated critical section 2025-12-26 09:06:19 +03:00
7d2bd7fd2e feat: added reinit 2025-12-26 09:04:25 +03:00
b70d625a05 doc: updated example 2025-12-25 17:13:59 +03:00
28d067eb98 refactor: refactored by pvs-studio 2025-12-25 16:44:34 +03:00
be29ff31f7 feat: added button 2025-12-25 11:16:30 +03:00
5ef3913eb9 style: removed esp8266 support 2025-12-24 19:02:48 +03:00
c4d6bf7dec doc: updated example 2025-12-24 15:32:42 +03:00
d8c6e2679f feat: added deinit 2025-12-24 15:17:50 +03:00
6b2ed520d0 perf: updated error checks 2025-12-24 14:46:06 +03:00
232933650d doc: changed example 2025-12-24 13:48:31 +03:00
37ae299426 perf: reduced min task values 2025-12-24 13:01:10 +03:00
7 changed files with 3401 additions and 199 deletions

View File

@@ -1,6 +1 @@
if(${IDF_TARGET} STREQUAL esp8266) idf_component_register(SRCS "zh_encoder.c" INCLUDE_DIRS "include" REQUIRES esp_event driver esp_timer)
set(requires driver)
else()
set(requires driver esp_event)
endif()
idf_component_register(SRCS "zh_encoder.c" INCLUDE_DIRS "include" REQUIRES ${requires})

View File

@@ -1,17 +1,26 @@
# ESP32 ESP-IDF and ESP8266 RTOS SDK component for rotary encoder # ESP32 ESP-IDF component for rotary encoder
## Tested on ## Tested on
1. [ESP8266 RTOS_SDK v3.4](https://docs.espressif.com/projects/esp8266-rtos-sdk/en/latest/index.html#) 1. [ESP32 ESP-IDF v5.5.2](https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32/index.html)
2. [ESP32 ESP-IDF v5.4](https://docs.espressif.com/projects/esp-idf/en/release-v5.4/esp32/index.html)
## SAST Tools
[PVS-Studio](https://pvs-studio.com/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code.
## Features ## Features
1. Support some encoders on one device. 1. Support some encoders on one device.
## Note ## Attention
1. Encoder pins must be pull up to the VCC via 0.1 µf capacitors. 1. For correct operation, please enable the following settings in the menuconfig:
```text
GPIO_CTRL_FUNC_IN_IRAM
PCNT_CTRL_FUNC_IN_IRAM
PCNT_ISR_IRAM_SAFE
```
## Using ## Using
@@ -19,7 +28,7 @@ In an existing project, run the following command to install the components:
```text ```text
cd ../your_project/components 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: In the application, add the component:
@@ -30,50 +39,61 @@ In the application, add the component:
## Examples ## Examples
One encoder on device: One encoder with button on device:
```c ```c
#include "zh_encoder.h" #include "zh_encoder.h"
#define ENCODER_NUMBER 0x01
zh_encoder_handle_t encoder_handle = {0}; zh_encoder_handle_t encoder_handle = {0};
void zh_encoder_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data); void zh_encoder_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data);
void app_main(void) 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(); 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); esp_event_handler_instance_register(ZH_ENCODER, ESP_EVENT_ANY_ID, &zh_encoder_event_handler, NULL, NULL);
#endif zh_encoder_init_config_t config = ZH_ENCODER_INIT_CONFIG_DEFAULT();
zh_encoder_init_config_t encoder_init_config = ZH_ENCODER_INIT_CONFIG_DEFAULT(); config.task_priority = 5;
encoder_init_config.a_gpio_number = GPIO_NUM_27; config.stack_size = configMINIMAL_STACK_SIZE;
encoder_init_config.b_gpio_number = GPIO_NUM_26; config.queue_size = 5;
// encoder_init_config.encoder_min_value = -10; // Just for example. config.a_gpio_number = GPIO_NUM_4;
// encoder_init_config.encoder_max_value = 20; // Just for example. config.b_gpio_number = GPIO_NUM_16;
// encoder_init_config.encoder_step = 0.1; // Just for example. config.s_gpio_number = GPIO_NUM_15;
encoder_init_config.encoder_number = 1; config.encoder_min_value = -10;
zh_encoder_init(&encoder_init_config, &encoder_handle); config.encoder_max_value = 10;
double position = 0; config.encoder_step = 0.001;
zh_encoder_get(&encoder_handle, &position); config.encoder_number = ENCODER_NUMBER;
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_init(&config, &encoder_handle);
// zh_encoder_set(&encoder_handle, 5); // Just for example. float encoder_position = 0;
// zh_encoder_reset(&encoder_handle); // Just for example. zh_encoder_get(&encoder_handle, &encoder_position);
printf("Encoder position %0.3f.\n", encoder_position);
for (;;) for (;;)
{ {
const zh_encoder_stats_t *stats = zh_encoder_get_stats(); 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 event post error: %ld.\n", stats->event_post_error);
printf("Number of queue overflow error: %ld.\n", stats->queue_overflow_error); printf("Number of queue overflow error: %ld.\n", stats->queue_overflow_error);
printf("Minimum free stack size: %ld.\n", stats->min_stack_size); 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) 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; switch (event_id)
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. {
case ZH_BUTTON_EVENT:
zh_encoder_button_event_on_isr_t *button_event = event_data;
printf("Encoder number %d button %s.\n", button_event->encoder_number, (button_event->button_status == 1) ? "released" : "pressed");
break;
case ZH_ENCODER_EVENT:
zh_encoder_event_on_isr_t *encoder_event = event_data;
printf("Encoder number %d position %0.3f.\n", encoder_event->encoder_number, encoder_event->encoder_position);
break;
default:
break;
}
} }
``` ```

2981
Schematic.pdf Executable file

File diff suppressed because it is too large Load Diff

View File

View File

@@ -6,6 +6,8 @@
#include "esp_log.h" #include "esp_log.h"
#include "driver/gpio.h" #include "driver/gpio.h"
#include "driver/pulse_cnt.h"
#include "esp_timer.h"
#include "freertos/FreeRTOS.h" #include "freertos/FreeRTOS.h"
#include "freertos/task.h" #include "freertos/task.h"
#include "esp_event.h" #include "esp_event.h"
@@ -13,16 +15,19 @@
/** /**
* @brief Encoder initial default values. * @brief Encoder initial default values.
*/ */
#define ZH_ENCODER_INIT_CONFIG_DEFAULT() \ #define ZH_ENCODER_INIT_CONFIG_DEFAULT() \
{ \ { \
.task_priority = 10, \ .task_priority = 1, \
.stack_size = 3072, \ .stack_size = configMINIMAL_STACK_SIZE, \
.queue_size = 10, \ .queue_size = 1, \
.a_gpio_number = 0, \ .a_gpio_number = GPIO_NUM_MAX, \
.b_gpio_number = 0, \ .b_gpio_number = GPIO_NUM_MAX, \
.encoder_min_value = -100, \ .s_gpio_number = GPIO_NUM_MAX, \
.encoder_max_value = 100, \ .s_gpio_debounce_time = 10, \
.encoder_step = 1, \ .pullup = true, \
.encoder_min_value = -10, \
.encoder_max_value = 10, \
.encoder_step = 1, \
.encoder_number = 0} .encoder_number = 0}
#ifdef __cplusplus #ifdef __cplusplus
@@ -30,22 +35,25 @@ extern "C"
{ {
#endif #endif
extern TaskHandle_t zh_encoder; /*!< Unique encoder Task Handle. */ extern TaskHandle_t zh_encoder; /*!< Encoder Task Handle. */
/** /**
* @brief Structure for initial initialization of encoder. * @brief Structure for initial initialization of encoder.
*/ */
typedef struct 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. */ float encoder_step; /*!< Encoder step. @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 3072 bytes. */ float encoder_min_value; /*!< Encoder min value. @note Must be less than encoder_max_value. */
uint8_t queue_size; /*!< Queue size for task for the encoder processing. @note It is not recommended to set a value less than 10. */ float encoder_max_value; /*!< Encoder max value. @note Must be greater than encoder_min_value. */
uint8_t a_gpio_number; /*!< Encoder A GPIO number. */ uint8_t task_priority; /*!< Task priority for the encoder isr processing. @note Minimum value is 1. */
uint8_t b_gpio_number; /*!< Encoder B GPIO number. */ uint8_t queue_size; /*!< Queue size for task for the encoder processing. @note Minimum value is 1. */
int32_t encoder_min_value; /*!< Encoder min value. @note Must be less than encoder_max_value. */ uint8_t a_gpio_number; /*!< Encoder A GPIO number. */
int32_t encoder_max_value; /*!< Encoder max value. @note Must be greater than encoder_min_value. */ uint8_t b_gpio_number; /*!< Encoder B GPIO number. */
double encoder_step; /*!< Encoder step. @note Must be greater than 0. */ uint8_t s_gpio_number; /*!< Encoder button GPIO number. */
uint8_t encoder_number; /*!< Unique encoder number. */ bool pullup; /*!< Pullup GPIO enable/disable. */
uint16_t s_gpio_debounce_time; /*!< Encoder button debounce_time. @note In microseconds. */
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; } zh_encoder_init_config_t;
/** /**
@@ -53,15 +61,20 @@ extern "C"
*/ */
typedef struct typedef struct
{ {
uint8_t a_gpio_number; /*!< Encoder A GPIO number. */ bool s_gpio_status; /*!< Encoder button status. */
uint8_t b_gpio_number; /*!< Encoder B GPIO number. */ bool is_initialized; /*!< Encoder initialization flag. */
int32_t encoder_min_value; /*!< Encoder min value. */ uint8_t encoder_number; /*!< Encoder unique number. */
int32_t encoder_max_value; /*!< Encoder max value. */ uint8_t s_gpio_number; /*!< Encoder button GPIO number. */
double encoder_step; /*!< Encoder step. */ uint16_t s_gpio_debounce_time; /*!< Encoder button debounce_time. */
double encoder_position; /*!< Encoder position. */ uint64_t s_gpio_prev_time; /*!< Encoder button prev interrupt time. */
uint8_t encoder_number; /*!< Encoder unique number. */ float encoder_step; /*!< Encoder step. */
uint8_t encoder_state; /*!< Encoder internal state. */ float encoder_position; /*!< Encoder position. */
bool is_initialized; /*!< Encoder initialization flag. */ float encoder_min_value; /*!< Encoder min value. */
float encoder_max_value; /*!< Encoder max value. */
pcnt_unit_handle_t pcnt_unit_handle; /*!< Encoder unique pcnt unit handle. */
pcnt_channel_handle_t pcnt_channel_a_handle; /*!< Encoder unique pcnt channel handle. */
pcnt_channel_handle_t pcnt_channel_b_handle; /*!< Encoder unique pcnt channel handle. */
} zh_encoder_handle_t; } zh_encoder_handle_t;
/** /**
@@ -74,19 +87,39 @@ extern "C"
uint32_t min_stack_size; /*!< Minimum free stack size. */ uint32_t min_stack_size; /*!< Minimum free stack size. */
} zh_encoder_stats_t; } zh_encoder_stats_t;
/**
* @brief Enumeration of encoder event ID.
*/
typedef enum
{
ZH_BUTTON_EVENT, /*!< Button event. */
ZH_ENCODER_EVENT /*!< Encoder event. */
} zh_encoder_event_id_t;
ESP_EVENT_DECLARE_BASE(ZH_ENCODER); ESP_EVENT_DECLARE_BASE(ZH_ENCODER);
/** /**
* @brief Structure for sending data to the event handler when cause an interrupt. * @brief Structure for sending data to the event handler when cause encoder interrupt.
* *
* @note Should be used with ZH_ENCODER event base. * @note Should be used with ZH_ENCODER event base and ZH_ENCODER_EVENT event ID.
*/ */
typedef struct typedef struct
{ {
uint8_t encoder_number; /*!< Encoder unique number. */ float encoder_position; /*!< Encoder current position. */
double encoder_position; /*!< Encoder current position. */ uint8_t encoder_number; /*!< Encoder unique number. */
} zh_encoder_event_on_isr_t; } zh_encoder_event_on_isr_t;
/**
* @brief Structure for sending data to the event handler when cause encoder button interrupt.
*
* @note Should be used with ZH_ENCODER event base and ZH_BUTTON_EVENT event ID.
*/
typedef struct
{
uint8_t encoder_number; /*!< Encoder unique number. */
bool button_status; /*!< Encoder button status. */
} zh_encoder_button_event_on_isr_t;
/** /**
* @brief Initialize encoder. * @brief Initialize encoder.
* *
@@ -103,6 +136,29 @@ extern "C"
*/ */
esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle); esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
/**
* @brief Deinitialize encoder.
*
* @param[in, out] handle Pointer to unique encoder handle.
*
* @return ESP_OK if success or an error code otherwise.
*/
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, float min, float max, float step);
/** /**
* @brief Set encoder position. * @brief Set encoder position.
* *
@@ -111,7 +167,7 @@ extern "C"
* *
* @return ESP_OK if success or an error code otherwise. * @return ESP_OK if success or an error code otherwise.
*/ */
esp_err_t zh_encoder_set(zh_encoder_handle_t *handle, double position); esp_err_t zh_encoder_set(zh_encoder_handle_t *handle, float position);
/** /**
* @brief Get encoder position. * @brief Get encoder position.
@@ -121,7 +177,7 @@ extern "C"
* *
* @return ESP_OK if success or an error code otherwise. * @return ESP_OK if success or an error code otherwise.
*/ */
esp_err_t zh_encoder_get(const zh_encoder_handle_t *handle, double *position); esp_err_t zh_encoder_get(const zh_encoder_handle_t *handle, float *position);
/** /**
* @brief Reset encoder position. * @brief Reset encoder position.

View File

@@ -1 +1 @@
1.1.0 2.3.1

View File

@@ -13,88 +13,135 @@
return err; \ return err; \
} }
#define ZH_ENCODER_DIRECTION_CW 0x10 #define ZH_ENCODER_DIRECTION_CW 1
#define ZH_ENCODER_DIRECTION_CCW 0x20 #define ZH_ENCODER_DIRECTION_CCW -1
static const uint8_t _encoder_matrix[7][4] = {
{0x03, 0x02, 0x01, 0x00},
{0x23, 0x00, 0x01, 0x00},
{0x13, 0x02, 0x00, 0x00},
{0x03, 0x05, 0x04, 0x00},
{0x03, 0x03, 0x04, 0x00},
{0x03, 0x05, 0x03, 0x00},
};
TaskHandle_t zh_encoder = NULL; TaskHandle_t zh_encoder = NULL;
static QueueHandle_t _queue_handle = NULL; static QueueHandle_t _queue_handle = NULL;
static bool _is_initialized = false; static portMUX_TYPE _spinlock = portMUX_INITIALIZER_UNLOCKED;
static bool _is_prev_gpio_isr_handler = false;
static zh_encoder_stats_t _stats = {0};
static esp_err_t _zh_encoder_validate_config(const zh_encoder_init_config_t *config); static uint8_t _encoder_counter = 0;
static zh_encoder_stats_t _stats = {0};
static uint8_t _encoder_number_matrix[CONFIG_SOC_PCNT_UNITS_PER_GROUP] = {0};
static esp_err_t _zh_encoder_validate_config(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
static esp_err_t _zh_encoder_pcnt_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle); static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
static esp_err_t _zh_encoder_resources_init(const zh_encoder_init_config_t *config); static esp_err_t _zh_encoder_resources_init(const zh_encoder_init_config_t *config);
static esp_err_t _zh_encoder_task_init(const zh_encoder_init_config_t *config); static esp_err_t _zh_encoder_task_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle);
static void _zh_encoder_isr_handler(void *arg); static bool _zh_encoder_isr_handler(pcnt_unit_handle_t unit, const pcnt_watch_event_data_t *edata, void *user_ctx);
static void _zh_encoder_isr_processing_task(void *pvParameter); static void _zh_encoder_isr_processing_task(void *pvParameter);
static void _zh_encoder_button_isr_handler(void *arg);
ESP_EVENT_DEFINE_BASE(ZH_ENCODER); ESP_EVENT_DEFINE_BASE(ZH_ENCODER);
esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle) esp_err_t zh_encoder_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle) // -V2008
{ {
ZH_LOGI("Encoder initialization started."); ZH_LOGI("Encoder initialization started.");
esp_err_t err = _zh_encoder_validate_config(config); ZH_ERROR_CHECK(config != NULL && handle != NULL, ESP_ERR_INVALID_ARG, NULL, "Encoder initialization failed. Invalid argument.");
ZH_ERROR_CHECK(handle->is_initialized == false, ESP_ERR_INVALID_STATE, NULL, "Encoder initialization failed. Encoder is already initialized.");
ZH_ERROR_CHECK(_encoder_counter < sizeof(_encoder_number_matrix), ESP_ERR_INVALID_ARG, NULL, "Encoder initialization failed. Maximum quantity reached.");
esp_err_t err = _zh_encoder_validate_config(config, handle);
ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Encoder initialization failed. Initial configuration check failed."); ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Encoder initialization failed. Initial configuration check failed.");
err = _zh_encoder_gpio_init(config, handle);
ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Encoder initialization failed. GPIO initialization failed.");
err = _zh_encoder_resources_init(config); err = _zh_encoder_resources_init(config);
if (_is_prev_gpio_isr_handler == true) ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Encoder initialization failed. Resources initialization failed.");
err = _zh_encoder_task_init(config, handle);
ZH_ERROR_CHECK(err == ESP_OK, err, vQueueDelete(_queue_handle); _queue_handle = NULL, "Encoder initialization failed. Processing task initialization failed.");
err = _zh_encoder_pcnt_init(config, handle);
ZH_ERROR_CHECK(err == ESP_OK, err, vQueueDelete(_queue_handle); _queue_handle = NULL; vTaskDelete(zh_encoder); zh_encoder = NULL,
"Encoder initialization failed. PCNT initialization failed.");
err = _zh_encoder_gpio_init(config, handle);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_unit_stop(handle->pcnt_unit_handle); pcnt_unit_disable(handle->pcnt_unit_handle); pcnt_del_channel(handle->pcnt_channel_a_handle);
pcnt_del_channel(handle->pcnt_channel_b_handle); pcnt_del_unit(handle->pcnt_unit_handle); vQueueDelete(_queue_handle); _queue_handle = NULL;
vTaskDelete(zh_encoder); zh_encoder = NULL, "Encoder initialization failed. GPIO initialization failed.");
if (_stats.min_stack_size == 0)
{ {
ZH_ERROR_CHECK(err == ESP_OK, err, gpio_isr_handler_remove((gpio_num_t)config->a_gpio_number); gpio_isr_handler_remove((gpio_num_t)config->b_gpio_number); gpio_reset_pin((gpio_num_t)config->a_gpio_number); _stats.min_stack_size = config->stack_size;
gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Encoder initialization failed. Resources initialization failed.");
} }
else
{
ZH_ERROR_CHECK(err == ESP_OK, err, gpio_isr_handler_remove((gpio_num_t)config->a_gpio_number); gpio_isr_handler_remove((gpio_num_t)config->b_gpio_number); gpio_uninstall_isr_service();
gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Encoder initialization failed. Resources initialization failed.");
}
err = _zh_encoder_task_init(config);
if (_is_prev_gpio_isr_handler == true)
{
ZH_ERROR_CHECK(err == ESP_OK, err, vQueueDelete(_queue_handle); _queue_handle = NULL; gpio_isr_handler_remove((gpio_num_t)config->a_gpio_number); gpio_isr_handler_remove((gpio_num_t)config->b_gpio_number);
gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Encoder initialization failed. Processing task initialization failed.");
}
else
{
ZH_ERROR_CHECK(err == ESP_OK, err, vQueueDelete(_queue_handle); _queue_handle = NULL; gpio_isr_handler_remove((gpio_num_t)config->a_gpio_number); gpio_isr_handler_remove((gpio_num_t)config->b_gpio_number);
gpio_uninstall_isr_service(); gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Encoder initialization failed. Processing task initialization failed.");
}
handle->a_gpio_number = config->a_gpio_number;
handle->b_gpio_number = config->b_gpio_number;
handle->encoder_number = config->encoder_number;
handle->encoder_min_value = config->encoder_min_value;
handle->encoder_max_value = config->encoder_max_value;
handle->encoder_step = config->encoder_step;
handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
handle->is_initialized = true; handle->is_initialized = true;
_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."); ZH_LOGI("Encoder initialization completed successfully.");
return ESP_OK; return ESP_OK;
} }
esp_err_t zh_encoder_set(zh_encoder_handle_t *handle, double position) 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.");
pcnt_unit_stop(handle->pcnt_unit_handle);
pcnt_unit_disable(handle->pcnt_unit_handle);
pcnt_del_channel(handle->pcnt_channel_a_handle);
pcnt_del_channel(handle->pcnt_channel_b_handle);
pcnt_del_unit(handle->pcnt_unit_handle);
if (handle->s_gpio_number != GPIO_NUM_MAX)
{
gpio_isr_handler_remove((gpio_num_t)handle->s_gpio_number);
gpio_reset_pin((gpio_num_t)handle->s_gpio_number);
}
if (_encoder_counter == 1)
{
vQueueDelete(_queue_handle);
_queue_handle = NULL;
vTaskDelete(zh_encoder);
zh_encoder = NULL;
}
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, float min, float max, float 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, float position)
{ {
ZH_LOGI("Encoder set position started."); 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(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."); 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; handle->encoder_position = position;
taskEXIT_CRITICAL(&_spinlock);
ZH_LOGI("Encoder set position completed successfully."); ZH_LOGI("Encoder set position completed successfully.");
return ESP_OK; return ESP_OK;
} }
esp_err_t zh_encoder_get(const zh_encoder_handle_t *handle, double *position) esp_err_t zh_encoder_get(const zh_encoder_handle_t *handle, float *position)
{ {
ZH_LOGI("Encoder get position started."); ZH_LOGI("Encoder get position started.");
ZH_ERROR_CHECK(handle != NULL && position != 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."); ZH_ERROR_CHECK(handle->is_initialized == true, ESP_FAIL, NULL, "Encoder get position failed. Encoder not initialized.");
*position = handle->encoder_position; *position = handle->encoder_position;
ZH_LOGI("Encoder get position completed successfully."); ZH_LOGI("Encoder get position completed successfully.");
@@ -104,8 +151,11 @@ 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) esp_err_t zh_encoder_reset(zh_encoder_handle_t *handle)
{ {
ZH_LOGI("Encoder reset started."); 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."); 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; handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
taskEXIT_CRITICAL(&_spinlock);
ZH_LOGI("Encoder reset completed successfully."); ZH_LOGI("Encoder reset completed successfully.");
return ESP_OK; return ESP_OK;
} }
@@ -124,129 +174,229 @@ void zh_encoder_reset_stats(void)
ZH_LOGI("Error statistic reset successfully."); 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, zh_encoder_handle_t *handle) // -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->task_priority >= 10 && config->stack_size >= 3072, 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->queue_size >= 10, 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_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_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.");
}
handle->encoder_number = config->encoder_number;
handle->encoder_min_value = config->encoder_min_value;
handle->encoder_max_value = config->encoder_max_value;
handle->encoder_step = config->encoder_step;
handle->encoder_position = (handle->encoder_min_value + handle->encoder_max_value) / 2;
return ESP_OK; return ESP_OK;
} }
static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle) static esp_err_t _zh_encoder_pcnt_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle) // -V2008
{ {
ZH_ERROR_CHECK(config->a_gpio_number < GPIO_NUM_MAX && config->b_gpio_number < GPIO_NUM_MAX, ESP_ERR_INVALID_ARG, NULL, "Invalid GPIO number.") ZH_ERROR_CHECK(config->a_gpio_number < GPIO_NUM_MAX && config->b_gpio_number < GPIO_NUM_MAX, ESP_ERR_INVALID_ARG, NULL, "Invalid GPIO number.")
ZH_ERROR_CHECK(config->a_gpio_number != config->b_gpio_number, ESP_ERR_INVALID_ARG, NULL, "Both GPIO is same.") ZH_ERROR_CHECK(config->a_gpio_number != config->b_gpio_number, ESP_ERR_INVALID_ARG, NULL, "Encoder A and B GPIO is same.")
gpio_config_t pin_config = { pcnt_unit_config_t pcnt_unit_config = {
.mode = GPIO_MODE_INPUT, .high_limit = 10,
.pin_bit_mask = (1ULL << config->a_gpio_number) | (1ULL << config->b_gpio_number), .low_limit = -10,
.pull_up_en = GPIO_PULLUP_ENABLE, };
.intr_type = GPIO_INTR_ANYEDGE}; pcnt_unit_handle_t pcnt_unit_handle = NULL;
esp_err_t err = gpio_config(&pin_config); esp_err_t err = pcnt_new_unit(&pcnt_unit_config, &pcnt_unit_handle);
ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "GPIO initialization failed."); ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "PCNT initialization failed.");
if (_is_initialized == false) pcnt_glitch_filter_config_t pcnt_glitch_filter_config = {
.max_glitch_ns = 1000,
};
err = pcnt_unit_set_glitch_filter(pcnt_unit_handle, &pcnt_glitch_filter_config);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
pcnt_chan_config_t pcnt_chan_a_config = {
.edge_gpio_num = config->a_gpio_number,
.level_gpio_num = config->b_gpio_number,
};
pcnt_channel_handle_t pcnt_channel_a_handle = NULL;
err = pcnt_new_channel(pcnt_unit_handle, &pcnt_chan_a_config, &pcnt_channel_a_handle);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
pcnt_chan_config_t pcnt_chan_b_config = {
.edge_gpio_num = config->b_gpio_number,
.level_gpio_num = config->a_gpio_number,
};
pcnt_channel_handle_t pcnt_channel_b_handle = NULL;
err = pcnt_new_channel(pcnt_unit_handle, &pcnt_chan_b_config, &pcnt_channel_b_handle);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_channel_set_edge_action(pcnt_channel_a_handle, PCNT_CHANNEL_EDGE_ACTION_DECREASE, PCNT_CHANNEL_EDGE_ACTION_HOLD);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_channel_set_level_action(pcnt_channel_a_handle, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_HOLD);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_channel_set_edge_action(pcnt_channel_b_handle, PCNT_CHANNEL_EDGE_ACTION_INCREASE, PCNT_CHANNEL_EDGE_ACTION_HOLD);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_channel_set_level_action(pcnt_channel_b_handle, PCNT_CHANNEL_LEVEL_ACTION_KEEP, PCNT_CHANNEL_LEVEL_ACTION_HOLD);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_unit_add_watch_point(pcnt_unit_handle, ZH_ENCODER_DIRECTION_CW);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_unit_add_watch_point(pcnt_unit_handle, ZH_ENCODER_DIRECTION_CCW);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
pcnt_event_callbacks_t cbs = {
.on_reach = _zh_encoder_isr_handler,
};
err = pcnt_unit_register_event_callbacks(pcnt_unit_handle, &cbs, NULL);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle),
"PCNT initialization failed.");
err = pcnt_unit_enable(pcnt_unit_handle);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle); pcnt_del_unit(pcnt_unit_handle),
"PCNT initialization failed.");
err = pcnt_unit_clear_count(pcnt_unit_handle);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_unit_disable(pcnt_unit_handle); pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle);
pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
err = pcnt_unit_start(pcnt_unit_handle);
ZH_ERROR_CHECK(err == ESP_OK, err, pcnt_unit_disable(pcnt_unit_handle); pcnt_del_channel(pcnt_channel_a_handle); pcnt_del_channel(pcnt_channel_b_handle);
pcnt_del_unit(pcnt_unit_handle), "PCNT initialization failed.");
if (config->pullup == false)
{ {
gpio_pullup_dis((gpio_num_t)config->a_gpio_number);
gpio_pullup_dis((gpio_num_t)config->b_gpio_number);
}
handle->pcnt_unit_handle = pcnt_unit_handle;
handle->pcnt_channel_a_handle = pcnt_channel_a_handle;
handle->pcnt_channel_b_handle = pcnt_channel_b_handle;
return ESP_OK;
}
static esp_err_t _zh_encoder_gpio_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle) // -V2008
{
ZH_ERROR_CHECK(config->s_gpio_number <= GPIO_NUM_MAX, ESP_ERR_INVALID_ARG, NULL, "Invalid GPIO number.")
ZH_ERROR_CHECK(config->a_gpio_number != config->s_gpio_number && config->b_gpio_number != config->s_gpio_number, ESP_ERR_INVALID_ARG, NULL, "Encoder GPIO and button GPIO is same.")
if (config->s_gpio_number != GPIO_NUM_MAX)
{
gpio_config_t pin_config = {
.mode = GPIO_MODE_INPUT,
.pull_up_en = (config->pullup == true) ? GPIO_PULLUP_ENABLE : GPIO_PULLUP_DISABLE,
.pin_bit_mask = (1ULL << config->s_gpio_number),
.intr_type = GPIO_INTR_ANYEDGE};
esp_err_t err = gpio_config(&pin_config);
ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "GPIO initialization failed.");
err = gpio_install_isr_service(ESP_INTR_FLAG_LOWMED); 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."); ZH_ERROR_CHECK(err == ESP_OK || err == ESP_ERR_INVALID_STATE, err, gpio_reset_pin((gpio_num_t)config->s_gpio_number), "Failed install isr service.");
if (err == ESP_ERR_INVALID_STATE) err = gpio_isr_handler_add((gpio_num_t)config->s_gpio_number, _zh_encoder_button_isr_handler, handle);
{ ZH_ERROR_CHECK(err == ESP_OK, err, gpio_reset_pin((gpio_num_t)config->s_gpio_number), "Interrupt initialization failed.");
_is_prev_gpio_isr_handler = true; handle->s_gpio_number = config->s_gpio_number;
} handle->s_gpio_debounce_time = config->s_gpio_debounce_time;
} handle->s_gpio_status = gpio_get_level((gpio_num_t)config->s_gpio_number);
err = gpio_isr_handler_add(config->a_gpio_number, _zh_encoder_isr_handler, handle);
ZH_ERROR_CHECK(err == ESP_OK, err, gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Interrupt initialization failed.");
err = gpio_isr_handler_add(config->b_gpio_number, _zh_encoder_isr_handler, handle);
if (_is_prev_gpio_isr_handler == true)
{
ZH_ERROR_CHECK(err == ESP_OK, err, gpio_isr_handler_remove((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Interrupt initialization failed.");
}
else
{
ZH_ERROR_CHECK(err == ESP_OK, err, gpio_isr_handler_remove((gpio_num_t)config->a_gpio_number); gpio_uninstall_isr_service(); gpio_reset_pin((gpio_num_t)config->a_gpio_number); gpio_reset_pin((gpio_num_t)config->b_gpio_number), "Interrupt initialization failed.");
} }
return ESP_OK; return ESP_OK;
} }
static esp_err_t _zh_encoder_resources_init(const zh_encoder_init_config_t *config) 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)); _queue_handle = xQueueCreate(config->queue_size, sizeof(int));
ZH_ERROR_CHECK(_queue_handle != NULL, ESP_FAIL, NULL, "Failed to create queue."); ZH_ERROR_CHECK(_queue_handle != NULL, ESP_FAIL, NULL, "Failed to create queue.");
} }
return ESP_OK; return ESP_OK;
} }
static esp_err_t _zh_encoder_task_init(const zh_encoder_init_config_t *config) static esp_err_t _zh_encoder_task_init(const zh_encoder_init_config_t *config, zh_encoder_handle_t *handle)
{ {
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); BaseType_t err = xTaskCreatePinnedToCore(&_zh_encoder_isr_processing_task, "zh_encoder_isr_processing", config->stack_size, handle, config->task_priority,
&zh_encoder, tskNO_AFFINITY);
ZH_ERROR_CHECK(err == pdPASS, ESP_FAIL, NULL, "Failed to create isr processing task."); ZH_ERROR_CHECK(err == pdPASS, ESP_FAIL, NULL, "Failed to create isr processing task.");
} }
return ESP_OK; return ESP_OK;
} }
static void IRAM_ATTR _zh_encoder_isr_handler(void *arg) static bool IRAM_ATTR _zh_encoder_isr_handler(pcnt_unit_handle_t unit, const pcnt_watch_event_data_t *edata, void *user_ctx)
{ {
zh_encoder_handle_t *encoder_handle = (zh_encoder_handle_t *)arg;
BaseType_t xHigherPriorityTaskWoken = pdFALSE; BaseType_t xHigherPriorityTaskWoken = pdFALSE;
encoder_handle->encoder_state = _encoder_matrix[encoder_handle->encoder_state & 0x0F][(gpio_get_level(encoder_handle->b_gpio_number) << 1) | gpio_get_level(encoder_handle->a_gpio_number)]; pcnt_unit_clear_count(unit);
switch (encoder_handle->encoder_state & 0x30) if (xQueueSendFromISR(_queue_handle, &edata->watch_point_value, &xHigherPriorityTaskWoken) != pdTRUE)
{ {
case ZH_ENCODER_DIRECTION_CW: ++_stats.queue_overflow_error;
if (encoder_handle->encoder_position < encoder_handle->encoder_max_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_position + encoder_handle->encoder_step;
if (encoder_handle->encoder_position > encoder_handle->encoder_max_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_max_value;
}
if (xQueueSendFromISR(_queue_handle, encoder_handle, &xHigherPriorityTaskWoken) != pdTRUE)
{
++_stats.queue_overflow_error;
}
}
break;
case ZH_ENCODER_DIRECTION_CCW:
if (encoder_handle->encoder_position > encoder_handle->encoder_min_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_position - encoder_handle->encoder_step;
if (encoder_handle->encoder_position < encoder_handle->encoder_min_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_min_value;
}
if (xQueueSendFromISR(_queue_handle, encoder_handle, &xHigherPriorityTaskWoken) != pdTRUE)
{
++_stats.queue_overflow_error;
}
}
break;
default:
break;
} }
if (xHigherPriorityTaskWoken == pdTRUE) if (xHigherPriorityTaskWoken == pdTRUE)
{ {
portYIELD_FROM_ISR(); return true;
}; };
return false;
} }
static void IRAM_ATTR _zh_encoder_isr_processing_task(void *pvParameter) static void IRAM_ATTR _zh_encoder_isr_processing_task(void *pvParameter)
{ {
zh_encoder_handle_t queue = {0}; zh_encoder_handle_t *encoder_handle = (zh_encoder_handle_t *)pvParameter;
zh_encoder_event_on_isr_t encoder_data = {0}; int pcnt_count = {0};
while (xQueueReceive(_queue_handle, &queue, portMAX_DELAY) == pdTRUE) bool is_value_changed = false;
while (xQueueReceive(_queue_handle, &pcnt_count, portMAX_DELAY) == pdTRUE)
{ {
encoder_data.encoder_number = queue.encoder_number; switch (pcnt_count)
encoder_data.encoder_position = queue.encoder_position;
esp_err_t err = esp_event_post(ZH_ENCODER, 0, &encoder_data, sizeof(zh_encoder_event_on_isr_t), 1000 / portTICK_PERIOD_MS);
if (err != ESP_OK)
{ {
++_stats.event_post_error; case ZH_ENCODER_DIRECTION_CW:
ZH_LOGE("Encoder isr processing failed. Failed to post interrupt event.", err); if (encoder_handle->encoder_position < encoder_handle->encoder_max_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_position + encoder_handle->encoder_step;
if (encoder_handle->encoder_position > encoder_handle->encoder_max_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_max_value;
}
is_value_changed = true;
}
break;
case ZH_ENCODER_DIRECTION_CCW:
if (encoder_handle->encoder_position > encoder_handle->encoder_min_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_position - encoder_handle->encoder_step;
if (encoder_handle->encoder_position < encoder_handle->encoder_min_value)
{
encoder_handle->encoder_position = encoder_handle->encoder_min_value;
}
is_value_changed = true;
}
break;
default:
break;
}
if (is_value_changed == true)
{
is_value_changed = false;
zh_encoder_event_on_isr_t encoder_data = {0};
encoder_data.encoder_number = encoder_handle->encoder_number;
encoder_data.encoder_position = encoder_handle->encoder_position;
esp_err_t err = esp_event_post(ZH_ENCODER, ZH_ENCODER_EVENT, &encoder_data, sizeof(zh_encoder_event_on_isr_t), 1000 / portTICK_PERIOD_MS);
if (err != ESP_OK)
{
++_stats.event_post_error;
ZH_LOGE("Encoder isr processing failed. Failed to post interrupt event.", err);
}
} }
_stats.min_stack_size = (uint32_t)uxTaskGetStackHighWaterMark(NULL); _stats.min_stack_size = (uint32_t)uxTaskGetStackHighWaterMark(NULL);
} }
vTaskDelete(NULL); vTaskDelete(NULL);
} }
static void IRAM_ATTR _zh_encoder_button_isr_handler(void *arg)
{
zh_encoder_handle_t *encoder_handle = (zh_encoder_handle_t *)arg;
BaseType_t xHigherPriorityTaskWoken = pdFALSE;
uint64_t _current_us = esp_timer_get_time();
if (_current_us - encoder_handle->s_gpio_prev_time >= encoder_handle->s_gpio_debounce_time)
{
bool s_gpio_status = gpio_get_level((gpio_num_t)encoder_handle->s_gpio_number);
if (encoder_handle->s_gpio_status != s_gpio_status)
{
encoder_handle->s_gpio_status = s_gpio_status;
zh_encoder_button_event_on_isr_t encoder_data = {0};
encoder_data.encoder_number = encoder_handle->encoder_number;
encoder_data.button_status = encoder_handle->s_gpio_status;
esp_err_t err = esp_event_isr_post(ZH_ENCODER, ZH_BUTTON_EVENT, &encoder_data, sizeof(zh_encoder_button_event_on_isr_t), &xHigherPriorityTaskWoken);
if (err != ESP_OK)
{
++_stats.event_post_error;
}
}
}
encoder_handle->s_gpio_prev_time = _current_us;
if (xHigherPriorityTaskWoken == pdTRUE)
{
portYIELD_FROM_ISR();
};
}