From c1ee850ea0ac6ea3d06ee69db2521b50424840eb Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 15 Jun 2021 15:39:41 +1200 Subject: [PATCH] Add creator page (#1241) Co-authored-by: Franck Nijhof Co-authored-by: Paulus Schoutsen --- guides/creators.rst | 57 +++++++++++++++++++++++++++++++++++++++++++++ index.rst | 1 + 2 files changed, 58 insertions(+) create mode 100644 guides/creators.rst diff --git a/guides/creators.rst b/guides/creators.rst new file mode 100644 index 000000000..9fec5da98 --- /dev/null +++ b/guides/creators.rst @@ -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` diff --git a/index.rst b/index.rst index 3ce494959..ef29c084b 100644 --- a/index.rst +++ b/index.rst @@ -40,6 +40,7 @@ Guides DIY Examples, guides/diy, earth.svg Configuration types, guides/configuration-types, puzzle.svg + Creating a Project, guides/creators, puzzle.svg .. _devices: