#include "mqtt_client.h" #ifdef USE_MQTT #include #include "esphome/components/network/util.h" #include "esphome/core/application.h" #include "esphome/core/helpers.h" #include "esphome/core/log.h" #include "esphome/core/version.h" #ifdef USE_LOGGER #include "esphome/components/logger/logger.h" #endif #include "lwip/dns.h" #include "lwip/err.h" #include "mqtt_component.h" #ifdef USE_API #include "esphome/components/api/api_server.h" #endif #ifdef USE_DASHBOARD_IMPORT #include "esphome/components/dashboard_import/dashboard_import.h" #endif namespace esphome { namespace mqtt { static const char *const TAG = "mqtt"; MQTTClientComponent::MQTTClientComponent() { global_mqtt_client = this; this->credentials_.client_id = App.get_name() + "-" + get_mac_address(); } // Connection void MQTTClientComponent::setup() { ESP_LOGCONFIG(TAG, "Setting up MQTT..."); this->mqtt_backend_.set_on_message( [this](const char *topic, const char *payload, size_t len, size_t index, size_t total) { if (index == 0) this->payload_buffer_.reserve(total); // append new payload, may contain incomplete MQTT message this->payload_buffer_.append(payload, len); // MQTT fully received if (len + index == total) { this->on_message(topic, this->payload_buffer_); this->payload_buffer_.clear(); } }); this->mqtt_backend_.set_on_disconnect([this](MQTTClientDisconnectReason reason) { this->state_ = MQTT_CLIENT_DISCONNECTED; this->disconnect_reason_ = reason; }); #ifdef USE_LOGGER if (this->is_log_message_enabled() && logger::global_logger != nullptr) { logger::global_logger->add_on_log_callback([this](int level, const char *tag, const char *message) { if (level <= this->log_level_ && this->is_connected()) { this->publish({.topic = this->log_message_.topic, .payload = message, .qos = this->log_message_.qos, .retain = this->log_message_.retain}); } }); } #endif if (this->is_discovery_enabled()) { this->subscribe( "esphome/discover", [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); }, 2); std::string topic = "esphome/ping/"; topic.append(App.get_name()); this->subscribe( topic, [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); }, 2); } this->last_connected_ = millis(); this->start_dnslookup_(); } void MQTTClientComponent::send_device_info_() { if (!this->is_connected() or !this->is_discovery_enabled()) { return; } std::string topic = "esphome/discover/"; topic.append(App.get_name()); this->publish_json( topic, [](JsonObject root) { uint8_t index = 0; for (auto &ip : network::get_ip_addresses()) { if (ip.is_set()) { root["ip" + (index == 0 ? "" : esphome::to_string(index))] = ip.str(); index++; } } root["name"] = App.get_name(); #ifdef USE_API root["port"] = api::global_api_server->get_port(); #endif root["version"] = ESPHOME_VERSION; root["mac"] = get_mac_address(); #ifdef USE_ESP8266 root["platform"] = "ESP8266"; #endif #ifdef USE_ESP32 root["platform"] = "ESP32"; #endif #ifdef USE_LIBRETINY root["platform"] = lt_cpu_get_model_name(); #endif root["board"] = ESPHOME_BOARD; #if defined(USE_WIFI) root["network"] = "wifi"; #elif defined(USE_ETHERNET) root["network"] = "ethernet"; #endif #ifdef ESPHOME_PROJECT_NAME root["project_name"] = ESPHOME_PROJECT_NAME; root["project_version"] = ESPHOME_PROJECT_VERSION; #endif // ESPHOME_PROJECT_NAME #ifdef USE_DASHBOARD_IMPORT root["package_import_url"] = dashboard_import::get_package_import_url(); #endif }, 2, this->discovery_info_.retain); } void MQTTClientComponent::dump_config() { ESP_LOGCONFIG(TAG, "MQTT:"); ESP_LOGCONFIG(TAG, " Server Address: %s:%u (%s)", this->credentials_.address.c_str(), this->credentials_.port, this->ip_.str().c_str()); ESP_LOGCONFIG(TAG, " Username: " LOG_SECRET("'%s'"), this->credentials_.username.c_str()); ESP_LOGCONFIG(TAG, " Client ID: " LOG_SECRET("'%s'"), this->credentials_.client_id.c_str()); if (!this->discovery_info_.prefix.empty()) { ESP_LOGCONFIG(TAG, " Discovery prefix: '%s'", this->discovery_info_.prefix.c_str()); ESP_LOGCONFIG(TAG, " Discovery retain: %s", YESNO(this->discovery_info_.retain)); } ESP_LOGCONFIG(TAG, " Topic Prefix: '%s'", this->topic_prefix_.c_str()); if (!this->log_message_.topic.empty()) { ESP_LOGCONFIG(TAG, " Log Topic: '%s'", this->log_message_.topic.c_str()); } if (!this->availability_.topic.empty()) { ESP_LOGCONFIG(TAG, " Availability: '%s'", this->availability_.topic.c_str()); } } bool MQTTClientComponent::can_proceed() { return network::is_disabled() || this->is_connected(); } void MQTTClientComponent::start_dnslookup_() { for (auto &subscription : this->subscriptions_) { subscription.subscribed = false; subscription.resubscribe_timeout = 0; } this->status_set_warning(); this->dns_resolve_error_ = false; this->dns_resolved_ = false; ip_addr_t addr; #if USE_NETWORK_IPV6 err_t err = dns_gethostbyname_addrtype(this->credentials_.address.c_str(), &addr, MQTTClientComponent::dns_found_callback, this, LWIP_DNS_ADDRTYPE_IPV6_IPV4); #else err_t err = dns_gethostbyname_addrtype(this->credentials_.address.c_str(), &addr, MQTTClientComponent::dns_found_callback, this, LWIP_DNS_ADDRTYPE_IPV4); #endif /* USE_NETWORK_IPV6 */ switch (err) { case ERR_OK: { // Got IP immediately this->dns_resolved_ = true; this->ip_ = network::IPAddress(&addr); this->start_connect_(); return; } case ERR_INPROGRESS: { // wait for callback ESP_LOGD(TAG, "Resolving MQTT broker IP address..."); break; } default: case ERR_ARG: { // error ESP_LOGW(TAG, "Error resolving MQTT broker IP address: %d", err); break; } } this->state_ = MQTT_CLIENT_RESOLVING_ADDRESS; this->connect_begin_ = millis(); } void MQTTClientComponent::check_dnslookup_() { if (!this->dns_resolved_ && millis() - this->connect_begin_ > 20000) { this->dns_resolve_error_ = true; } if (this->dns_resolve_error_) { ESP_LOGW(TAG, "Couldn't resolve IP address for '%s'!", this->credentials_.address.c_str()); this->state_ = MQTT_CLIENT_DISCONNECTED; return; } if (!this->dns_resolved_) { return; } ESP_LOGD(TAG, "Resolved broker IP address to %s", this->ip_.str().c_str()); this->start_connect_(); } #if defined(USE_ESP8266) && LWIP_VERSION_MAJOR == 1 void MQTTClientComponent::dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg) { #else void MQTTClientComponent::dns_found_callback(const char *name, const ip_addr_t *ipaddr, void *callback_arg) { #endif auto *a_this = (MQTTClientComponent *) callback_arg; if (ipaddr == nullptr) { a_this->dns_resolve_error_ = true; } else { a_this->ip_ = network::IPAddress(ipaddr); a_this->dns_resolved_ = true; } } void MQTTClientComponent::start_connect_() { if (!network::is_connected()) return; ESP_LOGI(TAG, "Connecting to MQTT..."); // Force disconnect first this->mqtt_backend_.disconnect(); this->mqtt_backend_.set_client_id(this->credentials_.client_id.c_str()); const char *username = nullptr; if (!this->credentials_.username.empty()) username = this->credentials_.username.c_str(); const char *password = nullptr; if (!this->credentials_.password.empty()) password = this->credentials_.password.c_str(); this->mqtt_backend_.set_credentials(username, password); this->mqtt_backend_.set_server(this->credentials_.address.c_str(), this->credentials_.port); if (!this->last_will_.topic.empty()) { this->mqtt_backend_.set_will(this->last_will_.topic.c_str(), this->last_will_.qos, this->last_will_.retain, this->last_will_.payload.c_str()); } this->mqtt_backend_.connect(); this->state_ = MQTT_CLIENT_CONNECTING; this->connect_begin_ = millis(); } bool MQTTClientComponent::is_connected() { return this->state_ == MQTT_CLIENT_CONNECTED && this->mqtt_backend_.connected(); } void MQTTClientComponent::check_connected() { if (!this->mqtt_backend_.connected()) { if (millis() - this->connect_begin_ > 60000) { this->state_ = MQTT_CLIENT_DISCONNECTED; this->start_dnslookup_(); } return; } this->state_ = MQTT_CLIENT_CONNECTED; this->sent_birth_message_ = false; this->status_clear_warning(); ESP_LOGI(TAG, "MQTT Connected!"); // MQTT Client needs some time to be fully set up. delay(100); // NOLINT this->resubscribe_subscriptions_(); this->send_device_info_(); for (MQTTComponent *component : this->children_) component->schedule_resend_state(); } void MQTTClientComponent::loop() { // Call the backend loop first mqtt_backend_.loop(); if (this->disconnect_reason_.has_value()) { const LogString *reason_s; switch (*this->disconnect_reason_) { case MQTTClientDisconnectReason::TCP_DISCONNECTED: reason_s = LOG_STR("TCP disconnected"); break; case MQTTClientDisconnectReason::MQTT_UNACCEPTABLE_PROTOCOL_VERSION: reason_s = LOG_STR("Unacceptable Protocol Version"); break; case MQTTClientDisconnectReason::MQTT_IDENTIFIER_REJECTED: reason_s = LOG_STR("Identifier Rejected"); break; case MQTTClientDisconnectReason::MQTT_SERVER_UNAVAILABLE: reason_s = LOG_STR("Server Unavailable"); break; case MQTTClientDisconnectReason::MQTT_MALFORMED_CREDENTIALS: reason_s = LOG_STR("Malformed Credentials"); break; case MQTTClientDisconnectReason::MQTT_NOT_AUTHORIZED: reason_s = LOG_STR("Not Authorized"); break; case MQTTClientDisconnectReason::ESP8266_NOT_ENOUGH_SPACE: reason_s = LOG_STR("Not Enough Space"); break; case MQTTClientDisconnectReason::TLS_BAD_FINGERPRINT: reason_s = LOG_STR("TLS Bad Fingerprint"); break; default: reason_s = LOG_STR("Unknown"); break; } if (!network::is_connected()) { reason_s = LOG_STR("WiFi disconnected"); } ESP_LOGW(TAG, "MQTT Disconnected: %s.", LOG_STR_ARG(reason_s)); this->disconnect_reason_.reset(); } const uint32_t now = millis(); switch (this->state_) { case MQTT_CLIENT_DISCONNECTED: if (now - this->connect_begin_ > 5000) { this->start_dnslookup_(); } break; case MQTT_CLIENT_RESOLVING_ADDRESS: this->check_dnslookup_(); break; case MQTT_CLIENT_CONNECTING: this->check_connected(); break; case MQTT_CLIENT_CONNECTED: if (!this->mqtt_backend_.connected()) { this->state_ = MQTT_CLIENT_DISCONNECTED; ESP_LOGW(TAG, "Lost MQTT Client connection!"); this->start_dnslookup_(); } else { if (!this->birth_message_.topic.empty() && !this->sent_birth_message_) { this->sent_birth_message_ = this->publish(this->birth_message_); } this->last_connected_ = now; this->resubscribe_subscriptions_(); } break; } if (millis() - this->last_connected_ > this->reboot_timeout_ && this->reboot_timeout_ != 0) { ESP_LOGE(TAG, "Can't connect to MQTT... Restarting..."); App.reboot(); } } float MQTTClientComponent::get_setup_priority() const { return setup_priority::AFTER_WIFI; } // Subscribe bool MQTTClientComponent::subscribe_(const char *topic, uint8_t qos) { if (!this->is_connected()) return false; bool ret = this->mqtt_backend_.subscribe(topic, qos); yield(); if (ret) { ESP_LOGV(TAG, "subscribe(topic='%s')", topic); } else { delay(5); ESP_LOGV(TAG, "Subscribe failed for topic='%s'. Will retry later.", topic); this->status_momentary_warning("subscribe", 1000); } return ret != 0; } void MQTTClientComponent::resubscribe_subscription_(MQTTSubscription *sub) { if (sub->subscribed) return; const uint32_t now = millis(); bool do_resub = sub->resubscribe_timeout == 0 || now - sub->resubscribe_timeout > 1000; if (do_resub) { sub->subscribed = this->subscribe_(sub->topic.c_str(), sub->qos); sub->resubscribe_timeout = now; } } void MQTTClientComponent::resubscribe_subscriptions_() { for (auto &subscription : this->subscriptions_) { this->resubscribe_subscription_(&subscription); } } void MQTTClientComponent::subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos) { MQTTSubscription subscription{ .topic = topic, .qos = qos, .callback = std::move(callback), .subscribed = false, .resubscribe_timeout = 0, }; this->resubscribe_subscription_(&subscription); this->subscriptions_.push_back(subscription); } void MQTTClientComponent::subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos) { auto f = [callback](const std::string &topic, const std::string &payload) { json::parse_json(payload, [topic, callback](JsonObject root) { callback(topic, root); }); }; MQTTSubscription subscription{ .topic = topic, .qos = qos, .callback = f, .subscribed = false, .resubscribe_timeout = 0, }; this->resubscribe_subscription_(&subscription); this->subscriptions_.push_back(subscription); } void MQTTClientComponent::unsubscribe(const std::string &topic) { bool ret = this->mqtt_backend_.unsubscribe(topic.c_str()); yield(); if (ret) { ESP_LOGV(TAG, "unsubscribe(topic='%s')", topic.c_str()); } else { delay(5); ESP_LOGV(TAG, "Unsubscribe failed for topic='%s'.", topic.c_str()); this->status_momentary_warning("unsubscribe", 1000); } auto it = subscriptions_.begin(); while (it != subscriptions_.end()) { if (it->topic == topic) { it = subscriptions_.erase(it); } else { ++it; } } } // Publish bool MQTTClientComponent::publish(const std::string &topic, const std::string &payload, uint8_t qos, bool retain) { return this->publish(topic, payload.data(), payload.size(), qos, retain); } bool MQTTClientComponent::publish(const std::string &topic, const char *payload, size_t payload_length, uint8_t qos, bool retain) { return publish({.topic = topic, .payload = payload, .qos = qos, .retain = retain}); } bool MQTTClientComponent::publish(const MQTTMessage &message) { if (!this->is_connected()) { // critical components will re-transmit their messages return false; } bool logging_topic = this->log_message_.topic == message.topic; bool ret = this->mqtt_backend_.publish(message); delay(0); if (!ret && !logging_topic && this->is_connected()) { delay(0); ret = this->mqtt_backend_.publish(message); delay(0); } if (!logging_topic) { if (ret) { ESP_LOGV(TAG, "Publish(topic='%s' payload='%s' retain=%d qos=%d)", message.topic.c_str(), message.payload.c_str(), message.retain, message.qos); } else { ESP_LOGV(TAG, "Publish failed for topic='%s' (len=%u). will retry later..", message.topic.c_str(), message.payload.length()); this->status_momentary_warning("publish", 1000); } } return ret != 0; } bool MQTTClientComponent::publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos, bool retain) { std::string message = json::build_json(f); return this->publish(topic, message, qos, retain); } /** Check if the message topic matches the given subscription topic * * INFO: MQTT spec mandates that topics must not be empty and must be valid NULL-terminated UTF-8 strings. * * @param message The message topic that was received from the MQTT server. Note: this must not contain * wildcard characters as mandated by the MQTT spec. * @param subscription The subscription topic we are matching against. * @param is_normal Is this a "normal" topic - Does the message topic not begin with a "$". * @param past_separator Are we past the first '/' topic separator. * @return true if the subscription topic matches the message topic, false otherwise. */ static bool topic_match(const char *message, const char *subscription, bool is_normal, bool past_separator) { // Reached end of both strings at the same time, this means we have a successful match if (*message == '\0' && *subscription == '\0') return true; // Either the message or the subscribe are at the end. This means they don't match. if (*message == '\0' || *subscription == '\0') return false; bool do_wildcards = is_normal || past_separator; if (*subscription == '+' && do_wildcards) { // single level wildcard // consume + from subscription subscription++; // consume everything from message until '/' found or end of string while (*message != '\0' && *message != '/') { message++; } // after this, both pointers will point to a '/' or to the end of the string return topic_match(message, subscription, is_normal, true); } if (*subscription == '#' && do_wildcards) { // multilevel wildcard - MQTT mandates that this must be at end of subscribe topic return true; } // this handles '/' and normal characters at the same time. if (*message != *subscription) return false; past_separator = past_separator || *subscription == '/'; // consume characters subscription++; message++; return topic_match(message, subscription, is_normal, past_separator); } static bool topic_match(const char *message, const char *subscription) { return topic_match(message, subscription, *message != '\0' && *message != '$', false); } void MQTTClientComponent::on_message(const std::string &topic, const std::string &payload) { #ifdef USE_ESP8266 // on ESP8266, this is called in lwIP/AsyncTCP task; some components do not like running // from a different task. this->defer([this, topic, payload]() { #endif for (auto &subscription : this->subscriptions_) { if (topic_match(topic.c_str(), subscription.topic.c_str())) subscription.callback(topic, payload); } #ifdef USE_ESP8266 }); #endif } // Setters void MQTTClientComponent::disable_log_message() { this->log_message_.topic = ""; } bool MQTTClientComponent::is_log_message_enabled() const { return !this->log_message_.topic.empty(); } void MQTTClientComponent::set_reboot_timeout(uint32_t reboot_timeout) { this->reboot_timeout_ = reboot_timeout; } void MQTTClientComponent::register_mqtt_component(MQTTComponent *component) { this->children_.push_back(component); } void MQTTClientComponent::set_log_level(int level) { this->log_level_ = level; } void MQTTClientComponent::set_keep_alive(uint16_t keep_alive_s) { this->mqtt_backend_.set_keep_alive(keep_alive_s); } void MQTTClientComponent::set_log_message_template(MQTTMessage &&message) { this->log_message_ = std::move(message); } const MQTTDiscoveryInfo &MQTTClientComponent::get_discovery_info() const { return this->discovery_info_; } void MQTTClientComponent::set_topic_prefix(const std::string &topic_prefix) { this->topic_prefix_ = topic_prefix; } const std::string &MQTTClientComponent::get_topic_prefix() const { return this->topic_prefix_; } void MQTTClientComponent::disable_birth_message() { this->birth_message_.topic = ""; this->recalculate_availability_(); } void MQTTClientComponent::disable_shutdown_message() { this->shutdown_message_.topic = ""; this->recalculate_availability_(); } bool MQTTClientComponent::is_discovery_enabled() const { return !this->discovery_info_.prefix.empty(); } const Availability &MQTTClientComponent::get_availability() { return this->availability_; } void MQTTClientComponent::recalculate_availability_() { if (this->birth_message_.topic.empty() || this->birth_message_.topic != this->last_will_.topic) { this->availability_.topic = ""; return; } this->availability_.topic = this->birth_message_.topic; this->availability_.payload_available = this->birth_message_.payload; this->availability_.payload_not_available = this->last_will_.payload; } void MQTTClientComponent::set_last_will(MQTTMessage &&message) { this->last_will_ = std::move(message); this->recalculate_availability_(); } void MQTTClientComponent::set_birth_message(MQTTMessage &&message) { this->birth_message_ = std::move(message); this->recalculate_availability_(); } void MQTTClientComponent::set_shutdown_message(MQTTMessage &&message) { this->shutdown_message_ = std::move(message); } void MQTTClientComponent::set_discovery_info(std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator, MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain, bool clean) { this->discovery_info_.prefix = std::move(prefix); this->discovery_info_.unique_id_generator = unique_id_generator; this->discovery_info_.object_id_generator = object_id_generator; this->discovery_info_.retain = retain; this->discovery_info_.clean = clean; } void MQTTClientComponent::disable_last_will() { this->last_will_.topic = ""; } void MQTTClientComponent::disable_discovery() { this->discovery_info_ = MQTTDiscoveryInfo{ .prefix = "", .retain = false, .clean = false, .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR, .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR, }; } void MQTTClientComponent::on_shutdown() { if (!this->shutdown_message_.topic.empty()) { yield(); this->publish(this->shutdown_message_); yield(); } this->mqtt_backend_.disconnect(); } void MQTTClientComponent::set_on_connect(mqtt_on_connect_callback_t &&callback) { this->mqtt_backend_.set_on_connect(std::forward(callback)); } void MQTTClientComponent::set_on_disconnect(mqtt_on_disconnect_callback_t &&callback) { this->mqtt_backend_.set_on_disconnect(std::forward(callback)); } #if ASYNC_TCP_SSL_ENABLED void MQTTClientComponent::add_ssl_fingerprint(const std::array &fingerprint) { this->mqtt_backend_.setSecure(true); this->mqtt_backend_.addServerFingerprint(fingerprint.data()); } #endif MQTTClientComponent *global_mqtt_client = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables) // MQTTMessageTrigger MQTTMessageTrigger::MQTTMessageTrigger(std::string topic) : topic_(std::move(topic)) {} void MQTTMessageTrigger::set_qos(uint8_t qos) { this->qos_ = qos; } void MQTTMessageTrigger::set_payload(const std::string &payload) { this->payload_ = payload; } void MQTTMessageTrigger::setup() { global_mqtt_client->subscribe( this->topic_, [this](const std::string &topic, const std::string &payload) { if (this->payload_.has_value() && payload != *this->payload_) { return; } this->trigger(payload); }, this->qos_); } void MQTTMessageTrigger::dump_config() { ESP_LOGCONFIG(TAG, "MQTT Message Trigger:"); ESP_LOGCONFIG(TAG, " Topic: '%s'", this->topic_.c_str()); ESP_LOGCONFIG(TAG, " QoS: %u", this->qos_); } float MQTTMessageTrigger::get_setup_priority() const { return setup_priority::AFTER_CONNECTION; } } // namespace mqtt } // namespace esphome #endif // USE_MQTT