Merge pull request #1317 from esphome/bump-1.20.0b4

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

_static/version

@@ -1 +1 @@
-1.20.0b3
+1.20.0b4

changelog/v1.20.0.rst

@@ -42,7 +42,7 @@ Unfortunately, some breaking changes had to be made:
   white channel being set to 30%, as expected.
 
 Full list of changes
---------------------
+--------------------s
 
 New Features
 ^^^^^^^^^^^^
@@ -81,6 +81,7 @@ Beta fixes
 - GH Actions CI use GHCR :esphomepr:`2027` by :ghuser:`OttoWinter`
 - Dashboard disable assets caching :esphomepr:`2025` by :ghuser:`OttoWinter`
 - Improve external components error messages :esphomepr:`2026` by :ghuser:`OttoWinter`
+- Number and Template Number updates :esphomepr:`2036` by :ghuser:`jesserockz`
 
 All changes
 ^^^^^^^^^^^
@@ -147,6 +148,7 @@ All changes
 - GH Actions CI use GHCR :esphomepr:`2027` by :ghuser:`OttoWinter`
 - Dashboard disable assets caching :esphomepr:`2025` by :ghuser:`OttoWinter`
 - Improve external components error messages :esphomepr:`2026` by :ghuser:`OttoWinter`
+- Number and Template Number updates :esphomepr:`2036` by :ghuser:`jesserockz`
 
 Past Changelogs
 ---------------

components/display/index.rst

@@ -573,7 +573,27 @@ You can then switch between these with three different actions:
           then:
             ...
 
+.. _display-on_page_change-trigger:
 
+**on_page_change**: This automation will be triggered when the page that is shown changes.
+
+.. code-block:: yaml
+
+    display:
+      - platform: ...
+        # ...
+        on_page_change:
+          - from: page1
+            to: page2
+            then:
+              lambda: |-
+                ESP_LOGD("display", "Page changed from 1 to 2");
+
+- **from** (*Optional*, :ref:`config-id`): A page id. If set the automation is only triggered if changing from this page. Defaults to all pages.
+- **to** (*Optional*, :ref:`config-id`): A page id. If set the automation is only triggered if changing to this page. Defaults to all pages.
+
+Additionally the old page will be given as the variable ``from`` and the new one as the variable ``to``.
+              
 See Also
 --------
 

components/number/template.rst

@@ -34,7 +34,9 @@ Configuration variables:
   number. Defaults to ``60s``.
 - **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode,
   any command sent to the template number will immediately update the reported state.
-  Defaults to ``false``.
+  Defaults to ``false``. Cannot be used with ``lambda``.
+- **initial_value** (*Optional*, float): The value to use if no ``lambda`` is used or no value
+  stored in RTC/flash at setup time.
 - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Sensor <config-number>`.
 

components/switch/gpio.rst

@@ -59,7 +59,7 @@ To create an active-low switch (one that is turned off by default), use the :ref
       - platform: gpio
         pin:
           number: 25
-          inverted: yes
+          inverted: true
 
 Momentary Switch
 ----------------

conf.py

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

guides/automations.rst

@@ -337,6 +337,7 @@ All Triggers
 - :ref:`ota.on_begin <ota-on_begin>` / :ref:`ota.on_progress <ota-on_progress>` /
   :ref:`ota.on_end <ota-on_end>` / :ref:`ota.on_error <ota-on_error>` /
   :ref:`ota.on_state_change <ota-on_state_change>`
+- :ref:`display.on_page_change <display-on_page_change-trigger>`
 
 All Actions
 -----------

guides/supporters.rst

@@ -608,4 +608,4 @@ Contributors
 - `San (@zhujunsan) <https://github.com/zhujunsan>`__
 - `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
 
-*This page was last updated July 19, 2021.*
+*This page was last updated July 20, 2021.*

web-api/index.rst

@@ -6,7 +6,7 @@ Web Server API
     :image: espeasy.png
 
 Since version 1.3, ESPHome includes a built-in web server that can be used to view states
-and send commands. In addition to visible the web-frontend available under the root index of the
+and send commands. In addition to the web-frontend available under the root index of the
 web server, there's also two other features the web server currently offers: A real time event
 source and REST API.
 
@@ -213,3 +213,39 @@ and ``/fan/<id>/toggle``. Turn on additionally supports these optional parameter
 
 -  **speed_level**: The new speed level of the fan. Values as above.
 -  **oscillation**: The new oscillation setting of the fan. Values as above.
+
+Cover
+*****
+
+Covers are again similar to switches whose two possible states are ``OPEN`` and ``CLOSED``.  They
+can however be in an intermediate position, anywhere between **0.0** (fully closed) to **1.0**
+(fully open). They usually take some time to move from one position to another and can also be
+stopped midway. An example GET request for ``/cover/front_window_blinds`` might return:
+
+.. code-block:: json
+
+    {
+      "id": "cover-front_window_blinds",
+      "state": "OPEN",
+      "value": 0.8,
+      "current_operation": "IDLE",
+      "tilt": 0.5
+    }
+
+-  **id**: The ID of the cover, prefixed with ``cover-``.
+-  **state**: ``OPEN`` or ``CLOSED``. Any position other than 0.0 is considered open.
+-  **value**: Current cover position as a float number.
+-  **current_operation**: ``OPENING``, ``CLOSING`` or ``IDLE``.
+-  **tilt**: (only if supported by this cover component) tilt angle from 0.0 to 1.0.
+
+POST requests on the other hand allow performing actions on the cover, the available
+methods being ``open``, ``close``, ``stop`` and ``set``. The following parameters
+can be used:
+
+-  **position**: The target position for a ``set`` call. The ``open`` method implies
+   a target position of 1.0, ``close`` implies a target position of 0.0.
+-  **tilt**: The tilt angle to set, if supported.
+
+Creating a POST request to ``/cover/front_window_blinds/set?position=0.1&tilt=0.3`` will
+start moving the blinds towards an almost completely closed position and a new tilt
+angle.