ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
mqtt_backend_esp8266.h
Go to the documentation of this file.
1#pragma once
2#include "mqtt_backend.h"
3
4#ifdef USE_MQTT
5#ifdef USE_ESP8266
6
7#include <AsyncMqttClient.h>
8#include <algorithm>
9
10namespace esphome::mqtt {
11
12class MQTTBackendESP8266 final : public MQTTBackend {
13 public:
14 void set_keep_alive(uint16_t keep_alive) final { mqtt_client_.setKeepAlive(keep_alive); }
15 void set_client_id(const char *client_id) final { mqtt_client_.setClientId(client_id); }
16 void set_clean_session(bool clean_session) final { mqtt_client_.setCleanSession(clean_session); }
17 void set_credentials(const char *username, const char *password) final {
18 mqtt_client_.setCredentials(username, password);
19 }
20 void set_will(const char *topic, uint8_t qos, bool retain, const char *payload) final {
21 mqtt_client_.setWill(topic, qos, retain, payload);
22 }
23 void set_server(network::IPAddress ip, uint16_t port) final { mqtt_client_.setServer(ip, port); }
24 void set_server(const char *host, uint16_t port) final { mqtt_client_.setServer(host, port); }
25 void set_on_connect(std::function<on_connect_callback_t> &&callback) final {
26 this->mqtt_client_.onConnect(std::move(callback));
27 }
28 void set_on_disconnect(std::function<on_disconnect_callback_t> &&callback) final {
29 auto async_callback = [callback](AsyncMqttClientDisconnectReason reason) {
30 // int based enum so casting isn't a problem
31 callback(static_cast<MQTTClientDisconnectReason>(reason));
32 };
33 this->mqtt_client_.onDisconnect(std::move(async_callback));
34 }
35 void set_on_subscribe(std::function<on_subscribe_callback_t> &&callback) final {
36 this->mqtt_client_.onSubscribe(std::move(callback));
37 }
38 void set_on_unsubscribe(std::function<on_unsubscribe_callback_t> &&callback) final {
39 this->mqtt_client_.onUnsubscribe(std::move(callback));
40 }
41 void set_on_message(std::function<on_message_callback_t> &&callback) final {
42 auto async_callback = [callback](const char *topic, const char *payload,
43 AsyncMqttClientMessageProperties async_properties, size_t len, size_t index,
44 size_t total) { callback(topic, payload, len, index, total); };
45 mqtt_client_.onMessage(std::move(async_callback));
46 }
47 void set_on_publish(std::function<on_publish_user_callback_t> &&callback) final {
48 this->mqtt_client_.onPublish(std::move(callback));
49 }
50
51 bool connected() const final { return mqtt_client_.connected(); }
52 void connect() final { mqtt_client_.connect(); }
53 void disconnect() final { mqtt_client_.disconnect(true); }
54 bool subscribe(const char *topic, uint8_t qos) final { return mqtt_client_.subscribe(topic, qos) != 0; }
55 bool unsubscribe(const char *topic) final { return mqtt_client_.unsubscribe(topic) != 0; }
56 bool publish(const char *topic, const char *payload, size_t length, uint8_t qos, bool retain) final {
57 return mqtt_client_.publish(topic, qos, retain, payload, length, false, 0) != 0;
58 }
60 bool publish_tracked(const MQTTMessage &message) final {
61 // Registered on first use, which is at shutdown
64 this->mqtt_client_.onPublish([this](uint16_t packet_id) {
65 if (packet_id == this->tracked_packet_id_)
66 this->tracked_acked_ = true;
67 });
68 }
69 this->tracked_acked_ = false;
70 uint16_t packet_id =
71 this->mqtt_client_.publish(message.topic.c_str(), std::max<uint8_t>(message.qos, 1), message.retain,
72 message.payload.c_str(), message.payload.length(), false, 0);
73 if (packet_id == 0)
74 return false;
75 this->tracked_packet_id_ = packet_id;
76 return true;
77 }
78 bool publish_acknowledged() const final { return this->tracked_acked_; }
79
80 protected:
81 AsyncMqttClient mqtt_client_;
82 // The callback only runs when the loop yields and publish() does not yield, so it cannot see the
83 // confirmation before tracked_packet_id_ is stored and a latch is enough
84 uint16_t tracked_packet_id_{0};
85 bool tracked_acked_{false};
87};
88
89} // namespace esphome::mqtt
90
91#endif // defined(USE_ESP8266)
92#endif
void set_on_subscribe(std::function< on_subscribe_callback_t > &&callback) final
void set_on_publish(std::function< on_publish_user_callback_t > &&callback) final
void set_will(const char *topic, uint8_t qos, bool retain, const char *payload) final
bool publish_tracked(const MQTTMessage &message) final
void set_keep_alive(uint16_t keep_alive) final
bool subscribe(const char *topic, uint8_t qos) final
void set_credentials(const char *username, const char *password) final
void set_on_unsubscribe(std::function< on_unsubscribe_callback_t > &&callback) final
bool unsubscribe(const char *topic) final
void set_on_disconnect(std::function< on_disconnect_callback_t > &&callback) final
void set_on_message(std::function< on_message_callback_t > &&callback) final
bool publish(const char *topic, const char *payload, size_t length, uint8_t qos, bool retain) final
void set_server(const char *host, uint16_t port) final
void set_clean_session(bool clean_session) final
void set_client_id(const char *client_id) final
void set_on_connect(std::function< on_connect_callback_t > &&callback) final
void set_server(network::IPAddress ip, uint16_t port) final
virtual bool publish(const char *topic, const char *payload, size_t length, uint8_t qos, bool retain)=0
const LogString * message
Definition component.cpp:35
const void size_t len
Definition hal.h:68
internal struct for MQTT messages.
uint16_t length
Definition tt21100.cpp:0