mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-13 20:11:53 +01:00
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
7594b01573
commit
2e3c3472e2
57
guides/creators.rst
Normal file
57
guides/creators.rst
Normal file
@ -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`
|
Loading…
Reference in New Issue
Block a user