# LED PWM 控制器

[English]

## 概述

LED 控制器 (LEDC) 主要用于控制 LED，也可产生 PWM 信号用于其他设备的控制。该控制器有 8 路通道，可以产生独立的波形，驱动 RGB LED 等设备。

LEDC 通道共有两组，分别为 8 路高速通道和 8 路低速通道。高速通道模式在硬件中实现，可以自动且无干扰地改变 PWM 占空比。低速通道模式下，PWM 占空比需要由软件中的驱动器改变。每组通道都可以使用不同的时钟源。

LED PWM 控制器可在无需 CPU 干预的情况下自动改变占空比，实现亮度和颜色渐变。

## 功能概览

设置 LEDC 通道在 高速模式或低速模式 下运行，需要进行如下配置：

1. 定时器配置 指定 PWM 信号的频率和占空比分辨率。

2. 通道配置 绑定定时器和输出 PWM 信号的 GPIO。

3. 改变 PWM 信号 输出 PWM 信号来驱动 LED。可通过软件控制或使用硬件渐变功能来改变 LED 的亮度。

另一个可选步骤是可以在渐变终端设置一个中断。

LED PWM 控制器 API 的关键配置

备注

首次 LEDC 配置时，建议先配置定时器（调用函数 `ledc_timer_config()`），再配置通道（调用函数 `ledc_channel_config()`）。这样可以确保 IO 脚上的 PWM 信号自有输出开始其频率就是正确的。

### 定时器配置

要设置定时器，可调用函数 `ledc_timer_config()`，并将包括如下配置参数的数据结构 `ledc_timer_config_t` 传递给该函数：

- 速度模式 `ledc_mode_t`

- 定时器索引 `ledc_timer_t`

- PWM 信号频率（Hz）

- PWM 占空比分辨率

- 时钟源 `ledc_clk_cfg_t`

频率和占空比分辨率相互关联。PWM 频率越高，占空比分辨率越低，反之亦然。如果 API 不是用来改变 LED 亮度，而是用于其它目的，这种相互关系可能会很重要。更多信息详见 频率和占空比分辨率支持范围 一节。

时钟源同样可以限制 PWM 频率。选择的时钟源频率越高，可以配置的 PWM 频率上限就越高。

ESP32 LEDC 时钟源特性
时钟名称 | 时钟频率 | 速度模式 | 时钟功能
--- | --- | --- | ---
APB_CLK | 80 MHz | 高速 / 低速 | /
REF_TICK | 1 MHz | 高速 / 低速 | 支持动态调频 (DFS) 功能
RC_FAST_CLK | ~ 8 MHz | 低速 | 支持动态调频 (DFS) 功能，支持 Light-sleep 模式

备注

1. 如果 ESP32 的定时器选用了 `RC_FAST_CLK` 作为其时钟源，驱动会通过内部校准来得知这个时钟源的实际频率。这样确保了输出 PWM 信号频率的精准性。

LEDC 驱动提供了一个辅助函数 `ledc_find_suitable_duty_resolution()`。传入时钟源频率及期望的 PWM 信号频率，这个函数可以直接找到最大可配的占空比分辨率值。

当一个定时器不再被任何通道所需要时，可以通过调用相同的函数 `ledc_timer_config()` 来重置这个定时器。此时，函数入参的配置结构体需要指定：

- `ledc_timer_config_t::speed_mode` 重置定时器的所属速度模式 （`ledc_mode_t`）

- `ledc_timer_config_t::timer_num` 重置定时器的索引 （`ledc_timer_t`）

- `ledc_timer_config_t::deconfigure` 将指定定时器重置必须配置此项为 true

### 通道配置

定时器设置好后，请配置所需的通道（`ledc_channel_t` 之一）。配置通道需调用函数 `ledc_channel_config()`。

通道的配置与定时器设置类似，需向通道配置函数传递包括通道配置参数的结构体 `ledc_channel_config_t` 。

此时，通道会按照 `ledc_channel_config_t` 的配置开始运作，并在选定的 GPIO 上生成由定时器设置指定的频率和占空比的 PWM 信号。在通道运作过程中，可以随时通过调用函数 `ledc_stop()` 将其暂停。

### 改变 PWM 信号

通道开始运行、生成具有恒定占空比和频率的 PWM 信号之后，有几种方式可以改变该信号。驱动 LED 时，主要通过改变占空比来变化光线亮度。

以下两节介绍了如何使用软件和硬件改变占空比。如有需要，PWM 信号的频率也可更改，详见 改变 PWM 频率 一节。

#### 使用软件改变 PWM 占空比

调用函数 `ledc_set_duty()` 可以设置新的占空比。之后，调用函数 `ledc_update_duty()` 使新配置生效。要查看当前设置的占空比，可使用 `_get_` 函数 `ledc_get_duty()`。

另外一种设置占空比和其他通道参数的方式是调用 通道配置 一节提到的函数 `ledc_channel_config()`。

传递给函数的占空比数值范围取决于选定的 `duty_resolution`，应为 `0` 至 `(2 ** duty_resolution)`。例如，如选定的占空比分辨率为 10，则占空比的数值范围为 0 至 1024。此时分辨率为 ~ 0.1%。

警告

在 ESP32 上，当通道绑定的定时器配置了其最大 PWM 占空比分辨率（ `MAX_DUTY_RES` ），通道的占空比不能被设置到 `(2 ** MAX_DUTY_RES)` 。否则，硬件内部占空比计数器会溢出，并导致占空比计算错误。

#### 使用硬件改变 PWM 占空比

LED PWM 控制器硬件可逐渐改变占空比的数值。要使用此功能，需用函数 `ledc_fade_func_install()` 使能渐变，之后用下列可用渐变函数之一配置：

- `ledc_set_fade_with_time()`

- `ledc_set_fade_with_step()`

- `ledc_set_fade()`

最后需要调用 `ledc_fade_start()` 开启渐变。渐变可以在阻塞或非阻塞模式下运行，具体区别请查看 `ledc_fade_mode_t`。需要特别注意的是，不管在哪种模式下，下一次渐变或单次占空比配置的指令生效都必须等到前一次渐变结束。由于 ESP32 的硬件限制，在渐变达到原先预期的占空比前想要中止本次渐变是不被支持的。

此外，在使能渐变后，每个通道都可以额外通过调用 `ledc_cb_register()` 注册一个回调函数用以获得渐变完成的事件通知。回调函数的原型被定义在 `ledc_cb_t`。每个回调函数都应当返回一个布尔值给驱动的中断处理函数，用以表示是否有高优先级任务被其唤醒。此外，值得注意的是，由于驱动的中断处理函数被放在了 IRAM 中， 回调函数和其调用的函数也需要被放在 IRAM 中。 `ledc_cb_register()` 会检查回调函数及函数上下文的指针地址是否在正确的存储区域。

如不需要渐变和渐变中断，可用函数 `ledc_fade_func_uninstall()` 关闭。

#### 改变 PWM 频率

LED PWM 控制器 API 有多种方式即时改变 PWM 频率：

> - 通过调用函数 `ledc_set_freq()` 设置频率。可用函数 `ledc_get_freq()` 查看当前频率。

> - 通过调用函数 `ledc_bind_channel_timer()` 将其他定时器绑定到该通道来改变频率和占空比分辨率。

> - 通过调用函数 `ledc_channel_config()` 改变通道的定时器。

#### 控制 PWM 的更多方式

有一些较独立的定时器特定函数可用于更改 PWM 输出：

- `ledc_timer_rst()`

- `ledc_timer_pause()`

- `ledc_timer_resume()`

第一个定时器复位函数在函数 `ledc_timer_config()` 内部完成所有定时器配置后会被调用一次。

## 电源管理

LEDC 驱动不使用电源管理锁来防止系统进入 Light-sleep 。相反，可以通过配置 `ledc_channel_config_t::sleep_mode` 来选择 LEDC 外设电源域状态和 PWM 信号在睡眠期间的输出行为。默认模式是 `LEDC_SLEEP_MODE_NO_ALIVE_NO_PD`，它表示没有信号输出，并且 LEDC 电源域在睡眠期间不会下电。

如果需要在 Light-sleep 中保持信号输出，则可以选择 `LEDC_SLEEP_MODE_KEEP_ALIVE` 模式。只要绑定的 LEDC 定时器时钟源兼容 Light-sleep ， PWM 信号就可以在系统进入 Light-sleep 期间继续输出。其代价是睡眠期间的功耗会更高，这是由于时钟源和 LEDC 所属的电源域无法被下电。值得注意的是，在入睡前未完成的渐变也可以在睡眠期间继续，只是有可能没法准确停在目标占空比上。系统被唤醒后，驱动会调整 PWM 占空比到原来设定的目标占空比上。

## LED PWM 控制器高速和低速模式

高速模式的优点是可平稳地改变定时器设置。也就是说，高速模式下如定时器设置改变，此变更会自动应用于定时器的下一次溢出中断。而更新低速定时器时，设置变更应由软件显式触发。LED PWM 驱动的设置将在硬件层面被修改，比如在调用函数 `ledc_timer_config()` 时。

更多关于速度模式的详细信息请参阅 ESP32 技术参考手册 > LED PWM 控制器 (LEDC) [PDF]。

## 频率和占空比分辨率支持范围

LED PWM 控制器主要用于驱动 LED。该控制器 PWM 占空比设置的分辨率范围较广。比如，PWM 频率为 5 kHz 时，占空比分辨率最大可为 13 位。这意味着占空比可为 0 至 100% 之间的任意值，分辨率为 ~0.012%（2 ** 13 = 8192 LED 亮度的离散电平）。然而，这些参数取决于为 LED PWM 控制器定时器计时的时钟信号，LED PWM 控制器为通道提供时钟（具体可参考 定时器配置 和 ESP32 技术参考手册 > LED PWM 计时器 (LEDC) [PDF]）。

LED PWM 控制器可用于生成频率较高的信号，足以为数码相机模组等其他设备提供时钟。此时，最大频率可为 40 MHz，占空比分辨率为 1 位。也就是说，占空比固定为 50%，无法调整。

LED PWM 控制器 API 会在设定的频率和占空比分辨率超过 LED PWM 控制器硬件范围时报错。例如，试图将频率设置为 20 MHz、占空比分辨率设置为 3 位时，串行端口监视器上会报告如下错误：

    E (196) ledc: requested frequency and duty resolution cannot be achieved, try reducing freq_hz or duty_resolution. div_param=128

此时，占空比分辨率或频率必须降低。比如，将占空比分辨率设置为 2 会解决这一问题，让占空比设置为 25% 的倍数，即 25%、50% 或 75%。

如设置的频率和占空比分辨率低于所支持的最低值，LED PWM 驱动器也会反映并报告，如：

    E (196) ledc: requested frequency and duty resolution cannot be achieved, try increasing freq_hz or duty_resolution. div_param=128000000

占空比分辨率通常用 `ledc_timer_bit_t` 设置，范围是 10 至 15 位。如需较低的占空比分辨率（上至 10，下至 1），可直接输入相应数值。

## 应用示例

- peripherals/ledc/ledc_basic 演示了如何使用 LEDC 生成低速模式的 PWM 信号。

- peripherals/ledc/ledc_fade 演示了如何使用 LEDC 实现 LED 亮度的渐变控制。

## API 参考

### Header File

- components/esp_driver_ledc/include/driver/ledc.h

- This header file can be included with:

  >     #include "driver/ledc.h"

- This header file is a part of the API provided by the `esp_driver_ledc` component. To declare that your component depends on `esp_driver_ledc`, add the following to your CMakeLists.txt:

  >     REQUIRES esp_driver_ledc

  > or

  >     PRIV_REQUIRES esp_driver_ledc

### Functions

esp_err_t ledc_channel_config(const ledc_channel_config_t *ledc_conf)

  LEDC channel configuration Configure LEDC channel with the given channel/output gpio_num/interrupt/source timer/frequency(Hz)/LEDC duty.

  参数:

    ledc_conf -- Pointer of LEDC channel configure struct

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

uint32_t ledc_find_suitable_duty_resolution(uint32_t src_clk_freq, uint32_t timer_freq)

  Helper function to find the maximum possible duty resolution in bits for ledc_timer_config()

  参数:

    - src_clk_freq -- LEDC timer source clock frequency (Hz) (See doxygen comments of `ledc_clk_cfg_t` or get from `esp_clk_tree_src_get_freq_hz`)

    - timer_freq -- Desired LEDC timer frequency (Hz)

  返回:

    - 0 The timer frequency cannot be achieved

    - Others The largest duty resolution value to be set

esp_err_t ledc_timer_config(const ledc_timer_config_t *timer_conf)

  LEDC timer configuration Configure LEDC timer with the given source timer/frequency(Hz)/duty_resolution.

  参数:

    timer_conf -- Pointer of LEDC timer configure struct

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_FAIL Can not find a proper pre-divider number base on the given frequency and the current duty_resolution.

    - ESP_ERR_INVALID_STATE Timer cannot be de-configured because timer is not configured or is not paused

esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel)

  LEDC update channel parameters.

  备注

  Call this function to activate the LEDC updated parameters. After ledc_set_duty, we need to call this function to update the settings. And the new LEDC parameters don't take effect until the next PWM cycle.

  备注

  ledc_set_duty, ledc_set_duty_with_hpoint and ledc_update_duty are not thread-safe, do not call these functions to control one LEDC channel in different tasks at the same time. A thread-safe version of API is ledc_set_duty_and_update

  备注

  If `CONFIG_LEDC_CTRL_FUNC_IN_IRAM` is enabled, this function will be placed in the IRAM by linker, makes it possible to execute even when the Cache is disabled.

  备注

  This function is allowed to run within ISR context.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

esp_err_t ledc_set_pin(int gpio_num, ledc_mode_t speed_mode, ledc_channel_t channel)

  Set LEDC output gpio.

  备注

  This function only routes the LEDC signal to GPIO through matrix, other LEDC resources initialization are not involved. Please use `ledc_channel_config()` instead to fully configure a LEDC channel.

  参数:

    - gpio_num -- The LEDC output gpio

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

esp_err_t ledc_stop(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t idle_level)

  LEDC stop. Disable LEDC output, and set idle level.

  备注

  If `CONFIG_LEDC_CTRL_FUNC_IN_IRAM` is enabled, this function will be placed in the IRAM by linker, makes it possible to execute even when the Cache is disabled.

  备注

  This function is allowed to run within ISR context.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - idle_level -- Set output idle level after LEDC stops.

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

esp_err_t ledc_set_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num, uint32_t freq_hz)

  LEDC set channel frequency (Hz)

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - timer_num -- LEDC timer index (0-3), select from ledc_timer_t

    - freq_hz -- Set the LEDC frequency

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_FAIL Can not find a proper pre-divider number base on the given frequency and the current duty_resolution.

uint32_t ledc_get_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num)

  LEDC get channel frequency (Hz)

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - timer_num -- LEDC timer index (0-3), select from ledc_timer_t

  返回:

    - 0 error

    - Others Current LEDC frequency

esp_err_t ledc_set_duty_with_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)

  LEDC set duty and hpoint value Only after calling ledc_update_duty will the duty update.

  备注

  ledc_set_duty, ledc_set_duty_with_hpoint and ledc_update_duty are not thread-safe, do not call these functions to control one LEDC channel in different tasks at the same time. A thread-safe version of API is ledc_set_duty_and_update

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - duty -- Set the LEDC duty, the range of duty setting is [0, (2**duty_resolution)]

    - hpoint -- Set the LEDC hpoint value, the range is [0, (2**duty_resolution)-1]

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

int ledc_get_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel)

  LEDC get hpoint value, the counter value when the output is set high level.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

  返回:

    - LEDC_ERR_VAL if parameter error

    - Others Current hpoint value of LEDC channel

esp_err_t ledc_set_duty(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty)

  LEDC set duty This function do not change the hpoint value of this channel. if needed, please call ledc_set_duty_with_hpoint. only after calling ledc_update_duty will the duty update.

  备注

  ledc_set_duty, ledc_set_duty_with_hpoint and ledc_update_duty are not thread-safe, do not call these functions to control one LEDC channel in different tasks at the same time. A thread-safe version of API is ledc_set_duty_and_update.

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - duty -- Set the LEDC duty, the range of duty setting is [0, (2**duty_resolution)]

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

uint32_t ledc_get_duty(ledc_mode_t speed_mode, ledc_channel_t channel)

  LEDC get duty This function returns the duty at the present PWM cycle. You shouldn't expect the function to return the new duty in the same cycle of calling ledc_update_duty, because duty update doesn't take effect until the next cycle.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

  返回:

    - LEDC_ERR_DUTY if parameter error

    - Others Current LEDC duty

esp_err_t ledc_set_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, ledc_duty_direction_t fade_direction, uint32_t step_num, uint32_t duty_cycle_num, uint32_t duty_scale)

  LEDC set gradient Set LEDC gradient, After the function calls the ledc_update_duty function, the function can take effect.

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - duty -- Set the start of the gradient duty, the range of duty setting is [0, (2**duty_resolution)]

    - fade_direction -- Set the direction of the gradient

    - step_num -- Set the number of the gradient

    - duty_cycle_num -- Set how many LEDC tick each time the gradient lasts

    - duty_scale -- Set gradient change amplitude

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

esp_err_t ledc_isr_register(void (*fn)(void*), void *arg, int intr_alloc_flags, ledc_isr_handle_t *handle)

  Register LEDC interrupt handler, the handler is an ISR. The handler will be attached to the same CPU core that this function is running on.

  参数:

    - fn -- Interrupt handler function.

    - arg -- User-supplied argument passed to the handler function.

    - intr_alloc_flags -- Flags used to allocate the interrupt. One or multiple (ORred) ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info.

    - handle -- Pointer to return handle. If non-NULL, a handle for the interrupt will be returned here.

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_NOT_FOUND Failed to find available interrupt source

esp_err_t ledc_timer_rst(ledc_mode_t speed_mode, ledc_timer_t timer_sel)

  Reset LEDC timer.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - timer_sel -- LEDC timer index (0-3), select from ledc_timer_t

  返回:

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_OK Success

esp_err_t ledc_timer_pause(ledc_mode_t speed_mode, ledc_timer_t timer_sel)

  Pause LEDC timer counter.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - timer_sel -- LEDC timer index (0-3), select from ledc_timer_t

  返回:

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_OK Success

esp_err_t ledc_timer_resume(ledc_mode_t speed_mode, ledc_timer_t timer_sel)

  Resume LEDC timer.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - timer_sel -- LEDC timer index (0-3), select from ledc_timer_t

  返回:

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_OK Success

esp_err_t ledc_bind_channel_timer(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_timer_t timer_sel)

  Bind LEDC channel with the selected timer.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel index (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - timer_sel -- LEDC timer index (0-3), select from ledc_timer_t

  返回:

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_OK Success

esp_err_t ledc_set_fade_with_step(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, uint32_t scale, uint32_t cycle_num)

  Set LEDC fade function.

  备注

  Call ledc_fade_func_install() once before calling this function. Call ledc_fade_start() after this to start fading.

  备注

  ledc_set_fade_with_step, ledc_set_fade_with_time and ledc_fade_start are not thread-safe, do not call these functions to control one LEDC channel in different tasks at the same time. A thread-safe version of API is ledc_set_fade_step_and_start

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel index (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - target_duty -- Target duty of fading [0, (2**duty_resolution)]

    - scale -- Controls the increase or decrease step scale.

    - cycle_num -- increase or decrease the duty every cycle_num cycles

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_INVALID_STATE Channel not initialized

    - ESP_FAIL Fade function init error

esp_err_t ledc_set_fade_with_time(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, int desired_fade_time_ms)

  Set LEDC fade function, with a limited time.

  备注

  Call ledc_fade_func_install() once before calling this function. Call ledc_fade_start() after this to start fading.

  备注

  ledc_set_fade_with_step, ledc_set_fade_with_time and ledc_fade_start are not thread-safe, do not call these functions to control one LEDC channel in different tasks at the same time. A thread-safe version of API is ledc_set_fade_step_and_start

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel index (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - target_duty -- Target duty of fading [0, (2**duty_resolution)]

    - desired_fade_time_ms -- The intended time of the fading ( ms ). Note that the actual time it takes to complete the fade could vary by a factor of up to 2x shorter or longer than the expected time due to internal rounding errors in calculations. Specifically:

      - The total number of cycles (total_cycle_num = desired_fade_time_ms * freq / 1000)

      - The difference in duty cycle (duty_delta = |target_duty - current_duty|) The fade may complete faster than expected if total_cycle_num larger than duty_delta. Conversely, it may take longer than expected if total_cycle_num is less than duty_delta. The closer the ratio of total_cycle_num/duty_delta (or its inverse) is to a whole number (the floor value), the more accurately the actual fade duration will match the intended time. If an exact fade time is expected, please consider to split the entire fade into several smaller linear fades. The split should make each fade step has a divisible total_cycle_num/duty_delta (or its inverse) ratio.

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_INVALID_STATE Channel not initialized

    - ESP_FAIL Fade function init error

esp_err_t ledc_fade_func_install(int intr_alloc_flags)

  Install LEDC fade function. This function will occupy interrupt of LEDC module.

  参数:

    intr_alloc_flags -- Flags used to allocate the interrupt. One or multiple (ORred) ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info.

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Intr flag error

    - ESP_ERR_NOT_FOUND Failed to find available interrupt source

    - ESP_ERR_INVALID_STATE Fade function already installed / LEDC not initialized

void ledc_fade_func_uninstall(void)

  Uninstall LEDC fade function.

esp_err_t ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)

  Start LEDC fading.

  备注

  Call ledc_fade_func_install() once before calling this function. Call this API right after ledc_set_fade_with_time or ledc_set_fade_with_step before to start fading.

  备注

  Starting fade operation with this API is not thread-safe, use with care.

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel number

    - fade_mode -- Whether to block until fading done. See ledc_types.h ledc_fade_mode_t for more info. Note that this function will not return until fading to the target duty if LEDC_FADE_WAIT_DONE mode is selected.

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_STATE Channel not initialized or fade function not installed.

    - ESP_ERR_INVALID_ARG Parameter error.

esp_err_t ledc_set_duty_and_update(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)

  A thread-safe API to set duty for LEDC channel and return when duty updated.

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - duty -- Set the LEDC duty, the range of duty setting is [0, (2**duty_resolution)]

    - hpoint -- Set the LEDC hpoint value, the range is [0, (2**duty_resolution)-1]

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_STATE Channel not initialized

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_FAIL Fade function init error

esp_err_t ledc_set_fade_time_and_start(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, uint32_t desired_fade_time_ms, ledc_fade_mode_t fade_mode)

  A thread-safe API to set and start LEDC fade function, with a limited time.

  备注

  Call ledc_fade_func_install() once, before calling this function.

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel index (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - target_duty -- Target duty of fading [0, (2**duty_resolution)]

    - desired_fade_time_ms -- The intended time of the fading ( ms ). Note that the actual time it takes to complete the fade could vary by a factor of up to 2x shorter or longer than the expected time due to internal rounding errors in calculations. Specifically:

      - The total number of cycles (total_cycle_num = desired_fade_time_ms * freq / 1000)

      - The difference in duty cycle (duty_delta = |target_duty - current_duty|) The fade may complete faster than expected if total_cycle_num larger than duty_delta. Conversely, it may take longer than expected if total_cycle_num is less than duty_delta. The closer the ratio of total_cycle_num/duty_delta (or its inverse) is to a whole number (the floor value), the more accurately the actual fade duration will match the intended time. If an exact fade time is expected, please consider to split the entire fade into several smaller linear fades. The split should make each fade step has a divisible total_cycle_num/duty_delta (or its inverse) ratio.

    - fade_mode -- choose blocking or non-blocking mode

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_INVALID_STATE Channel not initialized

    - ESP_FAIL Fade function init error

esp_err_t ledc_set_fade_step_and_start(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, uint32_t scale, uint32_t cycle_num, ledc_fade_mode_t fade_mode)

  A thread-safe API to set and start LEDC fade function.

  备注

  Call ledc_fade_func_install() once before calling this function.

  备注

  For ESP32, hardware does not support any duty change while a fade operation is running in progress on that channel. Other duty operations will have to wait until the fade operation has finished.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel index (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - target_duty -- Target duty of fading [0, (2**duty_resolution)]

    - scale -- Controls the increase or decrease step scale.

    - cycle_num -- increase or decrease the duty every cycle_num cycles

    - fade_mode -- choose blocking or non-blocking mode

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_INVALID_STATE Channel not initialized

    - ESP_FAIL Fade function init error

esp_err_t ledc_cb_register(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_cbs_t *cbs, void *user_arg)

  LEDC callback registration function.

  备注

  The callback is called from an ISR, it must never attempt to block, and any FreeRTOS API called must be ISR capable.

  参数:

    - speed_mode -- Select the LEDC channel group with specified speed mode. Note that not all targets support high speed mode.

    - channel -- LEDC channel index (0 - LEDC_CHANNEL_MAX-1), select from ledc_channel_t

    - cbs -- Group of LEDC callback functions

    - user_arg -- user registered data for the callback function

  返回:

    - ESP_OK Success

    - ESP_ERR_INVALID_ARG Parameter error

    - ESP_ERR_INVALID_STATE Channel not initialized

    - ESP_FAIL Fade function init error

### Structures

struct ledc_channel_config_t

  Configuration parameters of LEDC channel for ledc_channel_config function.

  Public Members

  int gpio_num

    the LEDC output gpio_num, if you want to use gpio16, gpio_num = 16

  ledc_mode_t speed_mode

    LEDC speed speed_mode, high-speed mode (only exists on esp32) or low-speed mode

  ledc_channel_t channel

    LEDC channel (0 - LEDC_CHANNEL_MAX-1)

  ledc_intr_type_t intr_type

    Deprecated:

      , no need to explicitly configure interrupt, handled in the driver

  ledc_timer_t timer_sel

    Select the timer source of channel (0 - LEDC_TIMER_MAX-1)

  uint32_t duty

    LEDC channel duty, the range of duty setting is [0, (2**duty_resolution)]

  int hpoint

    LEDC channel hpoint value, the range is [0, (2**duty_resolution)-1]

  ledc_sleep_mode_t sleep_mode

    choose the desired behavior for the LEDC channel in Light-sleep

  struct ledc_channel_config_t::ledc_channel_flags flags

    Extra configuration flags for LEDC channel

  bool deconfigure

    Set this field to de-configure a LEDC channel which has been configured before The driver only does limited action to release the pins occupied by this channel only. When this field is set, gpio_num, timer_sel, duty, hpoint, sleep_mode, flags fields are ignored.

  struct ledc_channel_flags

    Extra configuration flags for LEDC channel.

    Public Members

    unsigned int output_invert

      Enable (1) or disable (0) gpio output invert

struct ledc_timer_config_t

  Configuration parameters of LEDC timer for ledc_timer_config function.

  Public Members

  ledc_mode_t speed_mode

    LEDC speed speed_mode, high-speed mode (only exists on esp32) or low-speed mode

  ledc_timer_bit_t duty_resolution

    LEDC channel duty resolution

  ledc_timer_t timer_num

    The timer source of channel (0 - LEDC_TIMER_MAX-1)

  uint32_t freq_hz

    LEDC timer frequency (Hz)

  ledc_clk_cfg_t clk_cfg

    Configure LEDC source clock from ledc_clk_cfg_t. Note that LEDC_USE_RC_FAST_CLK and LEDC_USE_XTAL_CLK are non-timer-specific clock sources. You can not have one LEDC timer uses RC_FAST_CLK as the clock source and have another LEDC timer uses XTAL_CLK as its clock source. All chips except esp32 and esp32s2 do not have timer-specific clock sources, which means clock source for all timers must be the same one.

  bool deconfigure

    Set this field to de-configure a LEDC timer which has been configured before Note that it will not check whether the timer wants to be de-configured is binded to any channel. Also, the timer has to be paused first before it can be de-configured. When this field is set, duty_resolution, freq_hz, clk_cfg fields are ignored.

struct ledc_cb_param_t

  LEDC callback parameter.

  Public Members

  ledc_cb_event_t event

    Event name

  uint32_t speed_mode

    Speed mode of the LEDC channel group

  uint32_t channel

    LEDC channel (0 - LEDC_CHANNEL_MAX-1)

  uint32_t duty

    LEDC current duty of the channel, the range of duty is [0, (2**duty_resolution)]

struct ledc_cbs_t

  Group of supported LEDC callbacks.

  备注

  The callbacks are all running under ISR environment

  Public Members

  ledc_cb_t fade_cb

    LEDC fade_end callback function

### Macros

LEDC_ERR_DUTY

LEDC_ERR_VAL

### Type Definitions

typedef intr_handle_t ledc_isr_handle_t

typedef bool (*ledc_cb_t)(const ledc_cb_param_t *param, void *user_arg)

  Type of LEDC event callback.

  Param param:

    LEDC callback parameter

  Param user_arg:

    User registered data

  Return:

    Whether a high priority task has been waken up by this function

### Enumerations

enum ledc_sleep_mode_t

  Strategies to be applied to the LEDC channel during system Light-sleep period.

  Values:

  enumerator LEDC_SLEEP_MODE_NO_ALIVE_NO_PD

    The default mode: no LEDC output, and no power off the LEDC power domain.

  enumerator LEDC_SLEEP_MODE_NO_ALIVE_ALLOW_PD

    The low-power-consumption mode: no LEDC output, and allow to power off the LEDC power domain. This can save power, but at the expense of more RAM being consumed to save register context. This option is only available on targets that support TOP domain to be powered down.

  enumerator LEDC_SLEEP_MODE_KEEP_ALIVE

    The high-power-consumption mode: keep LEDC output when the system enters Light-sleep.

  enumerator LEDC_SLEEP_MODE_INVALID

    Invalid LEDC sleep mode strategy

enum ledc_cb_event_t

  LEDC callback event type.

  Values:

  enumerator LEDC_FADE_END_EVT

    LEDC fade end event

### Header File

- components/esp_hal_ledc/include/hal/ledc_types.h

- This header file can be included with:

  >     #include "hal/ledc_types.h"

- This header file is a part of the API provided by the `esp_hal_ledc` component. To declare that your component depends on `esp_hal_ledc`, add the following to your CMakeLists.txt:

  >     REQUIRES esp_hal_ledc

  > or

  >     PRIV_REQUIRES esp_hal_ledc

### Type Definitions

typedef soc_periph_ledc_clk_src_legacy_t ledc_clk_cfg_t

  LEDC clock source configuration struct.

  In theory, the following enumeration shall be placed in LEDC driver's header. However, as the next enumeration, `ledc_clk_src_t`, makes the use of some of these values and to avoid mutual inclusion of the headers, we must define it here.

### Enumerations

enum ledc_mode_t

  Values:

  enumerator LEDC_HIGH_SPEED_MODE

    LEDC high speed speed_mode

  enumerator LEDC_LOW_SPEED_MODE

    LEDC low speed speed_mode

  enumerator LEDC_SPEED_MODE_MAX

    LEDC speed limit

enum ledc_intr_type_t

  Values:

  enumerator LEDC_INTR_DISABLE

    Disable LEDC interrupt

  enumerator LEDC_INTR_FADE_END

    Enable LEDC interrupt

  enumerator LEDC_INTR_MAX

enum ledc_duty_direction_t

  Values:

  enumerator LEDC_DUTY_DIR_DECREASE

    LEDC duty decrease direction

  enumerator LEDC_DUTY_DIR_INCREASE

    LEDC duty increase direction

  enumerator LEDC_DUTY_DIR_MAX

enum ledc_slow_clk_sel_t

  LEDC global clock sources.

  Values:

  enumerator LEDC_SLOW_CLK_RC_FAST

    LEDC low speed timer clock source is RC_FAST clock

  enumerator LEDC_SLOW_CLK_APB

    LEDC low speed timer clock source is 80MHz APB clock

enum ledc_clk_src_t

  LEDC timer-specific clock sources.

  Note: Setting numeric values to match ledc_clk_cfg_t values are a hack to avoid collision with LEDC_AUTO_CLK in the driver, as these enums have very similar names and user may pass one of these by mistake.

  Values:

  enumerator LEDC_REF_TICK

    LEDC timer clock divided from reference tick (1Mhz)

  enumerator LEDC_APB_CLK

    LEDC timer clock divided from APB clock (80Mhz)

  enumerator LEDC_SCLK

    Selecting this value for LEDC_TICK_SEL_TIMER let the hardware take its source clock from LEDC_APB_CLK_SEL

enum ledc_timer_t

  Values:

  enumerator LEDC_TIMER_0

    LEDC timer 0

  enumerator LEDC_TIMER_1

    LEDC timer 1

  enumerator LEDC_TIMER_2

    LEDC timer 2

  enumerator LEDC_TIMER_3

    LEDC timer 3

  enumerator LEDC_TIMER_MAX

enum ledc_channel_t

  Values:

  enumerator LEDC_CHANNEL_0

    LEDC channel 0

  enumerator LEDC_CHANNEL_1

    LEDC channel 1

  enumerator LEDC_CHANNEL_2

    LEDC channel 2

  enumerator LEDC_CHANNEL_3

    LEDC channel 3

  enumerator LEDC_CHANNEL_4

    LEDC channel 4

  enumerator LEDC_CHANNEL_5

    LEDC channel 5

  enumerator LEDC_CHANNEL_6

    LEDC channel 6

  enumerator LEDC_CHANNEL_7

    LEDC channel 7

  enumerator LEDC_CHANNEL_MAX

enum ledc_timer_bit_t

  Values:

  enumerator LEDC_TIMER_1_BIT

    LEDC PWM duty resolution of 1 bits

  enumerator LEDC_TIMER_2_BIT

    LEDC PWM duty resolution of 2 bits

  enumerator LEDC_TIMER_3_BIT

    LEDC PWM duty resolution of 3 bits

  enumerator LEDC_TIMER_4_BIT

    LEDC PWM duty resolution of 4 bits

  enumerator LEDC_TIMER_5_BIT

    LEDC PWM duty resolution of 5 bits

  enumerator LEDC_TIMER_6_BIT

    LEDC PWM duty resolution of 6 bits

  enumerator LEDC_TIMER_7_BIT

    LEDC PWM duty resolution of 7 bits

  enumerator LEDC_TIMER_8_BIT

    LEDC PWM duty resolution of 8 bits

  enumerator LEDC_TIMER_9_BIT

    LEDC PWM duty resolution of 9 bits

  enumerator LEDC_TIMER_10_BIT

    LEDC PWM duty resolution of 10 bits

  enumerator LEDC_TIMER_11_BIT

    LEDC PWM duty resolution of 11 bits

  enumerator LEDC_TIMER_12_BIT

    LEDC PWM duty resolution of 12 bits

  enumerator LEDC_TIMER_13_BIT

    LEDC PWM duty resolution of 13 bits

  enumerator LEDC_TIMER_14_BIT

    LEDC PWM duty resolution of 14 bits

  enumerator LEDC_TIMER_15_BIT

    LEDC PWM duty resolution of 15 bits

  enumerator LEDC_TIMER_16_BIT

    LEDC PWM duty resolution of 16 bits

  enumerator LEDC_TIMER_17_BIT

    LEDC PWM duty resolution of 17 bits

  enumerator LEDC_TIMER_18_BIT

    LEDC PWM duty resolution of 18 bits

  enumerator LEDC_TIMER_19_BIT

    LEDC PWM duty resolution of 19 bits

  enumerator LEDC_TIMER_20_BIT

    LEDC PWM duty resolution of 20 bits

  enumerator LEDC_TIMER_BIT_MAX

enum ledc_fade_mode_t

  Values:

  enumerator LEDC_FADE_NO_WAIT

    LEDC fade function will return immediately

  enumerator LEDC_FADE_WAIT_DONE

    LEDC fade function will block until fading to the target duty

  enumerator LEDC_FADE_MAX

此文档对您有帮助吗？

- 反馈已收到，谢谢！
- 如果您有其他意见，欢迎填写乐鑫文档反馈表。

- 我们重视您的反馈。
- 您可以填写乐鑫文档反馈表告诉我们如何改进该文档。