#include <ledc_output.h>

Inheritance diagram for esphome::ledc::LEDCOutput:

Public Member Functions
	LEDCOutput (InternalGPIOPin *pin)

void	set_channel (uint8_t channel)

void	set_frequency (float frequency)

void	set_phase_angle (float angle)

void	update_frequency (float frequency) override
	Dynamically change frequency at runtime.

void	setup () override
	Setup LEDC.

void	dump_config () override

float	get_setup_priority () const override
	HARDWARE setup priority.

void	write_state (float state) override
	Override FloatOutput's write_state.

Public Member Functions inherited from esphome::output::FloatOutput
void	set_max_power (float max_power)
	Set the maximum power output of this component.

void	set_min_power (float min_power)
	Set the minimum power output of this component.

void	set_zero_means_zero (bool zero_means_zero)
	Sets this output to ignore min_power for a 0 state.

void	set_level (float state)
	Set the level of this float output, this is called from the front-end.

float	get_max_power () const
	Get the maximum power output.

float	get_min_power () const
	Get the minimum power output.

Public Member Functions inherited from esphome::output::BinaryOutput
void	set_inverted (bool inverted)
	Set the inversion state of this binary output.

void	set_power_supply (power_supply::PowerSupply *power_supply)
	Use this to connect up a power supply to this output.

virtual void	set_state (bool state)
	Enable or disable this binary output.

virtual void	turn_on ()
	Enable this binary output.

virtual void	turn_off ()
	Disable this binary output.

bool	is_inverted () const
	Return whether this binary output is inverted.

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Attributes
InternalGPIOPin *	pin_

uint8_t	channel_ {}

uint8_t	bit_depth_ {}

float	phase_angle_ {0.0f}

float	frequency_ {}

float	duty_ {0.0f}

bool	initialized_ = false

Protected Attributes inherited from esphome::output::FloatOutput
float	max_power_ {1.0f}

float	min_power_ {0.0f}

bool	zero_means_zero_

Protected Attributes inherited from esphome::output::BinaryOutput
bool	inverted_ {false}

power_supply::PowerSupplyRequester	power_ {}

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Additional Inherited Members
Protected Member Functions inherited from esphome::output::FloatOutput
void	write_state (bool state) override
	Implement BinarySensor's write_enabled; this should never be called.

Protected Member Functions inherited from esphome::output::BinaryOutput
Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (uint32_t id)

Detailed Description

Definition at line 16 of file ledc_output.h.

Constructor & Destructor Documentation

◆ LEDCOutput()

esphome::ledc::LEDCOutput::LEDCOutput ( InternalGPIOPin * pin )

inlineexplicit

Definition at line 18 of file ledc_output.h.

Member Function Documentation

◆ dump_config()

void esphome::ledc::LEDCOutput::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 151 of file ledc_output.cpp.

◆ get_setup_priority()

float esphome::ledc::LEDCOutput::get_setup_priority ( ) const

inlineoverridevirtual

HARDWARE setup priority.

Reimplemented from esphome::Component.

Definition at line 30 of file ledc_output.h.

◆ set_channel()

void esphome::ledc::LEDCOutput::set_channel ( uint8_t channel )

inline

Definition at line 20 of file ledc_output.h.

◆ set_frequency()

void esphome::ledc::LEDCOutput::set_frequency ( float frequency )

inline

Definition at line 21 of file ledc_output.h.

◆ set_phase_angle()

void esphome::ledc::LEDCOutput::set_phase_angle ( float angle )

inline

Definition at line 22 of file ledc_output.h.

◆ setup()

void esphome::ledc::LEDCOutput::setup ( )

overridevirtual

Setup LEDC.

Reimplemented from esphome::Component.

Definition at line 118 of file ledc_output.cpp.

◆ update_frequency()

void esphome::ledc::LEDCOutput::update_frequency ( float frequency )

overridevirtual

Dynamically change frequency at runtime.

Reimplemented from esphome::output::FloatOutput.

Definition at line 178 of file ledc_output.cpp.

◆ write_state()

void esphome::ledc::LEDCOutput::write_state ( float state )

overridevirtual

Override FloatOutput's write_state.

Implements esphome::output::FloatOutput.

Definition at line 91 of file ledc_output.cpp.

Field Documentation

◆ bit_depth_

uint8_t esphome::ledc::LEDCOutput::bit_depth_ {}

protected

Definition at line 38 of file ledc_output.h.

◆ channel_

uint8_t esphome::ledc::LEDCOutput::channel_ {}

protected

Definition at line 37 of file ledc_output.h.

◆ duty_

float esphome::ledc::LEDCOutput::duty_ {0.0f}

protected

Definition at line 41 of file ledc_output.h.

◆ frequency_

float esphome::ledc::LEDCOutput::frequency_ {}

protected

Definition at line 40 of file ledc_output.h.

◆ initialized_

bool esphome::ledc::LEDCOutput::initialized_ = false

protected

Definition at line 42 of file ledc_output.h.

◆ phase_angle_

float esphome::ledc::LEDCOutput::phase_angle_ {0.0f}

protected

Definition at line 39 of file ledc_output.h.

◆ pin_

InternalGPIOPin* esphome::ledc::LEDCOutput::pin_

protected

Definition at line 36 of file ledc_output.h.

The documentation for this class was generated from the following files:

esphome/components/ledc/ledc_output.h
esphome/components/ledc/ledc_output.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LEDCOutput()

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ set_channel()

◆ set_frequency()

◆ set_phase_angle()

◆ setup()

◆ update_frequency()

◆ write_state()

Field Documentation

◆ bit_depth_

◆ channel_

◆ duty_

◆ frequency_

◆ initialized_

◆ phase_angle_

◆ pin_