Add creator page (#1241)
Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
This commit is contained in:
parent
43f538b0de
commit
c1ee850ea0
|
@ -0,0 +1,57 @@
|
||||||
|
Using ESPHome for your Project
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. seo::
|
||||||
|
:description: Information for creators when using ESPHome firmware.
|
||||||
|
|
||||||
|
We have added configuration options to ESPHome to make it easier for creators
|
||||||
|
to create, configure, install and distribute devices running ESPHome.
|
||||||
|
|
||||||
|
Example configuration
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
esphome:
|
||||||
|
...
|
||||||
|
# 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"
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
See Also
|
||||||
|
--------
|
||||||
|
|
||||||
|
- :ghedit:`Edit`
|
|
@ -40,6 +40,7 @@ Guides
|
||||||
DIY Examples, guides/diy, earth.svg
|
DIY Examples, guides/diy, earth.svg
|
||||||
|
|
||||||
Configuration types, guides/configuration-types, puzzle.svg
|
Configuration types, guides/configuration-types, puzzle.svg
|
||||||
|
Creating a Project, guides/creators, puzzle.svg
|
||||||
|
|
||||||
.. _devices:
|
.. _devices:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue