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 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. 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`` | | +---------------------------------------+---------------------+----------------------+ 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 ------------------------ 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: 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 diff --git a/components/display/waveshare_epaper.rst b/components/display/waveshare_epaper.rst index bc5f632b3..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: ------------------------ @@ -73,7 +78,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) 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 diff --git a/components/sensor/pulse_counter.rst b/components/sensor/pulse_counter.rst index 0030b4779..c43c6c048 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 `. @@ -75,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 @@ -94,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/components/wifi.rst b/components/wifi.rst index 32181a1c2..44a349845 100644 --- a/components/wifi.rst +++ b/components/wifi.rst @@ -179,8 +179,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 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. 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 diff --git a/guides/faq.rst b/guides/faq.rst index a2c29bd2b..a4f75cfa4 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? @@ -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 @@ -155,13 +155,13 @@ 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: - 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 @@ -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: