ESPHome  2023.3.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_ESP_IDF)
13 #include "mqtt_backend_idf.h"
14 #elif defined(USE_ARDUINO)
15 #include "mqtt_backend_arduino.h"
16 #endif
17 #include "lwip/ip_addr.h"
18 
19 #include <vector>
20 
21 namespace esphome {
22 namespace mqtt {
23 
26 using mqtt_on_connect_callback_t = std::function<MQTTBackend::on_connect_callback_t>;
27 using mqtt_on_disconnect_callback_t = std::function<MQTTBackend::on_disconnect_callback_t>;
28 
33 using mqtt_callback_t = std::function<void(const std::string &, const std::string &)>;
34 using mqtt_json_callback_t = std::function<void(const std::string &, JsonObject)>;
35 
38  std::string topic;
39  uint8_t qos;
41  bool subscribed;
43 };
44 
47  std::string address;
48  uint16_t port;
49  std::string username;
50  std::string password;
51  std::string client_id;
52 };
53 
55 struct Availability {
56  std::string topic;
57  std::string payload_available;
58  std::string payload_not_available;
59 };
60 
65 };
66 
71 };
72 
78  std::string prefix;
79  bool retain;
80  bool clean;
83 };
84 
90 };
91 
92 class MQTTComponent;
93 
95  public:
97 
99  void set_last_will(MQTTMessage &&message);
101  void disable_last_will();
102 
104  void set_birth_message(MQTTMessage &&message);
106  void disable_birth_message();
107 
108  void set_shutdown_message(MQTTMessage &&message);
109  void disable_shutdown_message();
110 
112  void set_keep_alive(uint16_t keep_alive_s);
113 
122  void set_discovery_info(std::string &&prefix, MQTTDiscoveryUniqueIdGenerator unique_id_generator,
123  MQTTDiscoveryObjectIdGenerator object_id_generator, bool retain, bool clean = false);
125  const MQTTDiscoveryInfo &get_discovery_info() const;
127  void disable_discovery();
128  bool is_discovery_enabled() const;
129 
130 #if ASYNC_TCP_SSL_ENABLED
131 
143  void add_ssl_fingerprint(const std::array<uint8_t, SHA1_SIZE> &fingerprint);
144 #endif
145 #ifdef USE_ESP_IDF
146  void set_ca_certificate(const char *cert) { this->mqtt_backend_.set_ca_certificate(cert); }
147  void set_skip_cert_cn_check(bool skip_check) { this->mqtt_backend_.set_skip_cert_cn_check(skip_check); }
148 #endif
149  const Availability &get_availability();
150 
159  void set_topic_prefix(const std::string &topic_prefix);
161  const std::string &get_topic_prefix() const;
162 
164  void set_log_message_template(MQTTMessage &&message);
165  void set_log_level(int level);
167  void disable_log_message();
168  bool is_log_message_enabled() const;
169 
176  void subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos = 0);
177 
187  void subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos = 0);
188 
196  void unsubscribe(const std::string &topic);
197 
202  bool publish(const MQTTMessage &message);
203 
210  bool publish(const std::string &topic, const std::string &payload, uint8_t qos = 0, bool retain = false);
211 
212  bool publish(const std::string &topic, const char *payload, size_t payload_length, uint8_t qos = 0,
213  bool retain = false);
214 
221  bool publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos = 0, bool retain = false);
222 
224  void setup() override;
225  void dump_config() override;
227  void loop() override;
229  float get_setup_priority() const override;
230 
231  void on_message(const std::string &topic, const std::string &payload);
232 
233  bool can_proceed() override;
234 
235  void check_connected();
236 
237  void set_reboot_timeout(uint32_t reboot_timeout);
238 
239  void register_mqtt_component(MQTTComponent *component);
240 
241  bool is_connected();
242 
243  void on_shutdown() override;
244 
245  void set_broker_address(const std::string &address) { this->credentials_.address = address; }
246  void set_broker_port(uint16_t port) { this->credentials_.port = port; }
247  void set_username(const std::string &username) { this->credentials_.username = username; }
248  void set_password(const std::string &password) { this->credentials_.password = password; }
249  void set_client_id(const std::string &client_id) { this->credentials_.client_id = client_id; }
250  void set_on_connect(mqtt_on_connect_callback_t &&callback);
251  void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback);
252 
253  protected:
255  void start_connect_();
256  void start_dnslookup_();
257  void check_dnslookup_();
258 #if defined(USE_ESP8266) && LWIP_VERSION_MAJOR == 1
259  static void dns_found_callback(const char *name, ip_addr_t *ipaddr, void *callback_arg);
260 #else
261  static void dns_found_callback(const char *name, const ip_addr_t *ipaddr, void *callback_arg);
262 #endif
263 
265  void recalculate_availability_();
266 
267  bool subscribe_(const char *topic, uint8_t qos);
268  void resubscribe_subscription_(MQTTSubscription *sub);
269  void resubscribe_subscriptions_();
270 
278  bool sent_birth_message_{false};
281  Availability availability_{};
284  MQTTDiscoveryInfo discovery_info_{
285  .prefix = "homeassistant",
286  .retain = true,
287  .clean = false,
288  .unique_id_generator = MQTT_LEGACY_UNIQUE_ID_GENERATOR,
289  .object_id_generator = MQTT_NONE_OBJECT_ID_GENERATOR,
290  };
291  std::string topic_prefix_{};
293  std::string payload_buffer_;
294  int log_level_{ESPHOME_LOG_LEVEL};
295 
296  std::vector<MQTTSubscription> subscriptions_;
297 #if defined(USE_ESP_IDF)
299 #elif defined(USE_ARDUINO)
301 #endif
302 
305  bool dns_resolved_{false};
306  bool dns_resolve_error_{false};
307  std::vector<MQTTComponent *> children_;
308  uint32_t reboot_timeout_{300000};
309  uint32_t connect_begin_;
310  uint32_t last_connected_{0};
312 };
313 
314 extern MQTTClientComponent *global_mqtt_client; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
315 
316 class MQTTMessageTrigger : public Trigger<std::string>, public Component {
317  public:
318  explicit MQTTMessageTrigger(std::string topic);
319 
320  void set_qos(uint8_t qos);
321  void set_payload(const std::string &payload);
322  void setup() override;
323  void dump_config() override;
324  float get_setup_priority() const override;
325 
326  protected:
327  std::string topic_;
328  uint8_t qos_{0};
330 };
331 
332 class MQTTJsonMessageTrigger : public Trigger<JsonObjectConst> {
333  public:
334  explicit MQTTJsonMessageTrigger(const std::string &topic, uint8_t qos) {
335  global_mqtt_client->subscribe_json(
336  topic, [this](const std::string &topic, JsonObject root) { this->trigger(root); }, qos);
337  }
338 };
339 
340 class MQTTConnectTrigger : public Trigger<> {
341  public:
343  client->set_on_connect([this](bool session_present) { this->trigger(); });
344  }
345 };
346 
347 class MQTTDisconnectTrigger : public Trigger<> {
348  public:
350  client->set_on_disconnect([this](MQTTClientDisconnectReason reason) { this->trigger(); });
351  }
352 };
353 
354 template<typename... Ts> class MQTTPublishAction : public Action<Ts...> {
355  public:
356  MQTTPublishAction(MQTTClientComponent *parent) : parent_(parent) {}
357  TEMPLATABLE_VALUE(std::string, topic)
358  TEMPLATABLE_VALUE(std::string, payload)
359  TEMPLATABLE_VALUE(uint8_t, qos)
360  TEMPLATABLE_VALUE(bool, retain)
361 
362  void play(Ts... x) override {
363  this->parent_->publish(this->topic_.value(x...), this->payload_.value(x...), this->qos_.value(x...),
364  this->retain_.value(x...));
365  }
366 
367  protected:
368  MQTTClientComponent *parent_;
369 };
370 
371 template<typename... Ts> class MQTTPublishJsonAction : public Action<Ts...> {
372  public:
373  MQTTPublishJsonAction(MQTTClientComponent *parent) : parent_(parent) {}
374  TEMPLATABLE_VALUE(std::string, topic)
375  TEMPLATABLE_VALUE(uint8_t, qos)
376  TEMPLATABLE_VALUE(bool, retain)
377 
378  void set_payload(std::function<void(Ts..., JsonObject)> payload) { this->payload_ = payload; }
379 
380  void play(Ts... x) override {
381  auto f = std::bind(&MQTTPublishJsonAction<Ts...>::encode_, this, x..., std::placeholders::_1);
382  auto topic = this->topic_.value(x...);
383  auto qos = this->qos_.value(x...);
384  auto retain = this->retain_.value(x...);
385  this->parent_->publish_json(topic, f, qos, retain);
386  }
387 
388  protected:
389  void encode_(Ts... x, JsonObject root) { this->payload_(x..., root); }
390  std::function<void(Ts..., JsonObject)> payload_;
392 };
393 
394 template<typename... Ts> class MQTTConnectedCondition : public Condition<Ts...> {
395  public:
396  MQTTConnectedCondition(MQTTClientComponent *parent) : parent_(parent) {}
397  bool check(Ts... x) override { return this->parent_->is_connected(); }
398 
399  protected:
401 };
402 
403 } // namespace mqtt
404 } // namespace esphome
405 
406 #endif // USE_MQTT
void setup()
MQTTConnectedCondition(MQTTClientComponent *parent)
Definition: mqtt_client.h:396
const char * name
Definition: stm32flash.h:78
void loop()
std::function< void(Ts..., JsonObject)> payload_
Definition: mqtt_client.h:390
optional< std::string > payload_
Definition: mqtt_client.h:329
void set_client_id(const std::string &client_id)
Definition: mqtt_client.h:249
MQTTPublishAction(MQTTClientComponent *parent)
Definition: mqtt_client.h:356
std::string topic
Empty means disabled.
Definition: mqtt_client.h:56
MQTTDiscoveryUniqueIdGenerator unique_id_generator
Definition: mqtt_client.h:81
Internal struct for MQTT Home Assistant discovery.
Definition: mqtt_client.h:77
std::function< void(const std::string &, const std::string &)> mqtt_callback_t
Callback for MQTT subscriptions.
Definition: mqtt_client.h:33
std::string client_id
The client ID. Will automatically be truncated to 23 characters.
Definition: mqtt_client.h:51
void set_broker_port(uint16_t port)
Definition: mqtt_client.h:246
internal struct for MQTT messages.
Definition: mqtt_backend.h:23
std::vector< MQTTComponent * > children_
Definition: mqtt_client.h:307
void encode_(Ts... x, JsonObject root)
Definition: mqtt_client.h:389
STL namespace.
MQTTMessage last_will_
The last will message.
Definition: mqtt_client.h:274
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition: mqtt_client.h:78
std::function< MQTTBackend::on_connect_callback_t > mqtt_on_connect_callback_t
Callback for MQTT events.
Definition: mqtt_client.h:26
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:147
void set_on_connect(mqtt_on_connect_callback_t &&callback)
void set_password(const std::string &password)
Definition: mqtt_client.h:248
void set_broker_address(const std::string &address)
Definition: mqtt_client.h:245
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:334
uint16_t port
The port number of the server.
Definition: mqtt_client.h:48
MQTTDiscoveryUniqueIdGenerator
available discovery unique_id generators
Definition: mqtt_client.h:62
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:373
void set_ca_certificate(const char *cert)
Definition: mqtt_client.h:146
MQTTDiscoveryObjectIdGenerator
available discovery object_id generators
Definition: mqtt_client.h:68
internal struct for MQTT subscriptions.
Definition: mqtt_client.h:37
std::string address
The address of the server without port number.
Definition: mqtt_client.h:47
Simple data struct for Home Assistant component availability.
Definition: mqtt_client.h:55
std::function< MQTTBackend::on_disconnect_callback_t > mqtt_on_disconnect_callback_t
Definition: mqtt_client.h:27
MQTTMessage birth_message_
The birth message (e.g.
Definition: mqtt_client.h:277
Definition: a4988.cpp:4
std::string payload_not_available
Definition: mqtt_client.h:58
MQTTConnectTrigger(MQTTClientComponent *&client)
Definition: mqtt_client.h:342
std::vector< MQTTSubscription > subscriptions_
Definition: mqtt_client.h:296
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition: mqtt_client.h:82
void set_username(const std::string &username)
Definition: mqtt_client.h:247
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:46
MQTTDisconnectTrigger(MQTTClientComponent *&client)
Definition: mqtt_client.h:349
MQTTBackendArduino mqtt_backend_
Definition: mqtt_client.h:300
void set_on_disconnect(mqtt_on_disconnect_callback_t &&callback)
bool retain
Whether to retain discovery messages.
Definition: mqtt_client.h:79
std::function< void(const std::string &, JsonObject)> mqtt_json_callback_t
Definition: mqtt_client.h:34
MQTTComponent is the base class for all components that interact with MQTT to expose certain function...