Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-28 17:48:35 +01:00
Code Issues Projects Releases Wiki Activity

Add import_full_config to creators page (#2513)

Browse Source 
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
This commit is contained in:
Jesse Hills 2022-12-09 10:24:37 +13:00 committed by GitHub
parent 0ca5acd758
commit 99d4280905
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
guides/creators.rst
View File

@ -40,6 +40,7 @@ Example configuration
# This should point to the public location of this yaml file. # This should point to the public location of this yaml file.
dashboard_import: dashboard_import:
package_import_url: github://esphome/esphome-project-template/project-template-esp32.yaml@v6 package_import_url: github://esphome/esphome-project-template/project-template-esp32.yaml@v6
import_full_config: false # or true
wifi: wifi:
# Set up a wifi access point # Set up a wifi access point
@ -72,9 +73,11 @@ Relevant Documentation
- ``wifi`` -> ``ap`` allows you to flash a device that will not contain any - ``wifi`` -> ``ap`` allows you to flash a device that will not contain any
credentials and they must be set by the user via either the ``ap`` + ``captive_portal`` or credentials and they must be set by the user via either the ``ap`` + ``captive_portal`` or
the ``esp32_improv`` / ``improv_serial`` components. the ``esp32_improv`` / ``improv_serial`` components.
- ``dashboard_import`` -> ``package_import_url`` - This should point to the public repository containing - ``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 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`. 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` - ``improv_serial`` - :doc:`/components/improv_serial`
See Also See Also