ESPHome  2024.2.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_retain(bool retain) { this->retain_ = retain; }
18 
19 std::string MQTTComponent::get_discovery_topic_(const MQTTDiscoveryInfo &discovery_info) const {
20  std::string sanitized_name = str_sanitize(App.get_name());
21  return discovery_info.prefix + "/" + this->component_type() + "/" + sanitized_name + "/" +
22  this->get_default_object_id_() + "/config";
23 }
24 
25 std::string MQTTComponent::get_default_topic_for_(const std::string &suffix) const {
26  const std::string &topic_prefix = global_mqtt_client->get_topic_prefix();
27  if (topic_prefix.empty()) {
28  // If the topic_prefix is null, the default topic should be null
29  return "";
30  }
31 
32  return topic_prefix + "/" + this->component_type() + "/" + this->get_default_object_id_() + "/" + suffix;
33 }
34 
35 std::string MQTTComponent::get_state_topic_() const {
36  if (this->has_custom_state_topic_)
37  return this->custom_state_topic_.str();
38  return this->get_default_topic_for_("state");
39 }
40 
41 std::string MQTTComponent::get_command_topic_() const {
42  if (this->has_custom_command_topic_)
43  return this->custom_command_topic_.str();
44  return this->get_default_topic_for_("command");
45 }
46 
47 bool MQTTComponent::publish(const std::string &topic, const std::string &payload) {
48  if (topic.empty())
49  return false;
50  return global_mqtt_client->publish(topic, payload, 0, this->retain_);
51 }
52 
53 bool MQTTComponent::publish_json(const std::string &topic, const json::json_build_t &f) {
54  if (topic.empty())
55  return false;
56  return global_mqtt_client->publish_json(topic, f, 0, this->retain_);
57 }
58 
60  const MQTTDiscoveryInfo &discovery_info = global_mqtt_client->get_discovery_info();
61 
62  if (discovery_info.clean) {
63  ESP_LOGV(TAG, "'%s': Cleaning discovery...", this->friendly_name().c_str());
64  return global_mqtt_client->publish(this->get_discovery_topic_(discovery_info), "", 0, 0, true);
65  }
66 
67  ESP_LOGV(TAG, "'%s': Sending discovery...", this->friendly_name().c_str());
68 
70  this->get_discovery_topic_(discovery_info),
71  [this](JsonObject root) {
72  SendDiscoveryConfig config;
73  config.state_topic = true;
74  config.command_topic = true;
75 
76  this->send_discovery(root, config);
77 
78  // Fields from EntityBase
79  if (this->get_entity()->has_own_name()) {
80  root[MQTT_NAME] = this->friendly_name();
81  } else {
82  root[MQTT_NAME] = "";
83  }
84  if (this->is_disabled_by_default())
85  root[MQTT_ENABLED_BY_DEFAULT] = false;
86  if (!this->get_icon().empty())
87  root[MQTT_ICON] = this->get_icon();
88 
89  switch (this->get_entity()->get_entity_category()) {
91  break;
93  root[MQTT_ENTITY_CATEGORY] = "config";
94  break;
96  root[MQTT_ENTITY_CATEGORY] = "diagnostic";
97  break;
98  }
99 
100  if (config.state_topic)
101  root[MQTT_STATE_TOPIC] = this->get_state_topic_();
102  if (config.command_topic)
103  root[MQTT_COMMAND_TOPIC] = this->get_command_topic_();
104  if (this->command_retain_)
105  root[MQTT_COMMAND_RETAIN] = true;
106 
107  if (this->availability_ == nullptr) {
108  if (!global_mqtt_client->get_availability().topic.empty()) {
114  }
115  } else if (!this->availability_->topic.empty()) {
116  root[MQTT_AVAILABILITY_TOPIC] = this->availability_->topic;
117  if (this->availability_->payload_available != "online")
118  root[MQTT_PAYLOAD_AVAILABLE] = this->availability_->payload_available;
119  if (this->availability_->payload_not_available != "offline")
120  root[MQTT_PAYLOAD_NOT_AVAILABLE] = this->availability_->payload_not_available;
121  }
122 
123  std::string unique_id = this->unique_id();
124  const MQTTDiscoveryInfo &discovery_info = global_mqtt_client->get_discovery_info();
125  if (!unique_id.empty()) {
126  root[MQTT_UNIQUE_ID] = unique_id;
127  } else {
129  char friendly_name_hash[9];
130  sprintf(friendly_name_hash, "%08" PRIx32, fnv1_hash(this->friendly_name()));
131  friendly_name_hash[8] = 0; // ensure the hash-string ends with null
132  root[MQTT_UNIQUE_ID] = get_mac_address() + "-" + this->component_type() + "-" + friendly_name_hash;
133  } else {
134  // default to almost-unique ID. It's a hack but the only way to get that
135  // gorgeous device registry view.
136  root[MQTT_UNIQUE_ID] = "ESP" + this->component_type() + this->get_default_object_id_();
137  }
138  }
139 
140  const std::string &node_name = App.get_name();
142  root[MQTT_OBJECT_ID] = node_name + "_" + this->get_default_object_id_();
143 
144  std::string node_friendly_name = App.get_friendly_name();
145  if (node_friendly_name.empty()) {
146  node_friendly_name = node_name;
147  }
148  const std::string &node_area = App.get_area();
149 
150  JsonObject device_info = root.createNestedObject(MQTT_DEVICE);
151  device_info[MQTT_DEVICE_IDENTIFIERS] = get_mac_address();
152  device_info[MQTT_DEVICE_NAME] = node_friendly_name;
153  device_info[MQTT_DEVICE_SW_VERSION] = "esphome v" ESPHOME_VERSION " " + App.get_compilation_time();
154  device_info[MQTT_DEVICE_MODEL] = ESPHOME_BOARD;
155  device_info[MQTT_DEVICE_MANUFACTURER] = "espressif";
156  device_info[MQTT_DEVICE_SUGGESTED_AREA] = node_area;
157  },
158  0, discovery_info.retain);
159 }
160 
161 bool MQTTComponent::get_retain() const { return this->retain_; }
162 
165 }
166 
168  return str_sanitize(str_snake_case(this->friendly_name()));
169 }
170 
171 void MQTTComponent::subscribe(const std::string &topic, mqtt_callback_t callback, uint8_t qos) {
172  global_mqtt_client->subscribe(topic, std::move(callback), qos);
173 }
174 
175 void MQTTComponent::subscribe_json(const std::string &topic, const mqtt_json_callback_t &callback, uint8_t qos) {
176  global_mqtt_client->subscribe_json(topic, callback, qos);
177 }
178 
179 MQTTComponent::MQTTComponent() = default;
180 
183 void MQTTComponent::set_custom_state_topic(const char *custom_state_topic) {
184  this->custom_state_topic_ = StringRef(custom_state_topic);
185  this->has_custom_state_topic_ = true;
186 }
187 void MQTTComponent::set_custom_command_topic(const char *custom_command_topic) {
188  this->custom_command_topic_ = StringRef(custom_command_topic);
189  this->has_custom_command_topic_ = true;
190 }
191 void MQTTComponent::set_command_retain(bool command_retain) { this->command_retain_ = command_retain; }
192 
193 void MQTTComponent::set_availability(std::string topic, std::string payload_available,
194  std::string payload_not_available) {
195  this->availability_ = make_unique<Availability>();
196  this->availability_->topic = std::move(topic);
197  this->availability_->payload_available = std::move(payload_available);
198  this->availability_->payload_not_available = std::move(payload_not_available);
199 }
202  if (this->is_internal())
203  return;
204 
205  this->setup();
206 
208 
209  if (!this->is_connected_())
210  return;
211 
212  if (this->is_discovery_enabled()) {
213  if (!this->send_discovery_()) {
214  this->schedule_resend_state();
215  }
216  }
217  if (!this->send_initial_state()) {
218  this->schedule_resend_state();
219  }
220 }
221 
223  if (this->is_internal())
224  return;
225 
226  this->loop();
227 
228  if (!this->resend_state_ || !this->is_connected_()) {
229  return;
230  }
231 
232  this->resend_state_ = false;
233  if (this->is_discovery_enabled()) {
234  if (!this->send_discovery_()) {
235  this->schedule_resend_state();
236  }
237  }
238  if (!this->send_initial_state()) {
239  this->schedule_resend_state();
240  }
241 }
243  if (this->is_internal())
244  return;
245 
246  this->dump_config();
247 }
249 std::string MQTTComponent::unique_id() { return ""; }
251 
252 // Pull these properties from EntityBase if not overridden
253 std::string MQTTComponent::friendly_name() const { return this->get_entity()->get_name(); }
254 std::string MQTTComponent::get_icon() const { return this->get_entity()->get_icon(); }
257  if (this->has_custom_state_topic_) {
258  // If the custom state_topic is null, return true as it is internal and should not publish
259  // else, return false, as it is explicitly set to a topic, so it is not internal and should publish
260  return this->get_state_topic_().empty();
261  }
262 
263  if (this->has_custom_command_topic_) {
264  // If the custom command_topic is null, return true as it is internal and should not publish
265  // else, return false, as it is explicitly set to a topic, so it is not internal and should publish
266  return this->get_command_topic_().empty();
267  }
268 
269  // No custom topics have been set
270  if (this->get_default_topic_for_("").empty()) {
271  // If the default topic prefix is null, then the component, by default, is internal and should not publish
272  return true;
273  }
274 
275  // Use ESPHome's component internal state if topic_prefix is not null with no custom state_topic or command_topic
276  return this->get_entity()->is_internal();
277 }
278 
279 } // namespace mqtt
280 } // namespace esphome
281 
282 #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:279
std::string str() const
Definition: string_ref.h:73
virtual void loop()
This method will be called repeatedly.
Definition: component.cpp:49
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:263
const float AFTER_CONNECTION
For components that should be initialized after a data connection (API/MQTT) is connected.
Definition: component.cpp:26
constexpr const char *const MQTT_DEVICE_MODEL
Definition: mqtt_const.h:262
constexpr const char *const MQTT_NAME
Definition: mqtt_const.h:111
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
std::function< void(const std::string &, const std::string &)> mqtt_callback_t
Callback for MQTT subscriptions.
Definition: mqtt_client.h:35
constexpr const char *const MQTT_ENTITY_CATEGORY
Definition: mqtt_const.h:524
bool state_topic
If the state topic should be included. Defaults to true.
constexpr const char *const MQTT_PAYLOAD_AVAILABLE
Definition: mqtt_const.h:131
StringRef is a reference to a string owned by something else.
Definition: string_ref.h:21
const std::string & get_area() const
Get the area of this Application set by pre_setup().
Definition: application.h:166
const std::string & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
Definition: application.h:163
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:141
void disable_discovery()
Disable discovery. Sets friendly name to "".
constexpr const char *const MQTT_DEVICE_IDENTIFIERS
Definition: mqtt_const.h:259
std::string prefix
The Home Assistant discovery prefix. Empty means disabled.
Definition: mqtt_client.h:80
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:163
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:264
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:210
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:260
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:47
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:585
constexpr const char *const MQTT_COMMAND_TOPIC
Definition: mqtt_const.h:47
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:160
constexpr const char *const MQTT_DEVICE_MANUFACTURER
Definition: mqtt_const.h:261
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:286
MQTTComponent()
Constructs a MQTTComponent.
uint32_t fnv1_hash(const std::string &str)
Calculate a FNV-1 hash of str.
Definition: helpers.cpp:182
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:87
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:112
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
MQTTDiscoveryObjectIdGenerator object_id_generator
Definition: mqtt_client.h:84
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:60
constexpr const char *const MQTT_UNIQUE_ID
Definition: mqtt_const.h:245
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:173
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:56
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.
bool retain
Whether to retain discovery messages.
Definition: mqtt_client.h:81
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.