ESPHome  2024.4.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::datetime::OnTimeTrigger Class Reference

#include <time_entity.h>

Inheritance diagram for esphome::datetime::OnTimeTrigger:
esphome::Trigger<> esphome::Component esphome::Parented< TimeEntity >

Public Member Functions

 OnTimeTrigger (time::RealTimeClock *rtc)
 
void loop () override
 
- Public Member Functions inherited from esphome::Trigger<>
void trigger (Ts... x)
 Inform the parent automation that the event has triggered. More...
 
void set_automation_parent (Automation< Ts... > *automation_parent)
 
void stop_action ()
 Stop any action connected to this trigger. More...
 
bool is_action_running ()
 Returns true if any action connected to this trigger is running. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. 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 () 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. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::Parented< TimeEntity >
 Parented ()
 
 Parented (TimeEntity *parent)
 
TimeEntity * get_parent () const
 Get the parent of this object. More...
 
void set_parent (TimeEntity *parent)
 Set the parent of this object. More...
 

Protected Member Functions

bool matches_ (const ESPTime &time) const
 
- 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(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...
 

Protected Attributes

time::RealTimeClockrtc_
 
optional< ESPTimelast_check_
 
- Protected Attributes inherited from esphome::Trigger<>
Automation< Ts... > * automation_parent_
 
- 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}
 
- Protected Attributes inherited from esphome::Parented< TimeEntity >
TimeEntity * parent_
 

Detailed Description

Definition at line 120 of file time_entity.h.

Constructor & Destructor Documentation

◆ OnTimeTrigger()

esphome::datetime::OnTimeTrigger::OnTimeTrigger ( time::RealTimeClock rtc)
inlineexplicit

Definition at line 122 of file time_entity.h.

Member Function Documentation

◆ loop()

void esphome::datetime::OnTimeTrigger::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 102 of file time_entity.cpp.

◆ matches_()

bool esphome::datetime::OnTimeTrigger::matches_ ( const ESPTime time) const
protected

Definition at line 146 of file time_entity.cpp.

Field Documentation

◆ last_check_

optional<ESPTime> esphome::datetime::OnTimeTrigger::last_check_
protected

Definition at line 129 of file time_entity.h.

◆ rtc_

time::RealTimeClock* esphome::datetime::OnTimeTrigger::rtc_
protected

Definition at line 128 of file time_entity.h.


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