Add friendly_name to device (#4296)

esphome/dashboard/dashboard.py

@@ -40,7 +40,7 @@ from esphome.storage_json import (
 from esphome.util import get_serial_ports, shlex_quote
 from esphome.zeroconf import DashboardImportDiscovery, DashboardStatus, EsphomeZeroconf
 
-from .util import password_hash
+from .util import password_hash, friendly_name_slugify
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -390,12 +390,24 @@ class WizardRequestHandler(BaseHandler):
             for k, v in json.loads(self.request.body.decode()).items()
             if k in ("name", "platform", "board", "ssid", "psk", "password")
         }
+        if not kwargs["name"]:
+            self.set_status(422)
+            self.set_header("content-type", "application/json")
+            self.write(json.dumps({"error": "Name is required"}))
+            return
+
+        kwargs["friendly_name"] = kwargs["name"]
+        kwargs["name"] = friendly_name_slugify(kwargs["friendly_name"])
+
         kwargs["ota_password"] = secrets.token_hex(16)
         noise_psk = secrets.token_bytes(32)
         kwargs["api_encryption_key"] = base64.b64encode(noise_psk).decode()
-        destination = settings.rel_path(f"{kwargs['name']}.yaml")
+        filename = f"{kwargs['name']}.yaml"
+        destination = settings.rel_path(filename)
         wizard.wizard_write(path=destination, **kwargs)
         self.set_status(200)
+        self.set_header("content-type", "application/json")
+        self.write(json.dumps({"configuration": filename}))
         self.finish()
 
 
@@ -407,6 +419,7 @@ class ImportRequestHandler(BaseHandler):
         args = json.loads(self.request.body.decode())
         try:
             name = args["name"]
+            friendly_name = args.get("friendly_name")
 
             imported_device = next(
                 (res for res in IMPORT_RESULT.values() if res.device_name == name), None
@@ -414,12 +427,15 @@ class ImportRequestHandler(BaseHandler):
 
             if imported_device is not None:
                 network = imported_device.network
+                if friendly_name is None:
+                    friendly_name = imported_device.friendly_name
             else:
                 network = const.CONF_WIFI
 
             import_config(
                 settings.rel_path(f"{name}.yaml"),
                 name,
+                friendly_name,
                 args["project_name"],
                 args["package_import_url"],
                 network,
@@ -434,6 +450,8 @@ class ImportRequestHandler(BaseHandler):
             return
 
         self.set_status(200)
+        self.set_header("content-type", "application/json")
+        self.write(json.dumps({"configuration": f"{name}.yaml"}))
         self.finish()
 
 
@@ -581,6 +599,12 @@ class DashboardEntry:
             return self.filename.replace(".yml", "").replace(".yaml", "")
         return self.storage.name
 
+    @property
+    def friendly_name(self):
+        if self.storage is None:
+            return self.name
+        return self.storage.friendly_name
+
     @property
     def comment(self):
         if self.storage is None:
@@ -628,6 +652,7 @@ class ListDevicesHandler(BaseHandler):
                     "configured": [
                         {
                             "name": entry.name,
+                            "friendly_name": entry.friendly_name,
                             "configuration": entry.filename,
                             "loaded_integrations": entry.loaded_integrations,
                             "deployed_version": entry.update_old,
@@ -643,6 +668,7 @@ class ListDevicesHandler(BaseHandler):
                     "importable": [
                         {
                             "name": res.device_name,
+                            "friendly_name": res.friendly_name,
                             "package_import_url": res.package_import_url,
                             "project_name": res.project_name,
                             "project_version": res.project_version,

esphome/dashboard/util.py

@@ -1,4 +1,7 @@
 import hashlib
+import unicodedata
+
+from esphome.const import ALLOWED_NAME_CHARS
 
 
 def password_hash(password: str) -> bytes:
@@ -7,3 +10,23 @@ def password_hash(password: str) -> bytes:
     Note this is not meant for secure storage, but for securely comparing passwords.
     """
     return hashlib.sha256(password.encode()).digest()
+
+
+def strip_accents(value):
+    return "".join(
+        c
+        for c in unicodedata.normalize("NFD", str(value))
+        if unicodedata.category(c) != "Mn"
+    )
+
+
+def friendly_name_slugify(value):
+    value = (
+        strip_accents(value)
+        .lower()
+        .replace(" ", "-")
+        .replace("_", "-")
+        .replace("--", "-")
+        .strip("-")
+    )
+    return "".join(c for c in value if c in ALLOWED_NAME_CHARS)