Merge pull request #2444 from esphome/bump-2022.11.0b6

2022.11.0b6

Doxygen

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ESPHome"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2022.11.0b5
+PROJECT_NUMBER         = 2022.11.0b6
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Makefile

@@ -1,5 +1,5 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2022.11.0b5
+ESPHOME_REF = 2022.11.0b6
 
 .PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
 

_static/version

@@ -1 +1 @@
-2022.11.0b5
+2022.11.0b6

changelog/2022.11.0.rst

@@ -71,7 +71,13 @@ Thanks :ghuser:`numo68`.
 Preserving User WiFi Credentials
 --------------------------------
 
-To be written...
+If you purchase a device, or install ESPHome on a device that does not have Wi-Fi credentials pre-configured from YAML,
+ESPHome will now preserve any credentials entered via the :doc:`/components/captive_portal`, :doc:`/components/improv_serial`
+or :doc:`/components/esp32_improv` components after an OTA update of the firmeware is done. It is possible they can survive
+flashing via serial, but only if the flash was not erased first, which it is in the case of using ESPHome to flash.
+
+Products that use `ESP Web Tools <https://esphome.github.io/esp-web-tools>`__ are able to specify in the manifest that the flash
+should not be erased when installing the firmware and this is a way to provide updates for a device that was sold.
 
 Running ESPHome on lower powered machines
 -----------------------------------------
@@ -124,6 +130,7 @@ Beta Changes
 - Fix time components on rp2040 :esphomepr:`4024` by :ghuser:`jesserockz`
 - Mark mqtt as unavailable on rp2040 :esphomepr:`4025` by :ghuser:`jesserockz`
 - Update_interval less that 1 second in QMC5883L integration :esphomepr:`4031` by :ghuser:`2mikrobi`
+- Always save user wifi credentials if non in config :esphomepr:`4036` by :ghuser:`jesserockz`
 
 All changes
 ^^^^^^^^^^^
@@ -197,6 +204,7 @@ All changes
 - Fix time components on rp2040 :esphomepr:`4024` by :ghuser:`jesserockz`
 - Mark mqtt as unavailable on rp2040 :esphomepr:`4025` by :ghuser:`jesserockz`
 - Update_interval less that 1 second in QMC5883L integration :esphomepr:`4031` by :ghuser:`2mikrobi`
+- Always save user wifi credentials if non in config :esphomepr:`4036` by :ghuser:`jesserockz`
 
 Past Changelogs
 ---------------

components/captive_portal.rst

@@ -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
 --------

components/wifi.rst

@@ -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

conf.py

@@ -69,7 +69,7 @@ author = "ESPHome"
 # The short X.Y version.
 version = "2022.11"
 # The full version, including alpha/beta/rc tags.
-release = "2022.11.0b5"
+release = "2022.11.0b6"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.