feat: added dimmer deinit

include/zh_ac_dimmer.h

@@ -1,3 +1,7 @@
+/**
+ * @file zh_ac_dimmer.h
+ */
+
 #pragma once
 
 #include "freertos/FreeRTOS.h"
@@ -7,6 +11,9 @@
 #include "esp_log.h"
 #include "driver/gpio.h"
 
+/**
+ * @brief AC dimmer initial default values.
+ */
 #define ZH_AC_DIMMER_INIT_CONFIG_DEFAULT() \
     {                                      \
         .zero_cross_gpio = GPIO_NUM_MAX,   \
@@ -17,11 +24,13 @@
 extern "C"
 {
 #endif
-
-    typedef struct // Structure for initial initialization of AC dimmer.
+    /**
+     * @brief Structure for initial initialization of AC dimmer.
+     */
+    typedef struct
     {
-        uint8_t zero_cross_gpio; // Zero cross GPIO.
-        uint8_t triac_gpio;      // Triac GPIO.
+        uint8_t zero_cross_gpio; /*!< Zero cross GPIO. */
+        uint8_t triac_gpio;      /*!< Triac GPIO. */
     } zh_ac_dimmer_init_config_t;
 
     /**
@@ -37,6 +46,13 @@ extern "C"
      */
     esp_err_t zh_ac_dimmer_init(const zh_ac_dimmer_init_config_t *config);
 
+    /**
+     * @brief Deinitialize AC dimmer.
+     *
+     * @return ESP_OK if success or an error code otherwise.
+     */
+    esp_err_t zh_ac_dimmer_deinit(void);
+
     /**
      * @brief Start AC dimmer.
      *

version.txt

@@ -1 +1 @@
-v1.0.0
+1.1.0

zh_ac_dimmer.c

@@ -16,17 +16,16 @@ 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 uint64_t _prev_micros = 0;
-static uint32_t _current_frequency = 0;
-static uint32_t _prev_frequency = 0;
-static uint16_t _zero_cross_time = 0;
-static uint8_t _dimmer_value = 0;
-static bool _is_dimmer_work = false;
+static volatile uint64_t _prev_micros = 0;
+static volatile uint32_t _current_frequency = 0;
+static volatile uint32_t _prev_frequency = 0;
+static volatile uint16_t _zero_cross_time = 0;
+static volatile uint8_t _dimmer_value = 0;
+static volatile bool _is_dimmer_work = false;
 static bool _is_initialized = false;
 
 static esp_err_t _zh_ac_dimmer_validate_config(const zh_ac_dimmer_init_config_t *config);
 static esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *config);
-static esp_err_t _zh_ac_dimmer_interrupt_init(const zh_ac_dimmer_init_config_t *config);
 static esp_err_t _zh_ac_dimmer_timer_init(void);
 static void _zh_ac_dimmer_isr_handler(void *arg);
 static bool _zh_ac_dimmer_timer_on_alarm_cb(gptimer_handle_t timer, const gptimer_alarm_event_data_t *edata, void *user_ctx);
@@ -39,8 +38,6 @@ esp_err_t zh_ac_dimmer_init(const zh_ac_dimmer_init_config_t *config)
     ZH_ERROR_CHECK(err == ESP_OK, err, "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.");
-    err = _zh_ac_dimmer_interrupt_init(config);
-    ZH_ERROR_CHECK(err == ESP_OK, err, "AC dimmer initialization failed. Interrupt initialization failed.");
     err = _zh_ac_dimmer_timer_init();
     ZH_ERROR_CHECK(err == ESP_OK, err, "AC dimmer initialization failed. Timer initialization failed.");
     _init_config = *config;
@@ -49,6 +46,29 @@ esp_err_t zh_ac_dimmer_init(const zh_ac_dimmer_init_config_t *config)
     return ESP_OK;
 }
 
+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.");
+    _is_dimmer_work = false;
+    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();
+    _is_initialized = false;
+    _dimmer_value = 0;
+    _current_frequency = 0;
+    _prev_frequency = 0;
+    _zero_cross_time = 0;
+    _prev_micros = 0;
+    ZH_LOGI("AC dimmer deinitialization completed successfully.");
+    return ESP_OK;
+}
+
 esp_err_t zh_ac_dimmer_start(void)
 {
     ZH_LOGI("AC dimmer start begin.");
@@ -77,16 +97,16 @@ esp_err_t zh_ac_dimmer_set(uint8_t value)
     return ESP_OK;
 }
 
-esp_err_t _zh_ac_dimmer_validate_config(const zh_ac_dimmer_init_config_t *config)
+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->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->triac_gpio >= GPIO_NUM_0 && config->triac_gpio <= GPIO_NUM_MAX), ESP_ERR_INVALID_ARG, "Triac GPIO invalid.");
+    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->triac_gpio >= GPIO_NUM_0 && config->triac_gpio < GPIO_NUM_MAX), ESP_ERR_INVALID_ARG, "Triac GPIO invalid.");
     ZH_ERROR_CHECK((config->zero_cross_gpio != config->triac_gpio), ESP_ERR_INVALID_ARG, "Both GPIO is same.");
     return ESP_OK;
 }
 
-esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *config)
+static esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *config)
 {
     gpio_config_t triac_gpio_config = {
         .intr_type = GPIO_INTR_DISABLE,
@@ -97,6 +117,7 @@ esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *config)
     };
     esp_err_t err = gpio_config(&triac_gpio_config);
     ZH_ERROR_CHECK(err == ESP_OK, err, "Triac GPIO configuration failed.");
+    gpio_set_level(config->triac_gpio, 0);
     gpio_config_t zero_cross_gpio_config = {
         .intr_type = GPIO_INTR_POSEDGE,
         .mode = GPIO_MODE_INPUT,
@@ -106,20 +127,14 @@ esp_err_t _zh_ac_dimmer_gpio_init(const zh_ac_dimmer_init_config_t *config)
     };
     err = gpio_config(&zero_cross_gpio_config);
     ZH_ERROR_CHECK(err == ESP_OK, err, "Zero cross GPIO configuration failed.");
-    gpio_set_level(_init_config.triac_gpio, 0);
-    return ESP_OK;
-}
-
-esp_err_t _zh_ac_dimmer_interrupt_init(const zh_ac_dimmer_init_config_t *config)
-{
-    esp_err_t err = gpio_install_isr_service(ESP_INTR_FLAG_LEVEL3);
+    err = gpio_install_isr_service(ESP_INTR_FLAG_LEVEL3);
     ZH_ERROR_CHECK(err == ESP_OK, err, "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.");
     return ESP_OK;
 }
 
-esp_err_t _zh_ac_dimmer_timer_init(void)
+static esp_err_t _zh_ac_dimmer_timer_init(void)
 {
     gptimer_config_t timer_config = {
         .clk_src = GPTIMER_CLK_SRC_DEFAULT,
@@ -138,7 +153,7 @@ esp_err_t _zh_ac_dimmer_timer_init(void)
     return ESP_OK;
 }
 
-void IRAM_ATTR _zh_ac_dimmer_isr_handler(void *arg)
+static void IRAM_ATTR _zh_ac_dimmer_isr_handler(void *arg)
 {
     if (_is_dimmer_work == false)
     {
@@ -166,12 +181,12 @@ void IRAM_ATTR _zh_ac_dimmer_isr_handler(void *arg)
         }
         _alarm_config.alarm_count = ((_current_frequency / 110) * (100 - _dimmer_value)) + _zero_cross_time;
         _alarm_config.flags.auto_reload_on_alarm = false;
-        gptimer_set_alarm_action(_dimmer_timer, &_alarm_config);
-        gptimer_start(_dimmer_timer);
+        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.
     }
 }
 
-bool _zh_ac_dimmer_timer_on_alarm_cb(gptimer_handle_t timer, const gptimer_alarm_event_data_t *edata, void *user_ctx)
+static bool IRAM_ATTR _zh_ac_dimmer_timer_on_alarm_cb(gptimer_handle_t timer, const gptimer_alarm_event_data_t *edata, void *user_ctx)
 {
     gpio_set_level(_init_config.triac_gpio, 1);
     gptimer_stop(_dimmer_timer);