diff --git a/_static/changelog-1.17.0.png b/_static/changelog-1.17.0.png
index 2210c28f4..d9a24b1bd 100644
Binary files a/_static/changelog-1.17.0.png and b/_static/changelog-1.17.0.png differ
diff --git a/_static/changelog-1.18.0.png b/_static/changelog-1.18.0.png
new file mode 100644
index 000000000..2e0974f1c
Binary files /dev/null and b/_static/changelog-1.18.0.png differ
diff --git a/_static/custom.css b/_static/custom.css
index 70273f248..c24306b38 100644
--- a/_static/custom.css
+++ b/_static/custom.css
@@ -5,6 +5,10 @@
text-align: center;
}
+div.document {
+ margin-bottom: 50px;
+}
+
img.component-image {
border: none;
vertical-align: middle;
diff --git a/_static/version b/_static/version
index d1f502ab4..ff32b92aa 100644
--- a/_static/version
+++ b/_static/version
@@ -1 +1 @@
-1.19.0-dev
\ No newline at end of file
+1.19.0-dev
diff --git a/changelog/index.rst b/changelog/index.rst
index 8dd643894..bcd2faef6 100644
--- a/changelog/index.rst
+++ b/changelog/index.rst
@@ -2,7 +2,7 @@ Changelog
=========
.. redirect::
- :url: /changelog/v1.17.0.html
+ :url: /changelog/v1.18.0.html
.. toctree::
:glob:
diff --git a/changelog/v1.18.0.rst b/changelog/v1.18.0.rst
new file mode 100644
index 000000000..dd411615f
--- /dev/null
+++ b/changelog/v1.18.0.rst
@@ -0,0 +1,193 @@
+Changelog - Version 1.18.0 - 19th May 2021
+===============================================
+
+.. seo::
+ :description: Changelog for ESPHome version 1.18.0.
+ :image: /_static/changelog-1.18.0.png
+ :author: ESPHome
+ :author_twitter: @esphome_
+
+.. imgtable::
+ :columns: 4
+
+ BME680 via BSEC, components/sensor/bme680_bsec, bme680.jpg
+ b-parasite, components/sensor/b_parasite, b_parasite.jpg
+ SGP40, components/sensor/sgp40, sgp40.jpg
+ SHT4X, components/sensor/sht4x, sht4x.jpg
+
+ TCA9548A I²C Multiplexer, components/tca9548a, tca9548a.jpg
+ Grow Fingerprint Reader, components/fingerprint_grow, fingerprint.svg
+ TOF10120, components/sensor/tof10120, tof10120.jpg
+ SM2135, components/output/sm2135, sm2135.svg
+
+ ESP32 BLE Client, components/ble_client, bluetooth.svg
+ BLE Sensor, components/sensor/ble_sensor, bluetooth.svg
+ External Components, components/external_components, external_components.svg
+
+
+It feels like I was just writing the release notes for 1.17 not long ago, so here's to getting ESPHome going on a regular schedule.
+
+Releases will be set for the 3rd Wednesday of each month, with a beta release starting 1 week earlier for those who would like to test
+that and help make sure it is stable.
+
+Apart from a few new sensors, we now have built in support for :doc:`/components/external_components`, check it out. Thanks :ghuser:`OttoWinter` and :ghuser:`glmnet`
+
+Also now, an ESPHome device is able to connect to other BLE devices and become a :doc:`/components/ble_client`, reading sensors and controlling switches etc.
+You can read basic sensor values using the :doc:`/components/sensor/ble_sensor` component or use the data displayed in the logs to build a new native component
+that provides the sensors/switches/etc directly.
+
+Jesse
+
+
+New Integrations
+----------------
+
+- esphome: Add I2CMultiplexer in general and the TCA9548A in special :esphomepr:`1410` by :ghuser:`andreashergert1984` (new-integration)
+- esphome: Add BME680 via BSEC integration :esphomepr:`1313` by :ghuser:`trvrnrth` (new-integration)
+- esphome: Adds support for b-parasite soil moisture sensor :esphomepr:`1666` by :ghuser:`rbaron` (new-integration)
+- esphome: Sgp40 :esphomepr:`1513` by :ghuser:`SenexCrenshaw` (new-integration)
+- esphome: Add support for SHT4X :esphomepr:`1512` by :ghuser:`sjtrny` (new-integration)
+- esphome: Add Grow Fingerprint Reader :esphomepr:`1356` by :ghuser:`loongyh` (new-integration)
+- esphome: Support for TOF10120 distance sensor :esphomepr:`1375` by :ghuser:`wstrzalka` (new-integration)
+- esphome: BLE client support on ESP32 :esphomepr:`1177` by :ghuser:`buxtronix` (new-integration)
+- esphome: Implement external custom components installing from YAML :esphomepr:`1630` by :ghuser:`OttoWinter` (new-integration)
+- esphome: Add sm2135 component :esphomepr:`1736` by :ghuser:`BoukeHaarsma23` (cherry-picked) (new-integration)
+
+Breaking Changes
+----------------
+
+- esphome: Raise minimum python version to 3.7 :esphomepr:`1673` by :ghuser:`OttoWinter` (breaking-change)
+- esphome: Change wifi signal strength unit to dBm :esphomepr:`1734` by :ghuser:`mbo18` (breaking-change)
+- esphome: Use core constants for sample duration on bh1750 :esphomepr:`1764` by :ghuser:`yuvalabou` (breaking-change) (cherry-picked)
+
+Beta Fixes
+----------
+
+- docs: Update allowed characters for node names :docspr:`1072` by :ghuser:`pkuehne` (cherry-picked)
+- docs: Fix missed merge conflict :docspr:`1155` by :ghuser:`jesserockz` (cherry-picked)
+- docs: Replaced set_password with new_password :docspr:`1157` by :ghuser:`PaulAntonDeen` (cherry-picked)
+- esphome: Fix build issues for idf 4.2 (Support ESP32-S2) :esphomepr:`1433` by :ghuser:`misery` (cherry-picked)
+- esphome: Upgrade the version of AsyncTCP-esphome to v1.2.2 :esphomepr:`1762` by :ghuser:`glmnet` (cherry-picked)
+- esphome: Use core constants for sample duration on bh1750 :esphomepr:`1764` by :ghuser:`yuvalabou` (breaking-change) (cherry-picked)
+- esphome: Add sm2135 component :esphomepr:`1736` by :ghuser:`BoukeHaarsma23` (cherry-picked) (new-integration)
+- docs: Add sm2135 component :docspr:`1127` by :ghuser:`BoukeHaarsma23` (cherry-picked)
+- docs: Some clarification added to external components. :docspr:`1165` by :ghuser:`mmakaay` (cherry-picked)
+- esphome: Allow RC522 components to have multiple configurations :esphomepr:`1782` by :ghuser:`jesserockz` (cherry-picked)
+
+All changes
+-----------
+
+- esphome: Add I2CMultiplexer in generel and the TCA9548A in special :esphomepr:`1410` by :ghuser:`andreashergert1984` (new-integration)
+- docs: Add i2c multiplexer :docspr:`897` by :ghuser:`andreashergert1984`
+- esphome: Add the display.is_displaying_page condition :esphomepr:`1646` by :ghuser:`numo68`
+- docs: Add documentation for the display.is_displaying_page condition :docspr:`1079` by :ghuser:`numo68`
+- esphome: Add BME680 via BSEC integration :esphomepr:`1313` by :ghuser:`trvrnrth` (new-integration)
+- docs: Add BME680 BSEC docs :docspr:`793` by :ghuser:`trvrnrth`
+- esphome: Fixed CustomComponentConstructor::get_component() :esphomepr:`1653` by :ghuser:`dataway`
+- esphome: Bump pytest from 6.2.2 to 6.2.3 :esphomepr:`1663` by :ghuser:`dependabot[bot]`
+- esphome: Bump protobuf from 3.15.6 to 3.15.7 :esphomepr:`1662` by :ghuser:`dependabot[bot]`
+- esphome: Rewrite sun component calculations :esphomepr:`1661` by :ghuser:`OttoWinter`
+- esphome: Raise minimum python version to 3.7 :esphomepr:`1673` by :ghuser:`OttoWinter` (breaking-change)
+- esphome: Adds support for b-parasite soil moisture sensor :esphomepr:`1666` by :ghuser:`rbaron` (new-integration)
+- docs: Adds docs for the b-parasite soil moisture sensor :docspr:`1086` by :ghuser:`rbaron`
+- esphome: mqtt_client: Added MQTTClientComponent::unsubscribe() :esphomepr:`1672` by :ghuser:`dataway`
+- esphome: Disallow _ in node name :esphomepr:`1632` by :ghuser:`pkuehne`
+- esphome: Receive long MQTT payload :esphomepr:`1590` by :ghuser:`gaco79`
+- esphome: Daylight Saving Time spelling fix :esphomepr:`1677` by :ghuser:`dashdrum`
+- esphome: Support custom build_flags for bme680_bsec :esphomepr:`1678` by :ghuser:`SenexCrenshaw`
+- esphome: Add Arduino ESP32 version mapping :esphomepr:`1679` by :ghuser:`OttoWinter`
+- esphome: Automate building and publishing of esphome-lint docker image :esphomepr:`1680` by :ghuser:`OttoWinter`
+- esphome: Sgp40 :esphomepr:`1513` by :ghuser:`SenexCrenshaw` (new-integration)
+- docs: sgp40 :docspr:`985` by :ghuser:`SenexCrenshaw`
+- esphome: Bump protobuf from 3.15.7 to 3.15.8 :esphomepr:`1682` by :ghuser:`dependabot[bot]`
+- esphome: Implementing the remainder of GPS data for the GPS component. :esphomepr:`1676` by :ghuser:`coogle`
+- docs: Updating docs for the gps component. :docspr:`1094` by :ghuser:`coogle`
+- esphome: Bump AsyncTCP-esphome to 1.2.1. :esphomepr:`1693` by :ghuser:`mmakaay`
+- esphome: Revert "Bump AsyncTCP-esphome to 1.2.1." :esphomepr:`1709` by :ghuser:`glmnet`
+- esphome: Fix name_add_mac_suffix using _ instead of - :esphomepr:`1702` by :ghuser:`glmnet`
+- docs: Update name_add_mac_suffix use dash :docspr:`1111` by :ghuser:`glmnet`
+- esphome: Add monochromatic effects: Pulse, Random :esphomepr:`1616` by :ghuser:`ferbar`
+- docs: Add 'pulse' effect doc :docspr:`1067` by :ghuser:`ferbar`
+- esphome: Add support for SHT4X :esphomepr:`1512` by :ghuser:`sjtrny` (new-integration)
+- docs: Add docs for SHT4X :docspr:`1002` by :ghuser:`sjtrny`
+- esphome: Addition of forward and reverse active energy counters to ATM90E32 sensor component :esphomepr:`1271` by :ghuser:`elyorkhakimov`
+- docs: Add Atm90e32 energy docs :docspr:`1120` by :ghuser:`jesserockz`
+- esphome: Add Grow Fingerprint Reader :esphomepr:`1356` by :ghuser:`loongyh` (new-integration)
+- docs: Add Grow fingerprint reader docs :docspr:`835` by :ghuser:`loongyh`
+- esphome: Support for TOF10120 distance sensor :esphomepr:`1375` by :ghuser:`wstrzalka` (new-integration)
+- docs: Documentation for TOF10120 support :docspr:`846` by :ghuser:`wstrzalka`
+- esphome: Swap fan and swing fields for Fujitu ACs :esphomepr:`1635` by :ghuser:`alex-richards`
+- esphome: BLE client support on ESP32 :esphomepr:`1177` by :ghuser:`buxtronix` (new-integration)
+- docs: Ble client docs :docspr:`702` by :ghuser:`buxtronix`
+- esphome: Update email addresses :esphomepr:`1733` by :ghuser:`jesserockz`
+- esphome: Ble client fixes :esphomepr:`1739` by :ghuser:`buxtronix`
+- esphome: Fix #1940: Implement speed_count in TuyaFan :esphomepr:`1654` by :ghuser:`0x0a11c0de`
+- docs: Add speed_count to tuya fan :docspr:`1080` by :ghuser:`0x0a11c0de`
+- docs: Fix mcp3008 reference :docspr:`1131` by :ghuser:`jesserockz`
+- esphome: Add Hyperion Support :esphomepr:`1339` by :ghuser:`d-two`
+- docs: Add note about hyperion classic udp port :docspr:`1135` by :ghuser:`jesserockz`
+- esphome: Call ``Stepper::should_step_`` every loop iteration :esphomepr:`1373` by :ghuser:`akonradi`
+- esphome: Add support for controlling Tuya fan direction :esphomepr:`1409` by :ghuser:`rmounce`
+- docs: Document Tuya fan direction datapoint :docspr:`877` by :ghuser:`rmounce`
+- esphome: Change wifi signal strength unit to dBm :esphomepr:`1734` by :ghuser:`mbo18` (breaking-change)
+- docs: Change wifi signal strength unit to dBm :docspr:`1125` by :ghuser:`mbo18`
+- esphome: Added an option to disable mDNS :esphomepr:`1716` by :ghuser:`dnetguru`
+- docs: Added docs for enable_mdns option :docspr:`1118` by :ghuser:`dnetguru`
+- docs: add External components docs :docspr:`1107` by :ghuser:`glmnet`
+- esphome: Implement external custom components installing from YAML :esphomepr:`1630` by :ghuser:`OttoWinter` (new-integration)
+- esphome: Update copyright year :esphomepr:`1760` by :ghuser:`bonanitech`
+- docs: Fixed datasheet link for RC522 :docspr:`1144` by :ghuser:`0nikola1`
+- docs: Added receive for Fujitsu ACs :docspr:`1037` by :ghuser:`alex-richards`
+- docs: Update allowed characters for node names :docspr:`1072` by :ghuser:`pkuehne` (cherry-picked)
+- docs: Update docs: Add references to alternative ICs to HLW8012 and CSE7766 :docspr:`902` by :ghuser:`kubik369`
+- docs: Update pulse_counter.rst :docspr:`1089` by :ghuser:`Chupaka`
+- docs: Remove deprecated board_flash_mode from configuration example :docspr:`1149` by :ghuser:`frenck`
+- docs: Update deep_sleep.rst :docspr:`1152` by :ghuser:`theOzzieRat`
+- docs: Utalize pip3 for commands :docspr:`1143` by :ghuser:`rradar`
+- docs: FAQ page: Converting from "I" to "we" wording :docspr:`1103` by :ghuser:`spacegaier`
+- docs: thermostat min/max temperature clarification :docspr:`1057` by :ghuser:`larsonmpdx`
+- docs: Added compatibility notes :docspr:`1033` by :ghuser:`Dezorian`
+- docs: Specify format for BSSID entries. :docspr:`1046` by :ghuser:`marcteale`
+- docs: add font to usage example :docspr:`1050` by :ghuser:`azrael783`
+- docs: Fix missed merge conflict :docspr:`1155` by :ghuser:`jesserockz` (cherry-picked)
+- docs: Sample codeblock has incorrect variables :docspr:`1156` by :ghuser:`jcallaghan`
+- docs: Replaced set_password with new_password :docspr:`1157` by :ghuser:`PaulAntonDeen` (cherry-picked)
+- docs: pulse counter: Show how calculations are made :docspr:`861` by :ghuser:`fredrike`
+- esphome: Upgrade the version of AsyncTCP-esphome to v1.2.2 :esphomepr:`1762` by :ghuser:`glmnet` (cherry-picked)
+- esphome: Fix build issues for idf 4.2 (Support ESP32-S2) :esphomepr:`1433` by :ghuser:`misery` (cherry-picked)
+- esphome: Use core constants for sample duration on bh1750 :esphomepr:`1764` by :ghuser:`yuvalabou` (breaking-change) (cherry-picked)
+- docs: Fix docs for inkplate :docspr:`1158` by :ghuser:`NobodysNightmare`
+- docs: Fixed wrong link in i2c_id :docspr:`1163` by :ghuser:`petrepa`
+- docs: Explain where to upload .ttf font files :docspr:`1133` by :ghuser:`TheGroundZero`
+- esphome: Add sm2135 component :esphomepr:`1736` by :ghuser:`BoukeHaarsma23` (cherry-picked) (new-integration)
+- docs: Add sm2135 component :docspr:`1127` by :ghuser:`BoukeHaarsma23` (cherry-picked)
+- docs: Some clarification added to external components. :docspr:`1165` by :ghuser:`mmakaay` (cherry-picked)
+- 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` (cherry-picked)
+- docs: Update max frequency :docspr:`1172` by :ghuser:`bookcasey`
+- docs: Update web-api id component :docspr:`1168` by :ghuser:`meijerwynand`
+- docs: Fix docker build failure :docspr:`1179` by :ghuser:`martgras`
+- docs: Update ifan02 example with new fan speed options :docspr:`1177` by :ghuser:`workingmanrob`
+- docs: Document missing use_address in Ethernet component :docspr:`1176` by :ghuser:`xsnoopy`
+- docs: Lambda over multiple lines. added :docspr:`1173` by :ghuser:`klenaers`
+- docs: changed LG example to existing, working code :docspr:`1171` by :ghuser:`qqgg231`
+- docs: GPIO Switch: simplify Momentary Switch example :docspr:`1121` by :ghuser:`ianchi`
+- docs: Added warning: GPIOs are LIVE in power measurement devices :docspr:`583` by :ghuser:`CarlosGS`
+
+Past Changelogs
+---------------
+
+.. toctree::
+ :maxdepth: 1
+
+ v1.17.0
+ v1.16.0
+ v1.15.0
+ v1.14.0
+ v1.13.0
+ v1.12.0
+ v1.11.0
+ v1.10.0
+ v1.9.0
+ v1.8.0
+ v1.7.0
diff --git a/components/ble_client.rst b/components/ble_client.rst
index f74d75d56..a846ed24e 100644
--- a/components/ble_client.rst
+++ b/components/ble_client.rst
@@ -72,7 +72,7 @@ This automation is triggered when the client connects to the BLE device.
on_connect:
then:
- lambda: |-
- ESP_LOGD("ble_client_lambda", "Connected to BLE device");
+ ESP_LOGD("ble_client_lambda", "Connected to BLE device");
.. _ble_client-on_disconnect:
@@ -89,7 +89,7 @@ This automation is triggered when the client disconnects from a BLE device.
on_disconnect:
then:
- lambda: |-
- ESP_LOGD("ble_client_lambda", "Disconnected from BLE device");
+ ESP_LOGD("ble_client_lambda", "Disconnected from BLE device");
BLE Overview
------------
diff --git a/components/dfplayer.rst b/components/dfplayer.rst
index b3a156fe7..1a1b89783 100644
--- a/components/dfplayer.rst
+++ b/components/dfplayer.rst
@@ -99,8 +99,8 @@ Plays a track.
on_...:
then:
- dfplayer.play:
- file: 23
- loop: false
+ file: 23
+ loop: false
# Shorthand
- dfplayer.play: 23
diff --git a/components/display/images/addressable_light.jpg b/components/display/images/addressable_light.jpg
index bb0de7cd6..eee9e8bbe 100644
Binary files a/components/display/images/addressable_light.jpg and b/components/display/images/addressable_light.jpg differ
diff --git a/components/display/images/addressable_light_pixel_map_8x32.png b/components/display/images/addressable_light_pixel_map_8x32.png
index d5886c3d8..aa82f8430 100644
Binary files a/components/display/images/addressable_light_pixel_map_8x32.png and b/components/display/images/addressable_light_pixel_map_8x32.png differ
diff --git a/components/display/images/addressable_light_pixel_map_default.png b/components/display/images/addressable_light_pixel_map_default.png
index f39ab8893..7c587e5dd 100644
Binary files a/components/display/images/addressable_light_pixel_map_default.png and b/components/display/images/addressable_light_pixel_map_default.png differ
diff --git a/components/display/images/ili9341-full.jpg b/components/display/images/ili9341-full.jpg
index 3dfa8b749..83e2f0727 100644
Binary files a/components/display/images/ili9341-full.jpg and b/components/display/images/ili9341-full.jpg differ
diff --git a/components/display/images/inkplate6.jpg b/components/display/images/inkplate6.jpg
index a373c8082..e420beab6 100644
Binary files a/components/display/images/inkplate6.jpg and b/components/display/images/inkplate6.jpg differ
diff --git a/components/display/images/ssd1322-full.jpg b/components/display/images/ssd1322-full.jpg
index dc58e5251..fcc11cb99 100644
Binary files a/components/display/images/ssd1322-full.jpg and b/components/display/images/ssd1322-full.jpg differ
diff --git a/components/display/index.rst b/components/display/index.rst
index 448220a62..41f925402 100644
--- a/components/display/index.rst
+++ b/components/display/index.rst
@@ -167,8 +167,9 @@ Configuration variables:
.. note::
To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package
- to translate the TrueType files into an internal format. If you're running this as a Hass.io add-on or with
- the official ESPHome docker image, it should already be installed. Otherwise you need to install it using
+ to translate the TrueType files into an internal format. If you're running this as a Home Assistant
+ add-on or with the official ESPHome docker image, it should already be installed. Otherwise you need
+ to install it using
``pip install pillow``.
@@ -387,7 +388,7 @@ Configuration variables:
.. note::
To use images you will need to have the python ``pillow`` package installed.
- If you're running this as a Hass.io add-on or with the official ESPHome docker image, it should already be
+ If you're running this as a Home Assistant add-on or with the official ESPHome docker image, it should already be
installed. Otherwise you need to install it using ``pip install pillow``.
And then later in code:
diff --git a/components/display/nextion.rst b/components/display/nextion.rst
index e37e00f26..3e5590914 100644
--- a/components/display/nextion.rst
+++ b/components/display/nextion.rst
@@ -54,7 +54,7 @@ Rendering Lambda
With Nextion displays, a dedicated chip on the display itself does the whole rendering. ESPHome can only
send *instructions* to the display to tell it *how* to render something and *what* to render.
-First, you need to use the `Nextion Editor `__ to
+First, you need to use the `Nextion Editor `__ to
create a display file and insert it using the SD card slot. Then, in the rendering ``lambda``, you have 3 main methods
you can call to populate data on the display:
diff --git a/components/display/pcd8544.rst b/components/display/pcd8544.rst
index 21812e19e..381edcdd8 100644
--- a/components/display/pcd8544.rst
+++ b/components/display/pcd8544.rst
@@ -47,7 +47,7 @@ VCC to 3.3V and GND to GND.
Backlight
*********
-To use a backlight LIGHT pin needs to be connected to ground. If connected to GPIO pin it can be controlled from EPSHome. See :doc:`/components/light/monochromatic`.
+To use a backlight LIGHT pin needs to be connected to ground. If connected to GPIO pin it can be controlled from ESPHome. See :doc:`/components/light/monochromatic`.
Configuration variables:
diff --git a/components/esphome.rst b/components/esphome.rst
index 5c72ca211..afc5d5ba4 100644
--- a/components/esphome.rst
+++ b/components/esphome.rst
@@ -25,7 +25,7 @@ Configuration variables:
------------------------
- **name** (**Required**, string): This is the name of the node. It
- should always be unique in your ESPhome network. May only contain lowercase
+ should always be unique in your ESPHome network. May only contain lowercase
characters, digits and hyphens. See :ref:`esphome-changing_node_name`.
- **platform** (**Required**, string): The platform your board is on,
either ``ESP32`` or ``ESP8266``. See :ref:`esphome-arduino_version`.
@@ -173,7 +173,7 @@ is already set up. You can however change this using the ``priority`` parameter.
Configuration variables:
- **priority** (*Optional*, float): The priority to execute your custom initialization code. A higher value
- means a high priority and thus also your code being executed earlier. Please note this is an ESPhome-internal
+ means a high priority and thus also your code being executed earlier. Please note this is an ESPHome-internal
value and any change will not be marked as a breaking change. Defaults to ``-10``. Priorities (you can use any value between them too):
- ``800.0``: This is where all hardware initialization of vital components is executed. For example setting switches
diff --git a/components/ethernet.rst b/components/ethernet.rst
index f02fb9bec..aa00cba54 100644
--- a/components/ethernet.rst
+++ b/components/ethernet.rst
@@ -96,6 +96,18 @@ Configuration for Olimex ESP32-POE
phy_addr: 0
power_pin: GPIO12
+Configuration for Olimex ESP32-EVB
+----------------------------------
+
+.. code-block:: yaml
+
+ ethernet:
+ type: LAN8720
+ mdc_pin: GPIO23
+ mdio_pin: GPIO18
+ clk_mode: GPIO0_IN
+ phy_addr: 0
+
Configuration for LILYGO TTGO T-Internet-POE ESP32-WROOM LAN8270A Chip
----------------------------------------------------------------------
diff --git a/components/fan/images/fan-ui.png b/components/fan/images/fan-ui.png
index b25feffd8..899591a08 100644
Binary files a/components/fan/images/fan-ui.png and b/components/fan/images/fan-ui.png differ
diff --git a/components/fan/index.rst b/components/fan/index.rst
index 0b5f71ef5..a761d75c3 100644
--- a/components/fan/index.rst
+++ b/components/fan/index.rst
@@ -83,7 +83,7 @@ Turns the fan with the given ID off when executed.
``fan.turn_on`` Action
----------------------
-Turns the fan with the given ID off when executed.
+Turns the fan with the given ID on when executed.
.. code-block:: yaml
diff --git a/components/images/tca9548a.jpg b/components/images/tca9548a.jpg
index b241b0ec0..75a69d894 100644
Binary files a/components/images/tca9548a.jpg and b/components/images/tca9548a.jpg differ
diff --git a/components/light/index.rst b/components/light/index.rst
index c670102d8..2286b8240 100644
--- a/components/light/index.rst
+++ b/components/light/index.rst
@@ -385,11 +385,11 @@ This effect makes a pulsating light. The period can be defined by ``update_inter
effects:
- pulse:
- pulse:
- name: "Fast Puse"
+ name: "Fast Pulse"
transition_length: 0.5s
update_interval: 0.5s
- pulse:
- name: "Slow Puse"
+ name: "Slow Pulse"
# transition_length: 1s # defaults to 1s
update_interval: 2s
diff --git a/components/rf_bridge.rst b/components/rf_bridge.rst
index 7b0109248..d3b0e7831 100644
--- a/components/rf_bridge.rst
+++ b/components/rf_bridge.rst
@@ -106,7 +106,11 @@ Configuration options:
``rf_bridge.send_raw`` Action
-----------------------------
-Send a raw RF code using this action in automations.
+Send a raw command to the onboard EFM8BB1 chip.
+You can see a list of available commands and format in the `Portisch Wiki `__
+
+This can be used to send raw RF codes in automation's, mainly for protocols that are not supported.
+If you have *Portisch* firmware installed, these raw codes can be obtained with the help of :ref:`rf_bridge-start_bucket_sniffing_action`
.. code-block:: yaml
@@ -267,7 +271,71 @@ Configuration options:
id(rf_bridge).stop_advanced_sniffing();
+.. _rf_bridge-start_bucket_sniffing_action:
+``rf_bridge.start_bucket_sniffing`` Action
+------------------------------------------
+
+Tell the RF Bridge to dump raw sniffing data. Useful for getting codes for unsupported protocols.
+The raw data will be available in the log and can later be used with :ref:`rf_bridge-send_raw_action` action.
+
+.. note::
+
+ A conversion from *B1* (received) raw format to *B0* (send) raw command format should be applied.
+ For this, you can use the tool `BitBucket Converter `__
+
+.. note::
+
+ There seems to be an overflow problem in Portisch firmware and after a short while, the bucket sniffing stops.
+ You should re-call the action to reset and start sniffing again.
+
+.. code-block:: yaml
+
+ on_...:
+ then:
+ - rf_bridge.start_bucket_sniffing
+
+Configuration options:
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID of the RF Bridge if you have multiple components.
+
+.. note::
+
+ This action can also be written in :ref:`lambdas `:
+
+ .. code-block:: cpp
+
+ id(rf_bridge).start_bucket_sniffing();
+
+
+.. _rf_bridge-beep_action:
+
+``rf_bridge.beep`` Action
+-------------------------------------------
+
+Activate the internal buzzer to make a beep.
+
+
+.. code-block:: yaml
+
+ on_...:
+ then:
+ - rf_bridge.beep:
+ duration: 100
+
+Configuration options:
+
+- **duration** (**Required**, string, :ref:`templatable `): beep duration in milliseconds.
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID of the RF Bridge if you have multiple components.
+
+.. note::
+
+ This action can also be written in :ref:`lambdas `:
+
+ .. code-block:: cpp
+
+ id(rf_bridge).beep(100);
+
Getting started with Home Assistant
-----------------------------------
diff --git a/components/sensor/adc.rst b/components/sensor/adc.rst
index e9832c37f..789bb0b54 100644
--- a/components/sensor/adc.rst
+++ b/components/sensor/adc.rst
@@ -51,6 +51,8 @@ Configuration variables:
filters:
- multiply: 3.3
+
+
.. _adc-esp32_attenuation:
ESP32 Attenuation
@@ -88,6 +90,13 @@ To measure the VCC voltage, set ``pin:`` to ``VCC`` and make sure nothing is con
pin: VCC
name: "VCC Voltage"
+Multiple ADC Sensors
+---------------------
+
+You can only use as many ADC sensors as your device can support. The ESP8266 only has one ADC and can only handle one sensor at a time. For example, on the ESP8266, you can measure the value of an analog pin (A0 on ESP8266) or VCC (see below) but NOT both simultaneously. Using both at the same time will result in incorrect sensor values.
+
+
+
See Also
--------
diff --git a/components/sensor/as3935.rst b/components/sensor/as3935.rst
index 0c1a7fc87..98c62c90e 100644
--- a/components/sensor/as3935.rst
+++ b/components/sensor/as3935.rst
@@ -19,7 +19,7 @@ Component/Hub
The AS3935 can be configured to use either the SPI **or** I²C protocol for data communication.
First choose which communication method you want to use for the sensor, set the SI pin for the appropriate
-level and set up the ESPhome integration for the chosen communication method.
+level and set up the ESPHome integration for the chosen communication method.
Module Pins
-----------
diff --git a/components/sensor/b_parasite.rst b/components/sensor/b_parasite.rst
index 3faff4609..a1d340762 100644
--- a/components/sensor/b_parasite.rst
+++ b/components/sensor/b_parasite.rst
@@ -9,7 +9,7 @@ b-parasite
`b-parasite `__ is an open source soil moisture and ambient temperature/humidity sensor.
-The ``b_parasite`` sensor platform tracks b-parasite's Bluetooth Low Energy (BLE) advertisement packets. These packets contains soil moisture, air temperature/humidity and baterry voltage data.
+The ``b_parasite`` sensor platform tracks b-parasite's Bluetooth Low Energy (BLE) advertisement packets. These packets contains soil moisture, air temperature/humidity and battery voltage data.
.. figure:: images/b_parasite.jpg
:align: center
diff --git a/components/sensor/homeassistant.rst b/components/sensor/homeassistant.rst
index 687c8b985..67bb02a34 100644
--- a/components/sensor/homeassistant.rst
+++ b/components/sensor/homeassistant.rst
@@ -34,7 +34,7 @@ With Home Assistant 2021.6 or newer, entity state attributes can also be importe
Albeit you might not plan to __export__ states from the node and you do not need an entity of the node
in Home Assistant, this component still requires you to register the node under Home Assistant. See:
- :doc:`Getting started with Hassio `
+ :doc:`Getting started with Home Assistant `
Configuration variables:
------------------------
diff --git a/components/sensor/images/b_parasite.jpg b/components/sensor/images/b_parasite.jpg
index 22ff8e097..b83ae9d17 100644
Binary files a/components/sensor/images/b_parasite.jpg and b/components/sensor/images/b_parasite.jpg differ
diff --git a/components/sensor/images/bme680-bsec-ui.png b/components/sensor/images/bme680-bsec-ui.png
index f85dea8fd..4ca5c1db1 100644
Binary files a/components/sensor/images/bme680-bsec-ui.png and b/components/sensor/images/bme680-bsec-ui.png differ
diff --git a/components/sensor/images/inkbird_isbth1_mini-full.jpg b/components/sensor/images/inkbird_isbth1_mini-full.jpg
index e34559a40..0e277bbd4 100644
Binary files a/components/sensor/images/inkbird_isbth1_mini-full.jpg and b/components/sensor/images/inkbird_isbth1_mini-full.jpg differ
diff --git a/components/sensor/images/inkbird_isbth1_mini-ui.png b/components/sensor/images/inkbird_isbth1_mini-ui.png
index e12eb9496..10e42952d 100644
Binary files a/components/sensor/images/inkbird_isbth1_mini-ui.png and b/components/sensor/images/inkbird_isbth1_mini-ui.png differ
diff --git a/components/sensor/images/inkbird_isbth1_mini.png b/components/sensor/images/inkbird_isbth1_mini.png
index 1e21a6f63..cbcdaf728 100644
Binary files a/components/sensor/images/inkbird_isbth1_mini.png and b/components/sensor/images/inkbird_isbth1_mini.png differ
diff --git a/components/sensor/images/sht4x-full.jpg b/components/sensor/images/sht4x-full.jpg
index 50a3834a6..d422a6ab7 100644
Binary files a/components/sensor/images/sht4x-full.jpg and b/components/sensor/images/sht4x-full.jpg differ
diff --git a/components/sensor/images/teleinfo-full.jpg b/components/sensor/images/teleinfo-full.jpg
index aceb690c4..c1ade04a8 100644
Binary files a/components/sensor/images/teleinfo-full.jpg and b/components/sensor/images/teleinfo-full.jpg differ
diff --git a/components/sensor/images/wifi_signal-ui.png b/components/sensor/images/wifi_signal-ui.png
index 9a016fafd..88b6d49ac 100644
Binary files a/components/sensor/images/wifi_signal-ui.png and b/components/sensor/images/wifi_signal-ui.png differ
diff --git a/components/sensor/images/xiaomi_mhoc401.jpg b/components/sensor/images/xiaomi_mhoc401.jpg
index c78f0c4c7..3d439993c 100644
Binary files a/components/sensor/images/xiaomi_mhoc401.jpg and b/components/sensor/images/xiaomi_mhoc401.jpg differ
diff --git a/components/sensor/images/xiaomi_miscale2.jpg b/components/sensor/images/xiaomi_miscale2.jpg
index 81f767bbe..91fd5b19a 100644
Binary files a/components/sensor/images/xiaomi_miscale2.jpg and b/components/sensor/images/xiaomi_miscale2.jpg differ
diff --git a/components/sensor/scd30.rst b/components/sensor/scd30.rst
index 6b0942462..0ee214218 100644
--- a/components/sensor/scd30.rst
+++ b/components/sensor/scd30.rst
@@ -5,7 +5,7 @@ SCD30 CO₂, Temperature and Relative Humidity Sensor
:description: Instructions for setting up SCD30 CO₂ Temperature and Relative Humidity Sensor
:image: scd30.jpg
-The ``scd30`` sensor platform allows you to use your Sensiron SCD30 CO₂
+The ``scd30`` sensor platform allows you to use your Sensirion SCD30 CO₂
(`datasheet `__) sensors with ESPHome.
The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work.
@@ -31,7 +31,6 @@ The :ref:`I²C Bus ` is required to be set up in your configuration for thi
address: 0x61
update_interval: 5s
-
Configuration variables:
------------------------
@@ -47,7 +46,6 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor `.
-
- **humidity** (*Optional*): The information for the Humidity sensor.
- **name** (**Required**, string): The name for the humidity sensor.
@@ -76,8 +74,6 @@ Configuration variables:
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.
-
-
See Also
--------
diff --git a/components/sensor/sgp30.rst b/components/sensor/sgp30.rst
index c44e50f63..33c74c72f 100644
--- a/components/sensor/sgp30.rst
+++ b/components/sensor/sgp30.rst
@@ -5,7 +5,7 @@ SGP30 CO₂ and Volatile Organic Compound Sensor
:description: Instructions for setting up SGP30 CO₂eq and Volatile Organic Compound sensor
:image: sgp30.png
-The ``sgp30`` sensor platform allows you to use your Sensiron SGP30 multi-pixel gas
+The ``sgp30`` sensor platform allows you to use your Sensirion SGP30 multi-pixel gas
(`datasheet `__) sensors or the SVM30 breakout-boards (`product page `__) with ESPHome.
The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work.
@@ -27,7 +27,6 @@ The :ref:`I²C Bus ` is required to be set up in your configuration for thi
address: 0x58
update_interval: 5s
-
Configuration variables:
------------------------
diff --git a/components/sensor/sgp40.rst b/components/sensor/sgp40.rst
index 3551cc87d..48fba0219 100644
--- a/components/sensor/sgp40.rst
+++ b/components/sensor/sgp40.rst
@@ -5,7 +5,7 @@ SGP40 Volatile Organic Compound Sensor
:description: Instructions for setting up SGP40 Volatile Organic Compound sensor
:image: sgp40.jpg
-The ``sgp40`` sensor platform allows you to use your Sensiron SGP40 VOC sensor
+The ``sgp40`` sensor platform allows you to use your Sensirion SGP40 VOC sensor
(`datasheet `__) with ESPHome.
The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work.
@@ -20,14 +20,13 @@ The :ref:`I²C Bus ` is required to be set up in your configuration for thi
- platform: sgp40
name: "Workshop VOC"
-
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the CO₂eq sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``
-- **store_baseline** (*Optional*, boolean ): Stores and retrieves the baseline infortmation for quicker startups. Defaults to ``True``
+- **store_baseline** (*Optional*, boolean ): Stores and retrieves the baseline information for quicker startups. Defaults to ``True``
- **compensation** (*Optional*): The block containing sensors used for compensation. If not set defaults will be used.
diff --git a/components/sensor/sht3xd.rst b/components/sensor/sht3xd.rst
index d74e09fe1..0d340d3e0 100644
--- a/components/sensor/sht3xd.rst
+++ b/components/sensor/sht3xd.rst
@@ -5,7 +5,7 @@ SHT3X-D Temperature+Humidity Sensor
:description: Instructions for setting up SHT31-D temperature and humidity sensors
:image: sht3xd.jpg
-The ``sht3xd`` sensor platform Temperature+Humidity sensor allows you to use your Sensiron SHT31-D
+The ``sht3xd`` sensor platform Temperature+Humidity sensor allows you to use your Sensirion SHT31-D
(`datasheet `__,
`Adafruit`_ ) sensors with
ESPHome. The :ref:`I²C Bus ` is
diff --git a/components/sensor/shtcx.rst b/components/sensor/shtcx.rst
index b9e68c2eb..8cf0d267b 100644
--- a/components/sensor/shtcx.rst
+++ b/components/sensor/shtcx.rst
@@ -5,7 +5,7 @@ SHTCx Temperature+Humidity Sensors
:description: Instructions for setting up SHTC1 and SHTC3 temperature and humidity sensors
:image: shtc3.jpg
-The ``shtcx`` sensor platform Temperature+Humidity sensor allows you to use your Sensiron SHTC1
+The ``shtcx`` sensor platform Temperature+Humidity sensor allows you to use your Sensirion SHTC1
(`datasheet `__,
`Sensirion STHC1 `__) and
the newer SHTC3
diff --git a/components/sensor/sps30.rst b/components/sensor/sps30.rst
index 011acc5a1..8e91d7d14 100644
--- a/components/sensor/sps30.rst
+++ b/components/sensor/sps30.rst
@@ -5,8 +5,8 @@ SPS30 Particulate Matter Sensor
:description: Instructions for setting up SPS30 PM1.0, PM2.5, PM4, PM10 Particulate Matter sensors
:image: sps30.jpg
-The ``sps30`` sensor platform allows you to use your Sensiron SPS30
-(`datasheet `__) sensors with ESPHome.
+The ``sps30`` sensor platform allows you to use your Sensirion SPS30
+(`datasheet `__) sensors with ESPHome.
The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work.
This sensor supports both UART and I²C communication. However, at the moment only I²C communication is implemented.
@@ -51,7 +51,6 @@ This sensor supports both UART and I²C communication. However, at the moment on
address: 0x69
update_interval: 10s
-
Configuration variables:
------------------------
diff --git a/components/sensor/sts3x.rst b/components/sensor/sts3x.rst
index 5cac80d78..479760059 100644
--- a/components/sensor/sts3x.rst
+++ b/components/sensor/sts3x.rst
@@ -5,7 +5,7 @@ STS3X Temperature Sensor
:description: Instructions for setting up STS3x-DIS temperature sensors
:image: sts3x.jpg
-The ``sts3x`` sensor platform Temperature sensor allows you to use your Sensiron STS30-DIS, STS31-DIS or STS35-DIS
+The ``sts3x`` sensor platform Temperature sensor allows you to use your Sensirion STS30-DIS, STS31-DIS or STS35-DIS
(`datasheet `__,
`Sensirion STS3x `__) sensors with
ESPHome. The :ref:`I²C Bus ` is
diff --git a/components/stepper/index.rst b/components/stepper/index.rst
index 54b27dc4d..a9bffdeff 100644
--- a/components/stepper/index.rst
+++ b/components/stepper/index.rst
@@ -38,7 +38,7 @@ Configuration variables:
A4988 Component
---------------
-Put this code into the configuration file on ESPhome for this device.
+Put this code into the configuration file on ESPHome for this device.
.. code-block:: yaml
diff --git a/cookbook/brilliant-mirabella-genio-smart-plugs.rst b/cookbook/brilliant-mirabella-genio-smart-plugs.rst
index 913ef784e..b1365dbda 100644
--- a/cookbook/brilliant-mirabella-genio-smart-plugs.rst
+++ b/cookbook/brilliant-mirabella-genio-smart-plugs.rst
@@ -87,7 +87,7 @@ firmware can be uploaded allowing you to control the smart plugs via Home Assist
via SSH and ensure your connection type is set to **SFTP**
#. Browse to ``/root/tuya-convert/files``.
#. Upload your compiled ``firmware.bin`` file to this directory. For command line based installs you can access the file under
- ``//.pioenvs//firmware.bin`` alternatively Hass.io users can download the file directly from the web ui.
+ ``//.pioenvs//firmware.bin`` alternatively Home Assistant add-on users can download the file directly from the web ui.
2.7 Use tuya-convert to install ESPHome Firmware
************************************************
diff --git a/cookbook/display_time_temp_oled.rst b/cookbook/display_time_temp_oled.rst
index 1a5e9a74a..3dc17aab9 100644
--- a/cookbook/display_time_temp_oled.rst
+++ b/cookbook/display_time_temp_oled.rst
@@ -2,7 +2,7 @@ Time & Temperature on OLED Display
==================================
.. seo::
- :description: Instructions for setting up a display in ESPhome to show sensor values from Home Assistant
+ :description: Instructions for setting up a display in ESPHome to show sensor values from Home Assistant
:image: display_time_temp_oled_1.jpg
:keywords: Display
diff --git a/cookbook/images/iaq_board1.jpg b/cookbook/images/iaq_board1.jpg
index 9760141e3..e87781af0 100644
Binary files a/cookbook/images/iaq_board1.jpg and b/cookbook/images/iaq_board1.jpg differ
diff --git a/cookbook/images/iaq_board2.jpg b/cookbook/images/iaq_board2.jpg
index a83b8f1f6..61cf79a5b 100644
Binary files a/cookbook/images/iaq_board2.jpg and b/cookbook/images/iaq_board2.jpg differ
diff --git a/cookbook/images/infostrip-detail.jpg b/cookbook/images/infostrip-detail.jpg
index ee90a133f..f310975ca 100644
Binary files a/cookbook/images/infostrip-detail.jpg and b/cookbook/images/infostrip-detail.jpg differ
diff --git a/cookbook/images/infostrip-lights-ui.png b/cookbook/images/infostrip-lights-ui.png
index 0a8da59f7..30eb01e57 100644
Binary files a/cookbook/images/infostrip-lights-ui.png and b/cookbook/images/infostrip-lights-ui.png differ
diff --git a/cookbook/leak-detector-m5stickC.rst b/cookbook/leak-detector-m5stickC.rst
index 62050745d..2b8c713e8 100644
--- a/cookbook/leak-detector-m5stickC.rst
+++ b/cookbook/leak-detector-m5stickC.rst
@@ -3,11 +3,11 @@ ESP32 Water Leak Detector (with notification)
=============================================
.. seo::
- :description: Water leak detector with ESPhome on an M5StickC ESP32
+ :description: Water leak detector with ESPHome on an M5StickC ESP32
:image: images/leak-detector-m5stickC_dry.jpg
:keywords: Leak Detector M5StickC M5Stack M5Atom
-Using the ESP32's capacitive touch GPIOs, it's relatively easy to build a water leak detector using ESPhome. M5StickC was chosen as a platform due to the integrated Grove connector for clean connections and the fact it's well housed. The built-in display is a bonus, but not strictly necessary. Notifications are performed via HomeAssistant's 'alert' and 'notify' facilities, which send via Pushover to iOS & Android.
+Using the ESP32's capacitive touch GPIOs, it's relatively easy to build a water leak detector using ESPHome. M5StickC was chosen as a platform due to the integrated Grove connector for clean connections and the fact it's well housed. The built-in display is a bonus, but not strictly necessary. Notifications are performed via HomeAssistant's 'alert' and 'notify' facilities, which send via Pushover to iOS & Android.
.. figure:: images/leak-detector-m5stickC_LeakDetected.gif
:align: center
@@ -67,14 +67,14 @@ Assembled Components
Display Font
============
-You'll need to place the `OpenSans-Regular `__ font (or another of your choosing) alongside your ESPhome yaml file. See - :doc:`/components/display/index`.
+You'll need to place the `OpenSans-Regular `__ font (or another of your choosing) alongside your ESPHome yaml file. See - :doc:`/components/display/index`.
Flashing
========
I initially had trouble flashing the M5StickC; this is the procedure that I've found to work well with these devices.
-You must provide the ESP32 bootloader during the initial flash over USB. Compile your ESPhome binary, and flash it along with the required bootloader (bootloader_dio_80m.bin), `available here `__, from the commandline (example under macos):
+You must provide the ESP32 bootloader during the initial flash over USB. Compile your ESPHome binary, and flash it along with the required bootloader (bootloader_dio_80m.bin), `available here `__, from the commandline (example under macos):
``cd /Applications/ESPHome-Flasher-1.2.0-macOS.app/Contents/MacOS``
@@ -115,7 +115,7 @@ Not shown: Probe is placed on the floor in the corner, out of the way, in the lo
------------
-ESPhome configuration
+ESPHome configuration
=====================
.. code-block:: yaml
diff --git a/cookbook/mirabella-genio-bulb.rst b/cookbook/mirabella-genio-bulb.rst
index f9d291375..2f70cd9dd 100644
--- a/cookbook/mirabella-genio-bulb.rst
+++ b/cookbook/mirabella-genio-bulb.rst
@@ -92,7 +92,7 @@ firmware can be uploaded allowing you to control the bulbs via Home Assistant.
via SSH and ensure your connection type is set to **SFTP**
#. Browse to ``/root/tuya-convert/files``.
#. Upload your compiled ``firmware.bin`` file to this directory. For command line based installs you can access the file under
- ``//.pioenvs//firmware.bin`` alternatively Hass.io users can download the file directly from the web ui.
+ ``//.pioenvs//firmware.bin`` alternatively Home Assistant add-on users can download the file directly from the web ui.
2.7 Use tuya-convert to install ESPHome Firmware
************************************************
diff --git a/cookbook/zemismart-rgbw-downlights.rst b/cookbook/zemismart-rgbw-downlights.rst
index 8accbf7a6..3947839ef 100644
--- a/cookbook/zemismart-rgbw-downlights.rst
+++ b/cookbook/zemismart-rgbw-downlights.rst
@@ -87,7 +87,7 @@ firmware can be uploaded allowing you to control the smart plugs via Home Assist
via SSH and ensure your connection type is set to **SFTP**
#. Browse to ``/root/tuya-convert/files``.
#. Upload your compiled ``firmware.bin`` file to this directory. For command line based installs you can access the file under
- ``//.pioenvs//firmware.bin`` alternatively Hass.io users can download the file directly from the web UI.
+ ``//.pioenvs//firmware.bin`` alternatively Home Assistant add-on users can download the file directly from the web UI.
2.7 Use tuya-convert to install ESPHome Firmware
************************************************
diff --git a/devices/images/sonoff_4ch_mcu.jpg b/devices/images/sonoff_4ch_mcu.jpg
index 8b0a58bf1..b7e08141c 100644
Binary files a/devices/images/sonoff_4ch_mcu.jpg and b/devices/images/sonoff_4ch_mcu.jpg differ
diff --git a/devices/images/sonoff_t3_eu_3g_back_v1.0.jpg b/devices/images/sonoff_t3_eu_3g_back_v1.0.jpg
index 177418d45..678597da3 100644
Binary files a/devices/images/sonoff_t3_eu_3g_back_v1.0.jpg and b/devices/images/sonoff_t3_eu_3g_back_v1.0.jpg differ
diff --git a/devices/images/sonoff_t3_eu_3g_backplate_v1.0.jpg b/devices/images/sonoff_t3_eu_3g_backplate_v1.0.jpg
index 5328104be..89dc01962 100644
Binary files a/devices/images/sonoff_t3_eu_3g_backplate_v1.0.jpg and b/devices/images/sonoff_t3_eu_3g_backplate_v1.0.jpg differ
diff --git a/devices/images/sonoff_t3_eu_3g_plate_off_v1.0.jpg b/devices/images/sonoff_t3_eu_3g_plate_off_v1.0.jpg
index bb58947c4..39adcd7b1 100644
Binary files a/devices/images/sonoff_t3_eu_3g_plate_off_v1.0.jpg and b/devices/images/sonoff_t3_eu_3g_plate_off_v1.0.jpg differ
diff --git a/devices/images/sonoff_t3_eu_3g_touchpads_v1.0.jpg b/devices/images/sonoff_t3_eu_3g_touchpads_v1.0.jpg
index 449d512aa..d2ce7151d 100644
Binary files a/devices/images/sonoff_t3_eu_3g_touchpads_v1.0.jpg and b/devices/images/sonoff_t3_eu_3g_touchpads_v1.0.jpg differ
diff --git a/devices/images/sonoff_t3_eu_3g_uart_v1.0.jpg b/devices/images/sonoff_t3_eu_3g_uart_v1.0.jpg
index 4ae5aeb51..10ff3b9b2 100644
Binary files a/devices/images/sonoff_t3_eu_3g_uart_v1.0.jpg and b/devices/images/sonoff_t3_eu_3g_uart_v1.0.jpg differ
diff --git a/devices/images/sonoff_t3_eu_3g_v1.0.jpg b/devices/images/sonoff_t3_eu_3g_v1.0.jpg
index 967c0d094..1d909c96a 100644
Binary files a/devices/images/sonoff_t3_eu_3g_v1.0.jpg and b/devices/images/sonoff_t3_eu_3g_v1.0.jpg differ
diff --git a/devices/sonoff_4ch.rst b/devices/sonoff_4ch.rst
index f5232abde..89eb6d072 100644
--- a/devices/sonoff_4ch.rst
+++ b/devices/sonoff_4ch.rst
@@ -47,7 +47,7 @@ For this guide you will need:
- A USB to UART Bridge for flashing the device. These can be bought on Amazon (or other online stores) for less than 5 dollars.
Note that the bridge *must* be 3.3V compatible. Otherwise you will destroy your Sonoff.
- Jumper wires to connect the UART bridge to the header pins.
-- A computer running Home Assistant with the ESPHome Hass.io add-on.
+- A computer running Home Assistant with the ESPHome Home Assistant add-on.
- A screwdriver to open up the Sonoff 4CH.
Have everything? Great! Then you can start.
@@ -211,13 +211,17 @@ of the basic functions.
---------------------------------------- -----------------------------------------
``GPIO13`` Blue LED (inverted)
---------------------------------------- -----------------------------------------
-``GPIO1`` ``RX`` pin (for external sensors)
+``GPIO1`` ``TX`` pin (for external sensors)
---------------------------------------- -----------------------------------------
-``GPIO3`` ``TX`` pin (for external sensors)
+``GPIO3`` ``RX`` pin (for external sensors)
---------------------------------------- -----------------------------------------
``GPIO2`` ``IO2`` pin (for external sensors)
======================================== =========================================
+.. note::
+
+ The ESP8266 will be prevented from booting if the following pins are pulled LOW (connected to GND) on cold startup: ``GPIO0``, ``GPIO1``, ``GPIO2``. Be prepared if you want to use them for input sensors.
+
.. code-block:: yaml
esphome:
diff --git a/devices/sonoff_basic.rst b/devices/sonoff_basic.rst
index 463faa92e..590d76ce0 100644
--- a/devices/sonoff_basic.rst
+++ b/devices/sonoff_basic.rst
@@ -54,7 +54,8 @@ exposes all of the basic functions.
esphome:
name:
platform: ESP8266
- board: esp01_1m
+ board: esp8285
+ arduino_version: 2.4.2
wifi:
ssid:
diff --git a/devices/sonoff_s20.rst b/devices/sonoff_s20.rst
index e6640953c..254779505 100644
--- a/devices/sonoff_s20.rst
+++ b/devices/sonoff_s20.rst
@@ -46,7 +46,7 @@ For this guide you will need:
- Sonoff S20 😉.
- A USB to UART Bridge for flashing the device. These can be bought on Amazon (or other online stores) for less than 5 dollars.
Note that the bridge *must* be 3.3V compatible. Otherwise you will destroy your S20.
-- A computer running Home Assistant with the ESPHome Hass.io add-on.
+- A computer running Home Assistant with the ESPHome Home Assistant add-on.
- A screwdriver to open up the S20.
- A soldering iron and a few header pins to connect the UART interface.
@@ -200,6 +200,8 @@ of the basic functions.
``GPIO1`` ``RX`` pin (for external sensors)
---------------------------------------- ----------------------------------------
``GPIO3`` ``TX`` pin (for external sensors)
+---------------------------------------- ----------------------------------------
+``GPIO2`` ``E-LOG`` pin (From PCB V2.1; for external sensors)
======================================== ========================================
.. code-block:: yaml
@@ -207,8 +209,7 @@ of the basic functions.
esphome:
name:
platform: ESP8266
- board: esp8285
- arduino_version: 2.4.2
+ board: esp01_1m
wifi:
ssid:
@@ -229,6 +230,9 @@ of the basic functions.
name: "Sonoff S20 Button"
- platform: status
name: "Sonoff S20 Status"
+ - platform: gpio
+ pin: GPIO2
+ name: "Sonoff S20 Sensor"
switch:
diff --git a/devices/sonoff_t1_uk_3gang_v1.1.rst b/devices/sonoff_t1_uk_3gang_v1.1.rst
index 93235528a..ac3abb473 100644
--- a/devices/sonoff_t1_uk_3gang_v1.1.rst
+++ b/devices/sonoff_t1_uk_3gang_v1.1.rst
@@ -51,7 +51,7 @@ For this guide you will need:
- A USB to UART Bridge for flashing the device. These can be bought on Amazon for less than 5 dollars.
Note that the bridge *must* be 3.3V compatible. Otherwise you will destroy your Sonoff.
- Jumper wires to connect the UART bridge to the header pins and to connect GPIO0 to the Ground.
-- Computer running ESPHome or Hass.io add-on.
+- Computer running ESPHome or Home Assistant add-on.
- Screwdriver to open up the Sonoff T1 UK 3 Gang.
Have everything? Great! Then you can start.
diff --git a/guides/diy.rst b/guides/diy.rst
index d64c5520c..8bbec0584 100644
--- a/guides/diy.rst
+++ b/guides/diy.rst
@@ -44,7 +44,7 @@ Blog Posts & Videos
- `Washing machine phases detector (Sonoff Pow R2) `__ by `Gio-dot `__
- `Sonoff L1 LED Strip `__ by :ghuser:`emorydunn`
- `ESPHome for SP501E LED Controller `__ by `margau `__
-- `4$ Xiaomi mijia thermometer LYWSD03MMC + ESP32 + ESPhome `__ by `Omar GHADER `__
+- `4$ Xiaomi mijia thermometer LYWSD03MMC + ESP32 + ESPHome `__ by `Omar GHADER `__
- `Baseboard (Line Voltage) Thermostat from Smart Switch `__ by :ghuser:`rjmurph2241`
- `Office Doorbell `__ by :ghuser:`shish`
- `Display TM1637 with ESPHome and MQTT showing Youtube subscribers count and other info `__ by :ghuser:`electrofun-smart`
@@ -78,6 +78,7 @@ Custom Components & Code
- `Custom UART component for WS3 weather station and air particulate matter sensor `__ by :ghuser:`kquinsland`
- `ADEMCO/VISTA/Honeywell alarm system custom component `__ by :ghuser:`Dilbert66`
- `Winsen ZE08-CH2O (Formaldehyde sensor) custom component `__ by :ghuser:`cretep`
+- `ZclMqttBridge custom component `__ by :ghuser:`HyperReap`
Sample Configurations
---------------------
diff --git a/guides/faq.rst b/guides/faq.rst
index 799e1d736..1de600e9b 100644
--- a/guides/faq.rst
+++ b/guides/faq.rst
@@ -51,10 +51,10 @@ and did not mount the ESP device into your container using ``--device=/dev/ttyUS
Starting with ESPHome 1.9.0, the ESPHome suite provides
`esphome-flasher `__, a tool to flash ESPs over USB.
-First, you need to get the firmware file to flash. For Hass.io add-on based installs you can
-use the ``COMPILE`` button (click the overflow icon with the three dots) and then press
-``Download Binary``. For command line based installs you can access the file under
-``//.pioenvs//firmware.bin``.
+First, you need to get the firmware file to flash. For the Home Assistant add-on based
+installs you can use the ``COMPILE`` button (click the overflow icon with the three dots)
+and then press ``Download Binary``. For command line based installs you can access the
+file under ``//.pioenvs//firmware.bin``.
Then, install esphome-flasher by going to the `releases page `__
and downloading one of the pre-compiled binaries. Open up the application and select the serial port
@@ -125,7 +125,8 @@ It's simple. Run:
# From docker:
docker pull esphome/esphome:latest
-And in Hass.io, there's a simple UPDATE button when there's an update available as with all add-ons
+And in Home Assistant, there's a simple UPDATE button when there's an update
+available as with all add-ons.
.. _faq-beta:
@@ -159,7 +160,7 @@ If you find some, please do however report them.
To install the dev version of ESPHome:
-- In Hass.io: Add the ESPHome repository `https://github.com/esphome/hassio `
+- In Home Assistant: Add the ESPHome repository `https://github.com/esphome/hassio `
in Add-on store -> Repositories. Then install the add-on ``ESPHome Dev``
- From ``pip``: Run ``pip3 install https://github.com/esphome/esphome/archive/dev.zip``
- From docker, use the `esphome/esphome:dev `__ image
@@ -315,7 +316,8 @@ And a docker compose file looks like this:
2. Enable UDP traffic from ESPHome node's subnet to 224.0.0.251/32 on port 5353.
Alternatively, you can make esphome use ICMP pings to check the status of the device
- with the Hass.io Addon ``"status_use_ping": true,`` option or with docker ``-e ESPHOME_DASHBOARD_USE_PING=true``
+ with the Home Assistant add-on ``"status_use_ping": true,`` option or with
+ Docker ``-e ESPHOME_DASHBOARD_USE_PING=true``.
See also https://github.com/esphome/issues/issues/641#issuecomment-534156628.
.. _faq-notes_on_disabling_mdns:
diff --git a/guides/getting_started_command_line.rst b/guides/getting_started_command_line.rst
index 955dce3dd..7401e2825 100644
--- a/guides/getting_started_command_line.rst
+++ b/guides/getting_started_command_line.rst
@@ -160,7 +160,7 @@ Bonus: ESPHome dashboard
ESPHome features a dashboard that you can use to easily manage your nodes
from a nice web interface. It was primarily designed for
-:doc:`the Hass.io add-on `, but also works with a simple command on
+:doc:`the Home Assistant add-on `, but also works with a simple command on
\*nix machines (sorry, no windows).
To start the ESPHome dashboard, simply start ESPHome with the following command
diff --git a/guides/migrate_espeasy.rst b/guides/migrate_espeasy.rst
index 3f6793280..bfc61a8ec 100644
--- a/guides/migrate_espeasy.rst
+++ b/guides/migrate_espeasy.rst
@@ -14,8 +14,8 @@ Getting Binary
First follow the guides for the :ref:`different supported devices ` and create a configuration
file. Then, generate and download the binary:
-- **Using the Hass.io add-on/dashboard**: Just click the ``COMPILE`` button, wait for
- the compilation to end and press the ``DOWNLOAD BINARY`` button.
+- **Using the Home Assistant add-on/dashboard**: Just click the ``COMPILE`` button,
+ wait for the compilation to end and press the ``DOWNLOAD BINARY`` button.
.. figure:: images/download_binary.png
diff --git a/guides/migrate_espurna.rst b/guides/migrate_espurna.rst
index b8bf74da6..6de6d808c 100644
--- a/guides/migrate_espurna.rst
+++ b/guides/migrate_espurna.rst
@@ -14,8 +14,9 @@ Getting Binary
First follow the guides for the :ref:`different supported devices ` and create a configuration
file. Then, generate and download the binary:
-- **Using the Hass.io add-on/dashboard**: Just click the ``COMPILE`` button, wait for
- the compilation to end and press the ``DOWNLOAD BINARY`` button.
+- **Using the Home Assistant add-on/dashboard**: Just click the ``COMPILE``
+ button, wait for the compilation to end and press the ``DOWNLOAD BINARY``
+ button.
.. figure:: images/download_binary.png
diff --git a/guides/migrate_sonoff_tasmota.rst b/guides/migrate_sonoff_tasmota.rst
index 3ca1639fb..d7b7c9172 100644
--- a/guides/migrate_sonoff_tasmota.rst
+++ b/guides/migrate_sonoff_tasmota.rst
@@ -14,8 +14,9 @@ Getting the Binary
First follow the guides for the :ref:`different supported devices ` and create a configuration
file. Then, generate and download the binary:
-- **Using the Hass.io add-on/dashboard**: Just click the ``COMPILE`` button, wait for
- the compilation to end and press the ``DOWNLOAD BINARY`` button.
+- **Using the Home Assistant add-on/dashboard**: Just click the ``COMPILE``
+ button, wait for the compilation to end and press the ``DOWNLOAD BINARY``
+ button.
.. figure:: images/download_binary.png
diff --git a/guides/supporters.rst b/guides/supporters.rst
index cc302280d..29638654a 100644
--- a/guides/supporters.rst
+++ b/guides/supporters.rst
@@ -17,6 +17,7 @@ Contributors
(in alphabetical order)
- `0hax (@0hax) `__
+- `Nikola (@0nikola1) `__
- `0x0a11c0de (@0x0a11c0de) `__
- `2016for (@2016for) `__
- `Pavel Golovin (@31337Ghost) `__
@@ -31,6 +32,7 @@ Contributors
- `Andrea Donno (@adonno) `__
- `Adrien Brault (@adrienbrault) `__
- `Johan Bloemberg (@aequitas) `__
+- `Stefan Agner (@agners) `__
- `Anders (@ahd71) `__
- `Alexander Pohl (@ahpohl) `__
- `Airy André (@airy10) `__
@@ -44,6 +46,7 @@ Contributors
- `Alex Mekkering (@AlexMekkering) `__
- `Alex (@alexyao2015) `__
- `Amish Vishwakarma (@amishv) `__
+- `andig (@andig) `__
- `András Bíró (@andrasbiro) `__
- `Andreas Hergert (@andreashergert1984) `__
- `Andrzej (@andriej) `__
@@ -56,9 +59,11 @@ Contributors
- `Darius Ratkevičius (@aphex008) `__
- `Ash McKenzie (@ashmckenzie) `__
- `Pavel Pletenev (@ASMfreaK) `__
+- `Mike Dunston (@atanisoft) `__
- `Achilleas Pipinellis (@axilleas) `__
- `Kamil Trzciński (@ayufan) `__
- `Nicholas Peters (@Azimath) `__
+- `Daniel (@azrael783) `__
- `Florian Mösch (@badbadc0ffee) `__
- `balk77 (@balk77) `__
- `Paulus Schoutsen (@balloob) `__
@@ -68,8 +73,11 @@ Contributors
- `Ben Suffolk (@bensuffolk) `__
- `Bierchermuesli (@Bierchermuesli) `__
- `Jim Ekman (@blejdfist) `__
+- `Bob (@Bmooij) `__
- `Mauricio Bonani (@bonanitech) `__
+- `Casey Olson (@bookcasey) `__
- `boradwell (@boradwell) `__
+- `BoukeHaarsma23 (@BoukeHaarsma23) `__
- `Patrik Hermansson (@bphermansson) `__
- `Bram Kragten (@bramkragten) `__
- `Brad Davidson (@brandond) `__
@@ -81,13 +89,16 @@ Contributors
- `Carlos Gustavo Sarmiento (@carlos-sarmiento) `__
- `Carlos Garcia Saura (@CarlosGS) `__
- `cbialobos (@cbialobos) `__
+- `Ciprian Constantinescu (@cciprian5) `__
- `Marco (@cdrfun) `__
- `chris-jennings (@chris-jennings) `__
+- `Pavel Skuratovich (@Chupaka) `__
- `John (@CircuitSetup) `__
- `Chris Debenham (@cjd) `__
- `Cody James (@codyjamestechnical) `__
- `John Coggeshall (@coogle) `__
- `James Crook (@cooljimy84) `__
+- `copercini (@copercini) `__
- `Corban Mailloux (@corbanmailloux) `__
- `Dmitry Berezovsky (@corvis) `__
- `Connor Prussin (@cprussin) `__
@@ -121,6 +132,7 @@ Contributors
- `Mickaël Le Baillif (@demikl) `__
- `dependabot[bot] (@dependabot[bot]) `__
- `Destix (@Destix) `__
+- `Dezorian (@Dezorian) `__
- `Alain Turbide (@Dilbert66) `__
- `Mark (@Diramu) `__
- `Dirk Heinke (@DirkHeinke) `__
@@ -180,6 +192,7 @@ Contributors
- `Fredrik Erlandsson (@fredrike) `__
- `Evgeny (@freekode) `__
- `Brett McKenzie (@freerangeeggs) `__
+- `Franck Nijhof (@frenck) `__
- `Fritz Mueller (@fritzm) `__
- `Marc Egli (@frog32) `__
- `mr G1K (@G1K) `__
@@ -210,6 +223,7 @@ Contributors
- `HepoH3 (@HepoH3) `__
- `Hamish Moffatt (@hmoffatt) `__
- `MoA (@honomoa) `__
+- `Adrián Panella (@ianchi) `__
- `Ian Leeder (@ianleeder) `__
- `icarome (@icarome) `__
- `igg (@igg) `__
@@ -226,6 +240,7 @@ Contributors
- `Jason-nz (@Jason-nz) `__
- `Jason Hines (@jasonehines) `__
- `JbLb (@jblb) `__
+- `James Callaghan (@jcallaghan) `__
- `Joshua Dadswell (@jdads1) `__
- `jeff-h (@jeff-h) `__
- `Jeff Rescignano (@JeffResc) `__
@@ -262,6 +277,7 @@ Contributors
- `Kurt Kellner (@kkellner) `__
- `Klaas Schoute (@klaasnicolaas) `__
- `Klarstein (@Klarstein) `__
+- `klenaers (@klenaers) `__
- `Kevin Lewis (@kll) `__
- `korellas (@korellas) `__
- `Kevin Pelzel (@kpelzel) `__
@@ -270,7 +286,9 @@ Contributors
- `krikk (@krikk) `__
- `KristopherMackowiak (@KristopherMackowiak) `__
- `kroimon (@kroimon) `__
+- `krunkel (@krunkel) `__
- `Kendell R (@KTibow) `__
+- `Jakub Šimo (@kubik369) `__
- `kvvoff (@kvvoff) `__
- `Ken Davidson (@kwdavidson) `__
- `Kyle Manna (@kylemanna) `__
@@ -278,6 +296,7 @@ Contributors
- `Stefan Lässer (@Laess3r) `__
- `Steffen Weinreich (@lairsdragon) `__
- `Fredrik Lindqvist (@Landrash) `__
+- `larsonmpdx (@larsonmpdx) `__
- `lein1013 (@lein1013) `__
- `Riku Lindblad (@lepinkainen) `__
- `Juraj Liso (@LiJu09) `__
@@ -298,6 +317,7 @@ Contributors
- `Major Péter (@majorpeter) `__
- `Manuel Díez (@manutenfruits) `__
- `Marcel van der Veldt (@marcelveldt) `__
+- `Marc Teale (@marcteale) `__
- `marecabo (@marecabo) `__
- `Marvin Gaube (@margau) `__
- `Martynas Griškonis (@Margriko) `__
@@ -309,8 +329,10 @@ Contributors
- `MasterTim17 (@MasterTim17) `__
- `matikij (@matikij) `__
- `Michel Marti (@matoxp) `__
+- `matt123p (@matt123p) `__
- `Maurice Schleußinger (@maurice-schleussinger) `__
- `mbo18 (@mbo18) `__
+- `Me No Dev (@me-no-dev) `__
- `Joseph Mearman (@Mearman) `__
- `Mechotronic (@Mechotronic) `__
- `MeIchthys (@meichthys) `__
@@ -321,6 +343,7 @@ Contributors
- `Pauline Middelink (@middelink) `__
- `mikosoft83 (@mikosoft83) `__
- `Minideezel (@minideezel) `__
+- `André Klitzing (@misery) `__
- `Matthew Edwards (@mje-nz) `__
- `Maarten (@mjkl-gh) `__
- `mjoshd (@mjoshd) `__
@@ -355,15 +378,18 @@ Contributors
- `nldroid (@nldroid) `__
- `Niccolò Maggioni (@nmaggioni) `__
- `Alex (@nnmalex) `__
+- `Jan Sandbrink (@NobodysNightmare) `__
- `ffabi (@norges) `__
- `Greg Johnson (@notgwj) `__
- `Stanislav Meduna (@numo68) `__
- `Nuno Sousa (@nunofgs) `__
- `Chris Nussbaum (@nuttytree) `__
+- `obrain17 (@obrain17) `__
- `Dave Walker (@oddsockmachine) `__
- `Olivér Falvai (@ofalvai) `__
- `Omar Ghader (@omarghader) `__
- `Oncleben31 (@oncleben31) `__
+- `onde2rock (@onde2rock) `__
- `Oscar Bolmsten (@oscar-b) `__
- `Otamay (@Otamay) `__
- `Otto Winter (@OttoWinter) `__
@@ -375,6 +401,7 @@ Contributors
- `peq123 (@peq123) `__
- `per1234 (@per1234) `__
- `perjury (@perjury) `__
+- `Peter Remøy Paulsen (@petrepa) `__
- `Philip Rosenberg-Watt (@PhilRW) `__
- `phjr (@phjr) `__
- `pieterbrink123 (@pieterbrink123) `__
@@ -389,6 +416,7 @@ Contributors
- `Peter Tatrai (@ptatrai) `__
- `Leandro Puerari (@puerari) `__
- `puuu (@puuu) `__
+- `Karol Zlot (@qqgg231) `__
- `Tommy Jonsson (@quazzie) `__
- `Quinn Hosler (@quinnhosler) `__
- `r-jordan (@r-jordan) `__
@@ -412,14 +440,17 @@ Contributors
- `rnauber (@rnauber) `__
- `Rob Deutsch (@rob-deutsch) `__
- `Rob de Jonge (@robdejonge) `__
+- `Robert Alfaro (@robert-alfaro) `__
- `Robin Smidsrød (@robinsmidsrod) `__
- `RockBomber (@RockBomber) `__
- `RoganDawes (@RoganDawes) `__
+- `romerod (@romerod) `__
- `Jérôme W. (@RomRider) `__
- `Robbie Page (@rorpage) `__
- `rradar (@rradar) `__
- `rspaargaren (@rspaargaren) `__
- `Rubén G. (@rubengargar)