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

void	set_timezone (const std::string &tz)
	Set the time zone.

void	set_timezone (const char *tz, size_t len)
	Set the time zone from raw buffer, only if it differs from the current one.

std::string	get_timezone ()
	Get the time zone currently in use.

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.

void	add_on_time_sync_callback (std::function< void()> &&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.

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

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

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

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

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

void	apply_timezone_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

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

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

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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

bool	cancel_timeout (InternalSchedulerID id)

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

Protected Attributes
std::string	timezone_ {}

LazyCallbackManager< void()>	time_sync_callback_

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

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 18 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 50 of file real_time_clock.h.

◆ apply_timezone_()

void esphome::time::RealTimeClock::apply_timezone_ ( )

protected

Definition at line 92 of file real_time_clock.cpp.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

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

Definition at line 26 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 38 of file real_time_clock.h.

◆ now()

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

inline

Get the time in the currently defined timezone.

Definition at line 42 of file real_time_clock.h.

◆ set_timezone() [1/2]

void esphome::time::RealTimeClock::set_timezone	(	const char *	tz,
		size_t	len )

inline

Set the time zone from raw buffer, only if it differs from the current one.

Definition at line 30 of file real_time_clock.h.

◆ set_timezone() [2/2]

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

inline

Set the time zone.

Definition at line 24 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 35 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 48 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 45 of file real_time_clock.h.

Field Documentation

◆ time_sync_callback_

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

protected

Definition at line 65 of file real_time_clock.h.

◆ timezone_

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

protected

Definition at line 61 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()

◆ apply_timezone_()

◆ dump_config()

◆ get_timezone()

◆ now()

◆ set_timezone() [1/2]

◆ set_timezone() [2/2]

◆ synchronize_epoch_()

◆ timestamp_now()

◆ utcnow()

Field Documentation

◆ time_sync_callback_

◆ timezone_