diff --git a/README.md b/README.md index ea31407..dcca23e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ -# ESP32 ESP-IDF component for AC dimmer +# ESP32 ESP-IDF component for AC dimmer (phase-angle control) ## Features -1. Zero-crossing detection via GPIO interrupt on both edges (`GPIO_INTR_ANYEDGE`), with edge polarity determined from the current GPIO level and duplicate/glitch edge rejection. Spurious-interrupt filtering: the interval between rising edges must be within the half-cycle range derived from the frequency 30 - 500 Hz (shorter intervals are ignored, longer ones reset the timing and calibration state). -2. Measured zero-crossing half-period is low-pass filtered and used to calculate the TRIAC firing delay, so the dimmer adapts to the actual mains frequency. -3. TRIAC gate control through ESP-IDF gptimer (1 MHz resolution) with configurable dimming level (0–100%): 0 keeps the load off, 100 fires the TRIAC immediately. The firing delay is clamped to leave a guard band (period / 20, at least 5 us) before the end of the half-cycle. -4. Automatic runtime calibration of the hardware base offset: on each falling edge the width of the zero-crossing pulse is measured and fed into an EMA (`pulse_width / 2`), compensating for the zero-crossing detector advance relative to the physical mains zero crossing. -5. Handle-based API: init/deinit (with full GPIO, ISR and timer cleanup), start/stop, set/get dimming level. +1. Zero-crossing detection via GPIO interrupt on both edges with edge polarity determined from the current GPIO level and duplicate/glitch edge rejection. +2. Spurious-interrupt filtering based on half-cycle range derived from the mains frequency limits (30 to 500 Hz). +3. Low-pass filtered zero-crossing half-period measurement adapts the firing delay to the actual mains frequency. +4. TRIAC gate control through ESP-IDF gptimer with 1 MHz resolution and configurable dimming level from 0 to 100 percent. +5. Firing delay clamped to a guard band of at least 5 microseconds before the end of the half-cycle. +6. Automatic runtime calibration of the hardware base offset using exponential moving average of the zero-crossing pulse width. +7. Handle-based API with init, deinit, start, stop, set and get functions. +8. Memory managed through ESP-IDF heap_caps functions with full cleanup on initialization failure. + +## Attention + +1. Only one dimmer instance per zero-crossing GPIO pin. Initializing a second instance on the same pin replaces the ISR handler of the first one. +2. Not thread-safe. Volatile fields prevent compiler optimizations but do not provide mutual exclusion between tasks. +3. Calibration assumes a symmetric zero-crossing optocoupler pulse. Asymmetric pulses introduce a systematic offset error. +4. Supported mains frequency range is limited by the compile-time constants 30 to 500 Hz. Out-of-range intervals reset the timing and calibration state. ## Using @@ -23,7 +33,9 @@ In the application, add the component: #include "zh_ac_dimmer.h" ``` -## Example +## Examples + +### Basic Example: Initialize and Control Dimming Level ```c #include "zh_ac_dimmer.h" @@ -36,24 +48,136 @@ void app_main(void) zh_ac_dimmer_init_config_t config = ZH_AC_DIMMER_INIT_CONFIG_DEFAULT(); config.zero_cross_gpio = GPIO_NUM_16; config.triac_gpio = GPIO_NUM_17; - zh_ac_dimmer_init(&config, &ac_dimmer_handle); - zh_ac_dimmer_start(&ac_dimmer_handle); + esp_err_t ret = zh_ac_dimmer_init(&config, &ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Dimmer initialization error: %s\n", esp_err_to_name(ret)); + return; + } + ret = zh_ac_dimmer_start(&ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Dimmer start error: %s\n", esp_err_to_name(ret)); + } + uint8_t val1 = 50; + ret = zh_ac_dimmer_set(&ac_dimmer_handle, val1); + if (ret != ESP_OK) + { + printf("Dimmer set error: %s\n", esp_err_to_name(ret)); + } + uint8_t value = 0; + ret = zh_ac_dimmer_get(&ac_dimmer_handle, &value); + if (ret == ESP_OK) + { + printf("Dimmer value: %u\n", value); + } + else + { + printf("Dimmer get error: %s\n", esp_err_to_name(ret)); + } + vTaskDelay(5000 / portTICK_PERIOD_MS); + ret = zh_ac_dimmer_stop(&ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Dimmer stop error: %s\n", esp_err_to_name(ret)); + } + zh_ac_dimmer_deinit(&ac_dimmer_handle); +} +``` + +--- + +### Fade In Fade Out Example + +```c +#include "zh_ac_dimmer.h" + +zh_ac_dimmer_handle_t *ac_dimmer_handle = NULL; + +void app_main(void) +{ + esp_log_level_set("zh_ac_dimmer", ESP_LOG_ERROR); + zh_ac_dimmer_init_config_t config = ZH_AC_DIMMER_INIT_CONFIG_DEFAULT(); + config.zero_cross_gpio = GPIO_NUM_16; + config.triac_gpio = GPIO_NUM_17; + esp_err_t ret = zh_ac_dimmer_init(&config, &ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Dimmer initialization error: %s\n", esp_err_to_name(ret)); + return; + } + ret = zh_ac_dimmer_start(&ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Dimmer start error: %s\n", esp_err_to_name(ret)); + } uint8_t value = 0; for (uint8_t i = 0; i <= 100; ++i) { zh_ac_dimmer_set(&ac_dimmer_handle, i); zh_ac_dimmer_get(&ac_dimmer_handle, &value); - printf("Dimmer value: %d.\n", value); + printf("Dimmer value: %u\n", value); vTaskDelay(100 / portTICK_PERIOD_MS); } for (uint8_t i = 100; i > 0; --i) { zh_ac_dimmer_set(&ac_dimmer_handle, i); zh_ac_dimmer_get(&ac_dimmer_handle, &value); - printf("Dimmer value: %d.\n", value); + printf("Dimmer value: %u\n", value); vTaskDelay(100 / portTICK_PERIOD_MS); } zh_ac_dimmer_stop(&ac_dimmer_handle); zh_ac_dimmer_deinit(&ac_dimmer_handle); } ``` + +--- + +### Error Handling Example + +```c +#include "zh_ac_dimmer.h" + +zh_ac_dimmer_handle_t *ac_dimmer_handle = NULL; + +void app_main(void) +{ + esp_log_level_set("zh_ac_dimmer", ESP_LOG_ERROR); + zh_ac_dimmer_init_config_t config = ZH_AC_DIMMER_INIT_CONFIG_DEFAULT(); + config.zero_cross_gpio = GPIO_NUM_16; + config.triac_gpio = GPIO_NUM_16; + esp_err_t ret = zh_ac_dimmer_init(&config, &ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Expected init error: %s\n", esp_err_to_name(ret)); + } + config.triac_gpio = GPIO_NUM_17; + ret = zh_ac_dimmer_init(&config, &ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Dimmer initialization error: %s\n", esp_err_to_name(ret)); + return; + } + ret = zh_ac_dimmer_init(&config, &ac_dimmer_handle); + if (ret != ESP_OK) + { + printf("Expected double init error: %s\n", esp_err_to_name(ret)); + } + zh_ac_dimmer_start(&ac_dimmer_handle); + ret = zh_ac_dimmer_set(&ac_dimmer_handle, 101); + if (ret != ESP_OK) + { + printf("Expected set range error: %s\n", esp_err_to_name(ret)); + } + ret = zh_ac_dimmer_set(&ac_dimmer_handle, 75); + if (ret != ESP_OK) + { + printf("Dimmer set error: %s\n", esp_err_to_name(ret)); + } + uint8_t value = 0; + zh_ac_dimmer_get(&ac_dimmer_handle, &value); + printf("Dimmer value: %u\n", value); + zh_ac_dimmer_stop(&ac_dimmer_handle); + zh_ac_dimmer_deinit(&ac_dimmer_handle); +} +```