#include <wireguard.h>

Inheritance diagram for esphome::wireguard::Wireguard:

Public Member Functions
void	setup () override

void	loop () override

void	update () override

void	dump_config () override

void	on_shutdown () override

bool	can_proceed () override

float	get_setup_priority () const override

void	set_address (const char *address)

void	set_netmask (const char *netmask)

void	set_private_key (const char *key)

void	set_peer_endpoint (const char *endpoint)

void	set_peer_public_key (const char *key)

void	set_peer_port (uint16_t port)

void	set_preshared_key (const char *key)

void	set_address (const std::string &address)=delete
	Prevent accidental use of std::string which would dangle.

void	set_netmask (const std::string &netmask)=delete

void	set_private_key (const std::string &key)=delete

void	set_peer_endpoint (const std::string &endpoint)=delete

void	set_peer_public_key (const std::string &key)=delete

void	set_preshared_key (const std::string &key)=delete

void	set_allowed_ips (std::initializer_list< AllowedIP > ips)

void	set_allowed_ips (std::initializer_list< std::tuple< std::string, std::string > > ips)=delete
	Prevent accidental use of std::string which would dangle.

void	set_keepalive (uint16_t seconds)

void	set_reboot_timeout (uint32_t seconds)

void	set_srctime (time::RealTimeClock *srctime)

void	set_status_sensor (binary_sensor::BinarySensor *sensor)

void	set_enabled_sensor (binary_sensor::BinarySensor *sensor)

void	set_handshake_sensor (sensor::Sensor *sensor)

void	set_address_sensor (text_sensor::TextSensor *sensor)

void	disable_auto_proceed ()
	Block the setup step until peer is connected.

void	enable ()
	Enable the WireGuard component.

void	disable ()
	Stop any running connection and disable the WireGuard component.

void	publish_enabled_state ()
	Publish the enabled state if the enabled binary sensor is configured.

bool	is_enabled ()
	Return if the WireGuard component is or is not enabled.

bool	is_peer_up () const

time_t	get_latest_handshake () const

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.

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

	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

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

void	stop_connection_ ()

Protected Member Functions inherited from esphome::Component
void	call_loop_ ()

void	call_dump_config_ ()

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 (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
const char *	address_ {nullptr}

const char *	netmask_ {nullptr}

const char *	private_key_ {nullptr}

const char *	peer_endpoint_ {nullptr}

const char *	peer_public_key_ {nullptr}

const char *	preshared_key_ {nullptr}

FixedVector< AllowedIP >	allowed_ips_

uint16_t	peer_port_

uint16_t	keepalive_

uint32_t	reboot_timeout_

time::RealTimeClock *	srctime_

binary_sensor::BinarySensor *	status_sensor_ = nullptr

binary_sensor::BinarySensor *	enabled_sensor_ = nullptr

sensor::Sensor *	handshake_sensor_ = nullptr

text_sensor::TextSensor *	address_sensor_ = nullptr

bool	proceed_allowed_ = true
	Set to false to block the setup step until peer is connected.

bool	enabled_ = true
	When false the wireguard link will not be established.

wireguard_config_t	wg_config_ = ESP_WIREGUARD_CONFIG_DEFAULT()

wireguard_ctx_t	wg_ctx_ = ESP_WIREGUARD_CONTEXT_DEFAULT()

esp_err_t	wg_initialized_ = ESP_FAIL

esp_err_t	wg_connected_ = ESP_FAIL

uint32_t	wg_peer_offline_time_ = 0
	The last time the remote peer become offline.

time_t	latest_saved_handshake_ = 0
	The latest saved handshake.

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

Detailed Description

Main Wireguard component class.

Definition at line 35 of file wireguard.h.

Member Function Documentation

◆ can_proceed()

bool esphome::wireguard::Wireguard::can_proceed ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 167 of file wireguard.cpp.

◆ disable()

void esphome::wireguard::Wireguard::disable ( )

Stop any running connection and disable the WireGuard component.

Definition at line 207 of file wireguard.cpp.

◆ disable_auto_proceed()

void esphome::wireguard::Wireguard::disable_auto_proceed ( )

Block the setup step until peer is connected.

Definition at line 199 of file wireguard.cpp.

◆ dump_config()

void esphome::wireguard::Wireguard::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 132 of file wireguard.cpp.

◆ enable()

void esphome::wireguard::Wireguard::enable ( )

Enable the WireGuard component.

Definition at line 201 of file wireguard.cpp.

◆ get_latest_handshake()

time_t esphome::wireguard::Wireguard::get_latest_handshake ( ) const

Definition at line 174 of file wireguard.cpp.

◆ get_setup_priority()

float esphome::wireguard::Wireguard::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file wireguard.h.

◆ is_enabled()

bool esphome::wireguard::Wireguard::is_enabled ( )

Return if the WireGuard component is or is not enabled.

Definition at line 222 of file wireguard.cpp.

◆ is_peer_up()

bool esphome::wireguard::Wireguard::is_peer_up ( ) const

Definition at line 169 of file wireguard.cpp.

◆ loop()

void esphome::wireguard::Wireguard::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 65 of file wireguard.cpp.

◆ on_shutdown()

void esphome::wireguard::Wireguard::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 165 of file wireguard.cpp.

◆ publish_enabled_state()

void esphome::wireguard::Wireguard::publish_enabled_state ( )

Publish the enabled state if the enabled binary sensor is configured.

Definition at line 214 of file wireguard.cpp.

◆ set_address() [1/2]

void esphome::wireguard::Wireguard::set_address ( const char * address )

inline

Definition at line 46 of file wireguard.h.

◆ set_address() [2/2]

void esphome::wireguard::Wireguard::set_address ( const std::string & address )

delete

Prevent accidental use of std::string which would dangle.

◆ set_address_sensor()

void esphome::wireguard::Wireguard::set_address_sensor ( text_sensor::TextSensor * sensor )

Definition at line 196 of file wireguard.cpp.

◆ set_allowed_ips() [1/2]

void esphome::wireguard::Wireguard::set_allowed_ips ( std::initializer_list< AllowedIP > ips )

inline

Definition at line 62 of file wireguard.h.

◆ set_allowed_ips() [2/2]

void esphome::wireguard::Wireguard::set_allowed_ips ( std::initializer_list< std::tuple< std::string, std::string > > ips )

delete

Prevent accidental use of std::string which would dangle.

◆ set_enabled_sensor()

void esphome::wireguard::Wireguard::set_enabled_sensor ( binary_sensor::BinarySensor * sensor )

Definition at line 188 of file wireguard.cpp.

◆ set_handshake_sensor()

void esphome::wireguard::Wireguard::set_handshake_sensor ( sensor::Sensor * sensor )

Definition at line 192 of file wireguard.cpp.

◆ set_keepalive()

void esphome::wireguard::Wireguard::set_keepalive ( uint16_t seconds )

Definition at line 182 of file wireguard.cpp.

◆ set_netmask() [1/2]

void esphome::wireguard::Wireguard::set_netmask ( const char * netmask )

inline

Definition at line 47 of file wireguard.h.

◆ set_netmask() [2/2]

void esphome::wireguard::Wireguard::set_netmask ( const std::string & netmask )

delete

◆ set_peer_endpoint() [1/2]

void esphome::wireguard::Wireguard::set_peer_endpoint ( const char * endpoint )

inline

Definition at line 49 of file wireguard.h.

◆ set_peer_endpoint() [2/2]

void esphome::wireguard::Wireguard::set_peer_endpoint ( const std::string & endpoint )

delete

◆ set_peer_port()

void esphome::wireguard::Wireguard::set_peer_port ( uint16_t port )

inline

Definition at line 51 of file wireguard.h.

◆ set_peer_public_key() [1/2]

void esphome::wireguard::Wireguard::set_peer_public_key ( const char * key )

inline

Definition at line 50 of file wireguard.h.

◆ set_peer_public_key() [2/2]

void esphome::wireguard::Wireguard::set_peer_public_key ( const std::string & key )

delete

◆ set_preshared_key() [1/2]

void esphome::wireguard::Wireguard::set_preshared_key ( const char * key )

inline

Definition at line 52 of file wireguard.h.

◆ set_preshared_key() [2/2]

void esphome::wireguard::Wireguard::set_preshared_key ( const std::string & key )

delete

◆ set_private_key() [1/2]

void esphome::wireguard::Wireguard::set_private_key ( const char * key )

inline

Definition at line 48 of file wireguard.h.

◆ set_private_key() [2/2]

void esphome::wireguard::Wireguard::set_private_key ( const std::string & key )

delete

◆ set_reboot_timeout()

void esphome::wireguard::Wireguard::set_reboot_timeout ( uint32_t seconds )

Definition at line 183 of file wireguard.cpp.

◆ set_srctime()

void esphome::wireguard::Wireguard::set_srctime ( time::RealTimeClock * srctime )

Definition at line 184 of file wireguard.cpp.

◆ set_status_sensor()

void esphome::wireguard::Wireguard::set_status_sensor ( binary_sensor::BinarySensor * sensor )

Definition at line 187 of file wireguard.cpp.

◆ setup()

void esphome::wireguard::Wireguard::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file wireguard.cpp.

◆ start_connection_()

void esphome::wireguard::Wireguard::start_connection_ ( )

protected

Definition at line 224 of file wireguard.cpp.

◆ stop_connection_()

void esphome::wireguard::Wireguard::stop_connection_ ( )

protected

Definition at line 281 of file wireguard.cpp.

◆ update()

void esphome::wireguard::Wireguard::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 76 of file wireguard.cpp.

Field Documentation

◆ address_

const char* esphome::wireguard::Wireguard::address_ {nullptr}

protected

Definition at line 102 of file wireguard.h.

◆ address_sensor_

text_sensor::TextSensor* esphome::wireguard::Wireguard::address_sensor_ = nullptr

protected

Definition at line 127 of file wireguard.h.

◆ allowed_ips_

FixedVector<AllowedIP> esphome::wireguard::Wireguard::allowed_ips_

protected

Definition at line 109 of file wireguard.h.

◆ enabled_

bool esphome::wireguard::Wireguard::enabled_ = true

protected

When false the wireguard link will not be established.

Definition at line 134 of file wireguard.h.

◆ enabled_sensor_

binary_sensor::BinarySensor* esphome::wireguard::Wireguard::enabled_sensor_ = nullptr

protected

Definition at line 119 of file wireguard.h.

◆ handshake_sensor_

sensor::Sensor* esphome::wireguard::Wireguard::handshake_sensor_ = nullptr

protected

Definition at line 123 of file wireguard.h.

◆ keepalive_

uint16_t esphome::wireguard::Wireguard::keepalive_

protected

Definition at line 112 of file wireguard.h.

◆ latest_saved_handshake_

time_t esphome::wireguard::Wireguard::latest_saved_handshake_ = 0

protected

The latest saved handshake.

This is used to save (and log) the latest completed handshake even after a full refresh of the wireguard keys (for example after a stop/start connection cycle).

Definition at line 151 of file wireguard.h.

◆ netmask_

const char* esphome::wireguard::Wireguard::netmask_ {nullptr}

protected

Definition at line 103 of file wireguard.h.

◆ peer_endpoint_

const char* esphome::wireguard::Wireguard::peer_endpoint_ {nullptr}

protected

Definition at line 105 of file wireguard.h.

◆ peer_port_

uint16_t esphome::wireguard::Wireguard::peer_port_

protected

Definition at line 111 of file wireguard.h.

◆ peer_public_key_

const char* esphome::wireguard::Wireguard::peer_public_key_ {nullptr}

protected

Definition at line 106 of file wireguard.h.

◆ preshared_key_

const char* esphome::wireguard::Wireguard::preshared_key_ {nullptr}

protected

Definition at line 107 of file wireguard.h.

◆ private_key_

const char* esphome::wireguard::Wireguard::private_key_ {nullptr}

protected

Definition at line 104 of file wireguard.h.

◆ proceed_allowed_

bool esphome::wireguard::Wireguard::proceed_allowed_ = true

protected

Set to false to block the setup step until peer is connected.

Definition at line 131 of file wireguard.h.

◆ reboot_timeout_

uint32_t esphome::wireguard::Wireguard::reboot_timeout_

protected

Definition at line 113 of file wireguard.h.

◆ srctime_

time::RealTimeClock* esphome::wireguard::Wireguard::srctime_

protected

Definition at line 115 of file wireguard.h.

◆ status_sensor_

binary_sensor::BinarySensor* esphome::wireguard::Wireguard::status_sensor_ = nullptr

protected

Definition at line 118 of file wireguard.h.

◆ wg_config_

wireguard_config_t esphome::wireguard::Wireguard::wg_config_ = ESP_WIREGUARD_CONFIG_DEFAULT()

protected

Definition at line 136 of file wireguard.h.

◆ wg_connected_

esp_err_t esphome::wireguard::Wireguard::wg_connected_ = ESP_FAIL

protected

Definition at line 140 of file wireguard.h.

◆ wg_ctx_

wireguard_ctx_t esphome::wireguard::Wireguard::wg_ctx_ = ESP_WIREGUARD_CONTEXT_DEFAULT()

protected

Definition at line 137 of file wireguard.h.

◆ wg_initialized_

esp_err_t esphome::wireguard::Wireguard::wg_initialized_ = ESP_FAIL

protected

Definition at line 139 of file wireguard.h.

◆ wg_peer_offline_time_

uint32_t esphome::wireguard::Wireguard::wg_peer_offline_time_ = 0

protected

The last time the remote peer become offline.

Definition at line 143 of file wireguard.h.

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

esphome/components/wireguard/wireguard.h
esphome/components/wireguard/wireguard.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ can_proceed()

◆ disable()

◆ disable_auto_proceed()

◆ dump_config()

◆ enable()

◆ get_latest_handshake()

◆ get_setup_priority()

◆ is_enabled()

◆ is_peer_up()

◆ loop()

◆ on_shutdown()

◆ publish_enabled_state()

◆ set_address() [1/2]

◆ set_address() [2/2]

◆ set_address_sensor()

◆ set_allowed_ips() [1/2]

◆ set_allowed_ips() [2/2]

◆ set_enabled_sensor()

◆ set_handshake_sensor()

◆ set_keepalive()

◆ set_netmask() [1/2]

◆ set_netmask() [2/2]

◆ set_peer_endpoint() [1/2]

◆ set_peer_endpoint() [2/2]

◆ set_peer_port()

◆ set_peer_public_key() [1/2]

◆ set_peer_public_key() [2/2]

◆ set_preshared_key() [1/2]

◆ set_preshared_key() [2/2]

◆ set_private_key() [1/2]

◆ set_private_key() [2/2]

◆ set_reboot_timeout()

◆ set_srctime()

◆ set_status_sensor()

◆ setup()

◆ start_connection_()

◆ stop_connection_()

◆ update()

Field Documentation

◆ address_

◆ address_sensor_

◆ allowed_ips_

◆ enabled_

◆ enabled_sensor_

◆ handshake_sensor_

◆ keepalive_

◆ latest_saved_handshake_

◆ netmask_

◆ peer_endpoint_

◆ peer_port_

◆ peer_public_key_

◆ preshared_key_

◆ private_key_

◆ proceed_allowed_

◆ reboot_timeout_

◆ srctime_

◆ status_sensor_

◆ wg_config_

◆ wg_connected_

◆ wg_ctx_

◆ wg_initialized_

◆ wg_peer_offline_time_