#include <debug_component.h>

Inheritance diagram for esphome::debug::DebugComponent:

Public Member Functions
void	loop () override

void	update () override

float	get_setup_priority () const override

void	dump_config () override

void	set_device_info_sensor (text_sensor::TextSensor *device_info)

void	set_reset_reason_sensor (text_sensor::TextSensor *reset_reason)

void	set_free_sensor (sensor::Sensor *free_sensor)

void	set_block_sensor (sensor::Sensor *block_sensor)

void	set_fragmentation_sensor (sensor::Sensor *fragmentation_sensor)

void	set_min_free_sensor (sensor::Sensor *min_free_sensor)

void	set_loop_time_sensor (sensor::Sensor *loop_time_sensor)

void	set_psram_sensor (sensor::Sensor *psram_sensor)

void	set_cpu_frequency_sensor (sensor::Sensor *cpu_frequency_sensor)

void	on_shutdown () override

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

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.

void	mark_failed ()
	Mark this component as failed.

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

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

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

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

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
void	log_partition_info_ ()
	Logs information about the device's partition table.

const char *	get_reset_reason_ (std::span< char, RESET_REASON_BUFFER_SIZE > buffer)

const char *	get_wakeup_cause_ (std::span< char, WAKEUP_CAUSE_BUFFER_SIZE > buffer)

uint32_t	get_free_heap_ ()

size_t	get_device_info_ (std::span< char, DEVICE_INFO_BUFFER_SIZE > buffer, size_t pos)

void	update_platform_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

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

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

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 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 (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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 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 (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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.

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

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
uint32_t	free_heap_ {}

uint32_t	last_loop_timetag_ {0}

uint32_t	max_loop_time_ {0}

sensor::Sensor *	free_sensor_ {nullptr}

sensor::Sensor *	block_sensor_ {nullptr}

sensor::Sensor *	fragmentation_sensor_ {nullptr}

sensor::Sensor *	min_free_sensor_ {nullptr}

sensor::Sensor *	loop_time_sensor_ {nullptr}

sensor::Sensor *	psram_sensor_ {nullptr}

sensor::Sensor *	cpu_frequency_sensor_ {nullptr}

text_sensor::TextSensor *	device_info_ {nullptr}

text_sensor::TextSensor *	reset_reason_ {nullptr}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

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

ComponentRuntimeStats	runtime_stats_

Detailed Description

Definition at line 24 of file debug_component.h.

Member Function Documentation

◆ dump_config()

void esphome::debug::DebugComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file debug_component.cpp.

◆ get_device_info_()

size_t esphome::debug::DebugComponent::get_device_info_	(	std::span< char, DEVICE_INFO_BUFFER_SIZE >	buffer,
		size_t	pos )

protected

Definition at line 187 of file debug_esp32.cpp.

◆ get_free_heap_()

uint32_t esphome::debug::DebugComponent::get_free_heap_ ( )

protected

Definition at line 172 of file debug_esp32.cpp.

◆ get_reset_reason_()

const char * esphome::debug::DebugComponent::get_reset_reason_ ( std::span< char, RESET_REASON_BUFFER_SIZE > buffer )

protected

Definition at line 62 of file debug_esp32.cpp.

◆ get_setup_priority()

float esphome::debug::DebugComponent::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 93 of file debug_component.cpp.

◆ get_wakeup_cause_()

const char * esphome::debug::DebugComponent::get_wakeup_cause_ ( std::span< char, WAKEUP_CAUSE_BUFFER_SIZE > buffer )

protected

Definition at line 125 of file debug_esp32.cpp.

◆ log_partition_info_()

void esphome::debug::DebugComponent::log_partition_info_ ( )

protected

Logs information about the device's partition table.

This function iterates through the partition table and logs details about each partition, including its name, type, subtype, starting address, and size. The information is useful for diagnosing issues related to flash memory or verifying the partition configuration dynamically at runtime.

Only available when compiled for ESP32 and ZEPHYR platforms.

Definition at line 157 of file debug_esp32.cpp.

◆ loop()

void esphome::debug::DebugComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file debug_component.cpp.

◆ on_shutdown()

void esphome::debug::DebugComponent::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 48 of file debug_esp32.cpp.

◆ set_block_sensor()

void esphome::debug::DebugComponent::set_block_sensor ( sensor::Sensor * block_sensor )

inline

Definition at line 37 of file debug_component.h.

◆ set_cpu_frequency_sensor()

void esphome::debug::DebugComponent::set_cpu_frequency_sensor ( sensor::Sensor * cpu_frequency_sensor )

inline

Definition at line 48 of file debug_component.h.

◆ set_device_info_sensor()

void esphome::debug::DebugComponent::set_device_info_sensor ( text_sensor::TextSensor * device_info )

inline

Definition at line 32 of file debug_component.h.

◆ set_fragmentation_sensor()

void esphome::debug::DebugComponent::set_fragmentation_sensor ( sensor::Sensor * fragmentation_sensor )

inline

Definition at line 39 of file debug_component.h.

◆ set_free_sensor()

void esphome::debug::DebugComponent::set_free_sensor ( sensor::Sensor * free_sensor )

inline

Definition at line 36 of file debug_component.h.

◆ set_loop_time_sensor()

void esphome::debug::DebugComponent::set_loop_time_sensor ( sensor::Sensor * loop_time_sensor )

inline

Definition at line 44 of file debug_component.h.

◆ set_min_free_sensor()

void esphome::debug::DebugComponent::set_min_free_sensor ( sensor::Sensor * min_free_sensor )

inline

Definition at line 42 of file debug_component.h.

◆ set_psram_sensor()

void esphome::debug::DebugComponent::set_psram_sensor ( sensor::Sensor * psram_sensor )

inline

Definition at line 46 of file debug_component.h.

◆ set_reset_reason_sensor()

void esphome::debug::DebugComponent::set_reset_reason_sensor ( text_sensor::TextSensor * reset_reason )

inline

Definition at line 33 of file debug_component.h.

◆ update()

void esphome::debug::DebugComponent::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 75 of file debug_component.cpp.

◆ update_platform_()

void esphome::debug::DebugComponent::update_platform_ ( )

protected

Definition at line 291 of file debug_esp32.cpp.

Field Documentation

◆ block_sensor_

sensor::Sensor* esphome::debug::DebugComponent::block_sensor_ {nullptr}

protected

Definition at line 63 of file debug_component.h.

◆ cpu_frequency_sensor_

sensor::Sensor* esphome::debug::DebugComponent::cpu_frequency_sensor_ {nullptr}

protected

Definition at line 74 of file debug_component.h.

◆ device_info_

text_sensor::TextSensor* esphome::debug::DebugComponent::device_info_ {nullptr}

protected

Definition at line 92 of file debug_component.h.

◆ fragmentation_sensor_

sensor::Sensor* esphome::debug::DebugComponent::fragmentation_sensor_ {nullptr}

protected

Definition at line 65 of file debug_component.h.

◆ free_heap_

uint32_t esphome::debug::DebugComponent::free_heap_ {}

protected

Definition at line 56 of file debug_component.h.

◆ free_sensor_

sensor::Sensor* esphome::debug::DebugComponent::free_sensor_ {nullptr}

protected

Definition at line 62 of file debug_component.h.

◆ last_loop_timetag_

uint32_t esphome::debug::DebugComponent::last_loop_timetag_ {0}

protected

Definition at line 59 of file debug_component.h.

◆ loop_time_sensor_

sensor::Sensor* esphome::debug::DebugComponent::loop_time_sensor_ {nullptr}

protected

Definition at line 70 of file debug_component.h.

◆ max_loop_time_

uint32_t esphome::debug::DebugComponent::max_loop_time_ {0}

protected

Definition at line 60 of file debug_component.h.

◆ min_free_sensor_

sensor::Sensor* esphome::debug::DebugComponent::min_free_sensor_ {nullptr}

protected

Definition at line 68 of file debug_component.h.

◆ psram_sensor_

sensor::Sensor* esphome::debug::DebugComponent::psram_sensor_ {nullptr}

protected

Definition at line 72 of file debug_component.h.

◆ reset_reason_

text_sensor::TextSensor* esphome::debug::DebugComponent::reset_reason_ {nullptr}

protected

Definition at line 93 of file debug_component.h.

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

esphome/components/debug/debug_component.h
esphome/components/debug/debug_component.cpp
esphome/components/debug/debug_esp32.cpp
esphome/components/debug/debug_esp8266.cpp
esphome/components/debug/debug_host.cpp
esphome/components/debug/debug_libretiny.cpp
esphome/components/debug/debug_rp2.cpp
esphome/components/debug/debug_zephyr.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_device_info_()

◆ get_free_heap_()

◆ get_reset_reason_()

◆ get_setup_priority()

◆ get_wakeup_cause_()

◆ log_partition_info_()

◆ loop()

◆ on_shutdown()

◆ set_block_sensor()

◆ set_cpu_frequency_sensor()

◆ set_device_info_sensor()

◆ set_fragmentation_sensor()

◆ set_free_sensor()

◆ set_loop_time_sensor()

◆ set_min_free_sensor()

◆ set_psram_sensor()

◆ set_reset_reason_sensor()

◆ update()

◆ update_platform_()

Field Documentation

◆ block_sensor_

◆ cpu_frequency_sensor_

◆ device_info_

◆ fragmentation_sensor_

◆ free_heap_

◆ free_sensor_

◆ last_loop_timetag_

◆ loop_time_sensor_

◆ max_loop_time_

◆ min_free_sensor_

◆ psram_sensor_

◆ reset_reason_