ESPHome  2024.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::template_::TemplateDateTime Class Reference

#include <template_datetime.h>

Inheritance diagram for esphome::template_::TemplateDateTime:
esphome::datetime::DateTimeEntity esphome::PollingComponent esphome::datetime::DateTimeBase esphome::Component esphome::EntityBase

Public Member Functions

void set_template (std::function< optional< ESPTime >()> &&f)
 
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
Trigger< ESPTime > * get_set_trigger () const
 
void set_optimistic (bool optimistic)
 
void set_initial_value (ESPTime initial_value)
 
void set_restore_value (bool restore_value)
 
- Public Member Functions inherited from esphome::datetime::DateTimeEntity
void publish_state ()
 
DateTimeCall make_call ()
 
ESPTime state_as_esptime () const override
 
- Public Member Functions inherited from esphome::datetime::DateTimeBase
bool has_state () const
 Return whether this Datetime has gotten a full state yet. More...
 
void add_on_state_callback (std::function< void()> &&callback)
 
void set_rtc (time::RealTimeClock *rtc)
 
time::RealTimeClockget_rtc () const
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- 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...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. 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 () const
 
bool is_ready () const
 
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...
 

Protected Member Functions

void control (const datetime::DateTimeCall &call) override
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 
- 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...
 

Protected Attributes

bool optimistic_ {false}
 
ESPTime initial_value_ {}
 
bool restore_value_ {false}
 
Trigger< ESPTime > * set_trigger_ = new Trigger<ESPTime>()
 
optional< std::function< optional< ESPTime >)> > f_
 
ESPPreferenceObject pref_
 
- Protected Attributes inherited from esphome::datetime::DateTimeEntity
uint16_t year_
 
uint8_t month_
 
uint8_t day_
 
uint8_t hour_
 
uint8_t minute_
 
uint8_t second_
 
- Protected Attributes inherited from esphome::datetime::DateTimeBase
CallbackManager< void()> state_callback_
 
time::RealTimeClockrtc_
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- 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

- Data Fields inherited from esphome::datetime::DateTimeEntity
const uint16_t & year = year_
 
const uint8_t & month = month_
 
const uint8_t & day = day_
 
const uint8_t & hour = hour_
 
const uint8_t & minute = minute_
 
const uint8_t & second = second_
 

Detailed Description

Definition at line 16 of file template_datetime.h.

Member Function Documentation

◆ control()

void esphome::template_::TemplateDateTime::control ( const datetime::DateTimeCall call)
overrideprotectedvirtual

Implements esphome::datetime::DateTimeEntity.

Definition at line 59 of file template_datetime.cpp.

◆ dump_config()

void esphome::template_::TemplateDateTime::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 141 of file template_datetime.cpp.

◆ get_set_trigger()

Trigger<ESPTime>* esphome::template_::TemplateDateTime::get_set_trigger ( ) const
inline

Definition at line 25 of file template_datetime.h.

◆ get_setup_priority()

float esphome::template_::TemplateDateTime::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file template_datetime.h.

◆ set_initial_value()

void esphome::template_::TemplateDateTime::set_initial_value ( ESPTime  initial_value)
inline

Definition at line 28 of file template_datetime.h.

◆ set_optimistic()

void esphome::template_::TemplateDateTime::set_optimistic ( bool  optimistic)
inline

Definition at line 26 of file template_datetime.h.

◆ set_restore_value()

void esphome::template_::TemplateDateTime::set_restore_value ( bool  restore_value)
inline

Definition at line 29 of file template_datetime.h.

◆ set_template()

void esphome::template_::TemplateDateTime::set_template ( std::function< optional< ESPTime >()> &&  f)
inline

Definition at line 18 of file template_datetime.h.

◆ setup()

void esphome::template_::TemplateDateTime::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file template_datetime.cpp.

◆ update()

void esphome::template_::TemplateDateTime::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 42 of file template_datetime.cpp.

Field Documentation

◆ f_

optional<std::function<optional<ESPTime>)> > esphome::template_::TemplateDateTime::f_
protected

Definition at line 38 of file template_datetime.h.

◆ initial_value_

ESPTime esphome::template_::TemplateDateTime::initial_value_ {}
protected

Definition at line 35 of file template_datetime.h.

◆ optimistic_

bool esphome::template_::TemplateDateTime::optimistic_ {false}
protected

Definition at line 34 of file template_datetime.h.

◆ pref_

ESPPreferenceObject esphome::template_::TemplateDateTime::pref_
protected

Definition at line 40 of file template_datetime.h.

◆ restore_value_

bool esphome::template_::TemplateDateTime::restore_value_ {false}
protected

Definition at line 36 of file template_datetime.h.

◆ set_trigger_

Trigger<ESPTime>* esphome::template_::TemplateDateTime::set_trigger_ = new Trigger<ESPTime>()
protected

Definition at line 37 of file template_datetime.h.


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