[core] Update Entities (#6885)

esphome/components/mqtt/__init__.py

@@ -126,6 +126,7 @@ MQTTSelectComponent = mqtt_ns.class_("MQTTSelectComponent", MQTTComponent)
 MQTTButtonComponent = mqtt_ns.class_("MQTTButtonComponent", MQTTComponent)
 MQTTLockComponent = mqtt_ns.class_("MQTTLockComponent", MQTTComponent)
 MQTTEventComponent = mqtt_ns.class_("MQTTEventComponent", MQTTComponent)
+MQTTUpdateComponent = mqtt_ns.class_("MQTTUpdateComponent", MQTTComponent)
 MQTTValveComponent = mqtt_ns.class_("MQTTValveComponent", MQTTComponent)
 
 MQTTDiscoveryUniqueIdGenerator = mqtt_ns.enum("MQTTDiscoveryUniqueIdGenerator")

esphome/components/mqtt/mqtt_const.h

@@ -137,6 +137,7 @@ constexpr const char *const MQTT_PAYLOAD_CLOSE = "pl_cls";
 constexpr const char *const MQTT_PAYLOAD_DISARM = "pl_disarm";
 constexpr const char *const MQTT_PAYLOAD_HIGH_SPEED = "pl_hi_spd";
 constexpr const char *const MQTT_PAYLOAD_HOME = "pl_home";
+constexpr const char *const MQTT_PAYLOAD_INSTALL = "pl_inst";
 constexpr const char *const MQTT_PAYLOAD_LOCATE = "pl_loc";
 constexpr const char *const MQTT_PAYLOAD_LOCK = "pl_lock";
 constexpr const char *const MQTT_PAYLOAD_LOW_SPEED = "pl_lo_spd";
@@ -396,6 +397,7 @@ constexpr const char *const MQTT_PAYLOAD_CLOSE = "payload_close";
 constexpr const char *const MQTT_PAYLOAD_DISARM = "payload_disarm";
 constexpr const char *const MQTT_PAYLOAD_HIGH_SPEED = "payload_high_speed";
 constexpr const char *const MQTT_PAYLOAD_HOME = "payload_home";
+constexpr const char *const MQTT_PAYLOAD_INSTALL = "payload_install";
 constexpr const char *const MQTT_PAYLOAD_LOCATE = "payload_locate";
 constexpr const char *const MQTT_PAYLOAD_LOCK = "payload_lock";
 constexpr const char *const MQTT_PAYLOAD_LOW_SPEED = "payload_low_speed";

esphome/components/mqtt/mqtt_update.cpp

@@ -0,0 +1,62 @@
+#include "mqtt_update.h"
+#include "esphome/core/log.h"
+
+#include "mqtt_const.h"
+
+#ifdef USE_MQTT
+#ifdef USE_UPDATE
+
+namespace esphome {
+namespace mqtt {
+
+static const char *const TAG = "mqtt.update";
+
+using namespace esphome::update;
+
+MQTTUpdateComponent::MQTTUpdateComponent(UpdateEntity *update) : update_(update) {}
+
+void MQTTUpdateComponent::setup() {
+  this->subscribe(this->get_command_topic_(), [this](const std::string &topic, const std::string &payload) {
+    if (payload == "INSTALL") {
+      this->update_->perform();
+    } else {
+      ESP_LOGW(TAG, "'%s': Received unknown update payload: %s", this->friendly_name().c_str(), payload.c_str());
+      this->status_momentary_warning("state", 5000);
+    }
+  });
+
+  this->update_->add_on_state_callback([this]() { this->defer("send", [this]() { this->publish_state(); }); });
+}
+
+bool MQTTUpdateComponent::publish_state() {
+  return this->publish_json(this->get_state_topic_(), [this](JsonObject root) {
+    root["installed_version"] = this->update_->update_info.current_version;
+    root["latest_version"] = this->update_->update_info.latest_version;
+    root["title"] = this->update_->update_info.title;
+    if (!this->update_->update_info.summary.empty())
+      root["release_summary"] = this->update_->update_info.summary;
+    if (!this->update_->update_info.release_url.empty())
+      root["release_url"] = this->update_->update_info.release_url;
+  });
+}
+
+void MQTTUpdateComponent::send_discovery(JsonObject root, mqtt::SendDiscoveryConfig &config) {
+  root["schema"] = "json";
+  root[MQTT_PAYLOAD_INSTALL] = "INSTALL";
+}
+
+bool MQTTUpdateComponent::send_initial_state() { return this->publish_state(); }
+
+void MQTTUpdateComponent::dump_config() {
+  ESP_LOGCONFIG(TAG, "MQTT Update '%s': ", this->update_->get_name().c_str());
+  LOG_MQTT_COMPONENT(true, true);
+}
+
+std::string MQTTUpdateComponent::component_type() const { return "update"; }
+const EntityBase *MQTTUpdateComponent::get_entity() const { return this->update_; }
+
+}  // namespace mqtt
+}  // namespace esphome
+
+#endif  // USE_UPDATE
+#endif  // USE_MQTT

esphome/components/mqtt/mqtt_update.h

@@ -0,0 +1,41 @@
+#pragma once
+
+#include "esphome/core/defines.h"
+
+#ifdef USE_MQTT
+#ifdef USE_UPDATE
+
+#include "esphome/components/update/update_entity.h"
+#include "mqtt_component.h"
+
+namespace esphome {
+namespace mqtt {
+
+class MQTTUpdateComponent : public mqtt::MQTTComponent {
+ public:
+  explicit MQTTUpdateComponent(update::UpdateEntity *update);
+
+  // ========== INTERNAL METHODS ==========
+  // (In most use cases you won't need these)
+  void setup() override;
+  void dump_config() override;
+
+  void send_discovery(JsonObject root, mqtt::SendDiscoveryConfig &config) override;
+
+  bool send_initial_state() override;
+
+  bool publish_state();
+
+ protected:
+  /// "update" component type.
+  std::string component_type() const override;
+  const EntityBase *get_entity() const override;
+
+  update::UpdateEntity *update_;
+};
+
+}  // namespace mqtt
+}  // namespace esphome
+
+#endif  // USE_UPDATE
+#endif  // USE_MQTT