#include <mqtt_client.h>

Inheritance diagram for esphome::mqtt::MQTTClientComponent:

Public Member Functions
	MQTTClientComponent ()

void	set_last_will (MQTTMessage &&message)
	Set the last will testament message.

void	disable_last_will ()
	Remove the last will testament message.

void	set_birth_message (MQTTMessage &&message)
	Set the birth message.

void	disable_birth_message ()
	Remove the birth message.

void	set_shutdown_message (MQTTMessage &&message)

void	disable_shutdown_message ()

void	set_keep_alive (uint16_t keep_alive_s)
	Set the keep alive time in seconds, every 0.7*keep_alive a ping will be sent.

void	set_discovery_info (std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator, MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain, bool discover_ip, bool clean=false)
	Set the Home Assistant discovery info.

const MQTTDiscoveryInfo &	get_discovery_info () const
	Get Home Assistant discovery info.

void	disable_discovery ()
	Globally disable Home Assistant discovery.

bool	is_discovery_enabled () const

bool	is_discovery_ip_enabled () const

void	add_ssl_fingerprint (const std::array< uint8_t, SHA1_SIZE > &fingerprint)
	Add a SSL fingerprint to use for TCP SSL connections to the MQTT broker.

void	set_ca_certificate (const char *cert)

void	set_cl_certificate (const char *cert)

void	set_cl_key (const char *key)

void	set_skip_cert_cn_check (bool skip_check)

const Availability &	get_availability ()

void	set_topic_prefix (const std::string &topic_prefix, const std::string &check_topic_prefix)
	Set the topic prefix that will be prepended to all topics together with "/".

const std::string &	get_topic_prefix () const
	Get the topic prefix of this device, using default if necessary.

void	set_log_message_template (MQTTMessage &&message)
	Manually set the topic used for logging.

void	set_log_level (int level)

void	disable_log_message ()
	Get the topic used for logging. Defaults to "<topic_prefix>/debug" and the value is cached for speed.

bool	is_log_message_enabled () const

void	subscribe (const std::string &topic, mqtt_callback_t callback, uint8_t qos=0)
	Subscribe to an MQTT topic and call callback when a message is received.

void	subscribe_json (const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos=0)
	Subscribe to a MQTT topic and automatically parse JSON payload.

void	unsubscribe (const std::string &topic)
	Unsubscribe from an MQTT topic.

bool	publish (const MQTTMessage &message)
	Publish a MQTTMessage.

bool	publish (const std::string &topic, const std::string &payload, uint8_t qos=0, bool retain=false)
	Publish a MQTT message.

bool	publish (const std::string &topic, const char *payload, size_t payload_length, uint8_t qos=0, bool retain=false)

bool	publish (const char topic, const char payload, size_t payload_length, uint8_t qos=0, bool retain=false)
	Publish directly without creating MQTTMessage (avoids heap allocation for topic)

bool	publish_json (const std::string &topic, const json::json_build_t &f, uint8_t qos=0, bool retain=false)
	Construct and send a JSON MQTT message.

bool	publish_json (const char *topic, const json::json_build_t &f, uint8_t qos=0, bool retain=false)
	Publish JSON directly without heap allocation for topic.

void	setup () override
	Setup the MQTT client, registering a bunch of callbacks and attempting to connect.

void	dump_config () override

void	loop () override
	Reconnect if required.

float	get_setup_priority () const override
	MQTT client setup priority.

void	on_log (uint8_t level, const char tag, const char message, size_t message_len) override

void	on_message (const std::string &topic, const std::string &payload)

bool	can_proceed () override

void	check_connected ()

void	set_reboot_timeout (uint32_t reboot_timeout)

void	register_mqtt_component (MQTTComponent *component)

bool	is_connected ()

void	set_enable_on_boot (bool enable_on_boot)

void	enable ()

void	disable ()

void	on_shutdown () override

void	set_broker_address (const std::string &address)

void	set_broker_port (uint16_t port)

void	set_username (const std::string &username)

void	set_password (const std::string &password)

void	set_client_id (const std::string &client_id)

void	set_clean_session (const bool &clean_session)

void	set_on_connect (mqtt_on_connect_callback_t &&callback)

void	set_on_disconnect (mqtt_on_disconnect_callback_t &&callback)

void	set_publish_nan_as_none (bool publish_nan_as_none)

bool	is_publish_nan_as_none () const

void	set_wait_for_connection (bool wait_for_connection)

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.

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

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)

Public Member Functions inherited from esphome::logger::LogListener

Protected Member Functions
void	send_device_info_ ()

void	start_connect_ ()
	Reconnect to the MQTT broker if not already connected.

void	start_dnslookup_ ()

void	check_dnslookup_ ()

void	recalculate_availability_ ()
	Re-calculate the availability property.

bool	subscribe_ (const char *topic, uint8_t qos)

void	resubscribe_subscription_ (MQTTSubscription *sub)

void	resubscribe_subscriptions_ ()

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

virtual void	call_setup ()

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)

Static Protected Member Functions
static void	dns_found_callback (const char name, ip_addr_t ipaddr, void *callback_arg)

static void	dns_found_callback (const char name, const ip_addr_t ipaddr, void *callback_arg)

Protected Attributes
MQTTCredentials	credentials_

MQTTMessage	last_will_
	The last will message.

MQTTMessage	birth_message_
	The birth message (e.g.

bool	sent_birth_message_ {false}

MQTTMessage	shutdown_message_

Availability	availability_ {}
	Caches availability.

MQTTDiscoveryInfo	discovery_info_
	The discovery info options for Home Assistant.

std::string	topic_prefix_ {}

MQTTMessage	log_message_

std::string	payload_buffer_

int	log_level_ {ESPHOME_LOG_LEVEL}

std::vector< MQTTSubscription >	subscriptions_

MQTTBackendESP32	mqtt_backend_

MQTTBackendESP8266	mqtt_backend_

MQTTBackendLibreTiny	mqtt_backend_

MQTTClientState	state_ {MQTT_CLIENT_DISABLED}

network::IPAddress	ip_

bool	dns_resolved_ {false}

bool	dns_resolve_error_ {false}

bool	enable_on_boot_ {true}

std::vector< MQTTComponent * >	children_

uint32_t	reboot_timeout_ {300000}

uint32_t	connect_begin_

uint32_t	last_connected_ {0}

optional< MQTTClientDisconnectReason >	disconnect_reason_ {}

CallbackManager< MQTTBackend::on_disconnect_callback_t >	on_disconnect_

bool	publish_nan_as_none_ {false}

bool	wait_for_connection_ {false}

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

Definition at line 102 of file mqtt_client.h.

Constructor & Destructor Documentation

◆ MQTTClientComponent()

esphome::mqtt::MQTTClientComponent::MQTTClientComponent ( )

Member Function Documentation

◆ add_ssl_fingerprint()

void esphome::mqtt::MQTTClientComponent::add_ssl_fingerprint ( const std::array< uint8_t, SHA1_SIZE > & fingerprint )

Add a SSL fingerprint to use for TCP SSL connections to the MQTT broker.

To use this feature you first have to globally enable the ASYNC_TCP_SSL_ENABLED define flag. This function can be called multiple times and any certificate that matches any of the provided fingerprints will match. Calling this method will also automatically disable all non-ssl connections.

Warning: This is not secure and not how SSL is usually done. You'll have to add a separate fingerprint for every certificate you use. Additionally, the hashing algorithm used here due to the constraints of the MCU, SHA1, is known to be insecure.

Parameters

fingerprint The SSL fingerprint as a 20 value long std::array.

◆ can_proceed()

bool esphome::mqtt::MQTTClientComponent::can_proceed ( )

overridevirtual

Reimplemented from esphome::Component.

◆ check_connected()

void esphome::mqtt::MQTTClientComponent::check_connected ( )

◆ check_dnslookup_()

void esphome::mqtt::MQTTClientComponent::check_dnslookup_ ( )

protected

◆ disable()

void esphome::mqtt::MQTTClientComponent::disable ( )

◆ disable_birth_message()

void esphome::mqtt::MQTTClientComponent::disable_birth_message ( )

Remove the birth message.

◆ disable_discovery()

void esphome::mqtt::MQTTClientComponent::disable_discovery ( )

Globally disable Home Assistant discovery.

◆ disable_last_will()

void esphome::mqtt::MQTTClientComponent::disable_last_will ( )

Remove the last will testament message.

◆ disable_log_message()

void esphome::mqtt::MQTTClientComponent::disable_log_message ( )

Get the topic used for logging. Defaults to "<topic_prefix>/debug" and the value is cached for speed.

◆ disable_shutdown_message()

void esphome::mqtt::MQTTClientComponent::disable_shutdown_message ( )

◆ dns_found_callback() [1/2]

static void esphome::mqtt::MQTTClientComponent::dns_found_callback	(	const char *	name,
		const ip_addr_t *	ipaddr,
		void *	callback_arg )

staticprotected

◆ dns_found_callback() [2/2]

static void esphome::mqtt::MQTTClientComponent::dns_found_callback	(	const char *	name,
		ip_addr_t *	ipaddr,
		void *	callback_arg )

staticprotected

◆ dump_config()

void esphome::mqtt::MQTTClientComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

◆ enable()

void esphome::mqtt::MQTTClientComponent::enable ( )

◆ get_availability()

const Availability & esphome::mqtt::MQTTClientComponent::get_availability ( )

◆ get_discovery_info()

const MQTTDiscoveryInfo & esphome::mqtt::MQTTClientComponent::get_discovery_info ( ) const

Get Home Assistant discovery info.

◆ get_setup_priority()

float esphome::mqtt::MQTTClientComponent::get_setup_priority ( ) const

overridevirtual

MQTT client setup priority.

Reimplemented from esphome::Component.

◆ get_topic_prefix()

const std::string & esphome::mqtt::MQTTClientComponent::get_topic_prefix ( ) const

Get the topic prefix of this device, using default if necessary.

◆ is_connected()

bool esphome::mqtt::MQTTClientComponent::is_connected ( )

◆ is_discovery_enabled()

bool esphome::mqtt::MQTTClientComponent::is_discovery_enabled ( ) const

◆ is_discovery_ip_enabled()

bool esphome::mqtt::MQTTClientComponent::is_discovery_ip_enabled ( ) const

◆ is_log_message_enabled()

bool esphome::mqtt::MQTTClientComponent::is_log_message_enabled ( ) const

◆ is_publish_nan_as_none()

bool esphome::mqtt::MQTTClientComponent::is_publish_nan_as_none ( ) const

◆ loop()

void esphome::mqtt::MQTTClientComponent::loop ( )

overridevirtual

Reconnect if required.

Reimplemented from esphome::Component.

◆ on_log()

void esphome::mqtt::MQTTClientComponent::on_log	(	uint8_t	level,
		const char *	tag,
		const char *	message,
		size_t	message_len )

overridevirtual

Implements esphome::logger::LogListener.

◆ on_message()

void esphome::mqtt::MQTTClientComponent::on_message	(	const std::string &	topic,
		const std::string &	payload )

◆ on_shutdown()

void esphome::mqtt::MQTTClientComponent::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

◆ publish() [1/4]

bool esphome::mqtt::MQTTClientComponent::publish	(	const char *	topic,
		const char *	payload,
		size_t	payload_length,
		uint8_t	qos = 0,
		bool	retain = false )

Publish directly without creating MQTTMessage (avoids heap allocation for topic)

◆ publish() [2/4]

bool esphome::mqtt::MQTTClientComponent::publish ( const MQTTMessage & message )

Publish a MQTTMessage.

Parameters

message The message.

◆ publish() [3/4]

bool esphome::mqtt::MQTTClientComponent::publish	(	const std::string &	topic,
		const char *	payload,
		size_t	payload_length,
		uint8_t	qos = 0,
		bool	retain = false )

◆ publish() [4/4]

bool esphome::mqtt::MQTTClientComponent::publish	(	const std::string &	topic,
		const std::string &	payload,
		uint8_t	qos = 0,
		bool	retain = false )

Publish a MQTT message.

Parameters

topic	The topic.
payload	The payload.
retain	Whether to retain the message.

◆ publish_json() [1/2]

bool esphome::mqtt::MQTTClientComponent::publish_json	(	const char *	topic,
		const json::json_build_t &	f,
		uint8_t	qos = 0,
		bool	retain = false )

Publish JSON directly without heap allocation for topic.

◆ publish_json() [2/2]

bool esphome::mqtt::MQTTClientComponent::publish_json	(	const std::string &	topic,
		const json::json_build_t &	f,
		uint8_t	qos = 0,
		bool	retain = false )

Construct and send a JSON MQTT message.

Parameters

topic	The topic.
f	The Json Message builder.
retain	Whether to retain the message.

◆ recalculate_availability_()

void esphome::mqtt::MQTTClientComponent::recalculate_availability_ ( )

protected

Re-calculate the availability property.

◆ register_mqtt_component()

void esphome::mqtt::MQTTClientComponent::register_mqtt_component ( MQTTComponent * component )

◆ resubscribe_subscription_()

void esphome::mqtt::MQTTClientComponent::resubscribe_subscription_ ( MQTTSubscription * sub )

protected

◆ resubscribe_subscriptions_()

void esphome::mqtt::MQTTClientComponent::resubscribe_subscriptions_ ( )

protected

◆ send_device_info_()

void esphome::mqtt::MQTTClientComponent::send_device_info_ ( )

protected

◆ set_birth_message()

void esphome::mqtt::MQTTClientComponent::set_birth_message ( MQTTMessage && message )

Set the birth message.

◆ set_broker_address()

void esphome::mqtt::MQTTClientComponent::set_broker_address ( const std::string & address )

inline

Definition at line 275 of file mqtt_client.h.

◆ set_broker_port()

void esphome::mqtt::MQTTClientComponent::set_broker_port ( uint16_t port )

inline

Definition at line 276 of file mqtt_client.h.

◆ set_ca_certificate()

void esphome::mqtt::MQTTClientComponent::set_ca_certificate ( const char * cert )

inline

Definition at line 161 of file mqtt_client.h.

◆ set_cl_certificate()

void esphome::mqtt::MQTTClientComponent::set_cl_certificate ( const char * cert )

inline

Definition at line 162 of file mqtt_client.h.

◆ set_cl_key()

void esphome::mqtt::MQTTClientComponent::set_cl_key ( const char * key )

inline

Definition at line 163 of file mqtt_client.h.

◆ set_clean_session()

void esphome::mqtt::MQTTClientComponent::set_clean_session ( const bool & clean_session )

inline

Definition at line 280 of file mqtt_client.h.

◆ set_client_id()

void esphome::mqtt::MQTTClientComponent::set_client_id ( const std::string & client_id )

inline

Definition at line 279 of file mqtt_client.h.

◆ set_discovery_info()

void esphome::mqtt::MQTTClientComponent::set_discovery_info	(	std::string &&	prefix,
		MQTTDiscoveryUniqueIdGenerator	unique_id_generator,
		MQTTDiscoveryObjectIdGenerator	object_id_generator,
		bool	retain,
		bool	discover_ip,
		bool	clean = false )

Set the Home Assistant discovery info.

See MQTT Discovery.

Parameters

prefix	The Home Assistant discovery prefix.
unique_id_generator	Controls how UniqueId is generated.
object_id_generator	Controls how ObjectId is generated.
retain	Whether to retain discovery messages.

◆ set_enable_on_boot()

void esphome::mqtt::MQTTClientComponent::set_enable_on_boot ( bool enable_on_boot )

inline

Definition at line 269 of file mqtt_client.h.

◆ set_keep_alive()

void esphome::mqtt::MQTTClientComponent::set_keep_alive ( uint16_t keep_alive_s )

Set the keep alive time in seconds, every 0.7*keep_alive a ping will be sent.

◆ set_last_will()

void esphome::mqtt::MQTTClientComponent::set_last_will ( MQTTMessage && message )

Set the last will testament message.

◆ set_log_level()

void esphome::mqtt::MQTTClientComponent::set_log_level ( int level )

◆ set_log_message_template()

void esphome::mqtt::MQTTClientComponent::set_log_message_template ( MQTTMessage && message )

Manually set the topic used for logging.

◆ set_on_connect()

void esphome::mqtt::MQTTClientComponent::set_on_connect ( mqtt_on_connect_callback_t && callback )

◆ set_on_disconnect()

void esphome::mqtt::MQTTClientComponent::set_on_disconnect ( mqtt_on_disconnect_callback_t && callback )

◆ set_password()

void esphome::mqtt::MQTTClientComponent::set_password ( const std::string & password )

inline

Definition at line 278 of file mqtt_client.h.

◆ set_publish_nan_as_none()

void esphome::mqtt::MQTTClientComponent::set_publish_nan_as_none ( bool publish_nan_as_none )

◆ set_reboot_timeout()

void esphome::mqtt::MQTTClientComponent::set_reboot_timeout ( uint32_t reboot_timeout )

◆ set_shutdown_message()

void esphome::mqtt::MQTTClientComponent::set_shutdown_message ( MQTTMessage && message )

◆ set_skip_cert_cn_check()

void esphome::mqtt::MQTTClientComponent::set_skip_cert_cn_check ( bool skip_check )

inline

Definition at line 164 of file mqtt_client.h.

◆ set_topic_prefix()

void esphome::mqtt::MQTTClientComponent::set_topic_prefix	(	const std::string &	topic_prefix,
		const std::string &	check_topic_prefix )

Set the topic prefix that will be prepended to all topics together with "/".

This will, in most cases, be the name of your Application.

For example, if "livingroom" is passed to this method, all state topics will, by default, look like "livingroom/.../state"

Parameters

topic_prefix The topic prefix. The last "/" is appended automatically.

◆ set_username()

void esphome::mqtt::MQTTClientComponent::set_username ( const std::string & username )

inline

Definition at line 277 of file mqtt_client.h.

◆ set_wait_for_connection()

void esphome::mqtt::MQTTClientComponent::set_wait_for_connection ( bool wait_for_connection )

inline

Definition at line 288 of file mqtt_client.h.

◆ setup()

void esphome::mqtt::MQTTClientComponent::setup ( )

overridevirtual

Setup the MQTT client, registering a bunch of callbacks and attempting to connect.

Reimplemented from esphome::Component.

◆ start_connect_()

void esphome::mqtt::MQTTClientComponent::start_connect_ ( )

protected

Reconnect to the MQTT broker if not already connected.

◆ start_dnslookup_()

void esphome::mqtt::MQTTClientComponent::start_dnslookup_ ( )

protected

◆ subscribe()

void esphome::mqtt::MQTTClientComponent::subscribe	(	const std::string &	topic,
		mqtt_callback_t	callback,
		uint8_t	qos = 0 )

Subscribe to an MQTT topic and call callback when a message is received.

Parameters

topic	The topic. Wildcards are currently not supported.
callback	The callback function.
qos	The QoS of this subscription.

◆ subscribe_()

bool esphome::mqtt::MQTTClientComponent::subscribe_	(	const char *	topic,
		uint8_t	qos )

protected

◆ subscribe_json()

void esphome::mqtt::MQTTClientComponent::subscribe_json	(	const std::string &	topic,
		const mqtt_json_callback_t &	callback,
		uint8_t	qos = 0 )

Subscribe to a MQTT topic and automatically parse JSON payload.

If an invalid JSON payload is received, the callback will not be called.

Parameters

topic	The topic. Wildcards are currently not supported.
callback	The callback with a parsed JsonObject that will be called when a message with matching topic is received.
qos	The QoS of this subscription.

◆ unsubscribe()

void esphome::mqtt::MQTTClientComponent::unsubscribe ( const std::string & topic )

Unsubscribe from an MQTT topic.

If multiple existing subscriptions to the same topic exist, all of them will be removed.

Parameters

topic The topic to unsubscribe from. Must match the topic in the original subscribe or subscribe_json call exactly.

Field Documentation

◆ availability_

Availability esphome::mqtt::MQTTClientComponent::availability_ {}

protected

Caches availability.

Definition at line 320 of file mqtt_client.h.

◆ birth_message_

MQTTMessage esphome::mqtt::MQTTClientComponent::birth_message_

protected

The birth message (e.g.

the message that's send on an established connection. See last_will_ for what different values denote.

Definition at line 316 of file mqtt_client.h.

◆ children_

std::vector<MQTTComponent *> esphome::mqtt::MQTTClientComponent::children_

protected

Definition at line 350 of file mqtt_client.h.

◆ connect_begin_

uint32_t esphome::mqtt::MQTTClientComponent::connect_begin_

protected

Definition at line 352 of file mqtt_client.h.

◆ credentials_

MQTTCredentials esphome::mqtt::MQTTClientComponent::credentials_

protected

Definition at line 310 of file mqtt_client.h.

◆ disconnect_reason_

optional<MQTTClientDisconnectReason> esphome::mqtt::MQTTClientComponent::disconnect_reason_ {}

protected

Definition at line 354 of file mqtt_client.h.

◆ discovery_info_

MQTTDiscoveryInfo esphome::mqtt::MQTTClientComponent::discovery_info_

protected

Initial value:

{
      .prefix = "homeassistant",
      .retain = true,
      .discover_ip = true,
      .clean = false,
      .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR,
      .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR,
  }

The discovery info options for Home Assistant.

Undefined optional means default and empty prefix means disabled.

Definition at line 323 of file mqtt_client.h.

◆ dns_resolve_error_

bool esphome::mqtt::MQTTClientComponent::dns_resolve_error_ {false}

protected

Definition at line 348 of file mqtt_client.h.

◆ dns_resolved_

bool esphome::mqtt::MQTTClientComponent::dns_resolved_ {false}

protected

Definition at line 347 of file mqtt_client.h.

◆ enable_on_boot_

bool esphome::mqtt::MQTTClientComponent::enable_on_boot_ {true}

protected

Definition at line 349 of file mqtt_client.h.

◆ ip_

network::IPAddress esphome::mqtt::MQTTClientComponent::ip_

protected

Definition at line 346 of file mqtt_client.h.

◆ last_connected_

uint32_t esphome::mqtt::MQTTClientComponent::last_connected_ {0}

protected

Definition at line 353 of file mqtt_client.h.

◆ last_will_

MQTTMessage esphome::mqtt::MQTTClientComponent::last_will_

protected

The last will message.

Disabled optional denotes it being default and an empty topic denotes the the feature being disabled.

Definition at line 313 of file mqtt_client.h.

◆ log_level_

int esphome::mqtt::MQTTClientComponent::log_level_ {ESPHOME_LOG_LEVEL}

protected

Definition at line 334 of file mqtt_client.h.

◆ log_message_

MQTTMessage esphome::mqtt::MQTTClientComponent::log_message_

protected

Definition at line 332 of file mqtt_client.h.

◆ mqtt_backend_ [1/3]

MQTTBackendESP32 esphome::mqtt::MQTTClientComponent::mqtt_backend_

protected

Definition at line 338 of file mqtt_client.h.

◆ mqtt_backend_ [2/3]

MQTTBackendESP8266 esphome::mqtt::MQTTClientComponent::mqtt_backend_

protected

Definition at line 340 of file mqtt_client.h.

◆ mqtt_backend_ [3/3]

MQTTBackendLibreTiny esphome::mqtt::MQTTClientComponent::mqtt_backend_

protected

Definition at line 342 of file mqtt_client.h.

◆ on_disconnect_

CallbackManager<MQTTBackend::on_disconnect_callback_t> esphome::mqtt::MQTTClientComponent::on_disconnect_

protected

Definition at line 355 of file mqtt_client.h.

◆ payload_buffer_

std::string esphome::mqtt::MQTTClientComponent::payload_buffer_

protected

Definition at line 333 of file mqtt_client.h.

◆ publish_nan_as_none_

bool esphome::mqtt::MQTTClientComponent::publish_nan_as_none_ {false}

protected

Definition at line 357 of file mqtt_client.h.

◆ reboot_timeout_

uint32_t esphome::mqtt::MQTTClientComponent::reboot_timeout_ {300000}

protected

Definition at line 351 of file mqtt_client.h.

◆ sent_birth_message_

bool esphome::mqtt::MQTTClientComponent::sent_birth_message_ {false}

protected

Definition at line 317 of file mqtt_client.h.

◆ shutdown_message_

MQTTMessage esphome::mqtt::MQTTClientComponent::shutdown_message_

protected

Definition at line 318 of file mqtt_client.h.

◆ state_

MQTTClientState esphome::mqtt::MQTTClientComponent::state_ {MQTT_CLIENT_DISABLED}

protected

Definition at line 345 of file mqtt_client.h.

◆ subscriptions_

std::vector<MQTTSubscription> esphome::mqtt::MQTTClientComponent::subscriptions_

protected

Definition at line 336 of file mqtt_client.h.

◆ topic_prefix_

std::string esphome::mqtt::MQTTClientComponent::topic_prefix_ {}

protected

Definition at line 331 of file mqtt_client.h.

◆ wait_for_connection_

bool esphome::mqtt::MQTTClientComponent::wait_for_connection_ {false}

protected

Definition at line 358 of file mqtt_client.h.

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

esphome/components/mqtt/mqtt_client.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MQTTClientComponent()

Member Function Documentation

◆ add_ssl_fingerprint()

◆ can_proceed()

◆ check_connected()

◆ check_dnslookup_()

◆ disable()

◆ disable_birth_message()

◆ disable_discovery()

◆ disable_last_will()

◆ disable_log_message()

◆ disable_shutdown_message()

◆ dns_found_callback() [1/2]

◆ dns_found_callback() [2/2]

◆ dump_config()

◆ enable()

◆ get_availability()

◆ get_discovery_info()

◆ get_setup_priority()

◆ get_topic_prefix()

◆ is_connected()

◆ is_discovery_enabled()

◆ is_discovery_ip_enabled()

◆ is_log_message_enabled()

◆ is_publish_nan_as_none()

◆ loop()

◆ on_log()

◆ on_message()

◆ on_shutdown()

◆ publish() [1/4]

◆ publish() [2/4]

◆ publish() [3/4]

◆ publish() [4/4]

◆ publish_json() [1/2]

◆ publish_json() [2/2]

◆ recalculate_availability_()

◆ register_mqtt_component()

◆ resubscribe_subscription_()

◆ resubscribe_subscriptions_()

◆ send_device_info_()

◆ set_birth_message()

◆ set_broker_address()

◆ set_broker_port()

◆ set_ca_certificate()

◆ set_cl_certificate()

◆ set_cl_key()

◆ set_clean_session()

◆ set_client_id()

◆ set_discovery_info()

◆ set_enable_on_boot()

◆ set_keep_alive()

◆ set_last_will()

◆ set_log_level()

◆ set_log_message_template()

◆ set_on_connect()

◆ set_on_disconnect()

◆ set_password()

◆ set_publish_nan_as_none()

◆ set_reboot_timeout()

◆ set_shutdown_message()

◆ set_skip_cert_cn_check()

◆ set_topic_prefix()

◆ set_username()

◆ set_wait_for_connection()

◆ setup()

◆ start_connect_()

◆ start_dnslookup_()

◆ subscribe()

◆ subscribe_()

◆ subscribe_json()

◆ unsubscribe()

Field Documentation

◆ availability_

◆ birth_message_