ESPHome  2022.11.4
Public Member Functions | Protected Attributes
esphome::preferences::IntervalSyncer Class Reference

#include <syncer.h>

Inheritance diagram for esphome::preferences::IntervalSyncer:
esphome::Component

Public Member Functions

void set_write_interval (uint32_t write_interval)
 
void setup () override
 
void on_shutdown () override
 
float get_setup_priority () const override
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
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_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 write_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_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. 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 9 of file syncer.h.

Member Function Documentation

◆ get_setup_priority()

float esphome::preferences::IntervalSyncer::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file syncer.h.

◆ on_shutdown()

void esphome::preferences::IntervalSyncer::on_shutdown ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file syncer.h.

◆ set_write_interval()

void esphome::preferences::IntervalSyncer::set_write_interval ( uint32_t  write_interval)
inline

Definition at line 11 of file syncer.h.

◆ setup()

void esphome::preferences::IntervalSyncer::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file syncer.h.

Field Documentation

◆ write_interval_

uint32_t esphome::preferences::IntervalSyncer::write_interval_
protected

Definition at line 19 of file syncer.h.


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