ESPHome 2025.12.0-dev
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>
9#include "esphome/core/log.h"
11#ifdef USE_LOGGER
13#endif
14#include "lwip/dns.h"
15#include "lwip/err.h"
16#include "mqtt_component.h"
17
18#ifdef USE_API
20#endif
21#ifdef USE_DASHBOARD_IMPORT
23#endif
24
25namespace esphome {
26namespace mqtt {
27
28static const char *const TAG = "mqtt";
29
31 global_mqtt_client = this;
32 const std::string mac_addr = get_mac_address();
33 this->credentials_.client_id = make_name_with_suffix(App.get_name(), '-', mac_addr.c_str(), mac_addr.size());
34}
35
36// Connection
39 [this](const char *topic, const char *payload, size_t len, size_t index, size_t total) {
40 if (index == 0)
41 this->payload_buffer_.reserve(total);
42
43 // append new payload, may contain incomplete MQTT message
44 this->payload_buffer_.append(payload, len);
45
46 // MQTT fully received
47 if (len + index == total) {
48 this->on_message(topic, this->payload_buffer_);
49 this->payload_buffer_.clear();
50 }
51 });
53 if (this->state_ == MQTT_CLIENT_DISABLED)
54 return;
56 this->disconnect_reason_ = reason;
57 });
58#ifdef USE_LOGGER
59 if (this->is_log_message_enabled() && logger::global_logger != nullptr) {
61 [this](int level, const char *tag, const char *message, size_t message_len) {
62 if (level <= this->log_level_ && this->is_connected()) {
63 this->publish({.topic = this->log_message_.topic,
64 .payload = std::string(message, message_len),
65 .qos = this->log_message_.qos,
66 .retain = this->log_message_.retain});
67 }
68 });
69 }
70#endif
71
72 if (this->is_discovery_ip_enabled()) {
73 this->subscribe(
74 "esphome/discover", [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); },
75 2);
76
77 std::string topic = "esphome/ping/";
78 topic.append(App.get_name());
79 this->subscribe(
80 topic, [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); }, 2);
81 }
82
83 if (this->enable_on_boot_) {
84 this->enable();
85 }
86}
87
89 if (!this->is_connected() or !this->is_discovery_ip_enabled()) {
90 return;
91 }
92 std::string topic = "esphome/discover/";
93 topic.append(App.get_name());
94
95 // NOLINTBEGIN(clang-analyzer-cplusplus.NewDeleteLeaks) false positive with ArduinoJson
96 this->publish_json(
97 topic,
98 [](JsonObject root) {
99 uint8_t index = 0;
100 for (auto &ip : network::get_ip_addresses()) {
101 if (ip.is_set()) {
102 root["ip" + (index == 0 ? "" : esphome::to_string(index))] = ip.str();
103 index++;
104 }
105 }
106 root["name"] = App.get_name();
107 if (!App.get_friendly_name().empty()) {
108 root["friendly_name"] = App.get_friendly_name();
109 }
110#ifdef USE_API
111 root["port"] = api::global_api_server->get_port();
112#endif
113 root["version"] = ESPHOME_VERSION;
114 root["mac"] = get_mac_address();
115
116#ifdef USE_ESP8266
117 root["platform"] = "ESP8266";
118#endif
119#ifdef USE_ESP32
120 root["platform"] = "ESP32";
121#endif
122#ifdef USE_LIBRETINY
123 root["platform"] = lt_cpu_get_model_name();
124#endif
125
126 root["board"] = ESPHOME_BOARD;
127#if defined(USE_WIFI)
128 root["network"] = "wifi";
129#elif defined(USE_ETHERNET)
130 root["network"] = "ethernet";
131#endif
132
133#ifdef ESPHOME_PROJECT_NAME
134 root["project_name"] = ESPHOME_PROJECT_NAME;
135 root["project_version"] = ESPHOME_PROJECT_VERSION;
136#endif // ESPHOME_PROJECT_NAME
137
138#ifdef USE_DASHBOARD_IMPORT
139 root["package_import_url"] = dashboard_import::get_package_import_url();
140#endif
141
142#ifdef USE_API_NOISE
143 root[api::global_api_server->get_noise_ctx()->has_psk() ? "api_encryption" : "api_encryption_supported"] =
144 "Noise_NNpsk0_25519_ChaChaPoly_SHA256";
145#endif
146 },
147 2, this->discovery_info_.retain);
148 // NOLINTEND(clang-analyzer-cplusplus.NewDeleteLeaks)
149}
150
152 ESP_LOGCONFIG(TAG,
153 "MQTT:\n"
154 " Server Address: %s:%u (%s)\n"
155 " Username: " LOG_SECRET("'%s'") "\n"
156 " Client ID: " LOG_SECRET("'%s'") "\n"
157 " Clean Session: %s",
158 this->credentials_.address.c_str(), this->credentials_.port, this->ip_.str().c_str(),
159 this->credentials_.username.c_str(), this->credentials_.client_id.c_str(),
160 YESNO(this->credentials_.clean_session));
161 if (this->is_discovery_ip_enabled()) {
162 ESP_LOGCONFIG(TAG, " Discovery IP enabled");
163 }
164 if (!this->discovery_info_.prefix.empty()) {
165 ESP_LOGCONFIG(TAG,
166 " Discovery prefix: '%s'\n"
167 " Discovery retain: %s",
168 this->discovery_info_.prefix.c_str(), YESNO(this->discovery_info_.retain));
169 }
170 ESP_LOGCONFIG(TAG, " Topic Prefix: '%s'", this->topic_prefix_.c_str());
171 if (!this->log_message_.topic.empty()) {
172 ESP_LOGCONFIG(TAG, " Log Topic: '%s'", this->log_message_.topic.c_str());
173 }
174 if (!this->availability_.topic.empty()) {
175 ESP_LOGCONFIG(TAG, " Availability: '%s'", this->availability_.topic.c_str());
176 }
177}
179 return network::is_disabled() || this->state_ == MQTT_CLIENT_DISABLED || this->is_connected() ||
181}
182
184 for (auto &subscription : this->subscriptions_) {
185 subscription.subscribed = false;
186 subscription.resubscribe_timeout = 0;
187 }
188
189 this->status_set_warning();
190 this->dns_resolve_error_ = false;
191 this->dns_resolved_ = false;
192 ip_addr_t addr;
193 err_t err;
194 {
195 LwIPLock lock;
196#if USE_NETWORK_IPV6
197 err = dns_gethostbyname_addrtype(this->credentials_.address.c_str(), &addr, MQTTClientComponent::dns_found_callback,
198 this, LWIP_DNS_ADDRTYPE_IPV6_IPV4);
199#else
200 err = dns_gethostbyname_addrtype(this->credentials_.address.c_str(), &addr, MQTTClientComponent::dns_found_callback,
201 this, LWIP_DNS_ADDRTYPE_IPV4);
202#endif /* USE_NETWORK_IPV6 */
203 }
204 switch (err) {
205 case ERR_OK: {
206 // Got IP immediately
207 this->dns_resolved_ = true;
208 this->ip_ = network::IPAddress(&addr);
209 this->start_connect_();
210 return;
211 }
212 case ERR_INPROGRESS: {
213 // wait for callback
214 ESP_LOGD(TAG, "Resolving broker IP address");
215 break;
216 }
217 default:
218 case ERR_ARG: {
219 // error
220 ESP_LOGW(TAG, "Error resolving broker IP address: %d", err);
221 break;
222 }
223 }
224
226 this->connect_begin_ = millis();
227}
229 if (!this->dns_resolved_ && millis() - this->connect_begin_ > 20000) {
230 this->dns_resolve_error_ = true;
231 }
232
233 if (this->dns_resolve_error_) {
234 ESP_LOGW(TAG, "Couldn't resolve IP address for '%s'", this->credentials_.address.c_str());
238 return;
239 }
240
241 if (!this->dns_resolved_) {
242 return;
243 }
244
245 ESP_LOGD(TAG, "Resolved broker IP address to %s", this->ip_.str().c_str());
246 this->start_connect_();
247}
248#if defined(USE_ESP8266) && LWIP_VERSION_MAJOR == 1
249void MQTTClientComponent::dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg) {
250#else
251void MQTTClientComponent::dns_found_callback(const char *name, const ip_addr_t *ipaddr, void *callback_arg) {
252#endif
253 auto *a_this = (MQTTClientComponent *) callback_arg;
254 if (ipaddr == nullptr) {
255 a_this->dns_resolve_error_ = true;
256 } else {
257 a_this->ip_ = network::IPAddress(ipaddr);
258 a_this->dns_resolved_ = true;
259 }
260}
261
264 return;
265
266 ESP_LOGI(TAG, "Connecting");
267 // Force disconnect first
269
272 const char *username = nullptr;
273 if (!this->credentials_.username.empty())
274 username = this->credentials_.username.c_str();
275 const char *password = nullptr;
276 if (!this->credentials_.password.empty())
277 password = this->credentials_.password.c_str();
278
279 this->mqtt_backend_.set_credentials(username, password);
280
281 this->mqtt_backend_.set_server(this->credentials_.address.c_str(), this->credentials_.port);
282 if (!this->last_will_.topic.empty()) {
283 this->mqtt_backend_.set_will(this->last_will_.topic.c_str(), this->last_will_.qos, this->last_will_.retain,
284 this->last_will_.payload.c_str());
285 }
286
287 this->mqtt_backend_.connect();
289 this->connect_begin_ = millis();
290}
292 return this->state_ == MQTT_CLIENT_CONNECTED && this->mqtt_backend_.connected();
293}
294
296 if (!this->mqtt_backend_.connected()) {
297 if (millis() - this->connect_begin_ > 60000) {
299 this->start_dnslookup_();
300 }
301 return;
302 }
303
305 this->sent_birth_message_ = false;
306 this->status_clear_warning();
307 ESP_LOGI(TAG, "Connected");
308 // MQTT Client needs some time to be fully set up.
309 delay(100); // NOLINT
310
312 this->send_device_info_();
313
314 for (MQTTComponent *component : this->children_)
315 component->schedule_resend_state();
316}
317
319 // Call the backend loop first
321
322 if (this->disconnect_reason_.has_value()) {
323 const LogString *reason_s;
324 switch (*this->disconnect_reason_) {
326 reason_s = LOG_STR("TCP disconnected");
327 break;
329 reason_s = LOG_STR("Unacceptable Protocol Version");
330 break;
332 reason_s = LOG_STR("Identifier Rejected");
333 break;
335 reason_s = LOG_STR("Server Unavailable");
336 break;
338 reason_s = LOG_STR("Malformed Credentials");
339 break;
341 reason_s = LOG_STR("Not Authorized");
342 break;
344 reason_s = LOG_STR("Not Enough Space");
345 break;
347 reason_s = LOG_STR("TLS Bad Fingerprint");
348 break;
349 default:
350 reason_s = LOG_STR("Unknown");
351 break;
352 }
353 if (!network::is_connected()) {
354 reason_s = LOG_STR("WiFi disconnected");
355 }
356 ESP_LOGW(TAG, "Disconnected: %s", LOG_STR_ARG(reason_s));
358 }
359
361
362 switch (this->state_) {
364 return; // Return to avoid a reboot when disabled
366 if (now - this->connect_begin_ > 5000) {
367 this->start_dnslookup_();
368 }
369 break;
371 this->check_dnslookup_();
372 break;
374 this->check_connected();
375 break;
377 if (!this->mqtt_backend_.connected()) {
379 ESP_LOGW(TAG, "Lost client connection");
380 this->start_dnslookup_();
381 } else {
382 if (!this->birth_message_.topic.empty() && !this->sent_birth_message_) {
383 this->sent_birth_message_ = this->publish(this->birth_message_);
384 }
385
386 this->last_connected_ = now;
388 }
389 break;
390 }
391
392 if (millis() - this->last_connected_ > this->reboot_timeout_ && this->reboot_timeout_ != 0) {
393 ESP_LOGE(TAG, "Can't connect; restarting");
394 App.reboot();
395 }
396}
398
399// Subscribe
400bool MQTTClientComponent::subscribe_(const char *topic, uint8_t qos) {
401 if (!this->is_connected())
402 return false;
403
404 bool ret = this->mqtt_backend_.subscribe(topic, qos);
405 yield();
406
407 if (ret) {
408 ESP_LOGV(TAG, "subscribe(topic='%s')", topic);
409 } else {
410 delay(5);
411 ESP_LOGV(TAG, "Subscribe failed for topic='%s'. Will retry", topic);
412 this->status_momentary_warning("subscribe", 1000);
413 }
414 return ret != 0;
415}
416void MQTTClientComponent::resubscribe_subscription_(MQTTSubscription *sub) {
417 if (sub->subscribed)
418 return;
419
420 const uint32_t now = millis();
421 bool do_resub = sub->resubscribe_timeout == 0 || now - sub->resubscribe_timeout > 1000;
422
423 if (do_resub) {
424 sub->subscribed = this->subscribe_(sub->topic.c_str(), sub->qos);
425 sub->resubscribe_timeout = now;
426 }
427}
429 for (auto &subscription : this->subscriptions_) {
430 this->resubscribe_subscription_(&subscription);
431 }
432}
433
434void MQTTClientComponent::subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos) {
435 MQTTSubscription subscription{
436 .topic = topic,
437 .qos = qos,
438 .callback = std::move(callback),
439 .subscribed = false,
440 .resubscribe_timeout = 0,
441 };
442 this->resubscribe_subscription_(&subscription);
443 this->subscriptions_.push_back(subscription);
444}
445
446void MQTTClientComponent::subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos) {
447 auto f = [callback](const std::string &topic, const std::string &payload) {
448 json::parse_json(payload, [topic, callback](JsonObject root) -> bool {
449 callback(topic, root);
450 return true;
451 });
452 };
453 MQTTSubscription subscription{
454 .topic = topic,
455 .qos = qos,
456 .callback = f,
457 .subscribed = false,
458 .resubscribe_timeout = 0,
459 };
460 this->resubscribe_subscription_(&subscription);
461 this->subscriptions_.push_back(subscription);
462}
463
464void MQTTClientComponent::unsubscribe(const std::string &topic) {
465 bool ret = this->mqtt_backend_.unsubscribe(topic.c_str());
466 yield();
467 if (ret) {
468 ESP_LOGV(TAG, "unsubscribe(topic='%s')", topic.c_str());
469 } else {
470 delay(5);
471 ESP_LOGV(TAG, "Unsubscribe failed for topic='%s'.", topic.c_str());
472 this->status_momentary_warning("unsubscribe", 1000);
473 }
474
475 auto it = subscriptions_.begin();
476 while (it != subscriptions_.end()) {
477 if (it->topic == topic) {
478 it = subscriptions_.erase(it);
479 } else {
480 ++it;
481 }
482 }
483}
484
485// Publish
486bool MQTTClientComponent::publish(const std::string &topic, const std::string &payload, uint8_t qos, bool retain) {
487 return this->publish(topic, payload.data(), payload.size(), qos, retain);
488}
489
490bool MQTTClientComponent::publish(const std::string &topic, const char *payload, size_t payload_length, uint8_t qos,
491 bool retain) {
492 return publish({.topic = topic, .payload = std::string(payload, payload_length), .qos = qos, .retain = retain});
493}
494
495bool MQTTClientComponent::publish(const MQTTMessage &message) {
496 if (!this->is_connected()) {
497 // critical components will re-transmit their messages
498 return false;
499 }
500 bool logging_topic = this->log_message_.topic == message.topic;
501 bool ret = this->mqtt_backend_.publish(message);
502 delay(0);
503 if (!ret && !logging_topic && this->is_connected()) {
504 delay(0);
505 ret = this->mqtt_backend_.publish(message);
506 delay(0);
507 }
508
509 if (!logging_topic) {
510 if (ret) {
511 ESP_LOGV(TAG, "Publish(topic='%s' payload='%s' retain=%d qos=%d)", message.topic.c_str(), message.payload.c_str(),
512 message.retain, message.qos);
513 } else {
514 ESP_LOGV(TAG, "Publish failed for topic='%s' (len=%u). Will retry", message.topic.c_str(),
515 message.payload.length());
516 this->status_momentary_warning("publish", 1000);
517 }
518 }
519 return ret != 0;
520}
521bool MQTTClientComponent::publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos,
522 bool retain) {
523 std::string message = json::build_json(f);
524 return this->publish(topic, message, qos, retain);
525}
526
528 if (this->state_ != MQTT_CLIENT_DISABLED)
529 return;
530 ESP_LOGD(TAG, "Enabling");
532 this->last_connected_ = millis();
533 this->start_dnslookup_();
534}
535
537 if (this->state_ == MQTT_CLIENT_DISABLED)
538 return;
539 ESP_LOGD(TAG, "Disabling");
541 this->on_shutdown();
542}
543
555static bool topic_match(const char *message, const char *subscription, bool is_normal, bool past_separator) {
556 // Reached end of both strings at the same time, this means we have a successful match
557 if (*message == '\0' && *subscription == '\0')
558 return true;
559
560 // Either the message or the subscribe are at the end. This means they don't match.
561 if (*message == '\0' || *subscription == '\0')
562 return false;
563
564 bool do_wildcards = is_normal || past_separator;
565
566 if (*subscription == '+' && do_wildcards) {
567 // single level wildcard
568 // consume + from subscription
569 subscription++;
570 // consume everything from message until '/' found or end of string
571 while (*message != '\0' && *message != '/') {
572 message++;
573 }
574 // after this, both pointers will point to a '/' or to the end of the string
575
576 return topic_match(message, subscription, is_normal, true);
577 }
578
579 if (*subscription == '#' && do_wildcards) {
580 // multilevel wildcard - MQTT mandates that this must be at end of subscribe topic
581 return true;
582 }
583
584 // this handles '/' and normal characters at the same time.
585 if (*message != *subscription)
586 return false;
587
588 past_separator = past_separator || *subscription == '/';
589
590 // consume characters
591 subscription++;
592 message++;
593
594 return topic_match(message, subscription, is_normal, past_separator);
595}
596
597static bool topic_match(const char *message, const char *subscription) {
598 return topic_match(message, subscription, *message != '\0' && *message != '$', false);
599}
600
601void MQTTClientComponent::on_message(const std::string &topic, const std::string &payload) {
602#ifdef USE_ESP8266
603 // on ESP8266, this is called in lwIP/AsyncTCP task; some components do not like running
604 // from a different task.
605 this->defer([this, topic, payload]() {
606#endif
607 for (auto &subscription : this->subscriptions_) {
608 if (topic_match(topic.c_str(), subscription.topic.c_str()))
609 subscription.callback(topic, payload);
610 }
611#ifdef USE_ESP8266
612 });
613#endif
614}
615
616// Setters
618bool MQTTClientComponent::is_log_message_enabled() const { return !this->log_message_.topic.empty(); }
619void MQTTClientComponent::set_reboot_timeout(uint32_t reboot_timeout) { this->reboot_timeout_ = reboot_timeout; }
620void MQTTClientComponent::register_mqtt_component(MQTTComponent *component) { this->children_.push_back(component); }
621void MQTTClientComponent::set_log_level(int level) { this->log_level_ = level; }
622void MQTTClientComponent::set_keep_alive(uint16_t keep_alive_s) { this->mqtt_backend_.set_keep_alive(keep_alive_s); }
623void MQTTClientComponent::set_log_message_template(MQTTMessage &&message) { this->log_message_ = std::move(message); }
624const MQTTDiscoveryInfo &MQTTClientComponent::get_discovery_info() const { return this->discovery_info_; }
625void MQTTClientComponent::set_topic_prefix(const std::string &topic_prefix, const std::string &check_topic_prefix) {
626 if (App.is_name_add_mac_suffix_enabled() && (topic_prefix == check_topic_prefix)) {
628 } else {
629 this->topic_prefix_ = topic_prefix;
630 }
631}
632const std::string &MQTTClientComponent::get_topic_prefix() const { return this->topic_prefix_; }
633void MQTTClientComponent::set_publish_nan_as_none(bool publish_nan_as_none) {
634 this->publish_nan_as_none_ = publish_nan_as_none;
635}
638 this->birth_message_.topic = "";
640}
642 this->shutdown_message_.topic = "";
644}
645bool MQTTClientComponent::is_discovery_enabled() const { return !this->discovery_info_.prefix.empty(); }
647const Availability &MQTTClientComponent::get_availability() { return this->availability_; }
649 if (this->birth_message_.topic.empty() || this->birth_message_.topic != this->last_will_.topic) {
650 this->availability_.topic = "";
651 return;
652 }
656}
657
659 this->last_will_ = std::move(message);
661}
662
664 this->birth_message_ = std::move(message);
666}
667
668void MQTTClientComponent::set_shutdown_message(MQTTMessage &&message) { this->shutdown_message_ = std::move(message); }
669
670void MQTTClientComponent::set_discovery_info(std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator,
671 MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain,
672 bool discover_ip, bool clean) {
673 this->discovery_info_.prefix = std::move(prefix);
674 this->discovery_info_.discover_ip = discover_ip;
675 this->discovery_info_.unique_id_generator = unique_id_generator;
676 this->discovery_info_.object_id_generator = object_id_generator;
677 this->discovery_info_.retain = retain;
678 this->discovery_info_.clean = clean;
679}
680
682
684 this->discovery_info_ = MQTTDiscoveryInfo{
685 .prefix = "",
686 .retain = false,
687 .discover_ip = false,
688 .clean = false,
689 .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR,
690 .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR,
691 };
692}
694 if (!this->shutdown_message_.topic.empty()) {
695 yield();
696 this->publish(this->shutdown_message_);
697 yield();
698 }
700}
701
703 this->mqtt_backend_.set_on_connect(std::forward<mqtt_on_connect_callback_t>(callback));
704}
705
707 auto callback_copy = callback;
708 this->mqtt_backend_.set_on_disconnect(std::forward<mqtt_on_disconnect_callback_t>(callback));
709 this->on_disconnect_.add(std::move(callback_copy));
710}
711
712#if ASYNC_TCP_SSL_ENABLED
713void MQTTClientComponent::add_ssl_fingerprint(const std::array<uint8_t, SHA1_SIZE> &fingerprint) {
714 this->mqtt_backend_.setSecure(true);
715 this->mqtt_backend_.addServerFingerprint(fingerprint.data());
716}
717#endif
718
719MQTTClientComponent *global_mqtt_client = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
720
721// MQTTMessageTrigger
722MQTTMessageTrigger::MQTTMessageTrigger(std::string topic) : topic_(std::move(topic)) {}
723void MQTTMessageTrigger::set_qos(uint8_t qos) { this->qos_ = qos; }
724void MQTTMessageTrigger::set_payload(const std::string &payload) { this->payload_ = payload; }
725void MQTTMessageTrigger::setup() {
727 this->topic_,
728 [this](const std::string &topic, const std::string &payload) {
729 if (this->payload_.has_value() && payload != *this->payload_) {
730 return;
731 }
732
733 this->trigger(payload);
734 },
735 this->qos_);
736}
737void MQTTMessageTrigger::dump_config() {
738 ESP_LOGCONFIG(TAG,
739 "MQTT Message Trigger:\n"
740 " Topic: '%s'\n"
741 " QoS: %u",
742 this->topic_.c_str(), this->qos_);
743}
744float MQTTMessageTrigger::get_setup_priority() const { return setup_priority::AFTER_CONNECTION; }
745
746} // namespace mqtt
747} // namespace esphome
748
749#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.
void status_set_warning(const char *message=nullptr)
void status_momentary_warning(const std::string &name, uint32_t length=5000)
void defer(const std::string &name, std::function< void()> &&f)
Defer a callback to the next loop() call.
void status_clear_warning()
std::shared_ptr< APINoiseContext > get_noise_ctx()
Definition api_server.h:58
uint16_t get_port() const
void add_on_log_callback(std::function< void(uint8_t, const char *, const char *, size_t)> &&callback)
Register a callback that will be called for every log message sent.
Definition logger.cpp:233
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 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 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 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
APIServer * global_api_server
const std::string & 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:294
std::function< MQTTBackend::on_disconnect_callback_t > mqtt_on_disconnect_callback_t
Definition mqtt_client.h:30
MQTTDiscoveryObjectIdGenerator
available discovery object_id generators
Definition mqtt_client.h:72
@ MQTT_NONE_OBJECT_ID_GENERATOR
Definition mqtt_client.h:73
MQTTDiscoveryUniqueIdGenerator
available discovery unique_id generators
Definition mqtt_client.h:66
@ MQTT_LEGACY_UNIQUE_ID_GENERATOR
Definition mqtt_client.h:67
std::function< void(const std::string &, JsonObject)> mqtt_json_callback_t
Definition mqtt_client.h:37
std::function< void(const std::string &, const std::string &)> mqtt_callback_t
Callback for MQTT subscriptions.
Definition mqtt_client.h:36
MQTTClientComponent * global_mqtt_client
@ MQTT_CLIENT_DISCONNECTED
Definition mqtt_client.h:92
@ MQTT_CLIENT_RESOLVING_ADDRESS
Definition mqtt_client.h:93
std::function< MQTTBackend::on_connect_callback_t > mqtt_on_connect_callback_t
Callback for MQTT events.
Definition mqtt_client.h:29
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:66
const char *const TAG
Definition spi.cpp:8
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
std::string make_name_with_suffix(const std::string &name, char sep, const char *suffix_ptr, size_t suffix_len)
Concatenate a name with a separator and suffix using an efficient stack-based approach.
Definition helpers.cpp:241
std::string str_sanitize(const std::string &str)
Sanitizes the input string by removing all characters but alphanumerics, dashes and underscores.
Definition helpers.cpp:198
std::string size_t len
Definition helpers.h:500
void IRAM_ATTR HOT yield()
Definition core.cpp:29
void IRAM_ATTR HOT delay(uint32_t ms)
Definition core.cpp:31
uint32_t IRAM_ATTR HOT millis()
Definition core.cpp:30
std::string get_mac_address()
Get the device MAC address as a string, in lowercase hex notation.
Definition helpers.cpp:632
Application App
Global storage of Application pointer - only one Application can exist.
std::string payload_not_available
Definition mqtt_client.h:62
std::string topic
Empty means disabled.
Definition mqtt_client.h:60
std::string address
The address of the server without port number.
Definition mqtt_client.h:50
bool clean_session
Whether the session will be cleaned or remembered between connects.
Definition mqtt_client.h:55
std::string client_id
The client ID. Will automatically be truncated to 23 characters.
Definition mqtt_client.h:54
MQTTDiscoveryUniqueIdGenerator unique_id_generator
Definition mqtt_client.h:86
bool discover_ip
Enable the Home Assistant device discovery.
Definition mqtt_client.h:84
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition mqtt_client.h:82
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition mqtt_client.h:87
bool retain
Whether to retain discovery messages.
Definition mqtt_client.h:83
uint8_t qos
QoS. Only for last will testaments.
std::string str() const
Definition ip_address.h:52