doc: added wiki
This commit is contained in:
aZholtikov committed
1 parent
88907c3705
commit
f18ee9ba77
3 files changed
+704
No files matched your search
+350
@@ -0,0 +1,350 @@
|
||||
# zh_ac_dimmer - AC Dimmer Component for ESP-IDF
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Overview](#overview)
|
||||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [API Reference](#api-reference)
|
||||
- [Usage Examples](#usage-examples)
|
||||
- [Technical Specifications](#technical-specifications)
|
||||
- [Error Codes](#error-codes)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
`zh_ac_dimmer` is a lightweight ESP-IDF component for AC dimmer control. It provides a simple API to control AC load power using zero-crossing detection and TRIAC control. The component is designed specifically for ESP32 microcontrollers and uses ESP-IDF v5.0+ drivers (GPTimer, GPIO).
|
||||
|
||||
The component supports AC frequency 400Hz only and uses hardware timers for precise timing control.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
1. **AC Power Control**: Controls AC load power from 0% to 100%
|
||||
2. **Zero-Crossing Detection**: Uses GPIO interrupt for precise timing
|
||||
3. **TRIAC Control**: Controls TRIAC gate with precise timing
|
||||
4. **Hardware Timer**: Uses GPTimer for accurate dimming control
|
||||
5. **Error Handling**: Comprehensive error checking and validation
|
||||
6. **Thread-Safe**: Uses ESP-IDF drivers (thread-safe)
|
||||
7. **Low Memory**: Minimal memory footprint
|
||||
8. **Simple API**: Easy-to-use interface
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
1. Navigate to your project's components directory:
|
||||
|
||||
```bash
|
||||
cd ../your_project/components
|
||||
```
|
||||
|
||||
2. Clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/aZholtikov/zh_ac_dimmer.git
|
||||
```
|
||||
|
||||
3. In your application, include the header:
|
||||
|
||||
```c
|
||||
#include "zh_ac_dimmer.h"
|
||||
```
|
||||
|
||||
4. The component will be automatically built with your project.
|
||||
|
||||
### Required Configuration
|
||||
|
||||
For correct operation, please enable the following settings in menuconfig:
|
||||
|
||||
```text
|
||||
GPIO_CTRL_FUNC_IN_IRAM
|
||||
CONFIG_GPTIMER_ISR_HANDLER_IN_IRAM
|
||||
CONFIG_GPTIMER_CTRL_FUNC_IN_IRAM
|
||||
CONFIG_GPTIMER_ISR_CACHE_SAFE
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API Reference
|
||||
|
||||
### zh_ac_dimmer_init_config_t Structure
|
||||
|
||||
```c
|
||||
typedef struct
|
||||
{
|
||||
gpio_num_t zero_cross_gpio; // Zero cross GPIO
|
||||
gpio_num_t triac_gpio; // Triac GPIO
|
||||
} zh_ac_dimmer_init_config_t;
|
||||
```
|
||||
|
||||
Use `ZH_AC_DIMMER_INIT_CONFIG_DEFAULT()` macro to initialize with default values:
|
||||
|
||||
- `zero_cross_gpio`: GPIO_NUM_MAX
|
||||
- `triac_gpio`: GPIO_NUM_MAX
|
||||
|
||||
---
|
||||
|
||||
### zh_ac_dimmer_init()
|
||||
|
||||
Initializes the AC dimmer.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `config` - Pointer to AC dimmer initialization configuration structure
|
||||
|
||||
**Returns:**
|
||||
|
||||
- `ESP_OK` - Success
|
||||
- `ESP_ERR_INVALID_ARG` - Invalid argument (NULL config or invalid GPIO)
|
||||
- `ESP_ERR_INVALID_STATE` - AC dimmer is already initialized
|
||||
- `ESP_FAIL` - Initialization failed (GPIO or timer initialization)
|
||||
|
||||
**Example:**
|
||||
|
||||
```c
|
||||
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_deinit()
|
||||
|
||||
Deinitializes the AC dimmer and releases resources.
|
||||
|
||||
**Returns:**
|
||||
|
||||
- `ESP_OK` - Success
|
||||
- `ESP_ERR_INVALID_STATE` - AC dimmer is not initialized
|
||||
- `ESP_FAIL` - Deinitialization failed (GPIO or timer deinitialization)
|
||||
|
||||
---
|
||||
|
||||
### zh_ac_dimmer_start()
|
||||
|
||||
Starts AC dimmer operation.
|
||||
|
||||
**Returns:**
|
||||
|
||||
- `ESP_OK` - Success
|
||||
- `ESP_ERR_INVALID_STATE` - AC dimmer is not initialized
|
||||
|
||||
---
|
||||
|
||||
### zh_ac_dimmer_stop()
|
||||
|
||||
Stops AC dimmer operation.
|
||||
|
||||
**Returns:**
|
||||
|
||||
- `ESP_OK` - Success
|
||||
- `ESP_ERR_INVALID_STATE` - AC dimmer is not initialized
|
||||
|
||||
---
|
||||
|
||||
### zh_ac_dimmer_set()
|
||||
|
||||
Sets AC dimmer dimming value.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `value` - Dimming value (0 to 100, where 0 = off, 100 = full power)
|
||||
|
||||
**Returns:**
|
||||
|
||||
- `ESP_OK` - Success
|
||||
- `ESP_ERR_INVALID_STATE` - AC dimmer is not initialized
|
||||
- `ESP_ERR_INVALID_ARG` - Invalid dimming value
|
||||
|
||||
---
|
||||
|
||||
### zh_ac_dimmer_get()
|
||||
|
||||
Gets current AC dimmer dimming value.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `value` - Pointer to store the dimming value
|
||||
|
||||
**Returns:**
|
||||
|
||||
- `ESP_OK` - Success
|
||||
- `ESP_ERR_INVALID_STATE` - AC dimmer is not initialized
|
||||
- `ESP_ERR_INVALID_ARG` - Invalid argument (NULL value)
|
||||
|
||||
---
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Example: Dimmer Control
|
||||
|
||||
```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();
|
||||
uint8_t value = 0;
|
||||
for (uint8_t i = 0; i <= 100; ++i)
|
||||
{
|
||||
zh_ac_dimmer_set(i);
|
||||
zh_ac_dimmer_get(&value);
|
||||
printf("Dimmer value: %d.\\n", value);
|
||||
vTaskDelay(100 / portTICK_PERIOD_MS);
|
||||
}
|
||||
for (uint8_t i = 100; i > 0; --i)
|
||||
{
|
||||
zh_ac_dimmer_set(i);
|
||||
zh_ac_dimmer_get(&value);
|
||||
printf("Dimmer value: %d.\\n", value);
|
||||
vTaskDelay(100 / portTICK_PERIOD_MS);
|
||||
}
|
||||
zh_ac_dimmer_stop();
|
||||
zh_ac_dimmer_deinit();
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Example: Dimmer with Button Control
|
||||
|
||||
```c
|
||||
#include "zh_ac_dimmer.h"
|
||||
|
||||
#define ZERO_CROSS_GPIO GPIO_NUM_16
|
||||
#define TRIAC_GPIO GPIO_NUM_17
|
||||
#define BUTTON_GPIO GPIO_NUM_0
|
||||
|
||||
static uint8_t dimmer_value = 50;
|
||||
|
||||
static void IRAM_ATTR button_isr_handler(void *arg)
|
||||
{
|
||||
dimmer_value = (dimmer_value + 10) % 110;
|
||||
if (dimmer_value > 100)
|
||||
{
|
||||
dimmer_value = 0;
|
||||
}
|
||||
zh_ac_dimmer_set(dimmer_value);
|
||||
printf("Dimmer value: %d\\n", dimmer_value);
|
||||
}
|
||||
|
||||
void app_main(void)
|
||||
{
|
||||
esp_log_level_set("zh_ac_dimmer", ESP_LOG_ERROR);
|
||||
// Initialize dimmer
|
||||
zh_ac_dimmer_init_config_t config = ZH_AC_DIMMER_INIT_CONFIG_DEFAULT();
|
||||
config.zero_cross_gpio = ZERO_CROSS_GPIO;
|
||||
config.triac_gpio = TRIAC_GPIO;
|
||||
zh_ac_dimmer_init(&config);
|
||||
// Initialize button
|
||||
gpio_config_t button_config = {
|
||||
.intr_type = GPIO_INTR_POSEDGE,
|
||||
.mode = GPIO_MODE_INPUT,
|
||||
.pin_bit_mask = (1ULL << BUTTON_GPIO),
|
||||
.pull_down_en = GPIO_PULLDOWN_DISABLE,
|
||||
.pull_up_en = GPIO_PULLUP_ENABLE,
|
||||
};
|
||||
gpio_config(&button_config);
|
||||
gpio_install_isr_service(ESP_INTR_FLAG_DEFAULT);
|
||||
gpio_isr_handler_add(BUTTON_GPIO, button_isr_handler, NULL);
|
||||
// Start dimmer
|
||||
zh_ac_dimmer_start();
|
||||
printf("Dimmer initialized. Button on GPIO %d changes dimmer value.\\n", BUTTON_GPIO);
|
||||
for (;;)
|
||||
{
|
||||
vTaskDelay(1000 / portTICK_PERIOD_MS);
|
||||
uint8_t current_value;
|
||||
zh_ac_dimmer_get(¤t_value);
|
||||
printf("Current dimmer value: %d\\n", current_value);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Technical Specifications
|
||||
|
||||
| Parameter | Value |
|
||||
|-----------|-------|
|
||||
| **Dimming Range** | 0 - 100% |
|
||||
| **AC Frequency** | 400 Hz (supported only) |
|
||||
| **Zero-Crossing Detection** | GPIO interrupt (positive edge) |
|
||||
| **TRIAC Control** | GPIO output |
|
||||
| **Timer Resolution** | 1 MHz (1 µs) |
|
||||
| **Measurement Time** | ~1250 µs per cycle |
|
||||
| **ESP-IDF Version** | >= 5.0 |
|
||||
| **Platform** | ESP32 series |
|
||||
| **Language** | C (C99) |
|
||||
|
||||
---
|
||||
|
||||
## Error Codes
|
||||
|
||||
| Error Code | Description |
|
||||
|------------|-------------|
|
||||
| `ESP_OK` | Operation successful |
|
||||
| `ESP_ERR_INVALID_ARG` | Invalid argument (NULL pointer, invalid GPIO, or invalid dimming value) |
|
||||
| `ESP_ERR_INVALID_STATE` | AC dimmer is not initialized |
|
||||
| `ESP_FAIL` | General failure (GPIO or timer initialization/deinitialization) |
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! To contribute:
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
Please ensure your code follows the existing style and includes appropriate documentation.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the Apache License, Version 2.0 - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
### Apache License, Version 2.0
|
||||
|
||||
Copyright (c) 2026 Alexey Zholtikov
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
---
|
||||
|
||||
## Additional Notes
|
||||
|
||||
- **AC Frequency**: Currently supports 400Hz frequency only
|
||||
- **Zero-Crossing Timing**: 1250 µs period (400Hz) with 330 µs compensation for timer delay
|
||||
- **GPIO Interrupt**: Zero-crossing detection uses positive edge interrupt
|
||||
- **IRAM Requirements**: For correct operation, enable `GPIO_CTRL_FUNC_IN_IRAM`, `CONFIG_GPTIMER_ISR_HANDLER_IN_IRAM`, `CONFIG_GPTIMER_CTRL_FUNC_IN_IRAM`, and `CONFIG_GPTIMER_ISR_CACHE_SAFE` in menuconfig
|
||||
- **Thread Safety**: The component uses ESP-IDF drivers which are thread-safe
|
||||
|
||||
---
|
||||
|
||||
*Generated for zh_ac_dimmer v1.0.0*
|
||||
Reference in new issue
Block a user