Merge branch 'current' into next

2019-07-03 17:35:48 +02:00 · 2019-07-03 17:35:48 +02:00 · da052a7838
parent 032339271c 5e88e33e82
commit da052a7838
9 changed files with 92 additions and 15 deletions
--- a/components/binary_sensor/index.rst
+++ b/components/binary_sensor/index.rst
@ -64,7 +64,9 @@ Binary Sensor Filters
 ---------------------

 With binary sensor filters you can customize how ESPHome handles your binary sensor values even more.
-They are similar to :ref:`Sensor Filters <sensor-filters>`.
+They are similar to :ref:`Sensor Filters <sensor-filters>`. All filters are processed in a pipeline.
+This means all binary sensor filters are processed in the order given in the configuration (so order
+of these entries matters!)

 .. code-block:: yaml

--- a/components/esphome.rst
+++ b/components/esphome.rst
@ -22,9 +22,8 @@ Configuration variables:
 ------------------------

 - **name** (**Required**, string): This is the name of the node. It
-  should always be unique to the node and no other node in your system
-  can use the same name. It can also only contain upper/lowercase
-  characters, digits and underscores.
+  should always be unique in your esphome network. May only contain upper/lowercase
+  characters, digits and underscores. See :ref:`esphome-changing_node_name`.
 - **platform** (**Required**, string): The platform your board is on,
  either ``ESP32`` or ``ESP8266``. See :ref:`esphome-arduino_version`.
 - **board** (**Required**, string): The board ESPHome should
@ -96,15 +95,19 @@ option you can tell ESPHome which arduino framework to use for compiling.
 For the ESP8266, you currently can manually pin the arduino version to these values (see the full
 list of arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`__):

+* `2.5.2 <https://github.com/esp8266/Arduino/releases/tag/2.5.2>`__
+* `2.5.1 <https://github.com/esp8266/Arduino/releases/tag/2.5.1>`__
 * `2.5.0 <https://github.com/esp8266/Arduino/releases/tag/2.5.0>`__
 * `2.4.2 <https://github.com/esp8266/Arduino/releases/tag/2.4.2>`__ (default)
 * `2.4.1 <https://github.com/esp8266/Arduino/releases/tag/2.4.1>`__
 * `2.4.0 <https://github.com/esp8266/Arduino/releases/tag/2.4.0>`__
+* `2.3.0 <https://github.com/esp8266/Arduino/releases/tag/2.3.0>`__ (used by Tasmota etc)

-For the ESP32, there are two arduino framework versions:
+For the ESP32, there are these arduino `framework versions <https://github.com/espressif/arduino-esp32/releases>`__:

- `1.0.1 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.1>`__ (default).
- `1.0.0 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.0>`__.
+- `1.0.2 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.2>`__
+- `1.0.1 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.1>`__ (default)
+- `1.0.0 <https://github.com/espressif/arduino-esp32/releases/tag/1.0.0>`__

 .. _esphome-esp8266_restore_from_flash:

@ -246,6 +249,46 @@ This option behaves differently depending on what the included file is pointing
   AND included in the main.cpp. This way the lambda code can access it.
 - If the include str

+.. _esphome-changing_node_name:
+
+Changing ESPHome Node Name
+--------------------------
+
+Trying to change the name of a node or its address in the network?
+You can do so with the ``use_address`` option of the :doc:`WiFi configuration <wifi>`.
+
+Change the device name or address in your YAML to the new value and additionally
+set ``use_address`` to point to the old address like so:
+
+.. code-block:: yaml
+
+    # Step 1. Changing name from test8266 to kitchen
+    esphome:
+      name: kitchen
+      # ...
+
+    wifi:
+      # ...
+      use_address: test8266.local
+
+Now upload the updated config to the device. As a second step, you now need to remove the
+``use_address`` option from your configuration again so that subsequent uploads will work again
+(otherwise it will try to upload to the old address).
+
+.. code-block:: yaml
+
+    # Step 2
+    esphome:
+      name: kitchen
+      # ...
+
+    wifi:
+      # ...
+      # Remove or comment out use_address
+      # use_address: test8266.local
+
+The same procedure can be done for changing the static IP of a device.
+
 See Also
 --------

--- a/components/sun.rst
+++ b/components/sun.rst
@ -123,7 +123,7 @@ Configuration variables:
 ``sun.is_above_horizon`` / ``sun.is_below_horizon`` Conditions
 --------------------------------------------------------------

-The ``sun.is_above_horizon`` and ``sun.is_above_horizon`` :ref:`conditions <config-condition>`
+The ``sun.is_above_horizon`` and ``sun.is_below_horizon`` :ref:`conditions <config-condition>`
 allow you to check if the sun is currently above or below the horizon.

 .. code-block:: yaml
--- a/components/uart.rst
+++ b/components/uart.rst
@ -80,6 +80,9 @@ This :ref:`Action <config-action>` sends a defined UART signal to the given UART
    on_...:
      - uart.write: 'Hello World'

+      # For escape characters, you must use double quotes!
+      - uart.write: 'Hello World\r\n'
+
      # Raw data
      - uart.write: [0x00, 0x20, 0x42]

--- a/components/wifi.rst
+++ b/components/wifi.rst
@ -45,7 +45,8 @@ Configuration variables:
  - **dns2** (*Optional*, IPv4 address): The backup DNS server to use.

 - **use_address** (*Optional*, string): Manually override what address to use to connect
-  to the ESP. Defaults to auto-generated value. Example, if you have changed your static IP and want to flash OTA to the prior configured IP address.
+  to the ESP. Defaults to auto-generated value. Example, if you have changed your static IP and want to flash OTA to the previusly configured IP address.
+
 - **ap** (*Optional*): Enable an access point mode on the node.

  - **ssid** (*Required*, string): The name of the access point to create.
@ -111,6 +112,10 @@ Additionally, this can help with :doc:`Over-The-Air updates <ota>` if for exampl
 home network doesn't allow for ``.local`` addresses. When a manual IP is in your configuration,
 the OTA process will automatically choose that as the target for the upload.

+.. note::
+
+    See also :ref:`esphome-changing_node_name`.
+
 .. _wifi-power_save_mode:

 Power Save Mode
--- a/cookbook/bme280_environment.rst
+++ b/cookbook/bme280_environment.rst
@ -62,7 +62,7 @@ The formula derived from `here <https://github.com/finitespace/BME280/blob/maste
 converts the currently measured pressure to the altitudes in meters including temperature compensation.

 The lambda in the second :doc:`/components/sensor/template` defines two physical constants and
-converts the currently measured pressure to absolute humidity (grams/m^3).
+converts the currently measured temperature and relative humidity to absolute humidity (grams/m^3).

 .. note::

--- a/guides/faq.rst
+++ b/guides/faq.rst
@ -248,6 +248,9 @@ Command reference:
    # Start dashboard on port 6052
    docker run --rm -v "${PWD}":/config --net=host -it esphome/esphome

+    # Setup a bash alias:
+    alias esphome='docker run --rm -v "${PWD}":/config --net=host -it esphome/esphome'
+
 And a docker compose file looks like this:

 .. code-block:: yaml
@ -277,6 +280,16 @@ And a docker compose file looks like this:
    1. Enable Avahi on both subnets.
    2. Enable UDP traffic from ESPHome node's subnet to 224.0.0.251/32 on port 5353.

+Can Configuration Files Be Recovered From The Device?
+-----------------------------------------------------
+
+If you lost your ESPHome YAML configuration files, there's no way to recover them.
+The configuration is *not* stored on the device directly - only the generated firmware is on
+the device itself (technically, the configuration can be reverse-engineered from that, but only
+with a lot of work).
+
+Always back up all your files!
+
 See Also
 --------

--- a/guides/supporters.rst
+++ b/guides/supporters.rst
@ -45,6 +45,7 @@ You guys are awesome!
 - Clayton
 - Daan Damhuis
 - Dattas Moonchaser
+- David Padbury
 - Dennis Münchgesang
 - DrZzs
 - fabi
@ -54,15 +55,19 @@ You guys are awesome!
 - Kenvase
 - Magnus Overli
 - Nick Rout
+- Niklas Fondberg
 - Paul Krischer
 - Paul Morley
+- Philippe Penochet
 - Radu Tizu
 - Roman Priesol
 - Ryan
 - Ryan Bahm
 - Ryan Nazaretian
- starwolf73
+- Starwolf73
+- Vincèn
 - Wojciech Bederski
+- Yonatan Adest
 - Zoltán Jáki


@ -76,7 +81,7 @@ that have made it into the `ESPHome organization's <https://github.com/esphome>`
 Author & Main Developer
 ***********************

- `Otto Winter (@OttoWinter) <https://github.com/OttoWinter>`__ - 1824 contributions
+- `Otto Winter (@OttoWinter) <https://github.com/OttoWinter>`__ - 1836 contributions

 Contributors
 ************
@ -121,6 +126,7 @@ Contributors
 - `Corban Mailloux (@corbanmailloux) <https://github.com/corbanmailloux>`__ - 5 contributions
 - `cryptelli (@cryptelli) <https://github.com/cryptelli>`__ - 2 contributions
 - `Dave Richer (@davericher) <https://github.com/davericher>`__ - 2 contributions
+- `Mario Di Raimondo (@diraimondo) <https://github.com/diraimondo>`__ - 1 contribution
 - `Dirk Jahnke (@dirkj) <https://github.com/dirkj>`__ - 1 contribution
 - `Jiang Sheng (@doskoi) <https://github.com/doskoi>`__ - 1 contribution
 - `Robert Schütz (@dotlambda) <https://github.com/dotlambda>`__ - 3 contributions
@ -133,7 +139,7 @@ Contributors
 - `Fabian Affolter (@fabaff) <https://github.com/fabaff>`__ - 10 contributions
 - `gitolicious (@gitolicious) <https://github.com/gitolicious>`__ - 11 contributions
 - `The Gitter Badger (@gitter-badger) <https://github.com/gitter-badger>`__ - 1 contribution
- `Guillermo Ruffino (@glmnet) <https://github.com/glmnet>`__ - 4 contributions
+- `Guillermo Ruffino (@glmnet) <https://github.com/glmnet>`__ - 6 contributions
 - `Antoine GRÉA (@grea09) <https://github.com/grea09>`__ - 3 contributions
 - `Boris Hajduk (@hajdbo) <https://github.com/hajdbo>`__ - 4 contributions
 - `Ivan Kravets (@ivankravets) <https://github.com/ivankravets>`__ - 1 contribution
@ -158,7 +164,7 @@ Contributors
 - `meijerwynand (@meijerwynand) <https://github.com/meijerwynand>`__ - 2 contributions
 - `mjoshd (@mjoshd) <https://github.com/mjoshd>`__ - 2 contributions
 - `Matt N. (@mnoorenberghe) <https://github.com/mnoorenberghe>`__ - 1 contribution
- `mtl010957 (@mtl010957) <https://github.com/mtl010957>`__ - 4 contributions
+- `mtl010957 (@mtl010957) <https://github.com/mtl010957>`__ - 5 contributions
 - `Michiel van Turnhout (@mvturnho) <https://github.com/mvturnho>`__ - 10 contributions
 - `Kevin Uhlir (@n0bel) <https://github.com/n0bel>`__ - 1 contribution
 - `Alex (@nnmalex) <https://github.com/nnmalex>`__ - 1 contribution
@ -172,6 +178,7 @@ Contributors
 - `Plácido Revilla (@placidorevilla) <https://github.com/placidorevilla>`__ - 2 contributions
 - `Marcus Kempe (@plopp) <https://github.com/plopp>`__ - 1 contribution
 - `DK (@poldim) <https://github.com/poldim>`__ - 1 contribution
+- `Iván Povedano (@pove) <https://github.com/pove>`__ - 1 contribution
 - `Peter Tatrai (@ptatrai) <https://github.com/ptatrai>`__ - 1 contribution
 - `Leandro Puerari (@puerari) <https://github.com/puerari>`__ - 1 contribution
 - `puuu (@puuu) <https://github.com/puuu>`__ - 14 contributions
@ -179,12 +186,14 @@ Contributors
 - `r-jordan (@r-jordan) <https://github.com/r-jordan>`__ - 1 contribution
 - `Pär Stålberg (@rabbadab) <https://github.com/rabbadab>`__ - 1 contribution
 - `Richard Lewis (@richrd) <https://github.com/richrd>`__ - 2 contributions
+- `rnauber (@rnauber) <https://github.com/rnauber>`__ - 2 contributions
 - `Robbie Page (@rorpage) <https://github.com/rorpage>`__ - 1 contribution
 - `Ryan Nazaretian (@ryannazaretian) <https://github.com/ryannazaretian>`__ - 1 contribution
 - `sethcohn (@sethcohn) <https://github.com/sethcohn>`__ - 1 contribution
 - `Emanuele Tessore (@setola) <https://github.com/setola>`__ - 1 contribution
 - `Abdelkader Boudih (@seuros) <https://github.com/seuros>`__ - 1 contribution
 - `sherbang (@sherbang) <https://github.com/sherbang>`__ - 4 contributions
+- `Andrew Thompson (@thompsa) <https://github.com/thompsa>`__ - 1 contribution
 - `thubot (@thubot) <https://github.com/thubot>`__ - 1 contribution
 - `tiagofreire-pt (@tiagofreire-pt) <https://github.com/tiagofreire-pt>`__ - 1 contribution
 - `tubalainen (@tubalainen) <https://github.com/tubalainen>`__ - 2 contributions
@ -195,4 +204,4 @@ Contributors
 - `Vladimir Eremin (@yottatsa) <https://github.com/yottatsa>`__ - 1 contribution
 - `YuanL.Lee (@yuanl) <https://github.com/yuanl>`__ - 1 contribution

-*This page was last updated Sat Jun 15 16:55:22 2019 UTC.*
+*This page was last updated Mon Jun 24 20:42:10 2019 UTC.*
--- a/index.rst
+++ b/index.rst
@ -12,6 +12,8 @@ ESPHome

 .. image:: /images/logo-text.svg

+ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems.
+
 .. raw:: html

    <a href="https://github.com/esphome/esphome"><img src="/_images/shield-github.svg" alt="GitHub" class="index-shield"></a>