1
0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-03-26 16:01:38 +01:00

Improv serial docs ()

Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
This commit is contained in:
Jesse Hills 2021-11-11 09:01:30 +13:00 committed by GitHub
parent 59aeee460e
commit ebc6513223
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 46 additions and 4 deletions

View File

@ -42,5 +42,7 @@ See Also
--------
- :doc:`wifi`
- :doc:`improv_serial`
- :doc:`esp32_improv`
- :apiref:`captive_portal/captive_portal.h`
- :ghedit:`Edit`

View File

@ -1,8 +1,8 @@
Improv
======
Improv via BLE
==============
.. seo::
:description: Instructions for setting up Improv WiFi in ESPHome.
:description: Instructions for setting up Improv via BLE in ESPHome.
:image: improv-social.png
The ``esp32_improv`` component in ESPHome implements the open `Improv standard <https://www.improv-wifi.com/>`__
@ -35,6 +35,7 @@ See Also
--------
- :doc:`wifi`
- :doc:`improv_serial`
- :doc:`captive_portal`
- `Improv Wi-Fi <https://www.improv-wifi.com/>`__
- :apiref:`esp32_improv/esp32_improv_component.h`

View File

@ -0,0 +1,33 @@
Improv via Serial
=================
.. seo::
:description: Instructions for setting up Improv via Serial in ESPHome.
:image: improv-social.png
The ``improv_serial`` component in ESPHome implements the open `Improv standard <https://www.improv-wifi.com/>`__
for configuring Wi-Fi on an ESPHome device by using a serial connection to the device, eg. USB.
The ``improv_serial`` component requires the serial ``logger`` to be configured.
.. code-block:: yaml
# Example configuration entry
wifi:
# ...
improv_serial:
No configuration variables.
See Also
--------
- :doc:`wifi`
- :doc:`captive_portal`
- :doc:`esp32_improv`
- `Improv Wi-Fi <https://www.improv-wifi.com/>`__
- :apiref:`improv_serial/improv_serial_component.h`
- :ghedit:`Edit`

View File

@ -47,6 +47,10 @@ Example configuration
esp32_improv:
authorizer: none
logger:
improv_serial:
Relevant Documentation
----------------------
@ -61,6 +65,7 @@ Relevant Documentation
- ``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
--------

View File

@ -592,7 +592,8 @@ Misc Components
SIM800L, components/sim800l, sim800l.jpg
DFPlayer, components/dfplayer, dfplayer.svg
Captive Portal, components/captive_portal, wifi-strength-alert-outline.svg
Improv, components/esp32_improv, improv.svg
Improv via BLE, components/esp32_improv, improv.svg
Improv via Serial, components/improv_serial, improv.svg
Debug Component, components/debug, bug-report.svg
TM1651 Battery Display, components/tm1651, tm1651_battery_display.jpg
RF Bridge, components/rf_bridge, rf_bridge.jpg