Dashboard node import and render in browser (#2374)

esphome/components/dashboard_import/__init__.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components.packages import validate_source_shorthand
+from esphome.yaml_util import dump
+
+
+dashboard_import_ns = cg.esphome_ns.namespace("dashboard_import")
+
+# payload is in `esphomelib` mdns record, which only exists if api
+# is enabled
+DEPENDENCIES = ["api"]
+CODEOWNERS = ["@esphome/core"]
+
+
+def validate_import_url(value):
+    value = cv.string_strict(value)
+    value = cv.Length(max=255)(value)
+    # ignore result, only check if it's a valid shorthand
+    validate_source_shorthand(value)
+    return value
+
+
+CONF_PACKAGE_IMPORT_URL = "package_import_url"
+CONFIG_SCHEMA = cv.Schema(
+    {
+        cv.Required(CONF_PACKAGE_IMPORT_URL): validate_import_url,
+    }
+)
+
+
+async def to_code(config):
+    cg.add_define("USE_DASHBOARD_IMPORT")
+    cg.add(dashboard_import_ns.set_package_import_url(config[CONF_PACKAGE_IMPORT_URL]))
+
+
+def import_config(path: str, name: str, project_name: str, import_url: str) -> None:
+    p = Path(path)
+
+    if p.exists():
+        raise FileExistsError
+
+    config = {"substitutions": {"name": name}, "packages": {project_name: import_url}}
+    p.write_text(dump(config), encoding="utf8")

esphome/components/dashboard_import/dashboard_import.cpp

@@ -0,0 +1,12 @@
+#include "dashboard_import.h"
+
+namespace esphome {
+namespace dashboard_import {
+
+static std::string g_package_import_url;  // NOLINT
+
+std::string get_package_import_url() { return g_package_import_url; }
+void set_package_import_url(std::string url) { g_package_import_url = std::move(url); }
+
+}  // namespace dashboard_import
+}  // namespace esphome

esphome/components/dashboard_import/dashboard_import.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <string>
+
+namespace esphome {
+namespace dashboard_import {
+
+std::string get_package_import_url();
+void set_package_import_url(std::string url);
+
+}  // namespace dashboard_import
+}  // namespace esphome

esphome/components/mdns/mdns_component.cpp

@@ -6,6 +6,9 @@
 #ifdef USE_API
 #include "esphome/components/api/api_server.h"
 #endif
+#ifdef USE_DASHBOARD_IMPORT
+#include "esphome/components/dashboard_import/dashboard_import.h"
+#endif
 
 namespace esphome {
 namespace mdns {
@@ -42,6 +45,11 @@ std::vector<MDNSService> MDNSComponent::compile_services_() {
     service.txt_records.push_back({"project_name", ESPHOME_PROJECT_NAME});
     service.txt_records.push_back({"project_version", ESPHOME_PROJECT_VERSION});
 #endif  // ESPHOME_PROJECT_NAME
+
+#ifdef USE_DASHBOARD_IMPORT
+    service.txt_records.push_back({"package_import_url", dashboard_import::get_package_import_url()});
+#endif
+
     res.push_back(service);
   }
 #endif  // USE_API