Merge pull request #1178 from esphome/bump-1.18.0b4

1.18.0b4

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         = 1.18.0b3
+PROJECT_NUMBER         = 1.18.0b4
 
 # 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 = v1.18.0b3
+ESPHOME_REF = v1.18.0b4
 
 .PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png
 

_static/version

@@ -1 +1 @@
-1.18.0b3
+1.18.0b4

changelog/v1.18.0.rst

@@ -41,8 +41,8 @@ Breaking Changes
 - esphome: Raise minimum python version to 3.7 :esphomepr:`1673` (breaking-change)
 - esphome: Change wifi signal strength unit to dBm :esphomepr:`1734` by :ghuser:`mbo18` (breaking-change)
 
-Beta Fixes
-----------
+Beta Changes
+------------
 
 - docs: Update allowed characters for node names :docspr:`1072` by :ghuser:`pkuehne`
 - docs: Replaced set_password with new_password :docspr:`1157` by :ghuser:`PaulAntonDeen`
@@ -54,6 +54,9 @@ Beta Fixes
 - docs: Explain where to upload .ttf font files :docspr:`1133` by :ghuser:`TheGroundZero`
 - esphome: Add sm2135 component :esphomepr:`1736` by :ghuser:`BoukeHaarsma23` (new-integration)
 - docs: Add sm2135 component :docspr:`1127` by :ghuser:`BoukeHaarsma23`
+- docs: Some clarification added to external components. :docspr:`1165` by :ghuser:`mmakaay`
+- docs: Add new disconnect reasons to the FAQ. :docspr:`1129` by :ghuser:`mmakaay`
+- esphome: Allow RC522 components to have multiple configurations :esphomepr:`1782` by :ghuser:`jesserockz`
 
 All changes
 -----------

components/external_components.rst

@@ -5,8 +5,8 @@ External Components
     :description: Instructions for setting up ESPHome External Components.
     :keywords: External, Custom, Components, ESPHome
 
-You can easily import community components using the external components feature. Bundled components
-can be overridden using this feature.
+You can easily import community or personal components using the external components feature.
+Bundled components can be overridden using this feature.
 
 .. code-block:: yaml
 
@@ -22,6 +22,11 @@ can be overridden using this feature.
       - source: github://esphome/esphome@dev
         components: [ rtttl ]
 
+      # use all components from a local folder
+      - source:
+          type: local
+          path: my_components
+
 Configuration variables:
 
 - **source**: The location of the components you want to retrieve. See :ref:`external-components_local`
@@ -31,15 +36,15 @@ Configuration variables:
 
   git options:
 
-  - **url** (**Required**, url): Http git repository url. See :ref:`external-components_git`.
+  - **url** (**Required**, url): HTTP git repository url. See :ref:`external-components_git`.
   - **ref** (*Optional*, string): Git ref (branch or tag). If not specified the default branch is used.
 
   local options:
 
   - **path** (**Required**):  Path to use when using local components. See :ref:`external-components_local`.
 
-- **components** (*Optional*, list): The list of components to retrieve from the external source.
-  Defaults to ``all``.
+- **components** (*Optional*, list): The list of components to use from the external source.
+  By default, all available components are used.
 
 - **refresh** (*Optional*, :ref:`time <config-time>`): The interval the source will be checked. Has no
   effect on ``local``. See :ref:`external-components_refresh`. for more info. Defaults to ``1day``.
@@ -50,26 +55,48 @@ Configuration variables:
 Local
 -----
 
-You can specify a local path for the external components, this is most useful if you want to manually
-control the origin of the files.
+You can specify a local path containing external components. This is most useful when developing a
+component or if you want to manually control the origin of the files.
 
 .. code-block:: yaml
 
     external_components:
-      source:
-        path: /copied_components
+      - source:
+          path: /copied_components
 
     # shorthand
     external_components:
-      source: my_components
+      - source: my_components
 
 
 Notice that relative paths are supported, so you can enter ``my_components`` as the source path and then
 ESPHome will load components from a ``my_components`` folder in the same folder where your YAML configuration
 is.
 
+Example of local components
+***************************
 
-.. _external-components_git:
+Given the above example of ``my_components``, the folder structure must look like:
+
+.. code-block:: text
+
+    <CONFIG_DIR>
+    ├── node1.yaml
+    ├── node2.yaml
+    └── my_components
+        ├── my_component1
+        │   ├── __init__.py
+        │   ├── component1.cpp
+        │   ├── component1.h
+        │   └── sensor.py
+        └── my_component2
+            ├── __init__.py
+            ├── component2.cpp
+            ├── component2.h
+            └── switch.py
+
+
+..   _external-components_git:
 
 Git
 ---
@@ -120,7 +147,7 @@ repository:
     │  ...
     ...
 
-Http git repositories in general are supported with this configuration:
+HTTP git repositories in general are supported with this configuration:
 
 .. code-block:: yaml
 
@@ -130,7 +157,7 @@ Http git repositories in general are supported with this configuration:
         url: http://repository_url/
         ref: branch_or_tag
 
-The source fields accepts a short hand **github://** resource:
+The source field accepts a short hand **github://** resource:
 
 .. code-block:: yaml
 

conf.py

@@ -69,7 +69,7 @@ author = "Otto Winter"
 # The short X.Y version.
 version = "1.18"
 # The full version, including alpha/beta/rc tags.
-release = "1.18.0b3"
+release = "1.18.0b4"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

guides/faq.rst

@@ -89,7 +89,7 @@ That's no good. Here are some steps that resolve some problems:
 -  **If you're having WiFi problems**: See :ref:`wifi-problems`.
 -  Enable verbose logs in the logger: section.
 -  **Still an error?** Please file a bug report over in the `ESPHome issue tracker <https://github.com/esphome/issues>`__.
-   I will take a look at it as soon as I can. Thanks!
+   We will take a look at it as soon as we can. Thanks!
 
 .. _faq-bug_report:
 
@@ -186,13 +186,13 @@ Does ESPHome support [this device/feature]?
 -------------------------------------------
 
 If it's not in :doc:`the docs </index>`, it's probably not
-supported. However, I'm always trying to add support for new features, so feel free to create a feature
+supported. However, we are always trying to add support for new features, so feel free to create a feature
 request in the `ESPHome feature request tracker <https://github.com/esphome/feature-requests>`__. Thanks!
 
 I have a question... How can I contact you?
 -------------------------------------------
 
-Sure! We are be happy to help :) You can contact us here:
+Sure! We are happy to help :) You can contact us here:
 
 -  `Discord <https://discord.gg/KhAMKrd>`__
 -  `Home Assistant Community Forums <https://community.home-assistant.io/c/third-party/esphome>`__
@@ -207,7 +207,7 @@ My node keeps reconnecting randomly
 -----------------------------------
 
 Jep, that's a known issue. However, it seems to be very low-level and we don't really know
-how to solve it. We are working on possible workarounds for the issue but currently we do
+how to solve it. We are working on possible workarounds for the issue, but currently we do
 not have a real solution.
 
 Some steps that can help with the issue:
@@ -224,7 +224,21 @@ Some steps that can help with the issue:
   :doc:`api connection is lost </components/api>` or
   :doc:`mqtt connection is lost </components/mqtt>`. So if you are facing this problem you'll need
   to explicitly set the ``reboot_timeout`` option to ``0s`` on the components being used.
-
+- If you see ``Error: Disconnecting <NODE_NAME>`` in your logs, ESPHome is actively closing
+  the native API client connection. Connect a serial console to inspect the reason, which is only
+  logged via serial. If you see ``ack timeout 4`` right before a disconnect, this might be because
+  of a bug in the AsyncTCP library, for which a fix was included in ESPHome version 1.18.0.
+  If you are running an ESPHome version, prior to 1.18.0, then upgrade ESPHome and build fresh
+  firmware for your devices. 
+- We have seen an increase in disconnects while the log level was set to ``VERY_VERBOSE``,
+  especially on single-core devices, where the logging code might be interfering with the operation
+  of the networking code. For this reason, we advise using a lower log level for production
+  purposes.
+- Related to this, seems to be the number of clients that are simultaneously connected to the native
+  API server on the device. These might for example be Home Assistant (via the ESPHome integration) and
+  the log viewer on the web dashboard. In production, you will likely only have a single connection from
+  Home Assistant, making this less of an issue. But beware that attaching a log viewer might
+  have impact.
 
 Docker Reference
 ----------------

guides/supporters.rst

@@ -32,6 +32,7 @@ Contributors
 - `Andrea Donno (@adonno) <https://github.com/adonno>`__
 - `Adrien Brault (@adrienbrault) <https://github.com/adrienbrault>`__
 - `Johan Bloemberg (@aequitas) <https://github.com/aequitas>`__
+- `Stefan Agner (@agners) <https://github.com/agners>`__
 - `Anders (@ahd71) <https://github.com/ahd71>`__
 - `Alexander Pohl (@ahpohl) <https://github.com/ahpohl>`__
 - `Airy André (@airy10) <https://github.com/airy10>`__
@@ -487,6 +488,7 @@ Contributors
 - `TBobsin (@TBobsin) <https://github.com/TBobsin>`__
 - `Team Super Panda (@teamsuperpanda) <https://github.com/teamsuperpanda>`__
 - `teffcz (@teffcz) <https://github.com/teffcz>`__
+- `testbughub (@testbughub) <https://github.com/testbughub>`__
 - `The Impaler (@the-impaler) <https://github.com/the-impaler>`__
 - `Nejc (@thedexboy) <https://github.com/thedexboy>`__
 - `Thomas Eckerstorfer (@TheEggi) <https://github.com/TheEggi>`__
@@ -559,4 +561,4 @@ Contributors
 - `San (@zhujunsan) <https://github.com/zhujunsan>`__
 - `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
 
-*This page was last updated May 13, 2021.*
+*This page was last updated May 17, 2021.*