esphome-docs/guides/creators.rst
Jesse Hills ebc6513223
Improv serial docs (#1525)
Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
2021-11-11 09:01:30 +13:00

74 lines
2.2 KiB
ReStructuredText

Sharing ESPHome devices
=======================
.. seo::
:description: Information for creating and sharing devices using ESPHome firmware.
We have added configuration options to ESPHome to make it easier
to create, configure, install and distribute devices running ESPHome.
Example configuration
---------------------
.. code-block:: yaml
# These substitutions allow the end user to override certain values
substitutions:
name: "jesses-temperature-monitor"
esphome:
name: "${name}"
# Automatically add the mac address to the name
# so you can use a single firmware for all devices
name_add_mac_suffix: true
# This will allow for (future) project identification,
# configuration and updates.
project:
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/temperature-monitor.yaml@v6
wifi:
# Set up a wifi access point
ap:
ssid: jesses_temperature_monitor
password: "12345678"
# In combination with the `ap` this allows the user
# to provision wifi credentials to the device.
captive_portal:
# Sets up Bluetooth LE (Only on ESP32) to allow the user
# to provision wifi credentials to the device.
esp32_improv:
authorizer: none
logger:
improv_serial:
Relevant Documentation
----------------------
- ``name_add_mac_suffix`` - :ref:`esphome-mac_suffix`
- ``project`` - :ref:`esphome-creators_project`
- ``esp32_improv`` - :doc:`/components/esp32_improv`
- ``captive_portal`` - :doc:`/components/captive_portal`
- ``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`.
- ``improv_serial`` - :doc:`/components/improv_serial`
See Also
--------
- :ghedit:`Edit`