doc: updated example

README.md

@@ -9,6 +9,18 @@
 1. Supports frequency up to 400 Hz.
 2. Automatic frequency detection.
 
+## Attention
+
+For correct operation, please enable the following settings in the menuconfig:
+
+```text
+GPIO_CTRL_FUNC_IN_IRAM
+CONFIG_GPTIMER_ISR_HANDLER_IN_IRAM
+CONFIG_GPTIMER_CTRL_FUNC_IN_IRAM
+CONFIG_GPTIMER_ISR_CACHE_SAFE
+CONFIG_GPTIMER_OBJ_CACHE_SAFE
+```
+
 ## Using
 
 In an existing project, run the following command to install the components:
@@ -37,8 +49,6 @@ void app_main(void)
     config.triac_gpio = GPIO_NUM_17;
     zh_ac_dimmer_init(&config);
     zh_ac_dimmer_start();
-    for (;;)
-    {
     for (uint8_t i = 0; i <= 100; ++i)
     {
         zh_ac_dimmer_set(i);
@@ -49,6 +59,7 @@ void app_main(void)
         zh_ac_dimmer_set(i);
         vTaskDelay(100 / portTICK_PERIOD_MS);
     }
-    }
+    zh_ac_dimmer_stop();
+    zh_ac_dimmer_deinit();
 }
 ```

include/zh_ac_dimmer.h

@@ -20,10 +20,10 @@
         .triac_gpio = GPIO_NUM_MAX}
 
 #ifdef __cplusplus
-
 extern "C"
 {
 #endif
+
     /**
      * @brief Structure for initial initialization of AC dimmer.
      */

zh_ac_dimmer.c

@@ -5,10 +5,11 @@ static const char *TAG = "zh_ac_dimmer";
 #define ZH_LOGI(msg, ...) ESP_LOGI(TAG, msg, ##__VA_ARGS__)
 #define ZH_LOGE(msg, err, ...) ESP_LOGE(TAG, "[%s:%d:%s] " msg, __FILE__, __LINE__, esp_err_to_name(err), ##__VA_ARGS__)
 
-#define ZH_ERROR_CHECK(cond, err, msg, ...) \
+#define ZH_ERROR_CHECK(cond, err, cleanup, msg, ...) \
     if (!(cond))                                     \
     {                                                \
-        ZH_LOGE(msg, err);                  \
+        ZH_LOGE(msg, err, ##__VA_ARGS__);            \
+        cleanup;                                     \
         return err;                                  \
     }
 
@@ -16,10 +17,10 @@ static gptimer_handle_t _dimmer_timer = NULL;
 static gptimer_alarm_config_t _alarm_config = {0};
 
 static zh_ac_dimmer_init_config_t _init_config = {0};
-static volatile uint64_t _prev_micros = 0;
+static volatile uint64_t _prev_us = 0;
-static volatile uint32_t _current_frequency = 0;
+static volatile uint32_t _current_period_us = 0;
-static volatile uint32_t _prev_frequency = 0;
+static volatile uint32_t _prev_period_us = 0;
-static volatile uint16_t _zero_cross_time = 0;
+static volatile uint16_t _zero_cross_us = 0;
 static volatile uint8_t _dimmer_value = 0;
 static volatile bool _is_dimmer_work = false;
 static bool _is_initialized = false;
@@ -33,13 +34,14 @@ static bool _zh_ac_dimmer_timer_on_alarm_cb(gptimer_handle_t timer, const gptime
 esp_err_t zh_ac_dimmer_init(const zh_ac_dimmer_init_config_t *config)
 {
     ZH_LOGI("AC dimmer initialization started.");
-    ZH_ERROR_CHECK(_is_initialized == false, ESP_ERR_INVALID_STATE, "AC dimmer initialization failed. AC dimmer is already initialized.");
+    ZH_ERROR_CHECK(_is_initialized == false, ESP_ERR_INVALID_STATE, NULL, "AC dimmer initialization failed. AC dimmer is already initialized.");
     esp_err_t err = _zh_ac_dimmer_validate_config(config);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "AC dimmer initialization failed. Initial configuration check failed.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "AC dimmer initialization failed. Initial configuration check failed.");
     err = _zh_ac_dimmer_gpio_init(config);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "AC dimmer initialization failed. GPIO initialization failed.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "AC dimmer initialization failed. GPIO initialization failed.");
     err = _zh_ac_dimmer_timer_init();
-    ZH_ERROR_CHECK(err == ESP_OK, err, "AC dimmer initialization failed. Timer initialization failed.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, gpio_isr_handler_remove(config->zero_cross_gpio); gpio_uninstall_isr_service();
+                   gpio_reset_pin(config->triac_gpio); gpio_reset_pin(config->zero_cross_gpio), "AC dimmer initialization failed. Timer initialization failed.");
     _init_config = *config;
     _is_initialized = true;
     ZH_LOGI("AC dimmer initialization completed successfully.");
@@ -49,22 +51,22 @@ esp_err_t zh_ac_dimmer_init(const zh_ac_dimmer_init_config_t *config)
 esp_err_t zh_ac_dimmer_deinit(void)
 {
     ZH_LOGI("AC dimmer deinitialization started.");
-    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, "AC dimmer deinitialization failed. AC dimmer is not initialized.");
+    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, NULL, "AC dimmer deinitialization failed. AC dimmer is not initialized.");
-    _is_dimmer_work = false;
+    gptimer_stop(_dimmer_timer);
-    if (_dimmer_timer != NULL)
-    {
     gptimer_disable(_dimmer_timer);
     gptimer_del_timer(_dimmer_timer);
-        _dimmer_timer = NULL;
-    }
     gpio_isr_handler_remove(_init_config.zero_cross_gpio);
     gpio_uninstall_isr_service();
+    gpio_reset_pin(_init_config.triac_gpio);
+    gpio_reset_pin(_init_config.zero_cross_gpio);
+    _is_dimmer_work = false;
     _is_initialized = false;
+    _dimmer_timer = NULL;
     _dimmer_value = 0;
-    _current_frequency = 0;
+    _current_period_us = 0;
-    _prev_frequency = 0;
+    _prev_period_us = 0;
-    _zero_cross_time = 0;
+    _zero_cross_us = 0;
-    _prev_micros = 0;
+    _prev_us = 0;
     ZH_LOGI("AC dimmer deinitialization completed successfully.");
     return ESP_OK;
 }
@@ -72,7 +74,7 @@ esp_err_t zh_ac_dimmer_deinit(void)
 esp_err_t zh_ac_dimmer_start(void)
 {
     ZH_LOGI("AC dimmer start begin.");
-    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, "AC dimmer start failed. AC dimmer is not initialized.");
+    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, NULL, "AC dimmer start failed. AC dimmer is not initialized.");
     _is_dimmer_work = true;
     ZH_LOGI("AC dimmer start completed successfully.");
     return ESP_OK;
@@ -81,7 +83,7 @@ esp_err_t zh_ac_dimmer_start(void)
 esp_err_t zh_ac_dimmer_stop(void)
 {
     ZH_LOGI("AC dimmer stop begin.");
-    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, "AC dimmer stop failed. AC dimmer is not initialized.");
+    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, NULL, "AC dimmer stop failed. AC dimmer is not initialized.");
     _is_dimmer_work = false;
     ZH_LOGI("AC dimmer stop completed successfully.");
     return ESP_OK;
@@ -90,8 +92,8 @@ esp_err_t zh_ac_dimmer_stop(void)
 esp_err_t zh_ac_dimmer_set(uint8_t value)
 {
     ZH_LOGI("AC dimmer setup begin.");
-    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, "AC dimmer stop failed. AC dimmer is not initialized.");
+    ZH_ERROR_CHECK(_is_initialized == true, ESP_ERR_INVALID_STATE, NULL, "AC dimmer setup failed. AC dimmer is not initialized.");
-    ZH_ERROR_CHECK(value <= 100, ESP_ERR_INVALID_ARG, "AC dimmer setup failed. Dimming value invalid.");
+    ZH_ERROR_CHECK(value <= 100, ESP_ERR_INVALID_ARG, NULL, "AC dimmer setup failed. Dimming value invalid.");
     _dimmer_value = value;
     ZH_LOGI("AC dimmer setup completed successfully.");
     return ESP_OK;
@@ -99,10 +101,10 @@ esp_err_t zh_ac_dimmer_set(uint8_t value)
 
 static esp_err_t _zh_ac_dimmer_validate_config(const zh_ac_dimmer_init_config_t *config)
 {
-    ZH_ERROR_CHECK(config != NULL, ESP_ERR_INVALID_ARG, "Initial config is NULL.");
+    ZH_ERROR_CHECK(config != NULL, ESP_ERR_INVALID_ARG, NULL, "Initial config is NULL.");
-    ZH_ERROR_CHECK((config->zero_cross_gpio >= GPIO_NUM_0 && config->zero_cross_gpio < GPIO_NUM_MAX), ESP_ERR_INVALID_ARG, "Zero cross GPIO invalid.");
+    ZH_ERROR_CHECK((config->zero_cross_gpio >= GPIO_NUM_0 && config->zero_cross_gpio < GPIO_NUM_MAX), ESP_ERR_INVALID_ARG, NULL, "Zero cross GPIO invalid.");
-    ZH_ERROR_CHECK((config->triac_gpio >= GPIO_NUM_0 && config->triac_gpio < GPIO_NUM_MAX), ESP_ERR_INVALID_ARG, "Triac GPIO invalid.");
+    ZH_ERROR_CHECK((config->triac_gpio >= GPIO_NUM_0 && config->triac_gpio < GPIO_NUM_MAX), ESP_ERR_INVALID_ARG, NULL, "Triac GPIO invalid.");
-    ZH_ERROR_CHECK((config->zero_cross_gpio != config->triac_gpio), ESP_ERR_INVALID_ARG, "Both GPIO is same.");
+    ZH_ERROR_CHECK((config->zero_cross_gpio != config->triac_gpio), ESP_ERR_INVALID_ARG, NULL, "Both GPIO is same.");
     return ESP_OK;
 }
 
@@ -116,7 +118,7 @@ static esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *confi
         .pull_up_en = GPIO_PULLUP_DISABLE,
     };
     esp_err_t err = gpio_config(&triac_gpio_config);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Triac GPIO configuration failed.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Triac GPIO configuration failed.");
     gpio_set_level(config->triac_gpio, 0);
     gpio_config_t zero_cross_gpio_config = {
         .intr_type = GPIO_INTR_POSEDGE,
@@ -126,11 +128,11 @@ static esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *confi
         .pull_up_en = GPIO_PULLUP_DISABLE,
     };
     err = gpio_config(&zero_cross_gpio_config);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Zero cross GPIO configuration failed.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, gpio_reset_pin(config->triac_gpio), "Zero cross GPIO configuration failed.");
-    err = gpio_install_isr_service(ESP_INTR_FLAG_LEVEL3);
+    err = gpio_install_isr_service(ESP_INTR_FLAG_LOWMED);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Failed install isr service.")
+    ZH_ERROR_CHECK(err == ESP_OK, err, gpio_reset_pin(config->triac_gpio); gpio_reset_pin(config->zero_cross_gpio), "Failed install isr service.")
     err = gpio_isr_handler_add(config->zero_cross_gpio, _zh_ac_dimmer_isr_handler, NULL);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Failed add isr handler.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, gpio_uninstall_isr_service(); gpio_reset_pin(config->triac_gpio); gpio_reset_pin(config->zero_cross_gpio), "Failed add isr handler.");
     return ESP_OK;
 }
 
@@ -142,14 +144,14 @@ static esp_err_t _zh_ac_dimmer_timer_init(void)
         .resolution_hz = 1 * 1000 * 1000,
     };
     esp_err_t err = gptimer_new_timer(&timer_config, &_dimmer_timer);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Failed create dimmer timer.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, NULL, "Failed create dimmer timer.");
     gptimer_event_callbacks_t cbs = {
         .on_alarm = _zh_ac_dimmer_timer_on_alarm_cb,
     };
     err = gptimer_register_event_callbacks(_dimmer_timer, &cbs, NULL);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Failed register dimmer timer event callbacks.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, gptimer_del_timer(_dimmer_timer), "Failed register dimmer timer event callbacks.");
     err = gptimer_enable(_dimmer_timer);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "Failed enable dimmer timer.");
+    ZH_ERROR_CHECK(err == ESP_OK, err, gptimer_register_event_callbacks(_dimmer_timer, NULL, NULL); gptimer_del_timer(_dimmer_timer), "Failed enable dimmer timer.");
     return ESP_OK;
 }
 
@@ -160,18 +162,18 @@ static void IRAM_ATTR _zh_ac_dimmer_isr_handler(void *arg)
         return;
     }
     gpio_set_level(_init_config.triac_gpio, 0);
-    uint64_t _current_micros = esp_timer_get_time();
+    uint64_t _current_us = esp_timer_get_time();
-    _current_frequency = _current_micros - _prev_micros;
+    _current_period_us = (uint32_t)(_current_us - _prev_us);
-    _prev_micros = _current_micros;
+    _prev_us = _current_us;
-    if (_current_frequency < 1000)
+    if (_current_period_us < 1000)
     {
-        if (_current_frequency > 50)
+        if (_current_period_us > 50)
         {
-            _zero_cross_time = _current_frequency;
+            _zero_cross_us = (uint16_t)_current_period_us;
         }
-        _current_frequency = _prev_frequency;
+        _current_period_us = _prev_period_us;
     }
-    _prev_frequency = _current_frequency;
+    _prev_period_us = _current_period_us;
     if (_dimmer_value != 0)
     {
         if (_dimmer_value == 100)
@@ -179,7 +181,7 @@ static void IRAM_ATTR _zh_ac_dimmer_isr_handler(void *arg)
             gpio_set_level(_init_config.triac_gpio, 1);
             return;
         }
-        _alarm_config.alarm_count = ((_current_frequency / 110) * (100 - _dimmer_value)) + _zero_cross_time;
+        _alarm_config.alarm_count = (uint64_t)(((_current_period_us / 110) * (100 - _dimmer_value)) + _zero_cross_us);
         _alarm_config.flags.auto_reload_on_alarm = false;
         gptimer_set_alarm_action(_dimmer_timer, &_alarm_config); // This function is allowed to run within ISR context.
         gptimer_start(_dimmer_timer);                            // This function is allowed to run within ISR context.