Add docs for project information (#1224)

This commit is contained in:
Jesse Hills 2021-06-09 13:04:07 +12:00 committed by GitHub
parent cb129194da
commit bac3d7db72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions

View File

@ -55,6 +55,11 @@ Advanced options:
the name in the form ``<name>-aabbcc``. Defaults to ``False``.
See :ref:`esphome-mac_suffix`.
- **project** (*Optional*): ESPHome Creator's Project information. See :ref:`esphome-creators_project`.
- **name** (**Required**, string): Name of the project
- **version** (**Required**, string): Version of the project
ESP8266 Options:
- **esp8266_restore_from_flash** (*Optional*, boolean): Whether to save & restore data from flash on ESP8266s.
@ -317,6 +322,16 @@ many of the same device and they will all have unique names/hostnames.
Note that you will still need to create an individual YAML config file if you want to
OTA update the devices in the future.
.. _esphome-creators_project:
Project information
-------------------
This allows creators to add the project name and version to the compiled code. It is currently only
exposed via the logger, mDNS and the device_info response via the native API. The format of the name
should be ``namespace.project_name``.
See Also
--------