Merge pull request #2019 from esphome/bump-2022.4.0b2

2022.4.0b2

Doxygen

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ESPHome"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2022.4.0b1
+PROJECT_NUMBER         = 2022.4.0b2
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Makefile

@@ -1,5 +1,5 @@
 ESPHOME_PATH = ../esphome
-ESPHOME_REF = 2022.4.0b1
+ESPHOME_REF = 2022.4.0b2
 
 .PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify
 

_static/version

@@ -1 +1 @@
-2022.4.0b1
+2022.4.0b2

changelog/2022.4.0.rst

@@ -15,7 +15,7 @@ ESPHome 2022.4.0 - 20th April 2022
     Mi Motion Sensor 2, components/sensor/xiaomi_ble, xiaomi_rtcgq02lm.jpg
     Sonoff D1 Dimmer, components/light/sonoff_d1, sonoff_d1.jpg
     MCP3208, components/sensor/mcp3204, mcp3204.jpg
-
+    Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg
 
 
 Home Assistant Addon Repo
@@ -56,6 +56,11 @@ Please upgrade your local python if you are unable to update ESPHome further.
 This is taken care of automatically if you are using the Home Assistant Add-on, or the
 ESPHome docker container.
 
+Shelly Dimmer 2
+---------------
+
+Support for the STM32 chip of the Shelly Dimmer has been added in this release. The component also supports flashing custom firmware to the
+stm32 via ESPHome which is required to use the component. See the :doc:`documentation </components/light/shelly_dimmer>` for more details.
 
 Google Fonts
 ------------
@@ -119,6 +124,7 @@ New Components
 - Add Xiaomi RTCGQ02LM - Mi Motion Sensor 2 :esphomepr:`3186` by :ghuser:`jesserockz` (new-integration)
 - Add Sonoff D1 Dimmer support :esphomepr:`2775` by :ghuser:`anatoly-savchenkov` (new-integration)
 - Refactor Sensirion Sensors :esphomepr:`3374` by :ghuser:`martgras` (new-integration)
+- Add support for Shelly Dimmer 2 :esphomepr:`2954` by :ghuser:`rnauber` (new-integration)
 
 Breaking Changes
 ^^^^^^^^^^^^^^^^
@@ -130,6 +136,13 @@ Notable Changes
 
 - Font allow using google fonts directly :esphomepr:`3243` by :ghuser:`OttoWinter` (new-feature) (notable-change)
 
+Beta Changes
+^^^^^^^^^^^^
+
+- Changes accuracy of single cell voltage :esphomepr:`3387` by :ghuser:`matthias882`
+- Add support for Shelly Dimmer 2 :esphomepr:`2954` by :ghuser:`rnauber` (new-integration)
+- Allocate smaller amount of buffer for JSON :esphomepr:`3384` by :ghuser:`dz0ny`
+
 All changes
 ^^^^^^^^^^^
 
@@ -185,6 +198,9 @@ All changes
 - Fix silent config errors :esphomepr:`3380` by :ghuser:`jesserockz`
 - Move PN532OnTagTrigger to nfc::NfcOnTagTrigger :esphomepr:`3379` by :ghuser:`jesserockz`
 - Allow specifying deep sleep wakup clock time :esphomepr:`3312` by :ghuser:`jesserockz` (new-feature)
+- Changes accuracy of single cell voltage :esphomepr:`3387` by :ghuser:`matthias882`
+- Add support for Shelly Dimmer 2 :esphomepr:`2954` by :ghuser:`rnauber` (new-integration)
+- Allocate smaller amount of buffer for JSON :esphomepr:`3384` by :ghuser:`dz0ny`
 
 Past Changelogs
 ---------------

components/button/index.rst

@@ -5,9 +5,14 @@ Button Component
     :description: Instructions for setting up button components in ESPHome.
     :image: folder-open.svg
 
-ESPHome has support for components to create a button entity. A button entity is
-basically a momentary switch with no state and can be triggered by either YAML or
-the user/frontend.
+.. note::
+
+    To attach a physical buttons to ESPHome, see
+    :doc:`GPIO Binary Sensor </components/binary_sensor/gpio>`.
+
+ESPHome has support for components to create button entities in Home Assistant. A button entity is
+represented in ESPHome as a momentary switch with no state and can be triggered in Home Assistant
+via the UI or automations.
 
 .. note::
 
@@ -96,8 +101,8 @@ Configuration variables:
 
 .. note::
 
-    Buttons are designed to trigger an action on a device from Home Assistant, and have an unidirectional flow from 
-    Home Assistant to ESPHome. If you press a button using this action, no button press event will be triggered in Home 
+    Buttons are designed to trigger an action on a device from Home Assistant, and have an unidirectional flow from
+    Home Assistant to ESPHome. If you press a button using this action, no button press event will be triggered in Home
     Assistant. If you want to trigger an automation in Home Assistant, you should use a
     :ref:`Home Assistant event <api-homeassistant_event_action>` instead.
 

components/light/shelly_dimmer.rst

@@ -0,0 +1,99 @@
+Shelly Dimmer
+=============
+
+.. seo::
+    :description: Instructions for setting up a Shelly Dimmer 2.
+    :image: shellydimmer2.jpg
+    
+The ``shelly_dimmer`` component adds support for the dimming and power-metering functionality that can be found the `Shelly Dimmer 2 <https://shelly.cloud/knowledge-base/devices/shelly-dimmer-2/>`_. The interaction with mains is done via an STM32 microcontroller that is flashed with an `open source firmware <https://github.com/jamesturton/shelly-dimmer-stm32>`_.
+A detailed analysis of the Shelly Dimmer 2 hardware is given `here <https://github.com/arendst/Tasmota/issues/6914>`_.
+
+.. figure:: ../../images/shellydimmer2.jpg
+    :align: center
+    :width: 40.0%
+
+
+An example of a configuration of this component:
+
+.. code-block:: yaml
+
+    logger:
+        baud_rate: 0
+
+    uart:
+        tx_pin: 1
+        rx_pin: 3
+        baud_rate: 115200
+    sensor:
+
+    light:
+        - platform: shelly_dimmer
+          name: Shelly Dimmer 2 Light
+          id: thislight
+          power:
+            name: Shelly Dimmer 2 Light Power
+          voltage:
+            name: Shelly Dimmer 2 Light Voltage
+          current:
+            name: Shelly Dimmer 2 Light Current
+          max_brightness: 500
+          firmware:
+            version: "51.6"
+            update: true
+
+
+Configuration variables:
+------------------------
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
+- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub. 
+
+.. note::
+
+    Currently, only the first hardware UART of the ESP is supported, which has to be configured like this:  
+
+    .. code-block:: yaml
+
+        uart:
+            tx_pin: 1
+            rx_pin: 3
+            baud_rate: 115200
+
+
+- **name** (**Required**, string): The name of the light.
+- **leading_edge** (**Optional**, boolean): `Dimming mode <https://en.wikipedia.org/wiki/Dimmer#Solid-state_dimmer>`_: "true" means leading edge, "false" (default) is trailing edge.
+- **min_brightness** (**Optional**, int): Minimum brightness value on a scale from 0..1000, the default is 0.
+- **max_brightness** (**Optional**, int): Maximum brightness value on a scale from 0..1000, the default is 1000.
+- **warmup_brightness** (**Optional**, int): Brightness threshold below which the dimmer switches on later in mains current cycle. `This might help with dimming LEDs <https://github.com/jamesturton/shelly-dimmer-stm32/pull/23>`_. The value is from 0..1000 with an default of 0.
+- **nrst_pin** (**Optional**, :ref:`config-pin`): Pin connected with "NRST" of STM32. The  default is "GPIO5".
+- **boot0_pin** (**Optional**, :ref:`config-pin`): Pin connected with "BOOT0" of STM32. The  default is "GPIO4".
+- **current** (**Optional**): Sensor of the current in Amperes. All options from
+  :ref:`Sensor <config-sensor>`.
+- **voltage** (**Optional**): Sensor of the voltage in Volts. Only accurate if neutral is connected. All options from :ref:`Sensor <config-sensor>`.
+- **power** (**Optional**): Sensor of the active power in Watts. Only accurate if neutral is connected. All options from :ref:`Sensor <config-sensor>`.
+- **firmware**  (**Optional**):
+    - **version**  (**Optional**): Version string of the `firmware <https://github.com/jamesturton/shelly-dimmer-stm32>`_ that will be expected on the microcontroller. The default is "51.6", another known-good firmware is "51.5".
+    - **url** (**Optional**): An URL to download the firmware from. Defaults to github for known firmware versions.
+    - **sha256** (**Optional**):  A hash to compare the downloaded firmware against. Defaults a proper hash of known firmware versions.
+    - **update** (**Optional**):  Should the firmware of the STM be updated if necessary? The default is false.
+
+.. note::
+
+    When flashing Shelly Dimmer with esphome for the first time, flashing the STM firmware is necessary too for the dimmer to work:
+
+    .. code-block:: yaml
+
+        firmware:
+          version: "51.6" #<-- set version here
+          update: true
+
+
+- All other options from :ref:`Light <config-light>`.
+
+
+See Also
+--------
+
+- :doc:`/components/light/index`
+- :apiref:`shelly_dimmer/light/shelly_dimmer.h`
+- :ghedit:`Edit`

conf.py

@@ -68,7 +68,7 @@ author = "ESPHome"
 # The short X.Y version.
 version = "2022.4"
 # The full version, including alpha/beta/rc tags.
-release = "2022.4.0b1"
+release = "2022.4.0b2"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

guides/supporters.rst

@@ -364,6 +364,7 @@ Contributors
 - `Jérôme Laban (@jeromelaban) <https://github.com/jeromelaban>`__
 - `Jesse Hills (@jesserockz) <https://github.com/jesserockz>`__
 - `Yuval Brik (@jhamhader) <https://github.com/jhamhader>`__
+- `Joe (@jhansche) <https://github.com/jhansche>`__
 - `Jim Bauwens (@jimbauwens) <https://github.com/jimbauwens>`__
 - `Jérémy JOURDIN (@JJK801) <https://github.com/JJK801>`__
 - `Jonathan Jefferies (@jjok) <https://github.com/jjok>`__
@@ -478,6 +479,7 @@ Contributors
 - `matt123p (@matt123p) <https://github.com/matt123p>`__
 - `Matteo Franceschini (@matteofranceschini) <https://github.com/matteofranceschini>`__
 - `Matthew Mazzanti (@matthewmazzanti) <https://github.com/matthewmazzanti>`__
+- `matthias882 (@matthias882) <https://github.com/matthias882>`__
 - `Maurice Schleußinger (@maurice-schleussinger) <https://github.com/maurice-schleussinger>`__
 - `mbo18 (@mbo18) <https://github.com/mbo18>`__
 - `mckaymatthew (@mckaymatthew) <https://github.com/mckaymatthew>`__
@@ -727,7 +729,6 @@ Contributors
 - `Tempura San (@tempura-san) <https://github.com/tempura-san>`__
 - `testbughub (@testbughub) <https://github.com/testbughub>`__
 - `Greg Lincoln (@tetious) <https://github.com/tetious>`__
-- `Thane Gill (@thanegill) <https://github.com/thanegill>`__
 - `Nejc (@thedexboy) <https://github.com/thedexboy>`__
 - `Thomas Eckerstorfer (@TheEggi) <https://github.com/TheEggi>`__
 - `TheGroundZero (@TheGroundZero) <https://github.com/TheGroundZero>`__
@@ -817,4 +818,4 @@ Contributors
 - `Michael Labuschke (@zigman79) <https://github.com/zigman79>`__
 - `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
 
-*This page was last updated April 13, 2022.*
+*This page was last updated April 14, 2022.*

index.rst

@@ -465,6 +465,7 @@ Light Components
     Light Partition, components/light/partition, color_lens.svg
 
     Tuya Dimmer, components/light/tuya, tuya.png
+    Shelly Dimmer, components/light/shelly_dimmer, shellydimmer2.jpg    
     Custom Light, components/light/custom, language-cpp.svg
 
     H-bridge Light, components/light/hbridge, brightness-medium.svg