ESPHome  2024.10.2
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;
55 };
56 
58 struct Availability {
59  std::string topic;
60  std::string payload_available;
61  std::string payload_not_available;
62 };
63 
68 };
69 
74 };
75 
81  std::string prefix;
82  bool retain;
83  bool discover_ip;
84  bool clean;
87 };
88 
94 };
95 
96 class MQTTComponent;
97 
99  public:
101 
103  void set_last_will(MQTTMessage &&message);
105  void disable_last_will();
106 
108  void set_birth_message(MQTTMessage &&message);
110  void disable_birth_message();
111 
112  void set_shutdown_message(MQTTMessage &&message);
113  void disable_shutdown_message();
114 
116  void set_keep_alive(uint16_t keep_alive_s);
117 
126  void set_discovery_info(std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator,
127  MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain, bool discover_ip,
128  bool clean = false);
130  const MQTTDiscoveryInfo &get_discovery_info() const;
132  void disable_discovery();
133  bool is_discovery_enabled() const;
134  bool is_discovery_ip_enabled() const;
135 
136 #if ASYNC_TCP_SSL_ENABLED
137 
149  void add_ssl_fingerprint(const std::array<uint8_t, SHA1_SIZE> &fingerprint);
150 #endif
151 #ifdef USE_ESP32
152  void set_ca_certificate(const char *cert) { this->mqtt_backend_.set_ca_certificate(cert); }
153  void set_cl_certificate(const char *cert) { this->mqtt_backend_.set_cl_certificate(cert); }
154  void set_cl_key(const char *key) { this->mqtt_backend_.set_cl_key(key); }
155  void set_skip_cert_cn_check(bool skip_check) { this->mqtt_backend_.set_skip_cert_cn_check(skip_check); }
156 #endif
157  const Availability &get_availability();
158 
167  void set_topic_prefix(const std::string &topic_prefix);
169  const std::string &get_topic_prefix() const;
170 
172  void set_log_message_template(MQTTMessage &&message);
173  void set_log_level(int level);
175  void disable_log_message();
176  bool is_log_message_enabled() const;
177 
184  void subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos = 0);
185 
195  void subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos = 0);
196 
204  void unsubscribe(const std::string &topic);
205 
210  bool publish(const MQTTMessage &message);
211 
218  bool publish(const std::string &topic, const std::string &payload, uint8_t qos = 0, bool retain = false);
219 
220  bool publish(const std::string &topic, const char *payload, size_t payload_length, uint8_t qos = 0,
221  bool retain = false);
222 
229  bool publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos = 0, bool retain = false);
230 
232  void setup() override;
233  void dump_config() override;
235  void loop() override;
237  float get_setup_priority() const override;
238 
239  void on_message(const std::string &topic, const std::string &payload);
240 
241  bool can_proceed() override;
242 
243  void check_connected();
244 
245  void set_reboot_timeout(uint32_t reboot_timeout);
246 
247  void register_mqtt_component(MQTTComponent *component);
248 
249  bool is_connected();
250 
251  void on_shutdown() override;
252 
253  void set_broker_address(const std::string &address) { this->credentials_.address = address; }
254  void set_broker_port(uint16_t port) { this->credentials_.port = port; }
255  void set_username(const std::string &username) { this->credentials_.username = username; }
256  void set_password(const std::string &password) { this->credentials_.password = password; }
257  void set_client_id(const std::string &client_id) { this->credentials_.client_id = client_id; }
258  void set_clean_session(const bool &clean_session) { this->credentials_.clean_session = clean_session; }
259  void set_on_connect(mqtt_on_connect_callback_t &&callback);
260  void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback);
261 
262  protected:
263  void send_device_info_();
264 
266  void start_connect_();
267  void start_dnslookup_();
268  void check_dnslookup_();
269 #if defined(USE_ESP8266) && LWIP_VERSION_MAJOR == 1
270  static void dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg);
271 #else
272  static void dns_found_callback(const char *name, const ip_addr_t *ipaddr, void *callback_arg);
273 #endif
274 
276  void recalculate_availability_();
277 
278  bool subscribe_(const char *topic, uint8_t qos);
279  void resubscribe_subscription_(MQTTSubscription *sub);
280  void resubscribe_subscriptions_();
281 
289  bool sent_birth_message_{false};
292  Availability availability_{};
295  MQTTDiscoveryInfo discovery_info_{
296  .prefix = "homeassistant",
297  .retain = true,
298  .discover_ip = true,
299  .clean = false,
300  .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR,
301  .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR,
302  };
303  std::string topic_prefix_{};
305  std::string payload_buffer_;
306  int log_level_{ESPHOME_LOG_LEVEL};
307 
308  std::vector<MQTTSubscription> subscriptions_;
309 #if defined(USE_ESP32)
311 #elif defined(USE_ESP8266)
313 #elif defined(USE_LIBRETINY)
315 #endif
316 
319  bool dns_resolved_{false};
320  bool dns_resolve_error_{false};
321  std::vector<MQTTComponent *> children_;
322  uint32_t reboot_timeout_{300000};
323  uint32_t connect_begin_;
324  uint32_t last_connected_{0};
326 };
327 
328 extern MQTTClientComponent *global_mqtt_client; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
329 
330 class MQTTMessageTrigger : public Trigger<std::string>, public Component {
331  public:
332  explicit MQTTMessageTrigger(std::string topic);
333 
334  void set_qos(uint8_t qos);
335  void set_payload(const std::string &payload);
336  void setup() override;
337  void dump_config() override;
338  float get_setup_priority() const override;
339 
340  protected:
341  std::string topic_;
342  uint8_t qos_{0};
344 };
345 
346 class MQTTJsonMessageTrigger : public Trigger<JsonObjectConst> {
347  public:
348  explicit MQTTJsonMessageTrigger(const std::string &topic, uint8_t qos) {
349  global_mqtt_client->subscribe_json(
350  topic, [this](const std::string &topic, JsonObject root) { this->trigger(root); }, qos);
351  }
352 };
353 
354 class MQTTConnectTrigger : public Trigger<> {
355  public:
357  client->set_on_connect([this](bool session_present) { this->trigger(); });
358  }
359 };
360 
361 class MQTTDisconnectTrigger : public Trigger<> {
362  public:
364  client->set_on_disconnect([this](MQTTClientDisconnectReason reason) { this->trigger(); });
365  }
366 };
367 
368 template<typename... Ts> class MQTTPublishAction : public Action<Ts...> {
369  public:
370  MQTTPublishAction(MQTTClientComponent *parent) : parent_(parent) {}
371  TEMPLATABLE_VALUE(std::string, topic)
372  TEMPLATABLE_VALUE(std::string, payload)
373  TEMPLATABLE_VALUE(uint8_t, qos)
374  TEMPLATABLE_VALUE(bool, retain)
375 
376  void play(Ts... x) override {
377  this->parent_->publish(this->topic_.value(x...), this->payload_.value(x...), this->qos_.value(x...),
378  this->retain_.value(x...));
379  }
380 
381  protected:
382  MQTTClientComponent *parent_;
383 };
384 
385 template<typename... Ts> class MQTTPublishJsonAction : public Action<Ts...> {
386  public:
387  MQTTPublishJsonAction(MQTTClientComponent *parent) : parent_(parent) {}
388  TEMPLATABLE_VALUE(std::string, topic)
389  TEMPLATABLE_VALUE(uint8_t, qos)
390  TEMPLATABLE_VALUE(bool, retain)
391 
392  void set_payload(std::function<void(Ts..., JsonObject)> payload) { this->payload_ = payload; }
393 
394  void play(Ts... x) override {
395  auto f = std::bind(&MQTTPublishJsonAction<Ts...>::encode_, this, x..., std::placeholders::_1);
396  auto topic = this->topic_.value(x...);
397  auto qos = this->qos_.value(x...);
398  auto retain = this->retain_.value(x...);
399  this->parent_->publish_json(topic, f, qos, retain);
400  }
401 
402  protected:
403  void encode_(Ts... x, JsonObject root) { this->payload_(x..., root); }
404  std::function<void(Ts..., JsonObject)> payload_;
406 };
407 
408 template<typename... Ts> class MQTTConnectedCondition : public Condition<Ts...> {
409  public:
410  MQTTConnectedCondition(MQTTClientComponent *parent) : parent_(parent) {}
411  bool check(Ts... x) override { return this->parent_->is_connected(); }
412 
413  protected:
415 };
416 
417 } // namespace mqtt
418 } // namespace esphome
419 
420 #endif // USE_MQTT
void setup()
MQTTConnectedCondition(MQTTClientComponent *parent)
Definition: mqtt_client.h:410
const char * name
Definition: stm32flash.h:78
void loop()
std::function< void(Ts..., JsonObject)> payload_
Definition: mqtt_client.h:404
bool clean_session
Whether the session will be cleaned or remembered between connects.
Definition: mqtt_client.h:54
optional< std::string > payload_
Definition: mqtt_client.h:343
void set_client_id(const std::string &client_id)
Definition: mqtt_client.h:257
MQTTPublishAction(MQTTClientComponent *parent)
Definition: mqtt_client.h:370
std::string topic
Empty means disabled.
Definition: mqtt_client.h:59
MQTTDiscoveryUniqueIdGenerator unique_id_generator
Definition: mqtt_client.h:85
Internal struct for MQTT Home Assistant discovery.
Definition: mqtt_client.h:80
void set_cl_certificate(const char *cert)
Definition: mqtt_client.h:153
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:254
uint16_t x
Definition: tt21100.cpp:17
internal struct for MQTT messages.
Definition: mqtt_backend.h:24
std::vector< MQTTComponent * > children_
Definition: mqtt_client.h:321
void encode_(Ts... x, JsonObject root)
Definition: mqtt_client.h:403
STL namespace.
MQTTMessage last_will_
The last will message.
Definition: mqtt_client.h:285
bool discover_ip
Enable the Home Assistant device discovery.
Definition: mqtt_client.h:83
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition: mqtt_client.h:81
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:155
void set_on_connect(mqtt_on_connect_callback_t &&callback)
void set_password(const std::string &password)
Definition: mqtt_client.h:256
void set_broker_address(const std::string &address)
Definition: mqtt_client.h:253
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:348
MQTTBackendESP8266 mqtt_backend_
Definition: mqtt_client.h:312
uint16_t port
The port number of the server.
Definition: mqtt_client.h:50
MQTTDiscoveryUniqueIdGenerator
available discovery unique_id generators
Definition: mqtt_client.h:65
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:387
void set_ca_certificate(const char *cert)
Definition: mqtt_client.h:152
MQTTDiscoveryObjectIdGenerator
available discovery object_id generators
Definition: mqtt_client.h:71
internal struct for MQTT subscriptions.
Definition: mqtt_client.h:39
MQTTBackendLibreTiny mqtt_backend_
Definition: mqtt_client.h:314
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:58
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:288
void set_clean_session(const bool &clean_session)
Definition: mqtt_client.h:258
in_addr ip_addr_t
Definition: ip_address.h:22
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
std::string payload_not_available
Definition: mqtt_client.h:61
MQTTConnectTrigger(MQTTClientComponent *&client)
Definition: mqtt_client.h:356
uint8_t address
Definition: bl0906.h:211
std::vector< MQTTSubscription > subscriptions_
Definition: mqtt_client.h:308
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition: mqtt_client.h:86
void set_cl_key(const char *key)
Definition: mqtt_client.h:154
void set_username(const std::string &username)
Definition: mqtt_client.h:255
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:363
void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback)
bool retain
Whether to retain discovery messages.
Definition: mqtt_client.h:82
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...