ESPHome  2022.11.3
Public Member Functions | Protected Attributes
esphome::debug::DebugComponent Class Reference

#include <debug_component.h>

Inheritance diagram for esphome::debug::DebugComponent:
esphome::PollingComponent esphome::Component

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_free_sensor (sensor::Sensor *free_sensor)
 
void set_block_sensor (sensor::Sensor *block_sensor)
 
void set_fragmentation_sensor (sensor::Sensor *fragmentation_sensor)
 
void set_loop_time_sensor (sensor::Sensor *loop_time_sensor)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Attributes

uint32_t free_heap_ {}
 
uint32_t last_loop_timetag_ {0}
 
uint32_t max_loop_time_ {0}
 
sensor::Sensorfree_sensor_ {nullptr}
 
sensor::Sensorblock_sensor_ {nullptr}
 
sensor::Sensorfragmentation_sensor_ {nullptr}
 
sensor::Sensorloop_time_sensor_ {nullptr}
 
text_sensor::TextSensordevice_info_ {nullptr}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Definition at line 18 of file debug_component.h.

Member Function Documentation

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 39 of file debug_component.cpp.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 333 of file debug_component.cpp.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 284 of file debug_component.cpp.

◆ set_block_sensor()

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

Definition at line 30 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 26 of file debug_component.h.

◆ set_fragmentation_sensor()

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

Definition at line 32 of file debug_component.h.

◆ set_free_sensor()

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

Definition at line 29 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 34 of file debug_component.h.

◆ update()

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

Implements esphome::PollingComponent.

Definition at line 304 of file debug_component.cpp.

Field Documentation

◆ block_sensor_

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

Definition at line 44 of file debug_component.h.

◆ device_info_

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

Definition at line 52 of file debug_component.h.

◆ fragmentation_sensor_

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

Definition at line 46 of file debug_component.h.

◆ free_heap_

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

Definition at line 37 of file debug_component.h.

◆ free_sensor_

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

Definition at line 43 of file debug_component.h.

◆ last_loop_timetag_

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

Definition at line 40 of file debug_component.h.

◆ loop_time_sensor_

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

Definition at line 48 of file debug_component.h.

◆ max_loop_time_

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

Definition at line 41 of file debug_component.h.


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