2021-11-10 21:01:30 +01:00
|
|
|
Improv via BLE
|
|
|
|
|
==============
|
2021-06-08 01:56:31 +02:00
|
|
|
|
|
|
|
|
.. seo::
|
2021-11-10 21:01:30 +01:00
|
|
|
:description: Instructions for setting up Improv via BLE in ESPHome.
|
2021-06-08 01:56:31 +02:00
|
|
|
:image: improv-social.png
|
|
|
|
|
|
|
|
|
|
The ``esp32_improv`` component in ESPHome implements the open `Improv standard <https://www.improv-wifi.com/>`__
|
|
|
|
|
for configuring Wi-Fi on an ESP32 device by using Bluetooth Low Energy to receive the credentials.
|
|
|
|
|
|
2021-06-11 22:31:35 +02:00
|
|
|
The ``esp32_improv`` component will automatically set up the :doc:`BLE Server <esp32_ble>`.
|
2021-06-08 01:56:31 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
.. code-block:: yaml
|
|
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
wifi:
|
|
|
|
|
# ...
|
|
|
|
|
|
|
|
|
|
esp32_improv:
|
|
|
|
|
authorizer: binary_sensor_id
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Configuration variables:
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
- **authorizer** (**Required**, :ref:`config-id`): A :doc:`binary sensor <binary_sensor/index>` to authorize with.
|
|
|
|
|
Also accepts ``none``/``false`` to skip authorization.
|
|
|
|
|
- **authorized_duration** (*Optional*, :ref:`config-time`): The amount of time until authorization times out and needs
|
|
|
|
|
to be re-authorized. Defaults to ``1min``.
|
|
|
|
|
- **status_indicator** (*Optional*, :ref:`config-id`): An :doc:`output <output/index>` to display feedback to the user.
|
|
|
|
|
- **identify_duration** (*Optional*, :ref:`config-time`): The amount of time to identify for. Defaults to ``10s``.
|
2023-10-19 00:43:00 +02:00
|
|
|
- **wifi_timeout** (*Optional*, :ref:`config-time`): The amount of time to wait before starting the improv service after Wi-Fi
|
|
|
|
|
is no longer connected. Defaults to ``1min``.
|
2021-06-08 01:56:31 +02:00
|
|
|
|
2023-10-13 02:13:00 +02:00
|
|
|
Status Indicator
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
The ``status_indicator`` has the following patterns:
|
|
|
|
|
|
|
|
|
|
- solid: The improv service is active and waiting to be authorized.
|
|
|
|
|
- blinking once per second: The improv service is awaiting credentials.
|
|
|
|
|
- blinking 3 times per second with a break in between: The identify command has been used by the client.
|
|
|
|
|
- blinking 5 times per second: Credentials are being verified and saved to the device.
|
|
|
|
|
- off: The improv service is not running.
|
|
|
|
|
|
2021-06-08 01:56:31 +02:00
|
|
|
See Also
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
- :doc:`wifi`
|
2021-11-10 21:01:30 +01:00
|
|
|
- :doc:`improv_serial`
|
2021-06-08 01:56:31 +02:00
|
|
|
- :doc:`captive_portal`
|
|
|
|
|
- `Improv Wi-Fi <https://www.improv-wifi.com/>`__
|
|
|
|
|
- :apiref:`esp32_improv/esp32_improv_component.h`
|
|
|
|
|
- :ghedit:`Edit`
|
