esp_components/zh_encoder
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: changed example

Browse Source
This commit is contained in:
Alexey Zholtikov
2025-12-24 13:48:31 +03:00
parent 37ae299426
commit 232933650d
1 changed files with 14 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -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,35 @@ 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.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.a_gpio_number = GPIO_NUM_26;
encoder_init_config.b_gpio_number = GPIO_NUM_27;
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);
}
```