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

feat: initial

Browse Source
This commit is contained in:
Alexey Zholtikov
2025-10-20 19:01:06 +04:00
parent ae0f22187b
commit 780bcb00c6
9 changed files with 301 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@@ -1,5 +1 @@
.DS_Store
.vscode
build
sdkconfig
sdkconfig.old

2
CMakeLists.txt
View File

@@ -1 +1 @@
idf_component_register(SRCS "main.c" INCLUDE_DIRS "include")
idf_component_register(SRCS "zh_ac_dimmer.c" INCLUDE_DIRS "include" REQUIRES driver esp_timer)

55
README.md
View File

@@ -1,3 +1,54 @@
# esp_component_template
# ESP32 ESP-IDF component for AC dimmer
esp_component_template
## Tested on
1. [ESP32 ESP-IDF v5.5.1](https://docs.espressif.com/projects/esp-idf/en/v5.5.1/esp32/index.html)
## Features
1. Supports frequency up to 400 Hz.
2. Automatic frequency detection.
## 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/esp_components/zh_ac_dimmer
```
In the application, add the component:
```c
#include "zh_ac_dimmer.h"
```
## Examples
```c
#include "zh_ac_dimmer.h"
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;
zh_ac_dimmer_init(&config);
zh_ac_dimmer_start();
for (;;)
{
for (uint8_t i = 0; i <= 100; ++i)
{
zh_ac_dimmer_set(i);
vTaskDelay(100 / portTICK_PERIOD_MS);
}
for (uint8_t i = 100; i > 0; --i)
{
zh_ac_dimmer_set(i);
vTaskDelay(100 / portTICK_PERIOD_MS);
}
}
}
```

0
component.mk
View File

0
include/main.h
View File

65
include/zh_ac_dimmer.h Normal file
View File

@@ -0,0 +1,65 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/gptimer.h"
#include "esp_timer.h"
#include "esp_log.h"
#include "driver/gpio.h"
#define ZH_AC_DIMMER_INIT_CONFIG_DEFAULT() \
{ \
.zero_cross_gpio = GPIO_NUM_MAX, \
.triac_gpio = GPIO_NUM_MAX}
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct // Structure for initial initialization of AC dimmer.
{
uint8_t zero_cross_gpio; // Zero cross GPIO.
uint8_t triac_gpio; // Triac GPIO.
} zh_ac_dimmer_init_config_t;
/**
* @brief Initialize AC dimmer.
*
* @param[in] config Pointer to AC dimmer initialized configuration structure. Can point to a temporary variable.
*
* @note Before initialize the AC dimmer recommend initialize zh_ac_dimmer_init_config_t structure with default values.
*
* @code zh_ac_dimmer_init_config_t config = ZH_AC_DIMMER_INIT_CONFIG_DEFAULT @endcode
*
* @return ESP_OK if success or an error code otherwise.
*/
esp_err_t zh_ac_dimmer_init(const zh_ac_dimmer_init_config_t *config);
/**
* @brief Start AC dimmer.
*
* @return ESP_OK if success or an error code otherwise.
*/
esp_err_t zh_ac_dimmer_start(void);
/**
* @brief Stop AC dimmer.
*
* @return ESP_OK if success or an error code otherwise.
*/
esp_err_t zh_ac_dimmer_stop(void);
/**
* @brief Set AC dimmer dimming value.
*
* @param[in] value Dimming value (0 to 100).
*
* @return ESP_OK if success or an error code otherwise.
*/
esp_err_t zh_ac_dimmer_set(uint8_t value);
#ifdef __cplusplus
}
#endif

0
main.c
View File

1
version.txt
View File

@@ -0,0 +1 @@
v1.0.0

180
zh_ac_dimmer.c Normal file
View File

@@ -0,0 +1,180 @@
#include "zh_ac_dimmer.h"
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, ...) \
if (!(cond)) \
{ \
ZH_LOGE(msg, err); \
return err; \
}
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 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);
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.");
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.");
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;
_is_initialized = true;
ZH_LOGI("AC dimmer initialization completed successfully.");
return ESP_OK;
}
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.");
_is_dimmer_work = true;
ZH_LOGI("AC dimmer start completed successfully.");
return ESP_OK;
}
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.");
_is_dimmer_work = false;
ZH_LOGI("AC dimmer stop completed successfully.");
return ESP_OK;
}
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(value <= 100, ESP_ERR_INVALID_ARG, "AC dimmer setup failed. Dimming value invalid.");
_dimmer_value = value;
ZH_LOGI("AC dimmer setup completed successfully.");
return ESP_OK;
}
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 != 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)
{
gpio_config_t triac_gpio_config = {
.intr_type = GPIO_INTR_DISABLE,
.mode = GPIO_MODE_OUTPUT,
.pin_bit_mask = (1ULL << config->triac_gpio),
.pull_down_en = GPIO_PULLDOWN_DISABLE,
.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.");
gpio_config_t zero_cross_gpio_config = {
.intr_type = GPIO_INTR_POSEDGE,
.mode = GPIO_MODE_INPUT,
.pin_bit_mask = (1ULL << config->zero_cross_gpio),
.pull_down_en = GPIO_PULLDOWN_DISABLE,
.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.");
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);
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)
{
gptimer_config_t timer_config = {
.clk_src = GPTIMER_CLK_SRC_DEFAULT,
.direction = GPTIMER_COUNT_UP,
.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.");
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.");
err = gptimer_enable(_dimmer_timer);
ZH_ERROR_CHECK(err == ESP_OK, err, "Failed enable dimmer timer.");
return ESP_OK;
}
void IRAM_ATTR _zh_ac_dimmer_isr_handler(void *arg)
{
if (_is_dimmer_work == false)
{
return;
}
gpio_set_level(_init_config.triac_gpio, 0);
uint64_t _current_micros = esp_timer_get_time();
_current_frequency = _current_micros - _prev_micros;
_prev_micros = _current_micros;
if (_current_frequency < 1000)
{
if (_current_frequency > 50)
{
_zero_cross_time = _current_frequency;
}
_current_frequency = _prev_frequency;
}
_prev_frequency = _current_frequency;
if (_dimmer_value != 0)
{
if (_dimmer_value == 100)
{
gpio_set_level(_init_config.triac_gpio, 1);
return;
}
_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);
}
}
bool _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);
gptimer_set_raw_count(_dimmer_timer, 0);
return true;
}