ESPHome  2024.5.3
Public Member Functions | Protected Attributes
esphome::datetime::DateTimeBase Class Referenceabstract

#include <datetime_base.h>

Inheritance diagram for esphome::datetime::DateTimeBase:
esphome::EntityBase esphome::datetime::DateEntity esphome::datetime::DateTimeEntity esphome::datetime::TimeEntity esphome::template_::TemplateDate esphome::template_::TemplateDateTime esphome::template_::TemplateTime

Public Member Functions

bool has_state () const
 Return whether this Datetime has gotten a full state yet. More...
 
virtual ESPTime state_as_esptime () const =0
 
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)
 

Protected Attributes

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}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 

Detailed Description

Definition at line 13 of file datetime_base.h.

Member Function Documentation

◆ add_on_state_callback()

void esphome::datetime::DateTimeBase::add_on_state_callback ( std::function< void()> &&  callback)
inline

Definition at line 20 of file datetime_base.h.

◆ get_rtc()

time::RealTimeClock* esphome::datetime::DateTimeBase::get_rtc ( ) const
inline

Definition at line 23 of file datetime_base.h.

◆ has_state()

bool esphome::datetime::DateTimeBase::has_state ( ) const
inline

Return whether this Datetime has gotten a full state yet.

Definition at line 16 of file datetime_base.h.

◆ set_rtc()

void esphome::datetime::DateTimeBase::set_rtc ( time::RealTimeClock rtc)
inline

Definition at line 22 of file datetime_base.h.

◆ state_as_esptime()

virtual ESPTime esphome::datetime::DateTimeBase::state_as_esptime ( ) const
pure virtual

Field Documentation

◆ has_state_

bool esphome::datetime::DateTimeBase::has_state_ {false}
protected

Definition at line 30 of file datetime_base.h.

◆ rtc_

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

Definition at line 28 of file datetime_base.h.

◆ state_callback_

CallbackManager<void()> esphome::datetime::DateTimeBase::state_callback_
protected

Definition at line 26 of file datetime_base.h.


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