From bcbbd1dacd16092dc42653f3b4a7c96599959c10 Mon Sep 17 00:00:00 2001 From: Nikola Date: Sun, 9 May 2021 22:00:01 +0200 Subject: [PATCH 01/15] Fixed datasheet link for RC522 (#1144) --- components/binary_sensor/rc522.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/binary_sensor/rc522.rst b/components/binary_sensor/rc522.rst index bcf3e9ad4..9100c7966 100644 --- a/components/binary_sensor/rc522.rst +++ b/components/binary_sensor/rc522.rst @@ -9,7 +9,7 @@ RC522 RFID .. _rc522-component: The ``rc522`` component allows you to use RC522 RFID controllers -(`datasheet `__, `Ali Express `__) +(`datasheet `__, `Ali Express `__) with ESPHome. ESPHome can read the tag UID from it, every RFID tag comes with a unique UID value. Each known tag can be associated to a binary sensor, or you can use the tag information directly. See :ref:`rc522-setting_up_tags` for information on how to setup individual binary sensors for this component. From 436efccf69f3f184c6550bd9b802c858e6d74432 Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 10 May 2021 09:37:50 +1200 Subject: [PATCH 02/15] Added receive for Fujitsu ACs (#1037) Co-authored-by: Alex Richards --- components/climate/ir_climate.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/climate/ir_climate.rst b/components/climate/ir_climate.rst index fe0a8bbfe..232920c5e 100755 --- a/components/climate/ir_climate.rst +++ b/components/climate/ir_climate.rst @@ -23,7 +23,7 @@ request so it will be added (see FAQ). +---------------------------------------+---------------------+----------------------+ | Daikin | ``daikin`` | yes | +---------------------------------------+---------------------+----------------------+ -| Fujitsu General | ``fujitsu_general`` | | +| Fujitsu General | ``fujitsu_general`` | yes | +---------------------------------------+---------------------+----------------------+ | Mitsubishi | ``mitsubishi`` | | +---------------------------------------+---------------------+----------------------+ From fc793e06827e0e11e3c89344f6a555893b4129b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20=C5=A0imo?= Date: Mon, 10 May 2021 00:01:02 +0200 Subject: [PATCH 03/15] Update docs: Add references to alternative ICs to HLW8012 and CSE7766 (#902) --- components/sensor/cse7766.rst | 5 +++-- components/sensor/hlw8012.rst | 6 ++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/components/sensor/cse7766.rst b/components/sensor/cse7766.rst index 8aef0884a..287db2c8a 100644 --- a/components/sensor/cse7766.rst +++ b/components/sensor/cse7766.rst @@ -4,11 +4,12 @@ CSE7766 Power Sensor .. seo:: :description: Instructions for setting up CSE7766 power sensors for the Sonoff Pow R2 :image: cse7766.png - :keywords: cse7766, Sonoff Pow R2 + :keywords: cse7766, cse7759b, Sonoff Pow R2 The ``cse7766`` sensor platform allows you to use your CSE7766 voltage/current and power sensors (`datasheet `__) sensors with -ESPHome. This sensor is commonly found in Sonoff POW R2. +ESPHome. This sensor is commonly found in Sonoff POW R2. CSE7759B is similar to CSE7766 +and works with this integration. As the communication with the CSE7766 done using UART, you need to have an :ref:`UART bus ` in your configuration with the ``rx_pin`` connected to the CSE7766. diff --git a/components/sensor/hlw8012.rst b/components/sensor/hlw8012.rst index d6b8bd46a..f02f5c852 100644 --- a/components/sensor/hlw8012.rst +++ b/components/sensor/hlw8012.rst @@ -4,11 +4,13 @@ HLW8012 Power Sensor .. seo:: :description: Instructions for setting up HLW8012 power sensors for the Sonoff Pow R1 :image: hlw8012.png - :keywords: HLW8012, Sonoff Pow R1 + :keywords: HLW8012, CSE7759, BL0937, Sonoff Pow R1 The ``hlw8012`` sensor platform allows you to use your HLW8012 voltage/current and power sensors (`datasheet `__) sensors with -ESPHome. This sensor is commonly found in Sonoff POWs. +ESPHome. This sensor is commonly found in Sonoff POWs. CSE7759 and BL0937 are similar to HLW8012 +and work with this integration. Beware that CSE7759B is different and should be used +with the :doc:`CSE7766 ` integration. This sensor has two data outputs which both encode values using the frequency of a modulated signal: CF and CF1. CF's frequency is proportional to the (active) power measured and CF1 is proportional to the current/voltage. Using From 7dce09c4bcf070effb413ed672e94d61a51d6f87 Mon Sep 17 00:00:00 2001 From: Pavel Skuratovich Date: Mon, 10 May 2021 01:12:16 +0300 Subject: [PATCH 04/15] Update pulse_counter.rst (#1089) --- components/sensor/pulse_counter.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/components/sensor/pulse_counter.rst b/components/sensor/pulse_counter.rst index 0030b4779..b6304849b 100644 --- a/components/sensor/pulse_counter.rst +++ b/components/sensor/pulse_counter.rst @@ -48,8 +48,9 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **total** (*Optional*): Report the total number of pulses - All options from :ref:`Sensor `. +- **total** (*Optional*): Report the total number of pulses. + + - All options from :ref:`Sensor `. - All other options from :ref:`Sensor `. From 5b613f25fd63b64a1bdeaea84a5a1770301d4ba0 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 10 May 2021 00:34:21 +0200 Subject: [PATCH 05/15] Remove deprecated board_flash_mode from configuration example (#1149) --- guides/configuration-types.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/guides/configuration-types.rst b/guides/configuration-types.rst index 87fde6d27..87f656ca7 100644 --- a/guides/configuration-types.rst +++ b/guides/configuration-types.rst @@ -248,7 +248,6 @@ added ``board``, and overridden ``name`` substitutions): platform: ESP8266 board: esp01_1m includes: [] - board_flash_mode: dout libraries: [] esp8266_restore_from_flash: false build_path: device01 From 8b4d0867d6d37052238008a41daa9b30383ca0c7 Mon Sep 17 00:00:00 2001 From: Simon Date: Mon, 10 May 2021 16:59:48 +1000 Subject: [PATCH 06/15] Update deep_sleep.rst (#1152) The documentation is wrong, as discussed on discord. This fixes that. --- components/deep_sleep.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/components/deep_sleep.rst b/components/deep_sleep.rst index c056e3b66..4e9d65245 100644 --- a/components/deep_sleep.rst +++ b/components/deep_sleep.rst @@ -82,8 +82,9 @@ This action makes the given deep sleep component enter deep sleep immediately. on_...: then: - - deep_sleep.enter: deep_sleep_1 - sleep_duration: 20min + - deep_sleep.enter: + id: deep_sleep_1 + sleep_duration: 20min Configuration options: From e6afa1d228af5561f4661cb7c1c706a7fcc0ff33 Mon Sep 17 00:00:00 2001 From: rradar <34582688+rradar@users.noreply.github.com> Date: Mon, 10 May 2021 11:43:19 +0100 Subject: [PATCH 07/15] Utalize pip3 for commands (#1143) --- guides/faq.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/faq.rst b/guides/faq.rst index 89d356b2c..c179c01ab 100644 --- a/guides/faq.rst +++ b/guides/faq.rst @@ -121,7 +121,7 @@ It's simple. Run: .. code-block:: bash - pip install -U esphome + pip3 install -U esphome # From docker: docker pull esphome/esphome:latest @@ -139,7 +139,7 @@ by installing the tested beta: .. code-block:: bash # For pip-based installs - pip install --pre -U esphome + pip3 install --pre -U esphome # For docker-based installs docker run [...] -it esphome/esphome:beta livingroom.yaml run @@ -161,7 +161,7 @@ To install the dev version of ESPHome: - In Hass.io: Add the ESPHome repository `https://github.com/esphome/hassio ` in Add-on store -> Repositories. Then install the add-on ``ESPHome Dev`` -- From ``pip``: Run ``pip install https://github.com/esphome/esphome/archive/dev.zip`` +- From ``pip``: Run ``pip3 install https://github.com/esphome/esphome/archive/dev.zip`` - From docker, use the `esphome/esphome:dev `__ image .. code-block:: bash From 743bd9b4a4c55bbabc109858aa93133da5e7c213 Mon Sep 17 00:00:00 2001 From: Philip Allgaier Date: Mon, 10 May 2021 12:45:22 +0200 Subject: [PATCH 08/15] FAQ page: Converting from "I" to "we" wording (#1103) --- guides/faq.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/guides/faq.rst b/guides/faq.rst index c179c01ab..22d0a58ff 100644 --- a/guides/faq.rst +++ b/guides/faq.rst @@ -96,12 +96,12 @@ That's no good. Here are some steps that resolve some problems: How to submit an issue report ----------------------------- -First of all, thank you very much to everybody submitting issue reports! While I try to test ESPHome/yaml as much as -I can using my own hardware, I don't own every single device type and mostly only do tests with my own home automation -system. When doing some changes in the core, it can quickly happen that something somewhere breaks. Issue reports are a -great way for me to track and (hopefully) fix issues, so thank you! +First of all, thank you very much to everybody submitting issue reports! While we try to test ESPHome/YAML as much as +we can using our available hardware, we don't own every single device type and rely on testing done by the community +and the contributors. When doing some changes in the core, it can quickly happen that something somewhere breaks. +Issue reports are a great way for us to track and (hopefully) fix issues, so thank you! -For me to fix the issue quickly, there are some things that would be really helpful: +For us to fix the issue quickly, there are some things that would be really helpful: 1. **Just writing "X doesn't work" or "X gives bug" is not helpful!!!** Seriously, how do you expect help given just that information? @@ -155,7 +155,7 @@ How do I use the latest bleeding edge version? ---------------------------------------------- First, a fair warning that the latest bleeding edge version is not always stable and might have issues. -If you find some, please do however report them if you have time :) +If you find some, please do however report them. To install the dev version of ESPHome: @@ -192,7 +192,7 @@ request in the `ESPHome feature request tracker `__ - `Home Assistant Community Forums `__ @@ -206,8 +206,8 @@ Sure! I'd be happy to help :) You can contact me here: My node keeps reconnecting randomly ----------------------------------- -Jep, that's a known issue. However, it seems to be very low-level and I don't really know -how to solve it. I'm working on possible workarounds for the issue but currently I do +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 not have a real solution. Some steps that can help with the issue: From 2edeb7883843c5e7e1f2daae9287af66a612aabb Mon Sep 17 00:00:00 2001 From: larsonmpdx Date: Mon, 10 May 2021 03:55:06 -0700 Subject: [PATCH 09/15] thermostat min/max temperature clarification (#1057) Co-authored-by: Franck Nijhof --- components/climate/thermostat.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/components/climate/thermostat.rst b/components/climate/thermostat.rst index 2d6f52549..33fb18f7d 100644 --- a/components/climate/thermostat.rst +++ b/components/climate/thermostat.rst @@ -152,6 +152,9 @@ These temperatures are used when the device first starts up. **At least one of** ``default_target_temperature_low`` **and** ``default_target_temperature_high`` **must be specified.** +``min_temperature`` and ``max_temperature`` from the base climate component **are used to define the range** +of allowed temperature values in the thermostat component. See :doc:`/components/climate/index` + Heating and Cooling Actions *************************** @@ -267,7 +270,9 @@ Advanced Options .. note:: While this platform uses the term temperature everywhere, it can also be used to regulate other values. - For example, controlling humidity is also possible with this platform. + For example, controlling humidity is also possible with this platform. Note that ``min_temperature`` and + ``max_temperature`` from the base climate component are used the define the range of adjustability and the + defaults will probably not make sense for control of things like humidity. See :doc:`/components/climate/index` Bang-bang vs. Thermostat ------------------------ From 7cbd96e9551014d4897ca0e1d8b0433a260cb7f4 Mon Sep 17 00:00:00 2001 From: Dezorian Date: Mon, 10 May 2021 12:58:29 +0200 Subject: [PATCH 10/15] Added compatibility notes (#1033) --- components/display/waveshare_epaper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/display/waveshare_epaper.rst b/components/display/waveshare_epaper.rst index bc5f632b3..aa3bc1342 100644 --- a/components/display/waveshare_epaper.rst +++ b/components/display/waveshare_epaper.rst @@ -73,7 +73,7 @@ Configuration variables: - ``1.54in`` - ``2.13in`` (not tested) - - ``2.13in-ttgo`` (T5_V2.3 tested) + - ``2.13in-ttgo`` (T5_V2.3 tested. Also works for Wemos D1 Mini ePaper Shield 2.13 1.0.0 "LOLIN") - ``2.13in-ttgo-b73`` (T5_V2.3 with B73 display tested) - ``2.13in-ttgo-b1`` (T5_V2.3 with B1 display tested) - ``2.70in`` (currently not working with the HAT Rev 2.1 version) From 63d36b4d7d344565fec06dc4ca4e0c67d7b8e1ee Mon Sep 17 00:00:00 2001 From: Marc Teale Date: Mon, 10 May 2021 14:57:02 -0500 Subject: [PATCH 11/15] Specify format for BSSID entries. (#1046) Co-authored-by: Marc Teale --- components/wifi.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/wifi.rst b/components/wifi.rst index 4a3a9b083..a7a45f6df 100644 --- a/components/wifi.rst +++ b/components/wifi.rst @@ -176,8 +176,8 @@ Configuration variables: - **eap** (*Optional*): See :ref:`eap`. - **channel** (*Optional*, int): The channel of the network (1-14). If given, only connects to networks that are on this channel. -- **bssid** (*Optional*, string): Optionally define a BSSID (MAC-Address) of the network to connect to. - This can be used to further restrict which networks to connect to. +- **bssid** (*Optional*, string): The connection's BSSID (MAC address). BSSIDs must consist of six + two-digit hexadecimal values separated by colon characters ("``:``"). All letters must be in upper case. - **hidden** (*Optional*, boolean): Whether this network is hidden. Defaults to false. If you add this option you also have to specify ssid. - **priority** (*Optional*, float): The priority of this network. After each time, the network with From cd361ae115b9efa10c63af5ace2eb727f2d2ef28 Mon Sep 17 00:00:00 2001 From: Daniel <44697375+azrael783@users.noreply.github.com> Date: Tue, 11 May 2021 00:07:58 +0200 Subject: [PATCH 12/15] add font to usage example (#1050) Co-authored-by: Franck Nijhof --- components/display/waveshare_epaper.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/components/display/waveshare_epaper.rst b/components/display/waveshare_epaper.rst index aa3bc1342..9d296b096 100644 --- a/components/display/waveshare_epaper.rst +++ b/components/display/waveshare_epaper.rst @@ -49,6 +49,11 @@ configuration. .. code-block:: yaml # Example configuration entry + font: + - file: 'fonts/Comic Sans MS.ttf' + id: font1 + size: 8 + spi: clk_pin: D0 mosi_pin: D1 @@ -62,7 +67,7 @@ configuration. model: 2.90in full_update_every: 30 lambda: |- - it.print(0, 0, id(font), "Hello World!"); + it.print(0, 0, id(font1), "Hello World!"); Configuration variables: ------------------------ From 39d5fc63121c71fd7f63c54c9c9e74e78dce5d42 Mon Sep 17 00:00:00 2001 From: James Callaghan Date: Tue, 11 May 2021 13:40:52 +0100 Subject: [PATCH 13/15] Sample codeblock has incorrect variables (#1156) Four of the variables in the sample codeblock don't include underscores as defined in the variables section. This throws an error when using this sample code. To avoid others getting these errors I have updated the sample so it uses the right variables. --- components/display/st7735.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/components/display/st7735.rst b/components/display/st7735.rst index 2c5554ad5..58e5c341c 100644 --- a/components/display/st7735.rst +++ b/components/display/st7735.rst @@ -34,10 +34,10 @@ There are numerous board types out there. Some initialize differently as well. T cs_pin: D1 dc_pin: D2 rotation: 0 - devicewidth: 128 - deviceheight: 160 - colstart: 0 - rowstart: 0 + device_width: 128 + device_height: 160 + col_start: 0 + row_start: 0 eightbitcolor: true update_interval: 5s From 34b2bef1d1d4d73ecafba114fa0b2fa382e8b4fa Mon Sep 17 00:00:00 2001 From: Fredrik Erlandsson Date: Tue, 11 May 2021 16:21:47 +0200 Subject: [PATCH 14/15] Show how calculations are made (#861) Co-authored-by: Franck Nijhof --- components/sensor/pulse_counter.rst | 6 +++--- cookbook/power_meter.rst | 14 +++++++++++++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/components/sensor/pulse_counter.rst b/components/sensor/pulse_counter.rst index b6304849b..c43c6c048 100644 --- a/components/sensor/pulse_counter.rst +++ b/components/sensor/pulse_counter.rst @@ -76,7 +76,7 @@ count the light pulses on a power meter, you can do the following: unit_of_measurement: 'kW' name: 'Power Meter House' filters: - - multiply: 0.06 + - multiply: 0.06 # (60s/1000 pulses per kWh) Counting total pulses @@ -95,13 +95,13 @@ measure the total consumed energy in kWh. unit_of_measurement: 'kW' name: 'Power Meter House' filters: - - multiply: 0.06 + - multiply: 0.06 # (60s/1000 pulses per kWh) total: unit_of_measurement: 'kWh' name: 'Energy Meter House' filters: - - multiply: 0.001 + - multiply: 0.001 # (1/1000 pulses per kWh) See Also -------- diff --git a/cookbook/power_meter.rst b/cookbook/power_meter.rst index b67186154..268e6d6e7 100644 --- a/cookbook/power_meter.rst +++ b/cookbook/power_meter.rst @@ -24,6 +24,18 @@ And... that should already be it :) :align: center :width: 80.0% +.. note:: + + Some energy meters have an exposed S0 port (which essentially just is a switch that closes), if + that is the case the photodiode can be replaced with the following connection. + + .. code-block:: + + S0 ------------ VCC + S0 --+-- 10k -- GND + . | + . +--------- GPIO12 + For ESPHome, you can then use the :doc:`pulse counter sensor ` using below configuration: @@ -35,7 +47,7 @@ For ESPHome, you can then use the unit_of_measurement: 'kW' name: 'Power Meter' filters: - - multiply: 0.06 + - multiply: 0.06 # (60s/1000 pulses per kWh) Adjust ``GPIO12`` to match your set up of course. The output from the pulse counter sensor is in ``pulses/min`` and we also know that 1000 pulses from the LED should equal 1kWh of power usage. From 26f183bdfd5fe87eb9c4134060f8556674530879 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 12 May 2021 09:54:35 +1200 Subject: [PATCH 15/15] Add past changelogs --- changelog/v1.16.0.rst | 16 ++++++++++++++++ changelog/v1.17.0.rst | 17 +++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/changelog/v1.16.0.rst b/changelog/v1.16.0.rst index 20c6cc4d0..b1e28a9bc 100644 --- a/changelog/v1.16.0.rst +++ b/changelog/v1.16.0.rst @@ -387,3 +387,19 @@ All changes - docs: Update scd30 docs to show sensors are optional :docspr:`970` by :ghuser:`jesserockz` (cherry-picked) - esphome: fix esp8266 remote_transmitter using incorrect timings :esphomepr:`1465` by :ghuser:`hcoohb` (cherry-picked) - esphome: rc522 increased retry loop count :esphomepr:`1506` by :ghuser:`glmnet` (cherry-picked) + +Past Changelogs +--------------- + +.. toctree:: + :maxdepth: 1 + + 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/changelog/v1.17.0.rst b/changelog/v1.17.0.rst index d9ccf5178..69745deeb 100644 --- a/changelog/v1.17.0.rst +++ b/changelog/v1.17.0.rst @@ -221,3 +221,20 @@ All changes - docs: Update canbus.rst :docspr:`1115` by :ghuser:`meijerwynand` - docs: Update diy.rst :docspr:`1114` by :ghuser:`murilobaliego` - docs: Update email addresses :docspr:`1122` by :ghuser:`jesserockz` + +Past Changelogs +--------------- + +.. toctree:: + :maxdepth: 1 + + 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