This class simplifies creating components that periodically check a state. More...

#include <component.h>

Inheritance diagram for esphome::PollingComponent:

Public Member Functions
	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...

virtual void	update ()=0

void	call_setup () override

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

void	start_poller ()

void	stop_poller ()

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

virtual void	loop ()
	This method will be called repeatedly. More...

virtual void	dump_config ()

virtual float	get_setup_priority () const
	priority of setup(). 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 ()

bool	is_ready ()

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

This class simplifies creating components that periodically check a state.

You basically just need to implement the update() function, it will be called every update_interval ms after startup. Note that this class cannot guarantee a correct timing, as it's not using timers, just a software polling feature with set_interval() from Component.

Definition at line 282 of file component.h.

Constructor & Destructor Documentation

◆ PollingComponent() [1/2]

esphome::PollingComponent::PollingComponent ( )

inline

Definition at line 284 of file component.h.

◆ PollingComponent() [2/2]

esphome::PollingComponent::PollingComponent ( uint32_t update_interval )

explicit

Initialize this polling component with the given update interval in ms.

Parameters

update_interval The update interval in ms.

Definition at line 185 of file component.cpp.

Member Function Documentation

◆ call_setup()

void esphome::PollingComponent::call_setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 187 of file component.cpp.

◆ get_update_interval()

uint32_t esphome::PollingComponent::get_update_interval ( ) const

virtual

Get the update interval in ms of this sensor.

Definition at line 205 of file component.cpp.

◆ set_update_interval()

void esphome::PollingComponent::set_update_interval ( uint32_t update_interval )

virtual

Manually set the update interval in ms for this polling object.

Override this if you want to do some validation for the update interval.

Parameters

update_interval The update interval in ms.

Definition at line 206 of file component.cpp.

◆ start_poller()

void esphome::PollingComponent::start_poller ( )

Definition at line 195 of file component.cpp.

◆ stop_poller()

void esphome::PollingComponent::stop_poller ( )

Definition at line 200 of file component.cpp.

◆ update()

virtual void esphome::PollingComponent::update ( )

pure virtual

Field Documentation

◆ update_interval_

uint32_t esphome::PollingComponent::update_interval_

protected

Definition at line 318 of file component.h.

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

/opt/build/esphome/esphome/core/component.h
/opt/build/esphome/esphome/core/component.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members