The SNTP component allows you to configure local timekeeping via Simple Network Time Protocol. More...

#include <sntp_component.h>

Inheritance diagram for esphome::sntp::SNTPComponent:

Public Member Functions
void	setup () override

void	dump_config () override

void	set_servers (const std::string &server_1, const std::string &server_2, const std::string &server_3)
	Change the servers used by SNTP for timekeeping. More...

float	get_setup_priority () const override

void	update () override

void	loop () override

Public Member Functions inherited from esphome::time::RealTimeClock
	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...

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

bool	is_ready ()

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 Attributes
std::string	server_1_

std::string	server_2_

std::string	server_3_

bool	has_time_ {false}

Protected Attributes inherited from esphome::time::RealTimeClock
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}

Additional Inherited Members
Protected Member Functions inherited from esphome::time::RealTimeClock
void	synchronize_epoch_ (uint32_t epoch)
	Report a unix epoch as current time. More...

void	apply_timezone_ ()

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...

Detailed Description

The SNTP component allows you to configure local timekeeping via Simple Network Time Protocol.

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 15 of file sntp_component.h.

Member Function Documentation

◆ dump_config()

void esphome::sntp::SNTPComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 54 of file sntp_component.cpp.

◆ get_setup_priority()

float esphome::sntp::SNTPComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file sntp_component.h.

◆ loop()

void esphome::sntp::SNTPComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 71 of file sntp_component.cpp.

◆ set_servers()

void esphome::sntp::SNTPComponent::set_servers	(	const std::string &	server_1,
		const std::string &	server_2,
		const std::string &	server_3
	)

inline

Change the servers used by SNTP for timekeeping.

Definition at line 20 of file sntp_component.h.

◆ setup()

void esphome::sntp::SNTPComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 27 of file sntp_component.cpp.

◆ update()

void esphome::sntp::SNTPComponent::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 61 of file sntp_component.cpp.

Field Documentation

◆ has_time_

bool esphome::sntp::SNTPComponent::has_time_ {false}

protected

Definition at line 34 of file sntp_component.h.

◆ server_1_

std::string esphome::sntp::SNTPComponent::server_1_

protected

Definition at line 31 of file sntp_component.h.

◆ server_2_

std::string esphome::sntp::SNTPComponent::server_2_

protected

Definition at line 32 of file sntp_component.h.

◆ server_3_

std::string esphome::sntp::SNTPComponent::server_3_

protected

Definition at line 33 of file sntp_component.h.

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

/opt/build/esphome/esphome/components/sntp/sntp_component.h
/opt/build/esphome/esphome/components/sntp/sntp_component.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ set_servers()

◆ setup()

◆ update()

Field Documentation

◆ has_time_

◆ server_1_

◆ server_2_

◆ server_3_