ledc_set_fade_step_and_start() function

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

Syntax

Show:

Summary

Declaration

Definition

from ledc.h:585

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);

Implemented in ledc.c:1603

Arguments

Argument

Description

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

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_ERR_INVALID_STATE Channel not initialized - ESP_FAIL Fade function init error

Notes

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.

Examples

References

from examples

ledc_set_fade_step_and_start() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle