Add dashboard_import to sharing page (#1530)

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
This commit is contained in:
Jesse Hills 2021-10-17 11:03:24 +13:00 committed by GitHub
parent 657a7fd955
commit e79b1c6adf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 5 deletions

View File

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

View File

@ -69,7 +69,7 @@ ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configu
</li>
<li>
<a class="reference" href="/guides/creators.html">
Creating a Project
Sharing ESPHome devices
</a>
</li>
<li>