ESPHome  2024.11.1
mqtt_component.cpp
Go to the documentation of this file.
1 #include "mqtt_component.h"
2 
3 #ifdef USE_MQTT
4 
6 #include "esphome/core/helpers.h"
7 #include "esphome/core/log.h"
8 #include "esphome/core/version.h"
9 
10 #include "mqtt_const.h"
11 
12 namespace esphome {
13 namespace mqtt {
14 
15 static const char *const TAG = "mqtt.component";
16 
17 void MQTTComponent::set_qos(uint8_t qos) { this->qos_ = qos; }
18 
19 void MQTTComponent::set_subscribe_qos(uint8_t qos) { this->subscribe_qos_ = qos; }
20 
21 void MQTTComponent::set_retain(bool retain) { this->retain_ = retain; }
22 
23 std::string MQTTComponent::get_discovery_topic_(const MQTTDiscoveryInfo &discovery_info) const {
24  std::string sanitized_name = str_sanitize(App.get_name());
25  return discovery_info.prefix + "/" + this->component_type() + "/" + sanitized_name + "/" +
26  this->get_default_object_id_() + "/config";
27 }
28 
29 std::string MQTTComponent::get_default_topic_for_(const std::string &suffix) const {
30  const std::string &topic_prefix = global_mqtt_client->get_topic_prefix();
31  if (topic_prefix.empty()) {
32  // If the topic_prefix is null, the default topic should be null
33  return "";
34  }
35 
36  return topic_prefix + "/" + this->component_type() + "/" + this->get_default_object_id_() + "/" + suffix;
37 }
38 
39 std::string MQTTComponent::get_state_topic_() const {
40  if (this->has_custom_state_topic_)
41  return this->custom_state_topic_.str();
42  return this->get_default_topic_for_("state");
43 }
44 
45 std::string MQTTComponent::get_command_topic_() const {
46  if (this->has_custom_command_topic_)
47  return this->custom_command_topic_.str();
48  return this->get_default_topic_for_("command");
49 }
50 
51 bool MQTTComponent::publish(const std::string &topic, const std::string &payload) {
52  if (topic.empty())
53  return false;
54  return global_mqtt_client->publish(topic, payload, this->qos_, this->retain_);
55 }
56 
57 bool MQTTComponent::publish_json(const std::string &topic, const json::json_build_t &f) {
58  if (topic.empty())
59  return false;
60  return global_mqtt_client->publish_json(topic, f, this->qos_, this->retain_);
61 }
62 
64  const MQTTDiscoveryInfo &discovery_info = global_mqtt_client->get_discovery_info();
65 
66  if (discovery_info.clean) {
67  ESP_LOGV(TAG, "'%s': Cleaning discovery...", this->friendly_name().c_str());
68  return global_mqtt_client->publish(this->get_discovery_topic_(discovery_info), "", 0, this->qos_, true);
69  }
70 
71  ESP_LOGV(TAG, "'%s': Sending discovery...", this->friendly_name().c_str());
72 
74  this->get_discovery_topic_(discovery_info),
75  [this](JsonObject root) {
76  SendDiscoveryConfig config;
77  config.state_topic = true;
78  config.command_topic = true;
79 
80  this->send_discovery(root, config);
81  // Set subscription QoS (default is 0)
82  if (this->subscribe_qos_ != 0) {
83  root[MQTT_QOS] = this->subscribe_qos_;
84  }
85 
86  // Fields from EntityBase
87  if (this->get_entity()->has_own_name()) {
88  root[MQTT_NAME] = this->friendly_name();
89  } else {
90  root[MQTT_NAME] = "";
91  }
92  if (this->is_disabled_by_default())
93  root[MQTT_ENABLED_BY_DEFAULT] = false;
94  if (!this->get_icon().empty())
95  root[MQTT_ICON] = this->get_icon();
96 
97  switch (this->get_entity()->get_entity_category()) {
99  break;
101  root[MQTT_ENTITY_CATEGORY] = "config";
102  break;
104  root[MQTT_ENTITY_CATEGORY] = "diagnostic";
105  break;
106  }
107 
108  if (config.state_topic)
109  root[MQTT_STATE_TOPIC] = this->get_state_topic_();
110  if (config.command_topic)
111  root[MQTT_COMMAND_TOPIC] = this->get_command_topic_();
112  if (this->command_retain_)
113  root[MQTT_COMMAND_RETAIN] = true;
114 
115  if (this->availability_ == nullptr) {
116  if (!global_mqtt_client->get_availability().topic.empty()) {
122  }
123  } else if (!this->availability_->topic.empty()) {
124  root[MQTT_AVAILABILITY_TOPIC] = this->availability_->topic;
125  if (this->availability_->payload_available != "online")
126  root[MQTT_PAYLOAD_AVAILABLE] = this->availability_->payload_available;
127  if (this->availability_->payload_not_available != "offline")
128  root[MQTT_PAYLOAD_NOT_AVAILABLE] = this->availability_->payload_not_available;
129  }
130 
131  std::string unique_id = this->unique_id();
132  const MQTTDiscoveryInfo &discovery_info = global_mqtt_client->get_discovery_info();
133  if (!unique_id.empty()) {
134  root[MQTT_UNIQUE_ID] = unique_id;
135  } else {
137  char friendly_name_hash[9];
138  sprintf(friendly_name_hash, "%08" PRIx32, fnv1_hash(this->friendly_name()));
139  friendly_name_hash[8] = 0; // ensure the hash-string ends with null
140  root[MQTT_UNIQUE_ID] = get_mac_address() + "-" + this->component_type() + "-" + friendly_name_hash;
141  } else {
142  // default to almost-unique ID. It's a hack but the only way to get that
143  // gorgeous device registry view.
144  root[MQTT_UNIQUE_ID] = "ESP" + this->component_type() + this->get_default_object_id_();
145  }
146  }
147 
148  const std::string &node_name = App.get_name();
150  root[MQTT_OBJECT_ID] = node_name + "_" + this->get_default_object_id_();
151 
152  std::string node_friendly_name = App.get_friendly_name();
153  if (node_friendly_name.empty()) {
154  node_friendly_name = node_name;
155  }
156  const std::string &node_area = App.get_area();
157 
158  JsonObject device_info = root.createNestedObject(MQTT_DEVICE);
159  const auto mac = get_mac_address();
160  device_info[MQTT_DEVICE_IDENTIFIERS] = mac;
161  device_info[MQTT_DEVICE_NAME] = node_friendly_name;
162 #ifdef ESPHOME_PROJECT_NAME
163  device_info[MQTT_DEVICE_SW_VERSION] = ESPHOME_PROJECT_VERSION " (ESPHome " ESPHOME_VERSION ")";
164  const char *model = std::strchr(ESPHOME_PROJECT_NAME, '.');
165  if (model == nullptr) { // must never happen but check anyway
166  device_info[MQTT_DEVICE_MODEL] = ESPHOME_BOARD;
167  device_info[MQTT_DEVICE_MANUFACTURER] = ESPHOME_PROJECT_NAME;
168  } else {
169  device_info[MQTT_DEVICE_MODEL] = model + 1;
170  device_info[MQTT_DEVICE_MANUFACTURER] = std::string(ESPHOME_PROJECT_NAME, model - ESPHOME_PROJECT_NAME);
171  }
172 #else
173  device_info[MQTT_DEVICE_SW_VERSION] = ESPHOME_VERSION " (" + App.get_compilation_time() + ")";
174  device_info[MQTT_DEVICE_MODEL] = ESPHOME_BOARD;
175 #if defined(USE_ESP8266) || defined(USE_ESP32)
176  device_info[MQTT_DEVICE_MANUFACTURER] = "Espressif";
177 #elif defined(USE_RP2040)
178  device_info[MQTT_DEVICE_MANUFACTURER] = "Raspberry Pi";
179 #elif defined(USE_BK72XX)
180  device_info[MQTT_DEVICE_MANUFACTURER] = "Beken";
181 #elif defined(USE_RTL87XX)
182  device_info[MQTT_DEVICE_MANUFACTURER] = "Realtek";
183 #elif defined(USE_HOST)
184  device_info[MQTT_DEVICE_MANUFACTURER] = "Host";
185 #endif
186 #endif
187  if (!node_area.empty()) {
188  device_info[MQTT_DEVICE_SUGGESTED_AREA] = node_area;
189  }
190 
191  device_info[MQTT_DEVICE_CONNECTIONS][0][0] = "mac";
192  device_info[MQTT_DEVICE_CONNECTIONS][0][1] = mac;
193  },
194  this->qos_, discovery_info.retain);
195 }
196 
197 uint8_t MQTTComponent::get_qos() const { return this->qos_; }
198 
199 bool MQTTComponent::get_retain() const { return this->retain_; }
200 
203 }
204 
206  return str_sanitize(str_snake_case(this->friendly_name()));
207 }
208 
209 void MQTTComponent::subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos) {
210  global_mqtt_client->subscribe(topic, std::move(callback), qos);
211 }
212 
213 void MQTTComponent::subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos) {
214  global_mqtt_client->subscribe_json(topic, callback, qos);
215 }
216 
217 MQTTComponent::MQTTComponent() = default;
218 
221 void MQTTComponent::set_custom_state_topic(const char *custom_state_topic) {
222  this->custom_state_topic_ = StringRef(custom_state_topic);
223  this->has_custom_state_topic_ = true;
224 }
225 void MQTTComponent::set_custom_command_topic(const char *custom_command_topic) {
226  this->custom_command_topic_ = StringRef(custom_command_topic);
227  this->has_custom_command_topic_ = true;
228 }
229 void MQTTComponent::set_command_retain(bool command_retain) { this->command_retain_ = command_retain; }
230 
231 void MQTTComponent::set_availability(std::string topic, std::string payload_available,
232  std::string payload_not_available) {
233  this->availability_ = make_unique<Availability>();
234  this->availability_->topic = std::move(topic);
235  this->availability_->payload_available = std::move(payload_available);
236  this->availability_->payload_not_available = std::move(payload_not_available);
237 }
240  if (this->is_internal())
241  return;
242 
243  this->setup();
244 
246 
247  if (!this->is_connected_())
248  return;
249 
250  if (this->is_discovery_enabled()) {
251  if (!this->send_discovery_()) {
252  this->schedule_resend_state();
253  }
254  }
255  if (!this->send_initial_state()) {
256  this->schedule_resend_state();
257  }
258 }
259 
261  if (this->is_internal())
262  return;
263 
264  this->loop();
265 
266  if (!this->resend_state_ || !this->is_connected_()) {
267  return;
268  }
269 
270  this->resend_state_ = false;
271  if (this->is_discovery_enabled()) {
272  if (!this->send_discovery_()) {
273  this->schedule_resend_state();
274  }
275  }
276  if (!this->send_initial_state()) {
277  this->schedule_resend_state();
278  }
279 }
281  if (this->is_internal())
282  return;
283 
284  this->dump_config();
285 }
287 std::string MQTTComponent::unique_id() { return ""; }
289 
290 // Pull these properties from EntityBase if not overridden
291 std::string MQTTComponent::friendly_name() const { return this->get_entity()->get_name(); }
292 std::string MQTTComponent::get_icon() const { return this->get_entity()->get_icon(); }
295  if (this->has_custom_state_topic_) {
296  // If the custom state_topic is null, return true as it is internal and should not publish
297  // else, return false, as it is explicitly set to a topic, so it is not internal and should publish
298  return this->get_state_topic_().empty();
299  }
300 
301  if (this->has_custom_command_topic_) {
302  // If the custom command_topic is null, return true as it is internal and should not publish
303  // else, return false, as it is explicitly set to a topic, so it is not internal and should publish
304  return this->get_command_topic_().empty();
305  }
306 
307  // No custom topics have been set
308  if (this->get_default_topic_for_("").empty()) {
309  // If the default topic prefix is null, then the component, by default, is internal and should not publish
310  return true;
311  }
312 
313  // Use ESPHome's component internal state if topic_prefix is not null with no custom state_topic or command_topic
314  return this->get_entity()->is_internal();
315 }
316 
317 } // namespace mqtt
318 } // namespace esphome
319 
320 #endif // USE_MQTT
float get_setup_priority() const override
MQTT_COMPONENT setup priority.
const Availability & get_availability()
std::string str_snake_case(const std::string &str)
Convert the string to snake case (lowercase with underscores).
Definition: helpers.cpp:284
std::string str() const
Definition: string_ref.h:73
virtual void loop()
This method will be called repeatedly.
Definition: component.cpp:50
std::string get_default_topic_for_(const std::string &suffix) const
Get this components state/command/...
constexpr const char *const MQTT_DEVICE_SW_VERSION
Definition: mqtt_const.h:65
const float AFTER_CONNECTION
For components that should be initialized after a data connection (API/MQTT) is connected.
Definition: component.cpp:27
void set_subscribe_qos(uint8_t qos)
Set the QOS for subscribe messages (used in discovery).
constexpr const char *const MQTT_DEVICE_MODEL
Definition: mqtt_const.h:62
constexpr const char *const MQTT_NAME
Definition: mqtt_const.h:120
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
std::function< void(const std::string &, const std::string &)> mqtt_callback_t
Callback for MQTT subscriptions.
Definition: mqtt_client.h:35
bool state_topic
If the state topic should be included. Defaults to true.
constexpr const char *const MQTT_PAYLOAD_AVAILABLE
Definition: mqtt_const.h:136
StringRef is a reference to a string owned by something else.
Definition: string_ref.h:21
constexpr const char *const MQTT_ENTITY_CATEGORY
Definition: mqtt_const.h:75
const std::string & get_area() const
Get the area of this Application set by pre_setup().
Definition: application.h:208
const std::string & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
Definition: application.h:205
void set_custom_state_topic(const char *custom_state_topic)
Set a custom state topic. Set to "" for default behavior.
constexpr const char *const MQTT_PAYLOAD_NOT_AVAILABLE
Definition: mqtt_const.h:147
void disable_discovery()
Disable discovery. Sets friendly name to "".
constexpr const char *const MQTT_DEVICE_IDENTIFIERS
Definition: mqtt_const.h:60
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition: mqtt_client.h:81
bool publish_json(const std::string &topic, const json::json_build_t &f)
Construct and send a JSON MQTT message.
const std::string & get_topic_prefix() const
Get the topic prefix of this device, using default if necessary.
virtual void dump_config()
Definition: component.cpp:186
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.
constexpr const char *const MQTT_DEVICE_SUGGESTED_AREA
Definition: mqtt_const.h:64
bool command_topic
If the command topic should be included. Default to true.
bool publish(const std::string &topic, const std::string &payload)
Send a MQTT message.
virtual void send_discovery(JsonObject root, SendDiscoveryConfig &config)=0
Send discovery info the Home Assistant, override this.
MQTTClientComponent * global_mqtt_client
std::string get_icon() const
Definition: entity_base.cpp:30
void set_custom_command_topic(const char *custom_command_topic)
Set a custom command topic. Set to "" for default behavior.
constexpr const char *const MQTT_STATE_TOPIC
Definition: mqtt_const.h:221
void subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos=0)
Subscribe to a MQTT topic.
void set_retain(bool retain)
Set whether state message should be retained.
constexpr const char *const MQTT_DEVICE_NAME
Definition: mqtt_const.h:63
void set_availability(std::string topic, std::string payload_available, std::string payload_not_available)
Set the Home Assistant availability data.
virtual void setup()
Where the component&#39;s initialization should happen.
Definition: component.cpp:48
virtual const EntityBase * get_entity() const =0
Gets the Entity served by this MQTT component.
virtual std::string component_type() const =0
Override this method to return the component type (e.g. "light", "sensor", ...)
void register_mqtt_component(MQTTComponent *component)
bool publish(const MQTTMessage &message)
Publish a MQTTMessage.
std::string get_mac_address()
Get the device MAC address as a string, in lowercase hex notation.
Definition: helpers.cpp:706
constexpr const char *const MQTT_COMMAND_TOPIC
Definition: mqtt_const.h:50
bool is_internal() const
Definition: entity_base.cpp:22
Simple Helper struct used for Home Assistant MQTT send_discovery().
virtual bool send_initial_state()=0
std::function< void(JsonObject)> json_build_t
Callback function typedef for building JsonObjects.
Definition: json_util.h:20
Application App
Global storage of Application pointer - only one Application can exist.
const std::string & get_name() const
Get the name of this Application set by pre_setup().
Definition: application.h:202
constexpr const char *const MQTT_DEVICE_MANUFACTURER
Definition: mqtt_const.h:61
bool publish_json(const std::string &topic, const json::json_build_t &f, uint8_t qos=0, bool retain=false)
Construct and send a JSON MQTT message.
constexpr const char *const MQTT_COMMAND_RETAIN
Definition: mqtt_const.h:48
const MQTTDiscoveryInfo & get_discovery_info() const
Get Home Assistant discovery info.
void call_setup() override
Override setup_ so that we can call send_discovery() when needed.
std::string str_sanitize(const std::string &str)
Sanitizes the input string by removing all characters but alphanumerics, dashes and underscores...
Definition: helpers.cpp:291
void set_qos(uint8_t qos)
Set QOS for state messages.
constexpr const char *const MQTT_QOS
Definition: mqtt_const.h:184
MQTTComponent()
Constructs a MQTTComponent.
uint32_t fnv1_hash(const std::string &str)
Calculate a FNV-1 hash of str.
Definition: helpers.cpp:183
virtual std::string get_icon() const
Get the icon field of this component.
virtual bool is_disabled_by_default() const
Get whether the underlying Entity is disabled by default.
constexpr const char *const MQTT_ICON
Definition: mqtt_const.h:99
std::unique_ptr< Availability > availability_
virtual std::string friendly_name() const
Get the friendly name of this MQTT component.
constexpr const char *const MQTT_OBJECT_ID
Definition: mqtt_const.h:121
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
std::string payload_not_available
Definition: mqtt_client.h:61
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition: mqtt_client.h:86
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.
constexpr const char *const MQTT_ENABLED_BY_DEFAULT
Definition: mqtt_const.h:74
constexpr const char *const MQTT_UNIQUE_ID
Definition: mqtt_const.h:261
constexpr const char *const MQTT_AVAILABILITY_TOPIC
Definition: mqtt_const.h:20
std::string get_state_topic_() const
Get the MQTT topic that new states will be shared to.
virtual std::string unique_id()
A unique ID for this MQTT component, empty for no unique id.
void set_command_retain(bool command_retain)
Set whether command message should be retained.
std::string get_compilation_time() const
Definition: application.h:215
std::string get_default_object_id_() const
Generate the Home Assistant MQTT discovery object id by automatically transforming the friendly name...
std::string get_command_topic_() const
Get the MQTT topic for listening to commands.
bool is_disabled_by_default() const
Definition: entity_base.cpp:26
void subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos=0)
Subscribe to an MQTT topic and call callback when a message is received.
constexpr const char *const MQTT_DEVICE
Definition: mqtt_const.h:57
const StringRef & get_name() const
Definition: entity_base.cpp:10
std::string get_discovery_topic_(const MQTTDiscoveryInfo &discovery_info) const
Helper method to get the discovery topic for this component.
constexpr const char *const MQTT_DEVICE_CONNECTIONS
Definition: mqtt_const.h:59
bool retain
Whether to retain discovery messages.
Definition: mqtt_client.h:82
bool send_discovery_()
Internal method to start sending discovery info, this will call send_discovery(). ...
std::function< void(const std::string &, JsonObject)> mqtt_json_callback_t
Definition: mqtt_client.h:36
void schedule_resend_state()
Internal method for the MQTT client base to schedule a resend of the state on reconnect.