#include <mdns_component.h>

Inheritance diagram for esphome::mdns::MDNSComponent:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	add_extra_service (MDNSService service)

const StaticVector< MDNSService, MDNS_SERVICE_COUNT > &	get_services () const

bool	set_service_enabled (const char service_type, const char proto, bool enabled)
	Enable or disable a compiled-in service, matched by type and proto (e.g.

void	on_shutdown () override

const char *	add_dynamic_txt_value (const std::string &value)
	Add a dynamic TXT value and return pointer to it for use in MDNSTXTRecord.

void	on_active_interface (network::NetworkInterface interface) override

void	on_ip_state (const network::IPAddresses &ips, const network::IPAddress &dns1, const network::IPAddress &dns2) override

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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

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)

Public Member Functions inherited from esphome::wifi::WiFiIPStateListener
Public Member Functions inherited from esphome::ethernet::EthernetIPStateListener
Public Member Functions inherited from esphome::network::ActiveInterfaceListener

Static Public Attributes
static constexpr size_t	CONFIG_HASH_STR_SIZE = format_hex_size(sizeof(uint32_t))
	Size of buffer required for config hash hex string (8 hex chars + null terminator)

static constexpr uint32_t	MDNS_UPDATE_INTERVAL_MS = 50

static constexpr uint32_t	MDNS_POLL_WINDOW_MS = 15000

static constexpr uint32_t	MDNS_POLL_ID = 0

static constexpr uint32_t	MDNS_POLL_STOP_ID = 1

Protected Types
using	PlatformRegisterFn = void ()(MDNSComponent , StaticVector<MDNSService, MDNS_SERVICE_COUNT> &)
	Helper to set up services and MAC buffers, then call platform-specific registration.

Protected Member Functions
void	start_polling_window_ ()
	Arm a fresh MDNS_POLL_WINDOW_MS polling window.

void	setup_buffers_and_register_ (PlatformRegisterFn platform_register)

const char *	connected_network_ () const
	The first connected interface in network: priority order ("ethernet" or "wifi"), else nullptr.

void	update_network_txt_ (const char *network)
	Publish network as the "network" TXT value if it changed; nullptr keeps the current value.

bool	publish_network_txt_ (const char *network)
	Platform-specific: replace the "network" TXT value of the registered _esphomelib service.

void	compile_records_ (StaticVector< MDNSService, MDNS_SERVICE_COUNT > &services, const char mac_address_buf, const char config_hash_buf)

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.

virtual void	call_setup ()

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 *	network_txt_ {nullptr}
	Advertised value; nullptr until the _esphomelib service is registered, and after a failed publish.

MDNSTXTRecord *	network_record_ {nullptr}
	The "network" record in services_, kept in step with network_txt_.

StaticVector< std::string, MDNS_DYNAMIC_TXT_COUNT >	dynamic_txt_values_
	Storage for runtime-generated TXT values from user lambdas Pre-sized at compile time via MDNS_DYNAMIC_TXT_COUNT to avoid heap allocations.

char	mac_address_ [MAC_ADDRESS_BUFFER_SIZE]
	Fixed buffer for MAC address (only needed when services are stored)

char	config_hash_str_ [CONFIG_HASH_STR_SIZE]
	Fixed buffer for config hash hex string (only needed when services are stored)

StaticVector< MDNSService, MDNS_SERVICE_COUNT >	services_ {}

bool	initialized_ {false}

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_

Static Protected Attributes
static constexpr uint32_t	NETWORK_TXT_CHECK_INTERVAL_MS = 1000

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Detailed Description

Definition at line 74 of file mdns_component.h.

Member Typedef Documentation

◆ PlatformRegisterFn

using esphome::mdns::MDNSComponent::PlatformRegisterFn = void (*)(MDNSComponent *, StaticVector<MDNSService, MDNS_SERVICE_COUNT> &)

protected

Helper to set up services and MAC buffers, then call platform-specific registration.

Definition at line 164 of file mdns_component.h.

Member Function Documentation

◆ add_dynamic_txt_value()

const char * esphome::mdns::MDNSComponent::add_dynamic_txt_value ( const std::string & value )

inline

Add a dynamic TXT value and return pointer to it for use in MDNSTXTRecord.

Definition at line 142 of file mdns_component.h.

◆ add_extra_service()

void esphome::mdns::MDNSComponent::add_extra_service ( MDNSService service )

inline

Definition at line 118 of file mdns_component.h.

◆ compile_records_()

void esphome::mdns::MDNSComponent::compile_records_	(	StaticVector< MDNSService, MDNS_SERVICE_COUNT > &	services,
		const char *	mac_address_buf,
		const char *	config_hash_buf )

protected

Definition at line 128 of file mdns_component.cpp.

◆ connected_network_()

const char * esphome::mdns::MDNSComponent::connected_network_ ( ) const

protected

The first connected interface in network: priority order ("ethernet" or "wifi"), else nullptr.

Definition at line 51 of file mdns_component.cpp.

◆ dump_config()

void esphome::mdns::MDNSComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 335 of file mdns_component.cpp.

◆ get_services()

const StaticVector< MDNSService, MDNS_SERVICE_COUNT > & esphome::mdns::MDNSComponent::get_services ( ) const

inline

Definition at line 122 of file mdns_component.h.

◆ get_setup_priority()

float esphome::mdns::MDNSComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 115 of file mdns_component.h.

◆ on_active_interface()

void esphome::mdns::MDNSComponent::on_active_interface ( network::NetworkInterface interface )

overridevirtual

Implements esphome::network::ActiveInterfaceListener.

Definition at line 82 of file mdns_component.cpp.

◆ on_ip_state()

void esphome::mdns::MDNSComponent::on_ip_state	(	const network::IPAddresses &	ips,
		const network::IPAddress &	dns1,
		const network::IPAddress &	dns2 )

overridevirtual

Implements esphome::wifi::WiFiIPStateListener.

Definition at line 112 of file mdns_esp8266.cpp.

◆ on_shutdown()

void esphome::mdns::MDNSComponent::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 112 of file mdns_esp32.cpp.

◆ publish_network_txt_()

bool esphome::mdns::MDNSComponent::publish_network_txt_ ( const char * network )

protected

Platform-specific: replace the "network" TXT value of the registered _esphomelib service.

Definition at line 93 of file mdns_esp32.cpp.

◆ set_service_enabled()

bool esphome::mdns::MDNSComponent::set_service_enabled	(	const char *	service_type,
		const char *	proto,
		bool	enabled )

Enable or disable a compiled-in service, matched by type and proto (e.g.

"_sendspin", "_tcp"). Only valid once this component is ready. Re-enabling re-reads the port but keeps the boot-time TXT values. Returns true if the service is in the requested state afterwards. Blocks briefly on the mDNS task.

Definition at line 66 of file mdns_esp32.cpp.

◆ setup()

void esphome::mdns::MDNSComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 104 of file mdns_esp32.cpp.

◆ setup_buffers_and_register_()

void esphome::mdns::MDNSComponent::setup_buffers_and_register_ ( PlatformRegisterFn platform_register )

protected

Definition at line 97 of file mdns_component.cpp.

◆ start_polling_window_()

void esphome::mdns::MDNSComponent::start_polling_window_ ( )

protected

Arm a fresh MDNS_POLL_WINDOW_MS polling window.

Idempotent — re-arming replaces the previous window via the scheduler's atomic cancel-and-add on matching IDs.

Definition at line 81 of file mdns_esp8266.cpp.

◆ update_network_txt_()

void esphome::mdns::MDNSComponent::update_network_txt_ ( const char * network )

protected

Publish network as the "network" TXT value if it changed; nullptr keeps the current value.

Definition at line 65 of file mdns_component.cpp.

Field Documentation

◆ config_hash_str_

char esphome::mdns::MDNSComponent::config_hash_str_[CONFIG_HASH_STR_SIZE]

protected

Fixed buffer for config hash hex string (only needed when services are stored)

Definition at line 195 of file mdns_component.h.

◆ CONFIG_HASH_STR_SIZE

size_t esphome::mdns::MDNSComponent::CONFIG_HASH_STR_SIZE = format_hex_size(sizeof(uint32_t))

staticconstexpr

Size of buffer required for config hash hex string (8 hex chars + null terminator)

Definition at line 93 of file mdns_component.h.

◆ dynamic_txt_values_

StaticVector<std::string, MDNS_DYNAMIC_TXT_COUNT> esphome::mdns::MDNSComponent::dynamic_txt_values_

protected

Storage for runtime-generated TXT values from user lambdas Pre-sized at compile time via MDNS_DYNAMIC_TXT_COUNT to avoid heap allocations.

Static/compile-time values (version, board, etc.) are stored directly in flash and don't use this.

Definition at line 188 of file mdns_component.h.

◆ initialized_

bool esphome::mdns::MDNSComponent::initialized_ {false}

protected

Definition at line 202 of file mdns_component.h.

◆ mac_address_

char esphome::mdns::MDNSComponent::mac_address_[MAC_ADDRESS_BUFFER_SIZE]

protected

Fixed buffer for MAC address (only needed when services are stored)

Definition at line 193 of file mdns_component.h.

◆ MDNS_POLL_ID

uint32_t esphome::mdns::MDNSComponent::MDNS_POLL_ID = 0

staticconstexpr

Definition at line 112 of file mdns_component.h.

◆ MDNS_POLL_STOP_ID

uint32_t esphome::mdns::MDNSComponent::MDNS_POLL_STOP_ID = 1

staticconstexpr

Definition at line 113 of file mdns_component.h.

◆ MDNS_POLL_WINDOW_MS

uint32_t esphome::mdns::MDNSComponent::MDNS_POLL_WINDOW_MS = 15000

staticconstexpr

Definition at line 111 of file mdns_component.h.

◆ MDNS_UPDATE_INTERVAL_MS

uint32_t esphome::mdns::MDNSComponent::MDNS_UPDATE_INTERVAL_MS = 50

staticconstexpr

Definition at line 100 of file mdns_component.h.

◆ network_record_

MDNSTXTRecord* esphome::mdns::MDNSComponent::network_record_ {nullptr}

protected

The "network" record in services_, kept in step with network_txt_.

Definition at line 180 of file mdns_component.h.

◆ network_txt_

const char* esphome::mdns::MDNSComponent::network_txt_ {nullptr}

protected

Advertised value; nullptr until the _esphomelib service is registered, and after a failed publish.

Definition at line 177 of file mdns_component.h.

◆ NETWORK_TXT_CHECK_INTERVAL_MS

uint32_t esphome::mdns::MDNSComponent::NETWORK_TXT_CHECK_INTERVAL_MS = 1000

staticconstexprprotected

Definition at line 169 of file mdns_component.h.

◆ services_

StaticVector<MDNSService, MDNS_SERVICE_COUNT> esphome::mdns::MDNSComponent::services_ {}

protected

Definition at line 198 of file mdns_component.h.

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

esphome/components/mdns/mdns_component.h
esphome/components/mdns/mdns_component.cpp
esphome/components/mdns/mdns_esp32.cpp
esphome/components/mdns/mdns_esp8266.cpp
esphome/components/mdns/mdns_host.cpp
esphome/components/mdns/mdns_libretiny.cpp
esphome/components/mdns/mdns_rp2.cpp
esphome/components/mdns/mdns_zephyr.cpp

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PlatformRegisterFn

Member Function Documentation

◆ add_dynamic_txt_value()

◆ add_extra_service()

◆ compile_records_()

◆ connected_network_()

◆ dump_config()

◆ get_services()

◆ get_setup_priority()

◆ on_active_interface()

◆ on_ip_state()

◆ on_shutdown()

◆ publish_network_txt_()

◆ set_service_enabled()

◆ setup()

◆ setup_buffers_and_register_()

◆ start_polling_window_()

◆ update_network_txt_()

Field Documentation

◆ config_hash_str_

◆ CONFIG_HASH_STR_SIZE

◆ dynamic_txt_values_

◆ initialized_

◆ mac_address_

◆ MDNS_POLL_ID

◆ MDNS_POLL_STOP_ID

◆ MDNS_POLL_WINDOW_MS

◆ MDNS_UPDATE_INTERVAL_MS

◆ network_record_

◆ network_txt_

◆ NETWORK_TXT_CHECK_INTERVAL_MS

◆ services_