zh_encoder/README.md

ESP32 ESP-IDF and ESP8266 RTOS SDK component for rotary encoder

Tested on

1. ESP8266 RTOS_SDK v3.4
2. ESP32 ESP-IDF v5.4

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:

cd ../your_project/components
git clone http://git.zh.com.ru/alexey.zholtikov/zh_encoder

In the application, add the component:

#include "zh_encoder.h"

Examples

One encoder on device:

#include "zh_encoder.h"

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 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_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.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_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.
}

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.
}