2019-07-28 12:41:15 +02:00
|
|
|
Captive Portal
|
|
|
|
|
==============
|
|
|
|
|
|
|
|
|
|
.. seo::
|
|
|
|
|
:description: Instructions for setting up the Captive Portal fallback mechanism in ESPHome.
|
2021-11-16 03:19:33 +01:00
|
|
|
:image: wifi-strength-alert-outline.svg
|
2019-07-28 12:41:15 +02:00
|
|
|
|
|
|
|
|
The captive portal component in ESPHome is a fallback mechanism for when connecting to the
|
|
|
|
|
configured :doc:`WiFi <wifi>` fails.
|
|
|
|
|
|
2020-05-10 21:27:59 +02:00
|
|
|
After 1 minute of unsuccessful WiFi connection attempts, the ESP will start a WiFi hotspot
|
2019-07-28 12:41:15 +02:00
|
|
|
(with the credentials from your configuration)
|
|
|
|
|
|
|
|
|
|
.. figure:: images/captive_portal-ui.png
|
|
|
|
|
:align: center
|
|
|
|
|
:width: 70.0%
|
|
|
|
|
|
|
|
|
|
In this web interface, you can manually override the WiFi settings of the device (please note
|
2023-05-31 15:27:21 +02:00
|
|
|
this will be overwritten by any subsequent serial upload so make sure to also update your YAML configuration).
|
2019-07-28 12:41:15 +02:00
|
|
|
|
|
|
|
|
Additionally, you can upload a new firmware file.
|
|
|
|
|
|
|
|
|
|
When you connect to the fallback network, the web interface should open automatically (see also
|
|
|
|
|
login to network notifications). If that does not work, you can also navigate to http://192.168.4.1/
|
|
|
|
|
manually in your browser.
|
|
|
|
|
|
|
|
|
|
.. code-block:: yaml
|
|
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
wifi:
|
|
|
|
|
# ...
|
|
|
|
|
ap:
|
|
|
|
|
ssid: "Livingroom Fallback Hotspot"
|
2022-02-10 23:10:43 +01:00
|
|
|
password: !secret wifi_ap_password
|
2019-07-28 12:41:15 +02:00
|
|
|
|
|
|
|
|
captive_portal:
|
|
|
|
|
|
|
|
|
|
|
2022-11-16 03:46:36 +01:00
|
|
|
No configuration variables.
|
2022-10-13 21:58:46 +02:00
|
|
|
|
2019-07-28 12:41:15 +02:00
|
|
|
|
|
|
|
|
See Also
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
- :doc:`wifi`
|
2021-11-10 21:01:30 +01:00
|
|
|
- :doc:`improv_serial`
|
|
|
|
|
- :doc:`esp32_improv`
|
2019-07-28 12:41:15 +02:00
|
|
|
- :apiref:`captive_portal/captive_portal.h`
|
|
|
|
|
- :ghedit:`Edit`
|
