feat: initial

README.md

@@ -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);
+        }
+    }
+}
+```