#include <esp_ldo.h>

Inheritance diagram for esphome::esp_ldo::EspLdo:

Public Member Functions
	EspLdo (int channel)

void	setup () override

void	dump_config () override

void	set_adjustable (bool adjustable)

void	set_voltage (float voltage)

void	adjust_voltage (float voltage)

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

virtual float	get_setup_priority () const
	priority of setup().

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

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="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

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

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Attributes
int	channel_

float	voltage_ {2.7}

bool	adjustable_ {false}

esp_ldo_channel_handle_t	handle_ {}

Protected Attributes inherited from esphome::Component
uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free)

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

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

std::string	error_message_ {}

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

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

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

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Detailed Description

Definition at line 10 of file esp_ldo.h.

Constructor & Destructor Documentation

◆ EspLdo()

esphome::esp_ldo::EspLdo::EspLdo ( int channel )

inline

Definition at line 12 of file esp_ldo.h.

Member Function Documentation

◆ adjust_voltage()

void esphome::esp_ldo::EspLdo::adjust_voltage ( float voltage )

Definition at line 29 of file esp_ldo.cpp.

◆ dump_config()

void esphome::esp_ldo::EspLdo::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file esp_ldo.cpp.

◆ set_adjustable()

void esphome::esp_ldo::EspLdo::set_adjustable ( bool adjustable )

inline

Definition at line 17 of file esp_ldo.h.

◆ set_voltage()

void esphome::esp_ldo::EspLdo::set_voltage ( float voltage )

inline

Definition at line 18 of file esp_ldo.h.

◆ setup()

void esphome::esp_ldo::EspLdo::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file esp_ldo.cpp.

Field Documentation

◆ adjustable_

bool esphome::esp_ldo::EspLdo::adjustable_ {false}

protected

Definition at line 24 of file esp_ldo.h.

◆ channel_

int esphome::esp_ldo::EspLdo::channel_

protected

Definition at line 22 of file esp_ldo.h.

◆ handle_

esp_ldo_channel_handle_t esphome::esp_ldo::EspLdo::handle_ {}

protected

Definition at line 25 of file esp_ldo.h.

◆ voltage_

float esphome::esp_ldo::EspLdo::voltage_ {2.7}

protected

Definition at line 23 of file esp_ldo.h.

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

esphome/components/esp_ldo/esp_ldo.h
esphome/components/esp_ldo/esp_ldo.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EspLdo()

Member Function Documentation

◆ adjust_voltage()

◆ dump_config()

◆ set_adjustable()

◆ set_voltage()

◆ setup()

Field Documentation

◆ adjustable_

◆ channel_

◆ handle_

◆ voltage_