ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::wireguard::Wireguard Class Referencefinal

Main Wireguard component class. More...

#include <wireguard.h>

Inheritance diagram for esphome::wireguard::Wireguard:
esphome::PollingComponent esphome::Component

Protected Member Functions

void start_connection_ ()
 
void stop_connection_ ()
 
- 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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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

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}
 
const AllowedIP * allowed_ips_ {nullptr}
 
uint16_t peer_port_
 
uint16_t keepalive_
 
uint32_t reboot_timeout_
 
time::RealTimeClock * srctime_
 
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.
 
uint32_t wg_reconnect_time_ = 0
 
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
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_
 

Additional Inherited Members

- 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.
 
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.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
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 last before a reboot or deep sleep 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)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, 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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
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)
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Main Wireguard component class.

Definition at line 33 of file wireguard.h.

Member Function Documentation

◆ start_connection_()

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

Definition at line 202 of file wireguard.cpp.

◆ stop_connection_()

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

Definition at line 259 of file wireguard.cpp.

Field Documentation

◆ address_

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

Definition at line 97 of file wireguard.h.

◆ allowed_ips_

const AllowedIP* esphome::wireguard::Wireguard::allowed_ips_ {nullptr}
protected

Definition at line 104 of file wireguard.h.

◆ enabled_

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

When false the wireguard link will not be established.

Definition at line 116 of file wireguard.h.

◆ keepalive_

uint16_t esphome::wireguard::Wireguard::keepalive_
protected

Definition at line 107 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 134 of file wireguard.h.

◆ netmask_

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

Definition at line 98 of file wireguard.h.

◆ peer_endpoint_

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

Definition at line 100 of file wireguard.h.

◆ peer_port_

uint16_t esphome::wireguard::Wireguard::peer_port_
protected

Definition at line 106 of file wireguard.h.

◆ peer_public_key_

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

Definition at line 101 of file wireguard.h.

◆ preshared_key_

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

Definition at line 102 of file wireguard.h.

◆ private_key_

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

Definition at line 99 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 113 of file wireguard.h.

◆ reboot_timeout_

uint32_t esphome::wireguard::Wireguard::reboot_timeout_
protected

Definition at line 108 of file wireguard.h.

◆ srctime_

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

Definition at line 110 of file wireguard.h.

◆ wg_config_

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

Definition at line 118 of file wireguard.h.

◆ wg_connected_

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

Definition at line 122 of file wireguard.h.

◆ wg_ctx_

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

Definition at line 119 of file wireguard.h.

◆ wg_initialized_

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

Definition at line 121 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 125 of file wireguard.h.

◆ wg_reconnect_time_

uint32_t esphome::wireguard::Wireguard::wg_reconnect_time_ = 0
protected

Definition at line 126 of file wireguard.h.


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