From bff961afc67e8beece0e1ae3a1e7088f9015b1ac Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Mon, 6 Mar 2023 19:42:36 +1300 Subject: [PATCH] Minor updates on sharing page (#2722) --- guides/creators.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/guides/creators.rst b/guides/creators.rst index dc8c459ab..134f2ce0e 100644 --- a/guides/creators.rst +++ b/guides/creators.rst @@ -7,6 +7,10 @@ Sharing ESPHome devices We have added configuration options to ESPHome to make it easier to create, configure, install and distribute devices running ESPHome. +No part of a "template" configuration should have any references to secrets, +or have passwords pre-applied. ESPHome makes it easy for the end-user to add these +themselves after they adopt the device into their own ESPHome dashboard. + Example configuration --------------------- @@ -14,10 +18,13 @@ Example configuration # These substitutions allow the end user to override certain values substitutions: - name: "project-template-32" + name: "project-template" + friendly_name: "Project Template" esphome: name: "${name}" + # Friendly names are used where appropriate in Home Assistant + friendly_name: "${friendly_name}" # Automatically add the mac address to the name # so you can use a single firmware for all devices name_add_mac_suffix: true