[core] Update Entities (#6885)

esphome/components/http_request/update/__init__.py

@@ -0,0 +1,44 @@
+import esphome.config_validation as cv
+import esphome.codegen as cg
+
+from esphome.components import update
+from esphome.const import (
+    CONF_SOURCE,
+)
+
+from .. import http_request_ns, CONF_HTTP_REQUEST_ID, HttpRequestComponent
+from ..ota import OtaHttpRequestComponent
+
+
+AUTO_LOAD = ["json"]
+CODEOWNERS = ["@jesserockz"]
+DEPENDENCIES = ["ota.http_request"]
+
+HttpRequestUpdate = http_request_ns.class_(
+    "HttpRequestUpdate", update.UpdateEntity, cg.PollingComponent
+)
+
+CONF_OTA_ID = "ota_id"
+
+CONFIG_SCHEMA = update.UPDATE_SCHEMA.extend(
+    {
+        cv.GenerateID(): cv.declare_id(HttpRequestUpdate),
+        cv.GenerateID(CONF_OTA_ID): cv.use_id(OtaHttpRequestComponent),
+        cv.GenerateID(CONF_HTTP_REQUEST_ID): cv.use_id(HttpRequestComponent),
+        cv.Required(CONF_SOURCE): cv.url,
+    }
+).extend(cv.polling_component_schema("6h"))
+
+
+async def to_code(config):
+    var = await update.new_update(config)
+    ota_parent = await cg.get_variable(config[CONF_OTA_ID])
+    cg.add(var.set_ota_parent(ota_parent))
+    request_parent = await cg.get_variable(config[CONF_HTTP_REQUEST_ID])
+    cg.add(var.set_request_parent(request_parent))
+
+    cg.add(var.set_source_url(config[CONF_SOURCE]))
+
+    cg.add_define("USE_OTA_STATE_CALLBACK")
+
+    await cg.register_component(var, config)

esphome/components/http_request/update/http_request_update.cpp

@@ -0,0 +1,157 @@
+#include "http_request_update.h"
+
+#include "esphome/core/application.h"
+#include "esphome/core/version.h"
+
+#include "esphome/components/json/json_util.h"
+#include "esphome/components/network/util.h"
+
+namespace esphome {
+namespace http_request {
+
+static const char *const TAG = "http_request.update";
+
+static const size_t MAX_READ_SIZE = 256;
+
+void HttpRequestUpdate::setup() {
+  this->ota_parent_->add_on_state_callback([this](ota::OTAState state, float progress, uint8_t err) {
+    if (state == ota::OTAState::OTA_IN_PROGRESS) {
+      this->state_ = update::UPDATE_STATE_INSTALLING;
+      this->update_info_.has_progress = true;
+      this->update_info_.progress = progress;
+      this->publish_state();
+    } else if (state == ota::OTAState::OTA_ABORT || state == ota::OTAState::OTA_ERROR) {
+      this->state_ = update::UPDATE_STATE_AVAILABLE;
+      this->status_set_error("Failed to install firmware");
+      this->publish_state();
+    }
+  });
+}
+
+void HttpRequestUpdate::update() {
+  auto container = this->request_parent_->get(this->source_url_);
+
+  if (container == nullptr) {
+    std::string msg = str_sprintf("Failed to fetch manifest from %s", this->source_url_.c_str());
+    this->status_set_error(msg.c_str());
+    return;
+  }
+
+  ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
+  uint8_t *data = allocator.allocate(container->content_length);
+  if (data == nullptr) {
+    std::string msg = str_sprintf("Failed to allocate %d bytes for manifest", container->content_length);
+    this->status_set_error(msg.c_str());
+    container->end();
+    return;
+  }
+
+  size_t read_index = 0;
+  while (container->get_bytes_read() < container->content_length) {
+    int read_bytes = container->read(data + read_index, MAX_READ_SIZE);
+
+    App.feed_wdt();
+    yield();
+
+    read_index += read_bytes;
+  }
+
+  std::string response((char *) data, read_index);
+  allocator.deallocate(data, container->content_length);
+
+  container->end();
+
+  bool valid = json::parse_json(response, [this](JsonObject root) -> bool {
+    if (!root.containsKey("name") || !root.containsKey("version") || !root.containsKey("builds")) {
+      ESP_LOGE(TAG, "Manifest does not contain required fields");
+      return false;
+    }
+    this->update_info_.title = root["name"].as<std::string>();
+    this->update_info_.latest_version = root["version"].as<std::string>();
+
+    for (auto build : root["builds"].as<JsonArray>()) {
+      if (!build.containsKey("chipFamily")) {
+        ESP_LOGE(TAG, "Manifest does not contain required fields");
+        return false;
+      }
+      if (build["chipFamily"] == ESPHOME_VARIANT) {
+        if (!build.containsKey("ota")) {
+          ESP_LOGE(TAG, "Manifest does not contain required fields");
+          return false;
+        }
+        auto ota = build["ota"];
+        if (!ota.containsKey("path") || !ota.containsKey("md5")) {
+          ESP_LOGE(TAG, "Manifest does not contain required fields");
+          return false;
+        }
+        this->update_info_.firmware_url = ota["path"].as<std::string>();
+        this->update_info_.md5 = ota["md5"].as<std::string>();
+
+        if (ota.containsKey("summary"))
+          this->update_info_.summary = ota["summary"].as<std::string>();
+        if (ota.containsKey("release_url"))
+          this->update_info_.release_url = ota["release_url"].as<std::string>();
+
+        return true;
+      }
+    }
+    return false;
+  });
+
+  if (!valid) {
+    std::string msg = str_sprintf("Failed to parse JSON from %s", this->source_url_.c_str());
+    this->status_set_error(msg.c_str());
+    return;
+  }
+
+  // Merge source_url_ and this->update_info_.firmware_url
+  if (this->update_info_.firmware_url.find("http") == std::string::npos) {
+    std::string path = this->update_info_.firmware_url;
+    if (path[0] == '/') {
+      std::string domain = this->source_url_.substr(0, this->source_url_.find('/', 8));
+      this->update_info_.firmware_url = domain + path;
+    } else {
+      std::string domain = this->source_url_.substr(0, this->source_url_.rfind('/') + 1);
+      this->update_info_.firmware_url = domain + path;
+    }
+  }
+
+  std::string current_version = this->current_version_;
+  if (current_version.empty()) {
+#ifdef ESPHOME_PROJECT_VERSION
+    current_version = ESPHOME_PROJECT_VERSION;
+#else
+    current_version = ESPHOME_VERSION;
+#endif
+  }
+  this->update_info_.current_version = current_version;
+
+  if (this->update_info_.latest_version.empty()) {
+    this->state_ = update::UPDATE_STATE_NO_UPDATE;
+  } else if (this->update_info_.latest_version != this->current_version_) {
+    this->state_ = update::UPDATE_STATE_AVAILABLE;
+  }
+
+  this->update_info_.has_progress = false;
+  this->update_info_.progress = 0.0f;
+
+  this->status_clear_error();
+  this->publish_state();
+}
+
+void HttpRequestUpdate::perform() {
+  if (this->state_ != update::UPDATE_STATE_AVAILABLE) {
+    return;
+  }
+
+  this->state_ = update::UPDATE_STATE_INSTALLING;
+  this->publish_state();
+
+  this->ota_parent_->set_md5(this->update_info.md5);
+  this->ota_parent_->set_url(this->update_info.firmware_url);
+  // Flash in the next loop
+  this->defer([this]() { this->ota_parent_->flash(); });
+}
+
+}  // namespace http_request
+}  // namespace esphome

esphome/components/http_request/update/http_request_update.h

@@ -0,0 +1,37 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/helpers.h"
+
+#include "esphome/components/http_request/http_request.h"
+#include "esphome/components/http_request/ota/ota_http_request.h"
+#include "esphome/components/update/update_entity.h"
+
+namespace esphome {
+namespace http_request {
+
+class HttpRequestUpdate : public update::UpdateEntity, public PollingComponent {
+ public:
+  void setup() override;
+  void update() override;
+
+  void perform() override;
+
+  void set_source_url(const std::string &source_url) { this->source_url_ = source_url; }
+
+  void set_request_parent(HttpRequestComponent *request_parent) { this->request_parent_ = request_parent; }
+  void set_ota_parent(OtaHttpRequestComponent *ota_parent) { this->ota_parent_ = ota_parent; }
+
+  void set_current_version(const std::string &current_version) { this->current_version_ = current_version; }
+
+  float get_setup_priority() const override { return setup_priority::AFTER_WIFI; }
+
+ protected:
+  HttpRequestComponent *request_parent_;
+  OtaHttpRequestComponent *ota_parent_;
+  std::string source_url_;
+  std::string current_version_{""};
+};
+
+}  // namespace http_request
+}  // namespace esphome