ESPHome  2024.6.1
mqtt_client.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include "esphome/core/defines.h"
4 
5 #ifdef USE_MQTT
6 
9 #include "esphome/core/log.h"
12 #if defined(USE_ESP32)
13 #include "mqtt_backend_esp32.h"
14 #elif defined(USE_ESP8266)
15 #include "mqtt_backend_esp8266.h"
16 #elif defined(USE_LIBRETINY)
17 #include "mqtt_backend_libretiny.h"
18 #endif
19 #include "lwip/ip_addr.h"
20 
21 #include <vector>
22 
23 namespace esphome {
24 namespace mqtt {
25 
28 using mqtt_on_connect_callback_t = std::function<MQTTBackend::on_connect_callback_t>;
29 using mqtt_on_disconnect_callback_t = std::function<MQTTBackend::on_disconnect_callback_t>;
30 
35 using mqtt_callback_t = std::function<void(const std::string &, const std::string &)>;
36 using mqtt_json_callback_t = std::function<void(const std::string &, JsonObject)>;
37 
40  std::string topic;
41  uint8_t qos;
43  bool subscribed;
45 };
46 
49  std::string address;
50  uint16_t port;
51  std::string username;
52  std::string password;
53  std::string client_id;
54 };
55 
57 struct Availability {
58  std::string topic;
59  std::string payload_available;
60  std::string payload_not_available;
61 };
62 
67 };
68 
73 };
74 
80  std::string prefix;
81  bool retain;
82  bool clean;
85 };
86 
92 };
93 
94 class MQTTComponent;
95 
97  public:
99 
101  void set_last_will(MQTTMessage &&message);
103  void disable_last_will();
104 
106  void set_birth_message(MQTTMessage &&message);
108  void disable_birth_message();
109 
110  void set_shutdown_message(MQTTMessage &&message);
111  void disable_shutdown_message();
112 
114  void set_keep_alive(uint16_t keep_alive_s);
115 
124  void set_discovery_info(std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator,
125  MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain, bool clean = false);
127  const MQTTDiscoveryInfo &get_discovery_info() const;
129  void disable_discovery();
130  bool is_discovery_enabled() const;
131 
132 #if ASYNC_TCP_SSL_ENABLED
133 
145  void add_ssl_fingerprint(const std::array<uint8_t, SHA1_SIZE> &fingerprint);
146 #endif
147 #ifdef USE_ESP32
148  void set_ca_certificate(const char *cert) { this->mqtt_backend_.set_ca_certificate(cert); }
149  void set_cl_certificate(const char *cert) { this->mqtt_backend_.set_cl_certificate(cert); }
150  void set_cl_key(const char *key) { this->mqtt_backend_.set_cl_key(key); }
151  void set_skip_cert_cn_check(bool skip_check) { this->mqtt_backend_.set_skip_cert_cn_check(skip_check); }
152 #endif
153  const Availability &get_availability();
154 
163  void set_topic_prefix(const std::string &topic_prefix);
165  const std::string &get_topic_prefix() const;
166 
168  void set_log_message_template(MQTTMessage &&message);
169  void set_log_level(int level);
171  void disable_log_message();
172  bool is_log_message_enabled() const;
173 
180  void subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos = 0);
181 
191  void subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos = 0);
192 
200  void unsubscribe(const std::string &topic);
201 
206  bool publish(const MQTTMessage &message);
207 
214  bool publish(const std::string &topic, const std::string &payload, uint8_t qos = 0, bool retain = false);
215 
216  bool publish(const std::string &topic, const char *payload, size_t payload_length, uint8_t qos = 0,
217  bool retain = false);
218 
225  bool publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos = 0, bool retain = false);
226 
228  void setup() override;
229  void dump_config() override;
231  void loop() override;
233  float get_setup_priority() const override;
234 
235  void on_message(const std::string &topic, const std::string &payload);
236 
237  bool can_proceed() override;
238 
239  void check_connected();
240 
241  void set_reboot_timeout(uint32_t reboot_timeout);
242 
243  void register_mqtt_component(MQTTComponent *component);
244 
245  bool is_connected();
246 
247  void on_shutdown() override;
248 
249  void set_broker_address(const std::string &address) { this->credentials_.address = address; }
250  void set_broker_port(uint16_t port) { this->credentials_.port = port; }
251  void set_username(const std::string &username) { this->credentials_.username = username; }
252  void set_password(const std::string &password) { this->credentials_.password = password; }
253  void set_client_id(const std::string &client_id) { this->credentials_.client_id = client_id; }
254  void set_on_connect(mqtt_on_connect_callback_t &&callback);
255  void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback);
256 
257  protected:
258  void send_device_info_();
259 
261  void start_connect_();
262  void start_dnslookup_();
263  void check_dnslookup_();
264 #if defined(USE_ESP8266) && LWIP_VERSION_MAJOR == 1
265  static void dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg);
266 #else
267  static void dns_found_callback(const char *name, const ip_addr_t *ipaddr, void *callback_arg);
268 #endif
269 
271  void recalculate_availability_();
272 
273  bool subscribe_(const char *topic, uint8_t qos);
274  void resubscribe_subscription_(MQTTSubscription *sub);
275  void resubscribe_subscriptions_();
276 
284  bool sent_birth_message_{false};
287  Availability availability_{};
290  MQTTDiscoveryInfo discovery_info_{
291  .prefix = "homeassistant",
292  .retain = true,
293  .clean = false,
294  .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR,
295  .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR,
296  };
297  std::string topic_prefix_{};
299  std::string payload_buffer_;
300  int log_level_{ESPHOME_LOG_LEVEL};
301 
302  std::vector<MQTTSubscription> subscriptions_;
303 #if defined(USE_ESP32)
305 #elif defined(USE_ESP8266)
307 #elif defined(USE_LIBRETINY)
309 #endif
310 
313  bool dns_resolved_{false};
314  bool dns_resolve_error_{false};
315  std::vector<MQTTComponent *> children_;
316  uint32_t reboot_timeout_{300000};
317  uint32_t connect_begin_;
318  uint32_t last_connected_{0};
320 };
321 
322 extern MQTTClientComponent *global_mqtt_client; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
323 
324 class MQTTMessageTrigger : public Trigger<std::string>, public Component {
325  public:
326  explicit MQTTMessageTrigger(std::string topic);
327 
328  void set_qos(uint8_t qos);
329  void set_payload(const std::string &payload);
330  void setup() override;
331  void dump_config() override;
332  float get_setup_priority() const override;
333 
334  protected:
335  std::string topic_;
336  uint8_t qos_{0};
338 };
339 
340 class MQTTJsonMessageTrigger : public Trigger<JsonObjectConst> {
341  public:
342  explicit MQTTJsonMessageTrigger(const std::string &topic, uint8_t qos) {
343  global_mqtt_client->subscribe_json(
344  topic, [this](const std::string &topic, JsonObject root) { this->trigger(root); }, qos);
345  }
346 };
347 
348 class MQTTConnectTrigger : public Trigger<> {
349  public:
351  client->set_on_connect([this](bool session_present) { this->trigger(); });
352  }
353 };
354 
355 class MQTTDisconnectTrigger : public Trigger<> {
356  public:
358  client->set_on_disconnect([this](MQTTClientDisconnectReason reason) { this->trigger(); });
359  }
360 };
361 
362 template<typename... Ts> class MQTTPublishAction : public Action<Ts...> {
363  public:
364  MQTTPublishAction(MQTTClientComponent *parent) : parent_(parent) {}
365  TEMPLATABLE_VALUE(std::string, topic)
366  TEMPLATABLE_VALUE(std::string, payload)
367  TEMPLATABLE_VALUE(uint8_t, qos)
368  TEMPLATABLE_VALUE(bool, retain)
369 
370  void play(Ts... x) override {
371  this->parent_->publish(this->topic_.value(x...), this->payload_.value(x...), this->qos_.value(x...),
372  this->retain_.value(x...));
373  }
374 
375  protected:
376  MQTTClientComponent *parent_;
377 };
378 
379 template<typename... Ts> class MQTTPublishJsonAction : public Action<Ts...> {
380  public:
381  MQTTPublishJsonAction(MQTTClientComponent *parent) : parent_(parent) {}
382  TEMPLATABLE_VALUE(std::string, topic)
383  TEMPLATABLE_VALUE(uint8_t, qos)
384  TEMPLATABLE_VALUE(bool, retain)
385 
386  void set_payload(std::function<void(Ts..., JsonObject)> payload) { this->payload_ = payload; }
387 
388  void play(Ts... x) override {
389  auto f = std::bind(&MQTTPublishJsonAction<Ts...>::encode_, this, x..., std::placeholders::_1);
390  auto topic = this->topic_.value(x...);
391  auto qos = this->qos_.value(x...);
392  auto retain = this->retain_.value(x...);
393  this->parent_->publish_json(topic, f, qos, retain);
394  }
395 
396  protected:
397  void encode_(Ts... x, JsonObject root) { this->payload_(x..., root); }
398  std::function<void(Ts..., JsonObject)> payload_;
400 };
401 
402 template<typename... Ts> class MQTTConnectedCondition : public Condition<Ts...> {
403  public:
404  MQTTConnectedCondition(MQTTClientComponent *parent) : parent_(parent) {}
405  bool check(Ts... x) override { return this->parent_->is_connected(); }
406 
407  protected:
409 };
410 
411 } // namespace mqtt
412 } // namespace esphome
413 
414 #endif // USE_MQTT
void setup()
MQTTConnectedCondition(MQTTClientComponent *parent)
Definition: mqtt_client.h:404
const char * name
Definition: stm32flash.h:78
void loop()
std::function< void(Ts..., JsonObject)> payload_
Definition: mqtt_client.h:398
optional< std::string > payload_
Definition: mqtt_client.h:337
void set_client_id(const std::string &client_id)
Definition: mqtt_client.h:253
MQTTPublishAction(MQTTClientComponent *parent)
Definition: mqtt_client.h:364
std::string topic
Empty means disabled.
Definition: mqtt_client.h:58
MQTTDiscoveryUniqueIdGenerator unique_id_generator
Definition: mqtt_client.h:83
Internal struct for MQTT Home Assistant discovery.
Definition: mqtt_client.h:79
void set_cl_certificate(const char *cert)
Definition: mqtt_client.h:149
std::function< void(const std::string &, const std::string &)> mqtt_callback_t
Callback for MQTT subscriptions.
Definition: mqtt_client.h:35
std::string client_id
The client ID. Will automatically be truncated to 23 characters.
Definition: mqtt_client.h:53
void set_broker_port(uint16_t port)
Definition: mqtt_client.h:250
uint16_t x
Definition: tt21100.cpp:17
internal struct for MQTT messages.
Definition: mqtt_backend.h:23
std::vector< MQTTComponent * > children_
Definition: mqtt_client.h:315
void encode_(Ts... x, JsonObject root)
Definition: mqtt_client.h:397
STL namespace.
MQTTMessage last_will_
The last will message.
Definition: mqtt_client.h:280
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition: mqtt_client.h:80
std::function< MQTTBackend::on_connect_callback_t > mqtt_on_connect_callback_t
Callback for MQTT events.
Definition: mqtt_client.h:28
bool is_connected()
Return whether the node is connected to the network (through wifi, eth, ...)
Definition: util.cpp:15
void set_skip_cert_cn_check(bool skip_check)
Definition: mqtt_client.h:151
void set_on_connect(mqtt_on_connect_callback_t &&callback)
void set_password(const std::string &password)
Definition: mqtt_client.h:252
void set_broker_address(const std::string &address)
Definition: mqtt_client.h:249
MQTTClientComponent * global_mqtt_client
Base class for all automation conditions.
Definition: automation.h:74
MQTTJsonMessageTrigger(const std::string &topic, uint8_t qos)
Definition: mqtt_client.h:342
MQTTBackendESP8266 mqtt_backend_
Definition: mqtt_client.h:306
uint16_t port
The port number of the server.
Definition: mqtt_client.h:50
MQTTDiscoveryUniqueIdGenerator
available discovery unique_id generators
Definition: mqtt_client.h:64
std::function< void(JsonObject)> json_build_t
Callback function typedef for building JsonObjects.
Definition: json_util.h:20
MQTTPublishJsonAction(MQTTClientComponent *parent)
Definition: mqtt_client.h:381
void set_ca_certificate(const char *cert)
Definition: mqtt_client.h:148
MQTTDiscoveryObjectIdGenerator
available discovery object_id generators
Definition: mqtt_client.h:70
internal struct for MQTT subscriptions.
Definition: mqtt_client.h:39
MQTTBackendLibreTiny mqtt_backend_
Definition: mqtt_client.h:308
std::string address
The address of the server without port number.
Definition: mqtt_client.h:49
Simple data struct for Home Assistant component availability.
Definition: mqtt_client.h:57
std::function< MQTTBackend::on_disconnect_callback_t > mqtt_on_disconnect_callback_t
Definition: mqtt_client.h:29
MQTTMessage birth_message_
The birth message (e.g.
Definition: mqtt_client.h:283
in_addr ip_addr_t
Definition: ip_address.h:20
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
Definition: a01nyub.cpp:7
std::string payload_not_available
Definition: mqtt_client.h:60
MQTTConnectTrigger(MQTTClientComponent *&client)
Definition: mqtt_client.h:350
std::vector< MQTTSubscription > subscriptions_
Definition: mqtt_client.h:302
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition: mqtt_client.h:84
void set_cl_key(const char *key)
Definition: mqtt_client.h:150
void set_username(const std::string &username)
Definition: mqtt_client.h:251
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.
internal struct for MQTT credentials.
Definition: mqtt_client.h:48
MQTTDisconnectTrigger(MQTTClientComponent *&client)
Definition: mqtt_client.h:357
void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback)
bool retain
Whether to retain discovery messages.
Definition: mqtt_client.h:81
std::function< void(const std::string &, JsonObject)> mqtt_json_callback_t
Definition: mqtt_client.h:36
MQTTComponent is the base class for all components that interact with MQTT to expose certain function...