Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add note for project info requirement for dashboard import (#2908)

This commit is contained in:
Jesse Hills 2023-05-11 13:54:03 +12:00 committed by GitHub
parent da94201141
commit 24ebd833b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
guides/creators.rst
View File

@ -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