ESPHome  2021.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::time::RealTimeClock Class Reference

The RealTimeClock class exposes common timekeeping functions via the device's local real-time clock. More...

#include <real_time_clock.h>

Inheritance diagram for esphome::time::RealTimeClock:
esphome::PollingComponent esphome::Component esphome::ds1307::DS1307Component esphome::gps::GPSTime esphome::homeassistant::HomeassistantTime esphome::sntp::SNTPComponent

Public Member Functions

 RealTimeClock ()
 
void set_timezone (const std::string &tz)
 Set the time zone. More...
 
std::string get_timezone ()
 Get the time zone currently in use. More...
 
ESPTime now ()
 Get the time in the currently defined timezone. More...
 
ESPTime utcnow ()
 Get the time without any time zone or DST corrections. More...
 
time_t timestamp_now ()
 Get the current time as the UTC epoch since January 1st 1970. More...
 
void call_setup () override
 
void add_on_time_sync_callback (std::function< void()> callback)
 
- 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...
 
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...
 
- 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 ()
 
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 Member Functions

void synchronize_epoch_ (uint32_t epoch)
 Report a unix epoch as current time. More...
 
- 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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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

std::string timezone_ {}
 
CallbackManager< void()> time_sync_callback_
 
- 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
 

Detailed Description

The RealTimeClock class exposes common timekeeping functions via the device's local real-time clock.

Note
The C library (newlib) available on ESPs only supports TZ strings that specify an offset and DST info; you cannot specify zone names or paths to zoneinfo files.
See also
https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html

Definition at line 106 of file real_time_clock.h.

Constructor & Destructor Documentation

◆ RealTimeClock()

esphome::time::RealTimeClock::RealTimeClock ( )
explicitdefault

Member Function Documentation

◆ add_on_time_sync_callback()

void esphome::time::RealTimeClock::add_on_time_sync_callback ( std::function< void()>  callback)
inline

Definition at line 127 of file real_time_clock.h.

◆ call_setup()

void esphome::time::RealTimeClock::call_setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file real_time_clock.cpp.

◆ get_timezone()

std::string esphome::time::RealTimeClock::get_timezone ( )
inline

Get the time zone currently in use.

Definition at line 114 of file real_time_clock.h.

◆ now()

ESPTime esphome::time::RealTimeClock::now ( )
inline

Get the time in the currently defined timezone.

Definition at line 117 of file real_time_clock.h.

◆ set_timezone()

void esphome::time::RealTimeClock::set_timezone ( const std::string &  tz)
inline

Set the time zone.

Definition at line 111 of file real_time_clock.h.

◆ synchronize_epoch_()

void esphome::time::RealTimeClock::synchronize_epoch_ ( uint32_t  epoch)
protected

Report a unix epoch as current time.

Definition at line 20 of file real_time_clock.cpp.

◆ timestamp_now()

time_t esphome::time::RealTimeClock::timestamp_now ( )
inline

Get the current time as the UTC epoch since January 1st 1970.

Definition at line 123 of file real_time_clock.h.

◆ utcnow()

ESPTime esphome::time::RealTimeClock::utcnow ( )
inline

Get the time without any time zone or DST corrections.

Definition at line 120 of file real_time_clock.h.

Field Documentation

◆ time_sync_callback_

CallbackManager<void()> esphome::time::RealTimeClock::time_sync_callback_
protected

Definition at line 137 of file real_time_clock.h.

◆ timezone_

std::string esphome::time::RealTimeClock::timezone_ {}
protected

Definition at line 135 of file real_time_clock.h.


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