Merge pull request #4450 from esphome/bump-2024.11.0b3

jesserockz · web-flow · commit cf716c27b194 · 2024-11-20T07:27:58.000+13:00
2024.11.0b3
diff --git a/Doxygen b/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         = 2024.11.0b2
+PROJECT_NUMBER         = 2024.11.0b3
 
 # 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
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2024.11.0b2
+ESPHOME_REF = 2024.11.0b3
 PAGEFIND_VERSION=1.1.1
 PAGEFIND=pagefind
 NET_PAGEFIND=../pagefindbin/pagefind
diff --git a/_static/version b/_static/version
@@ -1 +1 @@
-2024.11.0b2
+2024.11.0b3
diff --git a/changelog/2024.11.0.rst b/changelog/2024.11.0.rst
@@ -82,6 +82,8 @@ Beta Changes
 - Fix reactive power unit of measurement from VAR to var :esphomepr:`7757` by :ghuser:`felipecrs`
 - Disable bluetooth proxy during update :esphomepr:`7695` by :ghuser:`jzucker2`
 - ld2420: fix typo in log message :esphomepr:`7758` by :ghuser:`bfabio`
+- TuyaFan control should use oscillation_type :esphomepr:`7776` by :ghuser:`pethans`
+- Bump esphome-dashboard to 20241118.0 :esphomepr:`7782` by :ghuser:`jesserockz`
 
 All changes
 ^^^^^^^^^^^
diff --git a/components/binary_sensor/custom.rst b/components/binary_sensor/custom.rst
@@ -9,8 +9,8 @@ Custom Binary Sensor
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/climate/custom.rst b/components/climate/custom.rst
@@ -9,8 +9,8 @@ Custom Climate
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/cover/custom.rst b/components/cover/custom.rst
@@ -9,8 +9,8 @@ Custom Cover
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/i2c.rst b/components/i2c.rst
@@ -58,11 +58,12 @@ Configuration variables:
             sda: GPIOXX
             scl: GPIOXX
             scan: true
-       # Sensors should be specified as follows
-       - platform: bme680
-         i2c_id: bus_b
-         address: 0x76
-         # ...
+        # Sensors should be specified as follows
+        sensor:
+          - platform: bme680
+            i2c_id: bus_b
+            address: 0x76
+        # ...
 
 For I²C multiplexing see :doc:`/components/tca9548a`.
 
diff --git a/components/light/custom.rst b/components/light/custom.rst
@@ -9,8 +9,8 @@ Custom Light Output
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/output/custom.rst b/components/output/custom.rst
@@ -9,8 +9,8 @@ Custom Output
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/sensor/bme280.rst b/components/sensor/bme280.rst
@@ -13,6 +13,8 @@ is used in *Forced Mode* where measurement is performed and then
 the sensor returns to sleep mode until next measurement. The :ref:`I²C <i2c>` or :ref:`SPI <spi>` is
 required to be set up in your configuration for this sensor to work.
 
+**Note:** In :ref:`I²C <i2c>` mode pulling CSB to 3V is recommended, in order to avoid ``[E][sensor.bme280:155]: Communication with BME280 failed!`` error. See the *Connection diagram* chapter in datasheet above.
+
 .. figure:: images/bme280-full.jpg
     :align: center
     :width: 50.0%
diff --git a/components/sensor/custom.rst b/components/sensor/custom.rst
@@ -9,8 +9,8 @@ Custom Sensor Component
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/switch/custom.rst b/components/switch/custom.rst
@@ -9,8 +9,8 @@ Custom Switch
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/components/text_sensor/custom.rst b/components/text_sensor/custom.rst
@@ -9,8 +9,8 @@ Custom Text Sensor
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/conf.py b/conf.py
@@ -73,7 +73,7 @@
 # The short X.Y version.
 version = "2024.11"
 # The full version, including alpha/beta/rc tags.
-release = "2024.11.0b2"
+release = "2024.11.0b3"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/custom/custom_component.rst b/custom/custom_component.rst
@@ -9,8 +9,8 @@ Generic Custom Component
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/custom/i2c.rst b/custom/i2c.rst
@@ -9,8 +9,8 @@ Custom I²C Device
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/custom/spi.rst b/custom/spi.rst
@@ -9,8 +9,8 @@ Custom SPI Device
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/custom/uart.rst b/custom/uart.rst
@@ -9,8 +9,8 @@ Custom UART Device
 .. warning::
 
     :ref:`Custom Components are deprecated<a_note_about_custom_components>`, not recommended for new configurations and
-    will be removed from ESPHome in a future release. Please look at creating a real ESPHome component and "importing"
-    it into your configuration with :doc:`/components/external_components`.
+    will be removed from ESPHome in the ``2025.1.0`` release. Please look at creating a real ESPHome component and
+    "importing" it into your configuration with :doc:`/components/external_components`.
 
     You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
 
diff --git a/guides/configuration-types.rst b/guides/configuration-types.rst
@@ -162,6 +162,7 @@ There are several ways of doing this. See below examples to see how you can spec
       # for all 'update_interval' options, also
       update_interval: never  # never update
       update_interval: 0ms  # update in every loop() iteration
+      update_interval: always # same as 0ms
 
 See Also
 --------
diff --git a/guides/contributing.rst b/guides/contributing.rst
@@ -207,8 +207,8 @@ adhere to the following order:
 
   .. note::
 
-      Referral links are not permitted unless they directly benefit the ESPHome project.
-      This applies to all official ESPHome documentation or websites.
+      Referral links are only permitted if they provide a direct benefit to the ESPHome project. 
+      This policy applies to all official ESPHome documentation and websites.
 
 - **References**: To reference another document, use the ``:doc:`` and ``:ref:`` roles (references are set up globally
   and can be used between documents):
@@ -1017,7 +1017,10 @@ ESPHome's "custom component" mechanism is a holdover from Home Assistant's featu
 :doc:`/components/external_components` and offered a way to "hack in" support for devices which were not officially
 supported by ESPHome.
 
-ESPHome has since deprecated this feature in favor of :doc:`/components/external_components` for several reasons:
+Why are Custom Components Deprecated?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There are several reasons for this change.
 
 - Custom components are very fragile:
 
@@ -1026,11 +1029,13 @@ ESPHome has since deprecated this feature in favor of :doc:`/components/external
     resulting in compiler errors, unexpected behavior and/or crashes.
   - Custom components are difficult to use. You have to manually copy all of the custom component's files into *just
     the right location* on your system or else you will receive compiler errors and the component won't work.
-  - Custom components almost always require C++ code changes when you want them to work even *slightly* differently
-    than the original author intended.
+  - Custom components lack flexibility and almost always require C++ code changes when you want them to work even
+    *slightly* differently than the original author intended/designed. For example, a simple change of input units
+    (``cm`` to ``m``, for example) could require significant changes to the C++ code, depending on how the original
+    author designed the custom component.
 
 - :doc:`/components/external_components` initially require a bit more effort by the developer but are ultimately more
-  robust and easier to use and share:
+  robust and are easier to use and share:
 
   - Just like any other ESPHome component/platform:
 
@@ -1044,7 +1049,8 @@ ESPHome has since deprecated this feature in favor of :doc:`/components/external
 
   - They tend to be more flexible since they are configured in YAML (as opposed to editing C++ code to make changes).
 
-**So what is the difference between custom components and** :doc:`/components/external_components`?
+What's the Difference?
+^^^^^^^^^^^^^^^^^^^^^^
 
 Custom components are typically (more or less) just the :ref:`runtime` part of an ESPHome component/platform. On the
 other hand, :doc:`/components/external_components` are just like any other ESPHome component -- the only difference is
@@ -1058,6 +1064,9 @@ In terms of implementation, custom components just lack the Python part of an ES
 As such, most custom components can be made into :doc:`/components/external_components` simply by adding the required
 Python parts to make the custom component into a proper, complete ESPHome component.
 
+What's Next?
+^^^^^^^^^^^^
+
 We encourage all custom component developers to extend their custom component(s) into proper
 :doc:`/components/external_components`; doing so will make your custom component easier to share and use. As you do so,
 be sure to have a look at the the :ref:`contributing_to_esphome` section above as it walks through ESPHome (component)
diff --git a/guides/faq.rst b/guides/faq.rst
@@ -374,6 +374,7 @@ And a docker compose file looks like this:
           # if needed, add esp device(s) as in command line examples above
           - /dev/ttyUSB0:/dev/ttyUSB0
           - /dev/ttyACM0:/dev/ttyACM0
+        # The host networking driver only works on Linux hosts, but is available as a Beta feature, on Docker Desktop version 4.29 and later.
         network_mode: host
         restart: always
 
@@ -384,9 +385,9 @@ And a docker compose file looks like this:
     By default ESPHome uses mDNS to show online/offline state in the dashboard view. So for that feature to work you
     need to enable host networking mode.
 
-    On MacOS the networking mode ("-net=host" option) doesn't work as expected. You have to use
-    another way to launch the dashboard with a port mapping option and use alternative to mDNS
-    to have the online/offline stat (see below)
+    The `host networking driver <https://docs.docker.com/network/drivers/host/>`_ only works on Linux hosts, but is available as a Beta feature, on Docker Desktop version 4.29 and later.
+
+    If you don't want to use the host networking driver, you have to use an alternative method described below.
 
     mDNS might not work if your Home Assistant server and your ESPHome nodes are on different subnets.
     If your router supports Avahi (eg. OpenWRT or pfSense), you are able to get mDNS working over different subnets
diff --git a/guides/supporters.rst b/guides/supporters.rst
@@ -221,6 +221,7 @@ Contributors
 - `Bert Hertogen (@berthertogen) <https://github.com/berthertogen>`__
 - `Ivan Bessarabov (@bessarabov) <https://github.com/bessarabov>`__
 - `besteru (@besteru) <https://github.com/besteru>`__
+- `Fabio Bonelli (@bfabio) <https://github.com/bfabio>`__
 - `Brandon (@bgulla) <https://github.com/bgulla>`__
 - `Benedikt Hübschen (@bhuebschen) <https://github.com/bhuebschen>`__
 - `Bierchermuesli (@Bierchermuesli) <https://github.com/Bierchermuesli>`__
@@ -623,6 +624,7 @@ Contributors
 - `Fabian Berthold (@fbrthld) <https://github.com/fbrthld>`__
 - `F.D.Castel (@fdcastel) <https://github.com/fdcastel>`__
 - `Sun Xiangyu (@feizi) <https://github.com/feizi>`__
+- `Felipe Santos (@felipecrs) <https://github.com/felipecrs>`__
 - `felixlungu (@felixlungu) <https://github.com/felixlungu>`__
 - `Felix Storm (@felixstorm) <https://github.com/felixstorm>`__
 - `felixstorm-c4a8 (@felixstorm-c4a8) <https://github.com/felixstorm-c4a8>`__
@@ -805,6 +807,7 @@ Contributors
 - `Jan Pobořil (@iBobik) <https://github.com/iBobik>`__
 - `icarome (@icarome) <https://github.com/icarome>`__
 - `icefest (@icefest) <https://github.com/icefest>`__
+- `ChenHsingYu (@idreamshen) <https://github.com/idreamshen>`__
 - `igg (@igg) <https://github.com/igg>`__
 - `Ignacio Hernandez-Ros (@IgnacioHR) <https://github.com/IgnacioHR>`__
 - `Petko Bordjukov (@ignisf) <https://github.com/ignisf>`__
@@ -1681,6 +1684,7 @@ Contributors
 - `shenxiaozheng (@shenxiaozheng) <https://github.com/shenxiaozheng>`__
 - `sherbang (@sherbang) <https://github.com/sherbang>`__
 - `Shish (@shish) <https://github.com/shish>`__
+- `Jerrod (@shomanjk) <https://github.com/shomanjk>`__
 - `Shreyas Karnik (@shreyaskarnik) <https://github.com/shreyaskarnik>`__
 - `Sherman K (@shrmnk) <https://github.com/shrmnk>`__
 - `shuchitak (@shuchitak) <https://github.com/shuchitak>`__
@@ -2023,4 +2027,4 @@ Contributors
 - `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
 - `Zynth-dev (@Zynth-dev) <https://github.com/Zynth-dev>`__
 
-*This page was last updated November 14, 2024.*
+*This page was last updated November 19, 2024.*
