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:

Public Member Functions
	RealTimeClock ()

ESPTime	now ()
	Get the time in the currently defined timezone.

ESPTime	utcnow ()
	Get the time without any time zone or DST corrections.

time_t	timestamp_now ()
	Get the current time as the UTC epoch since January 1st 1970.

template<typename F >
void	add_on_time_sync_callback (F &&callback)

void	dump_config () override

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

virtual void	update ()=0

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

virtual void	loop ()
	This method will be called repeatedly.

virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
void	synchronize_epoch_ (uint32_t epoch)
	Report a unix epoch as current time.

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
LazyCallbackManager< void()>	time_sync_callback_

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Detailed Description

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

Note: The timezone is pre-parsed into a ParsedTimezone struct: at codegen time from the YAML configuration, or at runtime by API clients that send the parsed struct (Home Assistant 2026.3.0 and newer). See set_global_tz() in posix_tz.h.

Definition at line 21 of file real_time_clock.h.

Constructor & Destructor Documentation

◆ RealTimeClock()

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

explicitdefault

Member Function Documentation

◆ add_on_time_sync_callback()

template<typename F >

void esphome::time::RealTimeClock::add_on_time_sync_callback ( F && callback )

inline

Definition at line 34 of file real_time_clock.h.

◆ dump_config()

void esphome::time::RealTimeClock::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::rx8130::RX8130Component, esphome::sntp::SNTPComponent, esphome::zigbee::ZigbeeTime, and esphome::zigbee::ZigbeeTime.

Definition at line 40 of file real_time_clock.cpp.

◆ now()

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

Get the time in the currently defined timezone.

◆ synchronize_epoch_()

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

protected

Report a unix epoch as current time.

Definition at line 59 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 32 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 29 of file real_time_clock.h.

Field Documentation

◆ time_sync_callback_

LazyCallbackManager<void()> esphome::time::RealTimeClock::time_sync_callback_

protected

Definition at line 44 of file real_time_clock.h.

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

esphome/components/time/real_time_clock.h
esphome/components/time/real_time_clock.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RealTimeClock()

Member Function Documentation

◆ add_on_time_sync_callback()

◆ dump_config()

◆ now()

◆ synchronize_epoch_()

◆ timestamp_now()

◆ utcnow()

Field Documentation

◆ time_sync_callback_