From e79b1c6adf6bc66eeeb43bf21158898a4ecb42da Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Sun, 17 Oct 2021 11:03:24 +1300 Subject: [PATCH] Add dashboard_import to sharing page (#1530) Co-authored-by: Paulus Schoutsen Co-authored-by: Oxan van Leeuwen --- guides/creators.rst | 15 +++++++++++---- index.rst | 2 +- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/guides/creators.rst b/guides/creators.rst index 9fec5da98..2da40be36 100644 --- a/guides/creators.rst +++ b/guides/creators.rst @@ -1,10 +1,10 @@ -Using ESPHome for your Project -============================== +Sharing ESPHome devices +======================= .. seo:: - :description: Information for creators when using ESPHome firmware. + :description: Information for creating and sharing devices using ESPHome firmware. -We have added configuration options to ESPHome to make it easier for creators +We have added configuration options to ESPHome to make it easier to create, configure, install and distribute devices running ESPHome. Example configuration @@ -24,6 +24,10 @@ Example configuration name: jesse.temperature_monitor version: "1.0" + # This should point to the public location of this yaml file. + dashboard_import: + package_import_url: github://jesserockz/dummy-esphome-configs@v1/temperature-monitor.yaml + wifi: # Set up a wifi access point ap: @@ -50,6 +54,9 @@ Relevant Documentation - ``wifi`` -> ``networks: []`` 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 the ``esp32_improv`` 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`. See Also -------- diff --git a/index.rst b/index.rst index 73254c360..e31e22d02 100644 --- a/index.rst +++ b/index.rst @@ -69,7 +69,7 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
  • - Creating a Project + Sharing ESPHome devices