Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-11-07 09:43:08 +01:00
Code Issues Projects Releases Wiki Activity

Updates for runtime entered wifi credentials (#2443)

Browse Source
This commit is contained in:
Jesse Hills 2022-11-16 15:46:36 +13:00 committed by GitHub
parent 72c0c15dae
commit 03884998ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
components/captive_portal.rst
View File

@ -16,7 +16,7 @@ After 1 minute of unsuccessful WiFi connection attempts, the ESP will start a Wi
:width: 70.0%
In this web interface, you can manually override the WiFi settings of the device (please note
this will be overwritten by any subsequent upload (unless ``keep_user_credentials`` is enabled) so make sure to also update your YAML configuration).
this will be overwritten by any subsequent upload so make sure to also update your YAML configuration).
Additionally, you can upload a new firmware file.
@ -34,16 +34,10 @@ manually in your browser.
password: !secret wifi_ap_password
captive_portal:
# Set to true to preserve captive_portal credentials over OTA updates
# Note that you can't set STA credentials in YAML if you're using this
keep_user_credentials: false
Configuration variables:
------------------------
No configuration variables.
- **keep_user_credentials** (*Optional*, boolean): Do not erase WiFi credentials entered using :doc:`captive_portal` over subsequent OTA updates.
Note: WiFi STA credentials cannot be set in YAML when using this.
See Also
--------

9
components/wifi.rst
View File

@ -120,6 +120,15 @@ devices name as the ssid with no password.
ap:
password: "W1PBGyrokfLz"
User Entered Credentials
------------------------
Some components such as :doc:`captive_portal`, :doc:`improv_serial` and :doc:`esp32_improv`
enable the user to send and save Wi-Fi credentials to the device. Beginning in 2022.11.0,
as long as no credentials are set in the config file, and firmware is uploaded without erasing
the flash (via OTA), the device will keep the saved credentials.
.. _wifi-manual_ip:
Manual IPs