From 24ebd833b362b266eee563e132577bdb9e81276a Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Thu, 11 May 2023 13:54:03 +1200 Subject: [PATCH] Add note for project info requirement for dashboard import (#2908) --- guides/creators.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/guides/creators.rst b/guides/creators.rst index 134f2ce0e..5aed84e01 100644 --- a/guides/creators.rst +++ b/guides/creators.rst @@ -79,10 +79,16 @@ Relevant Documentation credentials and they must be set by the user via either the ``ap`` + ``captive_portal`` or the ``esp32_improv`` / ``improv_serial`` components. - ``dashboard_import`` - - ``package_import_url`` - This should point to the public repository containing - the configuration for the device so that the user's ESPHome dashboard can autodetect this device and - create a minimal YAML using :ref:`config-git_packages`. - - ``import_full_config`` - This signals if ESPHome should download the entire YAML file as the user's config YAML instead of referencing the package. Set this to `true` if you are creating a tutorial to let users easily tweak the whole configuration or be able to uncomment follow-up tutorial steps. + .. note:: + + The :ref:`esphome-creators_project` above is required for adoption to work in the Dashboard. + + - ``package_import_url`` - This should point to the public repository containing + the configuration for the device so that the user's ESPHome dashboard can autodetect this device and + create a minimal YAML using :ref:`config-git_packages`. + - ``import_full_config`` - This signals if ESPHome should download the entire YAML file as the user's config + YAML instead of referencing the package. Set this to ``true`` if you are creating a tutorial to let users + easily tweak the whole configuration or be able to uncomment follow-up tutorial steps. - ``improv_serial`` - :doc:`/components/improv_serial` See Also