Improve UI experience for ESPHome add-ons (#67)

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>

esphome-beta/config.yaml

@@ -1,39 +1,37 @@
 ---
-advanced: true
+url: https://beta.esphome.io/
 arch:
 - amd64
 - armv7
 - aarch64
-auth_api: true
-backup_exclude:
-- '*/*/'
-description: Beta version of ESPHome add-on
 hassio_api: true
+auth_api: true
 host_network: true
-image: ghcr.io/esphome/esphome-hassio-{arch}
 ingress: true
 ingress_port: 0
-init: false
+panel_icon: mdi:chip
+uart: true
+ports:
+  6052/tcp: null
 map:
 - ssl:ro
 - config:rw
-name: ESPHome (beta)
-panel_icon: mdi:chip
-ports:
-  6052/tcp: null
-ports_description:
-  6052/tcp: Web interface (not required for Home Assistant ingress)
 schema:
-  certfile: str?
-  default_compile_process_limit: int(1,)?
-  keyfile: str?
-  leave_front_door_open: bool?
-  relative_url: str?
-  ssl: bool?
   status_use_ping: bool?
   streamer_mode: bool?
-slug: esphome-beta
+  default_compile_process_limit: int(1,)?
-stage: experimental
+  ssl: bool?
-uart: true
+  certfile: str?
-url: https://beta.esphome.io/
+  keyfile: str?
+  relative_url: str?
+  leave_front_door_open: bool?
+backup_exclude:
+- '*/*/'
+init: false
+name: ESPHome (beta)
 version: 2022.12.3
+slug: esphome-beta
+description: Beta version of ESPHome add-on
+image: ghcr.io/esphome/esphome-hassio-{arch}
+stage: experimental
+advanced: true

esphome-beta/translations/en.yaml

@@ -0,0 +1,60 @@
+---
+configuration:
+  certfile:
+    name: Certificate file
+    description: >-
+      The certificate file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  default_compile_process_limit:
+    name: Default compile process limit
+    description: >-
+      The default compile process limit. This is the maximum number of
+      simultaneous compile processes that ESPHome will run.
+  esphome_fork:
+    name: Install ESPHome from a fork or branch
+    description: >-
+      For example to test a pull request, use `pull/XXXX/head` where `XXXX` is
+      the PR number, or you can specify the username of the fork owner and
+      branch `username:branch` which assumes the repository is named `esphome`
+      still.
+
+      If you need to test the latest commit on dev branch before the image is
+      updated you can enter `dev` here.
+
+      Please note that the fork or branch you are using **must** be up to
+      date with ESPHome dev or the add-on **will not start**.
+  keyfile:
+    name: Private key file
+    description: >-
+      The private key file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  leave_front_door_open:
+    name: Disable external authentication
+    description: >-
+      Disables external authentication when having opened the add-on
+      on an external port. **WARNING**: This is a security risk!
+  relative_url:
+    name: Relative URL
+    description: >-
+      Host the ESPHome dashboard under a relative URL, so that it can be
+      integrated into existing web proxies like NGINX under a relative URL.
+      Defaults to `/`.
+  ssl:
+    name: SSL
+    description: >-
+      Enables/Disables SSL (HTTPS) on the web interface.
+  status_use_ping:
+    name: Use ping for status
+    description: >-
+      By default the dashboard uses mDNS to check if nodes are online. This does
+      not work across subnets unless your router supports mDNS forwarding
+      or avahi. Enabling this option will use ICMP ping to check if nodes are
+      online.
+  streamer_mode:
+    name: Streamer mode
+    description: >-
+      Enables/Disables streamer mode, which makes ESPHome hide all
+      potentially private information. So for example WiFi (B)SSIDs (which could
+      be used to find your location), usernames, etc.
+network:
+  6052/tcp: Web interface (to use without Home Assistant)

esphome-dev/config.yaml

@@ -1,39 +1,37 @@
 ---
-advanced: true
+url: https://next.esphome.io/
 arch:
 - amd64
 - armv7
 - aarch64
-auth_api: true
-backup_exclude:
-- '*/*/'
-description: Development version of ESPHome add-on
 hassio_api: true
+auth_api: true
 host_network: true
 ingress: true
 ingress_port: 0
-init: false
+panel_icon: mdi:chip
+uart: true
+ports:
+  6052/tcp: null
 map:
 - ssl:ro
 - config:rw
-name: ESPHome (dev)
-panel_icon: mdi:chip
-ports:
-  6052/tcp: null
-ports_description:
-  6052/tcp: Web interface (not required for Home Assistant ingress)
 schema:
-  certfile: str?
-  default_compile_process_limit: int(1,)?
-  esphome_fork: str?
-  keyfile: str?
-  leave_front_door_open: bool?
-  relative_url: str?
-  ssl: bool?
   status_use_ping: bool?
   streamer_mode: bool?
-slug: esphome-dev
+  default_compile_process_limit: int(1,)?
-stage: experimental
+  esphome_fork: str?
-uart: true
+  ssl: bool?
-url: https://next.esphome.io/
+  certfile: str?
+  keyfile: str?
+  relative_url: str?
+  leave_front_door_open: bool?
+backup_exclude:
+- '*/*/'
+init: false
+name: ESPHome (dev)
 version: dev
+slug: esphome-dev
+description: Development version of ESPHome add-on
+stage: experimental
+advanced: true

esphome-dev/translations/en.yaml

@@ -0,0 +1,60 @@
+---
+configuration:
+  certfile:
+    name: Certificate file
+    description: >-
+      The certificate file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  default_compile_process_limit:
+    name: Default compile process limit
+    description: >-
+      The default compile process limit. This is the maximum number of
+      simultaneous compile processes that ESPHome will run.
+  esphome_fork:
+    name: Install ESPHome from a fork or branch
+    description: >-
+      For example to test a pull request, use `pull/XXXX/head` where `XXXX` is
+      the PR number, or you can specify the username of the fork owner and
+      branch `username:branch` which assumes the repository is named `esphome`
+      still.
+
+      If you need to test the latest commit on dev branch before the image is
+      updated you can enter `dev` here.
+
+      Please note that the fork or branch you are using **must** be up to
+      date with ESPHome dev or the add-on **will not start**.
+  keyfile:
+    name: Private key file
+    description: >-
+      The private key file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  leave_front_door_open:
+    name: Disable external authentication
+    description: >-
+      Disables external authentication when having opened the add-on
+      on an external port. **WARNING**: This is a security risk!
+  relative_url:
+    name: Relative URL
+    description: >-
+      Host the ESPHome dashboard under a relative URL, so that it can be
+      integrated into existing web proxies like NGINX under a relative URL.
+      Defaults to `/`.
+  ssl:
+    name: SSL
+    description: >-
+      Enables/Disables SSL (HTTPS) on the web interface.
+  status_use_ping:
+    name: Use ping for status
+    description: >-
+      By default the dashboard uses mDNS to check if nodes are online. This does
+      not work across subnets unless your router supports mDNS forwarding
+      or avahi. Enabling this option will use ICMP ping to check if nodes are
+      online.
+  streamer_mode:
+    name: Streamer mode
+    description: >-
+      Enables/Disables streamer mode, which makes ESPHome hide all
+      potentially private information. So for example WiFi (B)SSIDs (which could
+      be used to find your location), usernames, etc.
+network:
+  6052/tcp: Web interface (to use without Home Assistant)

esphome/config.yaml

@@ -1,37 +1,35 @@
 ---
+url: https://esphome.io/
 arch:
 - amd64
 - armv7
 - aarch64
-auth_api: true
-backup_exclude:
-- '*/*/'
-description: ESPHome add-on for intelligently managing all your ESP8266/ESP32 devices
 hassio_api: true
+auth_api: true
 host_network: true
-image: ghcr.io/esphome/esphome-hassio-{arch}
 ingress: true
 ingress_port: 0
-init: false
+panel_icon: mdi:chip
+uart: true
+ports:
+  6052/tcp: null
 map:
 - ssl:ro
 - config:rw
-name: ESPHome
-panel_icon: mdi:chip
-ports:
-  6052/tcp: null
-ports_description:
-  6052/tcp: Web interface (not required for Home Assistant ingress)
 schema:
-  certfile: str?
-  default_compile_process_limit: int(1,)?
-  keyfile: str?
-  leave_front_door_open: bool?
-  relative_url: str?
-  ssl: bool?
   status_use_ping: bool?
   streamer_mode: bool?
-slug: esphome
+  default_compile_process_limit: int(1,)?
-uart: true
+  ssl: bool?
-url: https://esphome.io/
+  certfile: str?
+  keyfile: str?
+  relative_url: str?
+  leave_front_door_open: bool?
+backup_exclude:
+- '*/*/'
+init: false
+name: ESPHome
 version: 2022.12.3
+slug: esphome
+description: ESPHome add-on for intelligently managing all your ESP8266/ESP32 devices
+image: ghcr.io/esphome/esphome-hassio-{arch}

esphome/translations/en.yaml

@@ -0,0 +1,60 @@
+---
+configuration:
+  certfile:
+    name: Certificate file
+    description: >-
+      The certificate file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  default_compile_process_limit:
+    name: Default compile process limit
+    description: >-
+      The default compile process limit. This is the maximum number of
+      simultaneous compile processes that ESPHome will run.
+  esphome_fork:
+    name: Install ESPHome from a fork or branch
+    description: >-
+      For example to test a pull request, use `pull/XXXX/head` where `XXXX` is
+      the PR number, or you can specify the username of the fork owner and
+      branch `username:branch` which assumes the repository is named `esphome`
+      still.
+
+      If you need to test the latest commit on dev branch before the image is
+      updated you can enter `dev` here.
+
+      Please note that the fork or branch you are using **must** be up to
+      date with ESPHome dev or the add-on **will not start**.
+  keyfile:
+    name: Private key file
+    description: >-
+      The private key file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  leave_front_door_open:
+    name: Disable external authentication
+    description: >-
+      Disables external authentication when having opened the add-on
+      on an external port. **WARNING**: This is a security risk!
+  relative_url:
+    name: Relative URL
+    description: >-
+      Host the ESPHome dashboard under a relative URL, so that it can be
+      integrated into existing web proxies like NGINX under a relative URL.
+      Defaults to `/`.
+  ssl:
+    name: SSL
+    description: >-
+      Enables/Disables SSL (HTTPS) on the web interface.
+  status_use_ping:
+    name: Use ping for status
+    description: >-
+      By default the dashboard uses mDNS to check if nodes are online. This does
+      not work across subnets unless your router supports mDNS forwarding
+      or avahi. Enabling this option will use ICMP ping to check if nodes are
+      online.
+  streamer_mode:
+    name: Streamer mode
+    description: >-
+      Enables/Disables streamer mode, which makes ESPHome hide all
+      potentially private information. So for example WiFi (B)SSIDs (which could
+      be used to find your location), usernames, etc.
+network:
+  6052/tcp: Web interface (to use without Home Assistant)

script/generate.py

@@ -35,7 +35,7 @@ def main(args):
         dir_ = root / conf.pop("directory")
         path = dir_ / "config.yaml"
         with open(path, "w") as f:
-            yaml.dump(conf, f, indent=2, sort_keys=True, explicit_start=True)
+            yaml.dump(conf, f, indent=2, sort_keys=False, explicit_start=True)
 
         for file_, conf_ in copyf.items():
             if Path.exists(templ / channel.value / file_):

template/addon_config.yaml

@@ -21,20 +21,18 @@ base: &base
   uart: true
   ports:
     '6052/tcp': null
-  ports_description:
-    '6052/tcp': "Web interface (not required for Home Assistant ingress)"
   map:
     - ssl:ro
     - config:rw
   schema:
+    status_use_ping: bool?
+    streamer_mode: bool?
+    default_compile_process_limit: int(1,)?
     ssl: bool?
     certfile: str?
     keyfile: str?
-    leave_front_door_open: bool?
-    streamer_mode: bool?
     relative_url: str?
-    status_use_ping: bool?
+    leave_front_door_open: bool?
-    default_compile_process_limit: int(1,)?
   backup_exclude:
     - "*/*/"
   # Disable docker init for s6
@@ -51,15 +49,15 @@ esphome-dev:
   stage: experimental
   advanced: true
   schema:
+    status_use_ping: bool?
+    streamer_mode: bool?
+    default_compile_process_limit: int(1,)?
+    esphome_fork: str?
     ssl: bool?
     certfile: str?
     keyfile: str?
-    leave_front_door_open: bool?
-    streamer_mode: bool?
     relative_url: str?
-    status_use_ping: bool?
+    leave_front_door_open: bool?
-    esphome_fork: str?
-    default_compile_process_limit: int(1,)?
   base_image: ghcr.io/esphome/esphome-hassio-{arch}:dev
 
 esphome-beta:
@@ -84,8 +82,9 @@ esphome-stable:
   image: ghcr.io/esphome/esphome-hassio-{arch}
 
 copy_files:
+  CHANGELOG.md:
+  DOCS.md:
   icon.png:
   logo.png:
   README.md:
-  DOCS.md:
+  translations/en.yaml:
-  CHANGELOG.md:

template/translations/en.yaml

@@ -0,0 +1,60 @@
+---
+configuration:
+  certfile:
+    name: Certificate file
+    description: >-
+      The certificate file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  default_compile_process_limit:
+    name: Default compile process limit
+    description: >-
+      The default compile process limit. This is the maximum number of
+      simultaneous compile processes that ESPHome will run.
+  esphome_fork:
+    name: Install ESPHome from a fork or branch
+    description: >-
+      For example to test a pull request, use `pull/XXXX/head` where `XXXX` is
+      the PR number, or you can specify the username of the fork owner and
+      branch `username:branch` which assumes the repository is named `esphome`
+      still.
+
+      If you need to test the latest commit on dev branch before the image is
+      updated you can enter `dev` here.
+
+      Please note that the fork or branch you are using **must** be up to
+      date with ESPHome dev or the add-on **will not start**.
+  keyfile:
+    name: Private key file
+    description: >-
+      The private key file to use for SSL. Note that this file must
+      exist in the /ssl/ folder.
+  leave_front_door_open:
+    name: Disable external authentication
+    description: >-
+      Disables external authentication when having opened the add-on
+      on an external port. **WARNING**: This is a security risk!
+  relative_url:
+    name: Relative URL
+    description: >-
+      Host the ESPHome dashboard under a relative URL, so that it can be
+      integrated into existing web proxies like NGINX under a relative URL.
+      Defaults to `/`.
+  ssl:
+    name: SSL
+    description: >-
+      Enables/Disables SSL (HTTPS) on the web interface.
+  status_use_ping:
+    name: Use ping for status
+    description: >-
+      By default the dashboard uses mDNS to check if nodes are online. This does
+      not work across subnets unless your router supports mDNS forwarding
+      or avahi. Enabling this option will use ICMP ping to check if nodes are
+      online.
+  streamer_mode:
+    name: Streamer mode
+    description: >-
+      Enables/Disables streamer mode, which makes ESPHome hide all
+      potentially private information. So for example WiFi (B)SSIDs (which could
+      be used to find your location), usernames, etc.
+network:
+  6052/tcp: Web interface (to use without Home Assistant)