ESPHome 2025.6.3
|
#include <power_supply.h>
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 |
![]() | |
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) |
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} |
![]() | |
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 | |
![]() | |
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. | |
Definition at line 11 of file power_supply.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 17 of file power_supply.cpp.
|
overridevirtual |
Hardware setup priority (+1).
Reimplemented from esphome::Component.
Definition at line 28 of file power_supply.cpp.
bool esphome::power_supply::PowerSupply::is_enabled | ( | ) | const |
Is this power supply currently on?
Definition at line 30 of file power_supply.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 55 of file power_supply.cpp.
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.
|
inline |
Definition at line 16 of file power_supply.h.
|
inline |
Definition at line 14 of file power_supply.h.
|
inline |
Definition at line 15 of file power_supply.h.
|
inline |
Definition at line 13 of file power_supply.h.
|
overridevirtual |
Register callbacks.
Reimplemented from esphome::Component.
Definition at line 9 of file power_supply.cpp.
void esphome::power_supply::PowerSupply::unrequest_high_power | ( | ) |
Un-request high power mode.
Definition at line 42 of file power_supply.cpp.
|
protected |
Definition at line 42 of file power_supply.h.
|
protected |
Definition at line 39 of file power_supply.h.
|
protected |
Definition at line 40 of file power_supply.h.
|
protected |
Definition at line 41 of file power_supply.h.
|
protected |
Definition at line 38 of file power_supply.h.