zh_ac_dimmer.h File Reference

#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/gptimer.h"
#include "esp_timer.h"
#include "esp_log.h"
#include "driver/gpio.h"

Go to the source code of this file.

Data Structures
struct	zh_ac_dimmer_init_config_t
	Structure for initial initialization of AC dimmer. More...

Macros
#define	ZH_AC_DIMMER_INIT_CONFIG_DEFAULT()
	AC dimmer initial default values.

Functions
esp_err_t	zh_ac_dimmer_init (const zh_ac_dimmer_init_config_t *config)
	Initialize AC dimmer.
esp_err_t	zh_ac_dimmer_deinit (void)
	Deinitialize AC dimmer.
esp_err_t	zh_ac_dimmer_start (void)
	Start AC dimmer.
esp_err_t	zh_ac_dimmer_stop (void)
	Stop AC dimmer.
esp_err_t	zh_ac_dimmer_set (uint8_t value)
	Set AC dimmer dimming value.

Macro Definition Documentation

ZH_AC_DIMMER_INIT_CONFIG_DEFAULT

#define ZH_AC_DIMMER_INIT_CONFIG_DEFAULT

(

)

Value:

    {                                      \
        .zero_cross_gpio = GPIO_NUM_MAX,   \
        .triac_gpio = GPIO_NUM_MAX}

AC dimmer initial default values.

Definition at line 17 of file zh_ac_dimmer.h.

Function Documentation

zh_ac_dimmer_deinit()

esp_err_t zh_ac_dimmer_deinit

(

void

)

Deinitialize AC dimmer.

Returns

ESP_OK if success or an error code otherwise.

Definition at line 51 of file zh_ac_dimmer.c.

zh_ac_dimmer_init()

esp_err_t zh_ac_dimmer_init

(

const zh_ac_dimmer_init_config_t *

config

)

Initialize AC dimmer.

Parameters

[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.

zh_ac_dimmer_init_config_t config = ZH_AC_DIMMER_INIT_CONFIG_DEFAULT 

Returns

ESP_OK if success or an error code otherwise.

Definition at line 34 of file zh_ac_dimmer.c.

zh_ac_dimmer_set()

esp_err_t zh_ac_dimmer_set

(

uint8_t

value

)

Set AC dimmer dimming value.

Parameters

[in]

value

Dimming value (0 to 100).

Returns

ESP_OK if success or an error code otherwise.

Definition at line 92 of file zh_ac_dimmer.c.

zh_ac_dimmer_start()

esp_err_t zh_ac_dimmer_start

(

void

)

Start AC dimmer.

Returns

ESP_OK if success or an error code otherwise.

Definition at line 74 of file zh_ac_dimmer.c.

zh_ac_dimmer_stop()

esp_err_t zh_ac_dimmer_stop

(

void

)

Stop AC dimmer.

Returns

ESP_OK if success or an error code otherwise.

Definition at line 83 of file zh_ac_dimmer.c.