#include <power_supply.h>

Inheritance diagram for esphome::power_supply::PowerSupply:

Public Member Functions
void	set_pin (GPIOPin *pin)

void	set_enable_time (uint32_t enable_time)

void	set_keep_on_time (uint32_t keep_on_time)

void	set_enable_on_boot (bool enable_on_boot)

bool	is_enabled () const
	Is this power supply currently on?

void	request_high_power ()
	Request high power mode. Use unrequest_high_power() to remove this request.

void	unrequest_high_power ()
	Un-request high power mode.

void	setup () override
	Register callbacks.

void	dump_config () override

float	get_setup_priority () const override
	Hardware setup priority (+1).

void	on_powerdown () override

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.

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)

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="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
GPIOPin *	pin_

bool	enable_on_boot_ {false}

uint32_t	enable_time_

uint32_t	keep_on_time_

int16_t	active_requests_ {0}

Protected Attributes inherited from esphome::Component
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)

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)

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

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 (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

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

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

bool	cancel_interval (const char *name)

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 (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

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

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

bool	cancel_timeout (const char *name)

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

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

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 11 of file power_supply.h.

Member Function Documentation

◆ dump_config()

void esphome::power_supply::PowerSupply::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file power_supply.cpp.

◆ get_setup_priority()

float esphome::power_supply::PowerSupply::get_setup_priority ( ) const

overridevirtual

Hardware setup priority (+1).

Reimplemented from esphome::Component.

Definition at line 28 of file power_supply.cpp.

◆ is_enabled()

bool esphome::power_supply::PowerSupply::is_enabled ( ) const

Is this power supply currently on?

Definition at line 30 of file power_supply.cpp.

◆ on_powerdown()

void esphome::power_supply::PowerSupply::on_powerdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file power_supply.cpp.

◆ request_high_power()

void esphome::power_supply::PowerSupply::request_high_power ( )

Request high power mode. Use unrequest_high_power() to remove this request.

Definition at line 32 of file power_supply.cpp.

◆ set_enable_on_boot()

void esphome::power_supply::PowerSupply::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 16 of file power_supply.h.

◆ set_enable_time()

void esphome::power_supply::PowerSupply::set_enable_time ( uint32_t enable_time )

inline

Definition at line 14 of file power_supply.h.

◆ set_keep_on_time()

void esphome::power_supply::PowerSupply::set_keep_on_time ( uint32_t keep_on_time )

inline

Definition at line 15 of file power_supply.h.

◆ set_pin()

void esphome::power_supply::PowerSupply::set_pin ( GPIOPin * pin )

inline

Definition at line 13 of file power_supply.h.

◆ setup()

void esphome::power_supply::PowerSupply::setup ( )

overridevirtual

Register callbacks.

Reimplemented from esphome::Component.

Definition at line 9 of file power_supply.cpp.

◆ unrequest_high_power()

void esphome::power_supply::PowerSupply::unrequest_high_power ( )

Un-request high power mode.

Definition at line 42 of file power_supply.cpp.

Field Documentation

◆ active_requests_

int16_t esphome::power_supply::PowerSupply::active_requests_ {0}

protected

Definition at line 42 of file power_supply.h.

◆ enable_on_boot_

bool esphome::power_supply::PowerSupply::enable_on_boot_ {false}

protected

Definition at line 39 of file power_supply.h.

◆ enable_time_

uint32_t esphome::power_supply::PowerSupply::enable_time_

protected

Definition at line 40 of file power_supply.h.

◆ keep_on_time_

uint32_t esphome::power_supply::PowerSupply::keep_on_time_

protected

Definition at line 41 of file power_supply.h.

◆ pin_

GPIOPin* esphome::power_supply::PowerSupply::pin_

protected

Definition at line 38 of file power_supply.h.

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

esphome/components/power_supply/power_supply.h
esphome/components/power_supply/power_supply.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ is_enabled()

◆ on_powerdown()

◆ request_high_power()

◆ set_enable_on_boot()

◆ set_enable_time()

◆ set_keep_on_time()

◆ set_pin()

◆ setup()

◆ unrequest_high_power()

Field Documentation

◆ active_requests_

◆ enable_on_boot_

◆ enable_time_

◆ keep_on_time_

◆ pin_