ESPHome 2026.2.4
Loading...
Searching...
No Matches
mqtt_client.cpp
Go to the documentation of this file.
1#include "mqtt_client.h"
2
3#ifdef USE_MQTT
4
5#include <utility>
10#include "esphome/core/log.h"
13#ifdef USE_LOGGER
15#endif
16#include "lwip/dns.h"
17#include "lwip/err.h"
18#include "mqtt_component.h"
19
20#ifdef USE_API
22#endif
23#ifdef USE_DASHBOARD_IMPORT
25#endif
26
27namespace esphome::mqtt {
28
29static const char *const TAG = "mqtt";
30
31// Disconnect reason strings indexed by MQTTClientDisconnectReason enum (0-8)
32PROGMEM_STRING_TABLE(MQTTDisconnectReasonStrings, "TCP disconnected", "Unacceptable Protocol Version",
33 "Identifier Rejected", "Server Unavailable", "Malformed Credentials", "Not Authorized",
34 "Not Enough Space", "TLS Bad Fingerprint", "DNS Resolve Error", "Unknown");
35
37 global_mqtt_client = this;
38 char mac_addr[MAC_ADDRESS_BUFFER_SIZE];
40 this->credentials_.client_id = make_name_with_suffix(App.get_name(), '-', mac_addr, MAC_ADDRESS_BUFFER_SIZE - 1);
41}
42
43// Connection
46 [this](const char *topic, const char *payload, size_t len, size_t index, size_t total) {
47 if (index == 0)
48 this->payload_buffer_.reserve(total);
49
50 // append new payload, may contain incomplete MQTT message
51 this->payload_buffer_.append(payload, len);
52
53 // MQTT fully received
54 if (len + index == total) {
55 this->on_message(topic, this->payload_buffer_);
56 this->payload_buffer_.clear();
57 }
58 });
60 if (this->state_ == MQTT_CLIENT_DISABLED)
61 return;
63 this->disconnect_reason_ = reason;
64 });
65#ifdef USE_LOGGER
66 if (this->is_log_message_enabled() && logger::global_logger != nullptr) {
68 }
69#endif
70
71 if (this->is_discovery_ip_enabled()) {
72 this->subscribe(
73 "esphome/discover", [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); },
74 2);
75
76 // Format topic on stack - subscribe() copies it
77 // "esphome/ping/" (13) + name (ESPHOME_DEVICE_NAME_MAX_LEN) + null (1)
78 constexpr size_t ping_topic_buffer_size = 13 + ESPHOME_DEVICE_NAME_MAX_LEN + 1;
79 char ping_topic[ping_topic_buffer_size];
80 buf_append_printf(ping_topic, sizeof(ping_topic), 0, "esphome/ping/%s", App.get_name().c_str());
81 this->subscribe(
82 ping_topic, [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); }, 2);
83 }
84
85 if (this->enable_on_boot_) {
86 this->enable();
87 }
88}
89
91 if (!this->is_connected() or !this->is_discovery_ip_enabled()) {
92 return;
93 }
94 // Format topic on stack to avoid heap allocation
95 // "esphome/discover/" (17) + name (ESPHOME_DEVICE_NAME_MAX_LEN) + null (1)
96 constexpr size_t topic_buffer_size = 17 + ESPHOME_DEVICE_NAME_MAX_LEN + 1;
97 char topic[topic_buffer_size];
98 buf_append_printf(topic, sizeof(topic), 0, "esphome/discover/%s", App.get_name().c_str());
99
100 // NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks) false positive with ArduinoJson
101 this->publish_json(
102 topic,
103 [](JsonObject root) {
104 uint8_t index = 0;
105 for (auto &ip : network::get_ip_addresses()) {
106 if (ip.is_set()) {
107 char key[8]; // "ip" + up to 3 digits + null
108 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
109 if (index == 0) {
110 key[0] = 'i';
111 key[1] = 'p';
112 key[2] = '\0';
113 } else {
114 buf_append_printf(key, sizeof(key), 0, "ip%u", index);
115 }
116 ip.str_to(ip_buf);
117 root[key] = ip_buf;
118 index++;
119 }
120 }
121 root[ESPHOME_F("name")] = App.get_name();
122 if (!App.get_friendly_name().empty()) {
123 root[ESPHOME_F("friendly_name")] = App.get_friendly_name();
124 }
125#ifdef USE_API
126 root[ESPHOME_F("port")] = api::global_api_server->get_port();
127#endif
128 root[ESPHOME_F("version")] = ESPHOME_VERSION;
129 char mac_buf[MAC_ADDRESS_BUFFER_SIZE];
131 root[ESPHOME_F("mac")] = mac_buf;
132
133#ifdef USE_ESP8266
134 root[ESPHOME_F("platform")] = ESPHOME_F("ESP8266");
135#endif
136#ifdef USE_ESP32
137 root[ESPHOME_F("platform")] = ESPHOME_F("ESP32");
138#endif
139#ifdef USE_LIBRETINY
140 root[ESPHOME_F("platform")] = lt_cpu_get_model_name();
141#endif
142
143 root[ESPHOME_F("board")] = ESPHOME_BOARD;
144#if defined(USE_WIFI)
145 root[ESPHOME_F("network")] = ESPHOME_F("wifi");
146#elif defined(USE_ETHERNET)
147 root[ESPHOME_F("network")] = ESPHOME_F("ethernet");
148#endif
149
150#ifdef ESPHOME_PROJECT_NAME
151 root[ESPHOME_F("project_name")] = ESPHOME_PROJECT_NAME;
152 root[ESPHOME_F("project_version")] = ESPHOME_PROJECT_VERSION;
153#endif // ESPHOME_PROJECT_NAME
154
155#ifdef USE_DASHBOARD_IMPORT
156 root[ESPHOME_F("package_import_url")] = dashboard_import::get_package_import_url();
157#endif
158
159#ifdef USE_API_NOISE
160 root[api::global_api_server->get_noise_ctx().has_psk() ? ESPHOME_F("api_encryption")
161 : ESPHOME_F("api_encryption_supported")] =
162 ESPHOME_F("Noise_NNpsk0_25519_ChaChaPoly_SHA256");
163#endif
164 },
165 2, this->discovery_info_.retain);
166 // NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks)
167}
168
169#ifdef USE_LOGGER
170void MQTTClientComponent::on_log(uint8_t level, const char *tag, const char *message, size_t message_len) {
171 (void) tag;
172 if (level <= this->log_level_ && this->is_connected()) {
173 this->publish(this->log_message_.topic.c_str(), message, message_len, this->log_message_.qos,
174 this->log_message_.retain);
175 }
176}
177#endif
178
180 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
181 // clang-format off
182 ESP_LOGCONFIG(TAG,
183 "MQTT:\n"
184 " Server Address: %s:%u (%s)\n"
185 " Username: " LOG_SECRET("'%s'") "\n"
186 " Client ID: " LOG_SECRET("'%s'") "\n"
187 " Clean Session: %s",
188 this->credentials_.address.c_str(), this->credentials_.port, this->ip_.str_to(ip_buf),
189 this->credentials_.username.c_str(), this->credentials_.client_id.c_str(),
190 YESNO(this->credentials_.clean_session));
191 // clang-format on
192 if (this->is_discovery_ip_enabled()) {
193 ESP_LOGCONFIG(TAG, " Discovery IP enabled");
194 }
195 if (!this->discovery_info_.prefix.empty()) {
196 ESP_LOGCONFIG(TAG,
197 " Discovery prefix: '%s'\n"
198 " Discovery retain: %s",
199 this->discovery_info_.prefix.c_str(), YESNO(this->discovery_info_.retain));
200 }
201 ESP_LOGCONFIG(TAG, " Topic Prefix: '%s'", this->topic_prefix_.c_str());
202 if (!this->log_message_.topic.empty()) {
203 ESP_LOGCONFIG(TAG, " Log Topic: '%s'", this->log_message_.topic.c_str());
204 }
205 if (!this->availability_.topic.empty()) {
206 ESP_LOGCONFIG(TAG, " Availability: '%s'", this->availability_.topic.c_str());
207 }
208}
210 return network::is_disabled() || this->state_ == MQTT_CLIENT_DISABLED || this->is_connected() ||
212}
213
215 for (auto &subscription : this->subscriptions_) {
216 subscription.subscribed = false;
217 subscription.resubscribe_timeout = 0;
218 }
219
220 this->status_set_warning();
221 this->dns_resolve_error_ = false;
222 this->dns_resolved_ = false;
223 ip_addr_t addr;
224 err_t err;
225 {
226 LwIPLock lock;
227#if USE_NETWORK_IPV6
228 err = dns_gethostbyname_addrtype(this->credentials_.address.c_str(), &addr, MQTTClientComponent::dns_found_callback,
229 this, LWIP_DNS_ADDRTYPE_IPV6_IPV4);
230#else
231 err = dns_gethostbyname_addrtype(this->credentials_.address.c_str(), &addr, MQTTClientComponent::dns_found_callback,
232 this, LWIP_DNS_ADDRTYPE_IPV4);
233#endif /* USE_NETWORK_IPV6 */
234 }
235 switch (err) {
236 case ERR_OK: {
237 // Got IP immediately
238 this->dns_resolved_ = true;
239 this->ip_ = network::IPAddress(&addr);
240 this->start_connect_();
241 return;
242 }
243 case ERR_INPROGRESS: {
244 // wait for callback
245 ESP_LOGD(TAG, "Resolving broker IP address");
246 break;
247 }
248 default:
249 case ERR_ARG: {
250 // error
251 ESP_LOGW(TAG, "Error resolving broker IP address: %d", err);
252 break;
253 }
254 }
255
257 this->connect_begin_ = millis();
258}
260 if (!this->dns_resolved_ && millis() - this->connect_begin_ > 20000) {
261 this->dns_resolve_error_ = true;
262 }
263
264 if (this->dns_resolve_error_) {
265 ESP_LOGW(TAG, "Couldn't resolve IP address for '%s'", this->credentials_.address.c_str());
269 return;
270 }
271
272 if (!this->dns_resolved_) {
273 return;
274 }
275
276 char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
277 ESP_LOGD(TAG, "Resolved broker IP address to %s", this->ip_.str_to(ip_buf));
278 this->start_connect_();
279}
280#if defined(USE_ESP8266) && LWIP_VERSION_MAJOR == 1
281void MQTTClientComponent::dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg) {
282#else
283void MQTTClientComponent::dns_found_callback(const char *name, const ip_addr_t *ipaddr, void *callback_arg) {
284#endif
285 auto *a_this = (MQTTClientComponent *) callback_arg;
286 if (ipaddr == nullptr) {
287 a_this->dns_resolve_error_ = true;
288 } else {
289 a_this->ip_ = network::IPAddress(ipaddr);
290 a_this->dns_resolved_ = true;
291 }
292}
293
296 return;
297
298 ESP_LOGI(TAG, "Connecting");
299 // Force disconnect first
301
304 const char *username = nullptr;
305 if (!this->credentials_.username.empty())
306 username = this->credentials_.username.c_str();
307 const char *password = nullptr;
308 if (!this->credentials_.password.empty())
309 password = this->credentials_.password.c_str();
310
311 this->mqtt_backend_.set_credentials(username, password);
312
313 this->mqtt_backend_.set_server(this->credentials_.address.c_str(), this->credentials_.port);
314 if (!this->last_will_.topic.empty()) {
315 this->mqtt_backend_.set_will(this->last_will_.topic.c_str(), this->last_will_.qos, this->last_will_.retain,
316 this->last_will_.payload.c_str());
317 }
318
319 this->mqtt_backend_.connect();
321 this->connect_begin_ = millis();
322}
324 return this->state_ == MQTT_CLIENT_CONNECTED && this->mqtt_backend_.connected();
325}
326
328 if (!this->mqtt_backend_.connected()) {
329 if (millis() - this->connect_begin_ > 60000) {
331 this->start_dnslookup_();
332 }
333 return;
334 }
335
337 this->sent_birth_message_ = false;
338 this->status_clear_warning();
339 ESP_LOGI(TAG, "Connected");
340 // MQTT Client needs some time to be fully set up.
341 delay(100); // NOLINT
342
344 this->send_device_info_();
345
346 for (MQTTComponent *component : this->children_)
347 component->schedule_resend_state();
348}
349
351 // Call the backend loop first
353
354 if (this->disconnect_reason_.has_value()) {
355 const LogString *reason_s = MQTTDisconnectReasonStrings::get_log_str(
356 static_cast<uint8_t>(*this->disconnect_reason_), MQTTDisconnectReasonStrings::LAST_INDEX);
357 if (!network::is_connected()) {
358 reason_s = LOG_STR("WiFi disconnected");
359 }
360 ESP_LOGW(TAG, "Disconnected: %s", LOG_STR_ARG(reason_s));
362 }
363
365
366 switch (this->state_) {
368 return; // Return to avoid a reboot when disabled
370 if (now - this->connect_begin_ > 5000) {
371 this->start_dnslookup_();
372 }
373 break;
375 this->check_dnslookup_();
376 break;
378 this->check_connected();
379 break;
381 if (!this->mqtt_backend_.connected()) {
383 ESP_LOGW(TAG, "Lost client connection");
384 this->start_dnslookup_();
385 } else {
386 if (!this->birth_message_.topic.empty() && !this->sent_birth_message_) {
387 this->sent_birth_message_ = this->publish(this->birth_message_);
388 }
389
390 this->last_connected_ = now;
392
393 // Process pending resends for all MQTT components centrally
394 // This is more efficient than each component polling in its own loop
395 for (MQTTComponent *component : this->children_) {
396 component->process_resend();
397 }
398 }
399 break;
400 }
401
402 if (millis() - this->last_connected_ > this->reboot_timeout_ && this->reboot_timeout_ != 0) {
403 ESP_LOGE(TAG, "Can't connect; restarting");
404 App.reboot();
405 }
406}
408
409// Subscribe
410bool MQTTClientComponent::subscribe_(const char *topic, uint8_t qos) {
411 if (!this->is_connected())
412 return false;
413
414 bool ret = this->mqtt_backend_.subscribe(topic, qos);
415 yield();
416
417 if (ret) {
418 ESP_LOGV(TAG, "subscribe(topic='%s')", topic);
419 } else {
420 delay(5);
421 ESP_LOGV(TAG, "Subscribe failed for topic='%s'. Will retry", topic);
422 this->status_momentary_warning("subscribe", 1000);
423 }
424 return ret != 0;
425}
426void MQTTClientComponent::resubscribe_subscription_(MQTTSubscription *sub) {
427 if (sub->subscribed)
428 return;
429
430 const uint32_t now = millis();
431 bool do_resub = sub->resubscribe_timeout == 0 || now - sub->resubscribe_timeout > 1000;
432
433 if (do_resub) {
434 sub->subscribed = this->subscribe_(sub->topic.c_str(), sub->qos);
435 sub->resubscribe_timeout = now;
436 }
437}
439 for (auto &subscription : this->subscriptions_) {
440 this->resubscribe_subscription_(&subscription);
441 }
442}
443
444void MQTTClientComponent::subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos) {
445 MQTTSubscription subscription{
446 .topic = topic,
447 .qos = qos,
448 .callback = std::move(callback),
449 .subscribed = false,
450 .resubscribe_timeout = 0,
451 };
452 this->resubscribe_subscription_(&subscription);
453 this->subscriptions_.push_back(subscription);
454}
455
456void MQTTClientComponent::subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos) {
457 auto f = [callback](const std::string &topic, const std::string &payload) {
458 json::parse_json(payload, [topic, callback](JsonObject root) -> bool {
459 callback(topic, root);
460 return true;
461 });
462 };
463 MQTTSubscription subscription{
464 .topic = topic,
465 .qos = qos,
466 .callback = f,
467 .subscribed = false,
468 .resubscribe_timeout = 0,
469 };
470 this->resubscribe_subscription_(&subscription);
471 this->subscriptions_.push_back(subscription);
472}
473
474void MQTTClientComponent::unsubscribe(const std::string &topic) {
475 bool ret = this->mqtt_backend_.unsubscribe(topic.c_str());
476 yield();
477 if (ret) {
478 ESP_LOGV(TAG, "unsubscribe(topic='%s')", topic.c_str());
479 } else {
480 delay(5);
481 ESP_LOGV(TAG, "Unsubscribe failed for topic='%s'.", topic.c_str());
482 this->status_momentary_warning("unsubscribe", 1000);
483 }
484
485 auto it = subscriptions_.begin();
486 while (it != subscriptions_.end()) {
487 if (it->topic == topic) {
488 it = subscriptions_.erase(it);
489 } else {
490 ++it;
491 }
492 }
493}
494
495// Publish
496bool MQTTClientComponent::publish(const std::string &topic, const std::string &payload, uint8_t qos, bool retain) {
497 return this->publish(topic, payload.data(), payload.size(), qos, retain);
498}
499
500bool MQTTClientComponent::publish(const std::string &topic, const char *payload, size_t payload_length, uint8_t qos,
501 bool retain) {
502 return this->publish(topic.c_str(), payload, payload_length, qos, retain);
503}
504
505bool MQTTClientComponent::publish(const MQTTMessage &message) {
506 return this->publish(message.topic.c_str(), message.payload.c_str(), message.payload.length(), message.qos,
507 message.retain);
508}
509bool MQTTClientComponent::publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos,
510 bool retain) {
511 return this->publish_json(topic.c_str(), f, qos, retain);
512}
513
514bool MQTTClientComponent::publish(const char *topic, const char *payload, size_t payload_length, uint8_t qos,
515 bool retain) {
516 if (!this->is_connected()) {
517 return false;
518 }
519 size_t topic_len = strlen(topic);
520 bool logging_topic = (topic_len == this->log_message_.topic.size()) &&
521 (memcmp(this->log_message_.topic.c_str(), topic, topic_len) == 0);
522 bool ret = this->mqtt_backend_.publish(topic, payload, payload_length, qos, retain);
523 delay(0);
524 if (!ret && !logging_topic && this->is_connected()) {
525 delay(0);
526 ret = this->mqtt_backend_.publish(topic, payload, payload_length, qos, retain);
527 delay(0);
528 }
529
530 if (!logging_topic) {
531 if (ret) {
532 ESP_LOGV(TAG, "Publish(topic='%s' retain=%d qos=%d)", topic, retain, qos);
533 ESP_LOGVV(TAG, "Publish payload (len=%u): '%.*s'", payload_length, static_cast<int>(payload_length), payload);
534 } else {
535 ESP_LOGV(TAG, "Publish failed for topic='%s' (len=%u). Will retry", topic, payload_length);
536 this->status_momentary_warning("publish", 1000);
537 }
538 }
539 return ret != 0;
540}
541
542bool MQTTClientComponent::publish_json(const char *topic, const json::json_build_t &f, uint8_t qos, bool retain) {
543 std::string message = json::build_json(f);
544 return this->publish(topic, message.c_str(), message.length(), qos, retain);
545}
546
548 if (this->state_ != MQTT_CLIENT_DISABLED)
549 return;
550 ESP_LOGD(TAG, "Enabling");
552 this->last_connected_ = millis();
553 this->start_dnslookup_();
554}
555
557 if (this->state_ == MQTT_CLIENT_DISABLED)
558 return;
559 ESP_LOGD(TAG, "Disabling");
561 this->on_shutdown();
562}
563
575static bool topic_match(const char *message, const char *subscription, bool is_normal, bool past_separator) {
576 // Reached end of both strings at the same time, this means we have a successful match
577 if (*message == '\0' && *subscription == '\0')
578 return true;
579
580 // Either the message or the subscribe are at the end. This means they don't match.
581 if (*message == '\0' || *subscription == '\0')
582 return false;
583
584 bool do_wildcards = is_normal || past_separator;
585
586 if (*subscription == '+' && do_wildcards) {
587 // single level wildcard
588 // consume + from subscription
589 subscription++;
590 // consume everything from message until '/' found or end of string
591 while (*message != '\0' && *message != '/') {
592 message++;
593 }
594 // after this, both pointers will point to a '/' or to the end of the string
595
596 return topic_match(message, subscription, is_normal, true);
597 }
598
599 if (*subscription == '#' && do_wildcards) {
600 // multilevel wildcard - MQTT mandates that this must be at end of subscribe topic
601 return true;
602 }
603
604 // this handles '/' and normal characters at the same time.
605 if (*message != *subscription)
606 return false;
607
608 past_separator = past_separator || *subscription == '/';
609
610 // consume characters
611 subscription++;
612 message++;
613
614 return topic_match(message, subscription, is_normal, past_separator);
615}
616
617static bool topic_match(const char *message, const char *subscription) {
618 return topic_match(message, subscription, *message != '\0' && *message != '$', false);
619}
620
621void MQTTClientComponent::on_message(const std::string &topic, const std::string &payload) {
622#ifdef USE_ESP8266
623 // IMPORTANT: This defer is REQUIRED to prevent stack overflow crashes on ESP8266.
624 //
625 // On ESP8266, this callback is invoked directly from the lwIP/AsyncTCP network stack
626 // which runs in the "sys" context with a very limited stack (~4KB). By the time we
627 // reach this function, the stack is already partially consumed by the network
628 // processing chain: tcp_input -> AsyncClient::_recv -> AsyncMqttClient::_onMessage -> here.
629 //
630 // MQTT subscription callbacks can trigger arbitrary user actions (automations, HTTP
631 // requests, sensor updates, etc.) which may have deep call stacks of their own.
632 // For example, an HTTP request action requires: DNS lookup -> TCP connect -> TLS
633 // handshake (if HTTPS) -> request formatting. This easily overflows the remaining
634 // system stack space, causing a LoadStoreAlignmentCause exception or silent corruption.
635 //
636 // By deferring to the main loop, we ensure callbacks execute with a fresh, full-size
637 // stack in the normal application context rather than the constrained network task.
638 //
639 // DO NOT REMOVE THIS DEFER without understanding the above. It may appear to work
640 // in simple tests but will cause crashes with complex automations.
641 this->defer([this, topic, payload]() {
642#endif
643 for (auto &subscription : this->subscriptions_) {
644 if (topic_match(topic.c_str(), subscription.topic.c_str()))
645 subscription.callback(topic, payload);
646 }
647#ifdef USE_ESP8266
648 });
649#endif
650}
651
652// Setters
654bool MQTTClientComponent::is_log_message_enabled() const { return !this->log_message_.topic.empty(); }
655void MQTTClientComponent::set_reboot_timeout(uint32_t reboot_timeout) { this->reboot_timeout_ = reboot_timeout; }
656void MQTTClientComponent::register_mqtt_component(MQTTComponent *component) { this->children_.push_back(component); }
657void MQTTClientComponent::set_log_level(int level) { this->log_level_ = level; }
658void MQTTClientComponent::set_keep_alive(uint16_t keep_alive_s) { this->mqtt_backend_.set_keep_alive(keep_alive_s); }
659void MQTTClientComponent::set_log_message_template(MQTTMessage &&message) { this->log_message_ = std::move(message); }
660const MQTTDiscoveryInfo &MQTTClientComponent::get_discovery_info() const { return this->discovery_info_; }
661void MQTTClientComponent::set_topic_prefix(const std::string &topic_prefix, const std::string &check_topic_prefix) {
662 if (App.is_name_add_mac_suffix_enabled() && (topic_prefix == check_topic_prefix)) {
663 char buf[ESPHOME_DEVICE_NAME_MAX_LEN + 1];
664 this->topic_prefix_ = str_sanitize_to(buf, App.get_name().c_str());
665 } else {
666 this->topic_prefix_ = topic_prefix;
667 }
668}
669const std::string &MQTTClientComponent::get_topic_prefix() const { return this->topic_prefix_; }
670void MQTTClientComponent::set_publish_nan_as_none(bool publish_nan_as_none) {
671 this->publish_nan_as_none_ = publish_nan_as_none;
672}
675 this->birth_message_.topic = "";
677}
679 this->shutdown_message_.topic = "";
681}
682bool MQTTClientComponent::is_discovery_enabled() const { return !this->discovery_info_.prefix.empty(); }
684const Availability &MQTTClientComponent::get_availability() { return this->availability_; }
686 if (this->birth_message_.topic.empty() || this->birth_message_.topic != this->last_will_.topic) {
687 this->availability_.topic = "";
688 return;
689 }
693}
694
696 this->last_will_ = std::move(message);
698}
699
701 this->birth_message_ = std::move(message);
703}
704
705void MQTTClientComponent::set_shutdown_message(MQTTMessage &&message) { this->shutdown_message_ = std::move(message); }
706
707void MQTTClientComponent::set_discovery_info(std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator,
708 MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain,
709 bool discover_ip, bool clean) {
710 this->discovery_info_.prefix = std::move(prefix);
711 this->discovery_info_.discover_ip = discover_ip;
712 this->discovery_info_.unique_id_generator = unique_id_generator;
713 this->discovery_info_.object_id_generator = object_id_generator;
714 this->discovery_info_.retain = retain;
715 this->discovery_info_.clean = clean;
716}
717
719
721 this->discovery_info_ = MQTTDiscoveryInfo{
722 .prefix = "",
723 .retain = false,
724 .discover_ip = false,
725 .clean = false,
726 .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR,
727 .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR,
728 };
729}
731 if (!this->shutdown_message_.topic.empty()) {
732 yield();
733 this->publish(this->shutdown_message_);
734 yield();
735 }
737}
738
740 this->mqtt_backend_.set_on_connect(std::forward<mqtt_on_connect_callback_t>(callback));
741}
742
744 auto callback_copy = callback;
745 this->mqtt_backend_.set_on_disconnect(std::forward<mqtt_on_disconnect_callback_t>(callback));
746 this->on_disconnect_.add(std::move(callback_copy));
747}
748
749MQTTClientComponent *global_mqtt_client = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
750
751// MQTTMessageTrigger
752MQTTMessageTrigger::MQTTMessageTrigger(std::string topic) : topic_(std::move(topic)) {}
753void MQTTMessageTrigger::set_qos(uint8_t qos) { this->qos_ = qos; }
754void MQTTMessageTrigger::set_payload(const std::string &payload) { this->payload_ = payload; }
755void MQTTMessageTrigger::setup() {
757 this->topic_,
758 [this](const std::string &topic, const std::string &payload) {
759 if (this->payload_.has_value() && payload != *this->payload_) {
760 return;
761 }
762
763 this->trigger(payload);
764 },
765 this->qos_);
766}
767void MQTTMessageTrigger::dump_config() {
768 ESP_LOGCONFIG(TAG,
769 "MQTT Message Trigger:\n"
770 " Topic: '%s'\n"
771 " QoS: %u",
772 this->topic_.c_str(), this->qos_);
773}
774float MQTTMessageTrigger::get_setup_priority() const { return setup_priority::AFTER_CONNECTION; }
775
776} // namespace esphome::mqtt
777
778#endif // USE_MQTT
const std::string & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
bool is_name_add_mac_suffix_enabled() const
const std::string & get_name() const
Get the name of this Application set by pre_setup().
uint32_t IRAM_ATTR HOT get_loop_component_start_time() const
Get the cached time in milliseconds from when the current component started its loop execution.
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.
Definition component.h:479
void status_set_warning(const char *message=nullptr)
void status_momentary_warning(const char *name, uint32_t length=5000)
Set warning status flag and automatically clear it after a timeout.
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
Definition component.h:373
void status_clear_warning()
APINoiseContext & get_noise_ctx()
Definition api_server.h:78
uint16_t get_port() const
void add_log_listener(LogListener *listener)
Register a log listener to receive log messages.
Definition logger.h:191
void set_keep_alive(uint16_t keep_alive) final
void set_on_message(std::function< on_message_callback_t > &&callback) final
void set_client_id(const char *client_id) final
void set_on_connect(std::function< on_connect_callback_t > &&callback) final
void set_will(const char *topic, uint8_t qos, bool retain, const char *payload) final
bool subscribe(const char *topic, uint8_t qos) final
void set_server(network::IPAddress ip, uint16_t port) final
bool publish(const char *topic, const char *payload, size_t length, uint8_t qos, bool retain) final
void set_clean_session(bool clean_session) final
bool unsubscribe(const char *topic) final
void set_on_disconnect(std::function< on_disconnect_callback_t > &&callback) final
void set_credentials(const char *username, const char *password) final
void set_birth_message(MQTTMessage &&message)
Set the birth message.
void start_connect_()
Reconnect to the MQTT broker if not already connected.
void setup() override
Setup the MQTT client, registering a bunch of callbacks and attempting to connect.
void disable_discovery()
Globally disable Home Assistant discovery.
void recalculate_availability_()
Re-calculate the availability property.
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.
void set_reboot_timeout(uint32_t reboot_timeout)
float get_setup_priority() const override
MQTT client setup priority.
void disable_log_message()
Get the topic used for logging. Defaults to "<topic_prefix>/debug" and the value is cached for speed.
const std::string & get_topic_prefix() const
Get the topic prefix of this device, using default if necessary.
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 register_mqtt_component(MQTTComponent *component)
void set_last_will(MQTTMessage &&message)
Set the last will testament message.
bool publish(const MQTTMessage &message)
Publish a MQTTMessage.
const MQTTDiscoveryInfo & get_discovery_info() const
Get Home Assistant discovery info.
void disable_birth_message()
Remove the birth message.
static void dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg)
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.
MQTTMessage last_will_
The last will message.
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 "/".
void set_shutdown_message(MQTTMessage &&message)
MQTTMessage birth_message_
The birth message (e.g.
std::vector< MQTTComponent * > children_
void set_on_connect(mqtt_on_connect_callback_t &&callback)
optional< MQTTClientDisconnectReason > disconnect_reason_
void unsubscribe(const std::string &topic)
Unsubscribe from an MQTT topic.
void on_log(uint8_t level, const char *tag, const char *message, size_t message_len) override
void set_publish_nan_as_none(bool publish_nan_as_none)
void on_message(const std::string &topic, const std::string &payload)
void set_log_message_template(MQTTMessage &&message)
Manually set the topic used for logging.
void resubscribe_subscription_(MQTTSubscription *sub)
void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback)
bool subscribe_(const char *topic, uint8_t qos)
const Availability & get_availability()
std::vector< MQTTSubscription > subscriptions_
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.
void disable_last_will()
Remove the last will testament 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 loop() override
Reconnect if required.
MQTTDiscoveryInfo discovery_info_
The discovery info options for Home Assistant.
CallbackManager< MQTTBackend::on_disconnect_callback_t > on_disconnect_
Availability availability_
Caches availability.
MQTTMessageTrigger(std::string topic)
bool has_value() const
Definition optional.h:92
const Component * component
Definition component.cpp:37
const char * message
Definition component.cpp:38
in_addr ip_addr_t
Definition ip_address.h:22
PROGMEM_STRING_TABLE(AlarmControlPanelStateStrings, "DISARMED", "ARMED_HOME", "ARMED_AWAY", "ARMED_NIGHT", "ARMED_VACATION", "ARMED_CUSTOM_BYPASS", "PENDING", "ARMING", "DISARMING", "TRIGGERED", "UNKNOWN")
APIServer * global_api_server
const char * get_package_import_url()
std::function< void(JsonObject)> json_build_t
Callback function typedef for building JsonObjects.
Definition json_util.h:46
bool parse_json(const std::string &data, const json_parse_t &f)
Parse a JSON string and run the provided json parse function if it's valid.
Definition json_util.cpp:27
std::string build_json(const json_build_t &f)
Build a JSON string with the provided json build function.
Definition json_util.cpp:18
Logger * global_logger
Definition logger.cpp:279
std::function< MQTTBackend::on_disconnect_callback_t > mqtt_on_disconnect_callback_t
Definition mqtt_client.h:32
MQTTDiscoveryObjectIdGenerator
available discovery object_id generators
Definition mqtt_client.h:74
@ MQTT_NONE_OBJECT_ID_GENERATOR
Definition mqtt_client.h:75
MQTTDiscoveryUniqueIdGenerator
available discovery unique_id generators
Definition mqtt_client.h:68
@ MQTT_LEGACY_UNIQUE_ID_GENERATOR
Definition mqtt_client.h:69
std::function< void(const std::string &, JsonObject)> mqtt_json_callback_t
Definition mqtt_client.h:39
std::function< void(const std::string &, const std::string &)> mqtt_callback_t
Callback for MQTT subscriptions.
Definition mqtt_client.h:38
MQTTClientComponent * global_mqtt_client
@ MQTT_CLIENT_DISCONNECTED
Definition mqtt_client.h:94
@ MQTT_CLIENT_RESOLVING_ADDRESS
Definition mqtt_client.h:95
std::function< MQTTBackend::on_connect_callback_t > mqtt_on_connect_callback_t
Callback for MQTT events.
Definition mqtt_client.h:31
bool is_connected()
Return whether the node is connected to the network (through wifi, eth, ...)
Definition util.cpp:26
network::IPAddresses get_ip_addresses()
Definition util.cpp:66
bool is_disabled()
Return whether the network is disabled (only wifi for now)
Definition util.cpp:53
const float AFTER_WIFI
For components that should be initialized after WiFi is connected.
Definition component.cpp:91
const char *const TAG
Definition spi.cpp:7
std::string size_t len
Definition helpers.h:692
void IRAM_ATTR HOT yield()
Definition core.cpp:24
char * str_sanitize_to(char *buffer, size_t buffer_size, const char *str)
Sanitize a string to buffer, keeping only alphanumerics, dashes, and underscores.
Definition helpers.cpp:210
void get_mac_address_into_buffer(std::span< char, MAC_ADDRESS_BUFFER_SIZE > buf)
Get the device MAC address into the given buffer, in lowercase hex notation.
Definition helpers.cpp:813
void IRAM_ATTR HOT delay(uint32_t ms)
Definition core.cpp:26
uint32_t IRAM_ATTR HOT millis()
Definition core.cpp:25
Application App
Global storage of Application pointer - only one Application can exist.
std::string make_name_with_suffix(const char *name, size_t name_len, char sep, const char *suffix_ptr, size_t suffix_len)
Optimized string concatenation: name + separator + suffix (const char* overload) Uses a fixed stack b...
Definition helpers.cpp:281
std::string payload_not_available
Definition mqtt_client.h:64
std::string topic
Empty means disabled.
Definition mqtt_client.h:62
std::string address
The address of the server without port number.
Definition mqtt_client.h:52
bool clean_session
Whether the session will be cleaned or remembered between connects.
Definition mqtt_client.h:57
std::string client_id
The client ID. Will automatically be truncated to 23 characters.
Definition mqtt_client.h:56
MQTTDiscoveryUniqueIdGenerator unique_id_generator
Definition mqtt_client.h:88
bool discover_ip
Enable the Home Assistant device discovery.
Definition mqtt_client.h:86
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition mqtt_client.h:84
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition mqtt_client.h:89
bool retain
Whether to retain discovery messages.
Definition mqtt_client.h:85