From dbb0f3a92913da4957bf566aa600f59adef8501c Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 24 May 2022 21:56:19 +1200 Subject: [PATCH 1/6] Bump version to 2022.5.1 --- Doxygen | 2 +- Makefile | 2 +- _static/version | 2 +- conf.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Doxygen b/Doxygen index 3e7ef4a89..7e8a90906 100644 --- a/Doxygen +++ b/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.5.0 +PROJECT_NUMBER = 2022.5.1 # 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 diff --git a/Makefile b/Makefile index 4c07ea35d..5b8301601 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ ESPHOME_PATH = ../esphome -ESPHOME_REF = 2022.5.0 +ESPHOME_REF = 2022.5.1 .PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify diff --git a/_static/version b/_static/version index 0c2c2b9c3..d41e2e729 100644 --- a/_static/version +++ b/_static/version @@ -1 +1 @@ -2022.5.0 \ No newline at end of file +2022.5.1 \ No newline at end of file diff --git a/conf.py b/conf.py index 7bf9e54d6..c64a518a4 100644 --- a/conf.py +++ b/conf.py @@ -68,7 +68,7 @@ author = "ESPHome" # The short X.Y version. version = "2022.5" # The full version, including alpha/beta/rc tags. -release = "2022.5.0" +release = "2022.5.1" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. From 2fc392be001d7a24a8ca9a977fd898fb6fa4cc35 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 24 May 2022 21:56:44 +1200 Subject: [PATCH 2/6] Update changelog for 2022.5.1 --- changelog/2022.5.0.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/changelog/2022.5.0.rst b/changelog/2022.5.0.rst index 0ea974529..418bf656d 100644 --- a/changelog/2022.5.0.rst +++ b/changelog/2022.5.0.rst @@ -42,6 +42,13 @@ The ``select`` component has had a bunch of new features and actions added. Alongside these new changes were some removals of internal (but public) functions on ``select`` and ``number`` components that might break ``external_components`` or ``lambdas`` that might have been using them. See :esphomepr:`3457` and :esphomepr:`3458` for more details. +Release 2022.5.1 - May 24 +------------------------- + +- Update bedjet_const.h to remove blank spaces before speed steps, fixes Unknown Error when using climate.set_fan_mode in HA :esphomepr:`3476` by :ghuser:`user897943` +- Add missing import to bedjet :esphomepr:`3490` by :ghuser:`jesserockz` +- esp32: fix NVS :esphomepr:`3497` by :ghuser:`martgras` + Full list of changes -------------------- From c9d0d27934ca59fd033a952cfa81c4b7d5ec7d90 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 24 May 2022 21:57:17 +1200 Subject: [PATCH 3/6] Update supporters for 2022.5.1 --- guides/supporters.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/guides/supporters.rst b/guides/supporters.rst index a87ee5210..94c2df205 100644 --- a/guides/supporters.rst +++ b/guides/supporters.rst @@ -286,6 +286,7 @@ Contributors - `Aljaž Srebrnič (@g5pw) `__ - `Gabe Cook (@gabe565) `__ - `Gareth Cooper (@gaco79) `__ +- `gazoodle (@gazoodle) `__ - `GeekVisit (@GeekVisit) `__ - `Ian Reinhart Geiser (@geiseri) `__ - `R Huish (@genestealer) `__ @@ -398,6 +399,7 @@ Contributors - `Jonathan Treffler (@JonathanTreffler) `__ - `JonnyaiR (@jonnyair) `__ - `Joppy (@JoppyFurr) `__ +- `joseph douce (@josephdouce) `__ - `Joshua Spence (@joshuaspence) `__ - `Joscha Wagner (@jowgn) `__ - `jsuanet (@jsuanet) `__ @@ -535,7 +537,6 @@ Contributors - `Moritz Glöckl (@moritzgloeckl) `__ - `Matthew Pettitt (@mpettitt) `__ - `Sam Hughes (@MrEditor97) `__ -- `Simon Sasburg (@MrHacky) `__ - `Mariusz Kryński (@mrk-its) `__ - `Michael Davidson (@MrMDavidson) `__ - `Ryan Matthews (@mrrsm) `__ @@ -547,6 +548,7 @@ Contributors - `Martin Weinelt (@mweinelt) `__ - `myhomeiot (@myhomeiot) `__ - `Igor Scheller (@MyIgel) `__ +- `myml (@myml) `__ - `Mynasru (@Mynasru) `__ - `Niels Ulrik Andersen (@myplacedk) `__ - `Kevin Uhlir (@n0bel) `__ @@ -696,10 +698,8 @@ Contributors - `Silvio (@s1lvi0) `__ - `Jan Čermák (@sairon) `__ - `sascha lammers (@sascha432) `__ -- `Sascha (@Scarbous) `__ - `Nils Schulte (@Schnilz) `__ - `Ville Skyttä (@scop) `__ -- `Seganku (@seganku) `__ - `sekkr1 (@sekkr1) `__ - `SenexCrenshaw (@SenexCrenshaw) `__ - `Sergio (@sergio303) `__ @@ -759,7 +759,6 @@ Contributors - `Mateusz Soszyński (@TheLastGimbus) `__ - `Zixuan Wang (@TheNetAdmin) `__ - `Dominik Bruhn (@theomega) `__ -- `Simon (@theOzzieRat) `__ - `Florian Gareis (@TheZoker) `__ - `Thomas Klingbeil (@thomasklingbeil) `__ - `Thomas Dietrich (@ThomDietrich) `__ @@ -798,6 +797,7 @@ Contributors - `Tyler Menezes (@tylermenezes) `__ - `ukewea (@ukewea) `__ - `Unai (@unaiur) `__ +- `user897943 (@user897943) `__ - `Vc (@Valcob) `__ - `Nad (@valordk) `__ - `André Lademann (@vergissberlin) `__ @@ -824,6 +824,7 @@ Contributors - `Rick van Hattem (@WoLpH) `__ - `workingmanrob (@workingmanrob) `__ - `Wojtek Strzalka (@wstrzalka) `__ +- `Wumpf (@Wumpf) `__ - `wysiwyng (@wysiwyng) `__ - `Mike (@xsnoopy) `__ - `Yaroslav (@Yarikx) `__ @@ -842,4 +843,4 @@ Contributors - `Michael Labuschke (@zigman79) `__ - `Christian Zufferey (@zuzu59) `__ -*This page was last updated May 18, 2022.* +*This page was last updated May 24, 2022.* From 00419a4e47a859ce7b48c423d4e22262f32aba06 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Fri, 3 Jun 2022 15:00:37 +1200 Subject: [PATCH 4/6] Update changelogs to use single button for addon (#2111) --- changelog/2022.2.0.rst | 17 +++-------------- changelog/2022.4.0.rst | 17 +++-------------- 2 files changed, 6 insertions(+), 28 deletions(-) diff --git a/changelog/2022.2.0.rst b/changelog/2022.2.0.rst index 3243c3603..5a0667e27 100644 --- a/changelog/2022.2.0.rst +++ b/changelog/2022.2.0.rst @@ -41,23 +41,12 @@ and everyone should move to the ESPHome repo. It is safe to delete the ESPHome addon as your configuration YAML files are stored in the Home Assistant configuration folder. -You can add the repository here: +You can add the ESPHome addon here: .. raw:: html - - Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled. - - -And then install the latest ESPHome addon here: - -.. raw:: html - - - Open your Home Assistant instance and show the dashboard of a Supervisor add-on. + + Open your Home Assistant instance and show the dashboard of the ESPHome add-on. Locks diff --git a/changelog/2022.4.0.rst b/changelog/2022.4.0.rst index d1ec8c273..93b880ad7 100644 --- a/changelog/2022.4.0.rst +++ b/changelog/2022.4.0.rst @@ -29,23 +29,12 @@ deprecate the ESPHome addon inside the `Community Addons - Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled. - - -And then install the latest ESPHome addon here: - -.. raw:: html - - - Open your Home Assistant instance and show the dashboard of a Supervisor add-on. + + Open your Home Assistant instance and show the dashboard of the ESPHome add-on. Python 3.8 Minimum From 3ab83fc7361be6fc39a65723f96616ed4e5babb9 Mon Sep 17 00:00:00 2001 From: Guillermo Ruffino Date: Mon, 6 Jun 2022 20:31:19 -0300 Subject: [PATCH 5/6] format clean up 2022-05 (#2091) --- components/number/index.rst | 10 ++++----- components/select/index.rst | 10 ++++----- components/sensor/scd4x.rst | 10 ++++----- components/sensor/sen5x.rst | 44 ++++++++++++++++++------------------- components/sensor/sps30.rst | 4 ++-- 5 files changed, 39 insertions(+), 39 deletions(-) diff --git a/components/number/index.rst b/components/number/index.rst index d453ab706..ec91665e0 100644 --- a/components/number/index.rst +++ b/components/number/index.rst @@ -184,10 +184,10 @@ step size (default: 1). Configuration variables: - **id** (**Required**, :ref:`config-id`): The ID of the number component to update. -- **cycle** (**Optional**, boolean): Whether or not to set the number to its minimum +- **cycle** (*Optional*, boolean): Whether or not to set the number to its minimum value when the increment pushes the value beyond its maximum value. This will only work when the number component uses a minimum and maximum value. - Defaults to ``true``. + Defaults to ``true``. .. _number-decrement_action: @@ -209,10 +209,10 @@ step size (default: 1). Configuration variables: - **id** (**Required**, :ref:`config-id`): The ID of the number component to update. -- **cycle** (**Optional**, boolean): Whether or not to set the number to its maximum +- **cycle** (*Optional*, boolean): Whether or not to set the number to its maximum value when the decrement pushes the value below its minimum value. This will only work when the number component uses a minimum and maximum value. - Defaults to ``true``. + Defaults to ``true``. .. _number-to-min_action: @@ -286,7 +286,7 @@ Configuration variables: lambda for this field, then return one of the following enum values: ``NUMBER_OP_TO_MIN``, ``NUMBER_OP_TO_MAX``, ``NUMBER_OP_DECREMENT`` or ``NUMBER_OP_INCREMENT``. -- **cycle** (**Optional**, bool, :ref:`templatable `): +- **cycle** (*Optional*, bool, :ref:`templatable `): Can be used with ``DECREMENT`` or ``INCREMENT`` to specify whether or not to wrap around the value when respectively the minimum or maximum value of the number is exceeded. diff --git a/components/select/index.rst b/components/select/index.rst index 7a98220b7..dc7cab254 100644 --- a/components/select/index.rst +++ b/components/select/index.rst @@ -143,8 +143,8 @@ This is an :ref:`Action ` for selecting the next option in a sele Configuration variables: - **id** (**Required**, :ref:`config-id`): The ID of the select to set. -- **cycle** (**Optional**, boolean): Whether or not to jump back to the first option - of the select when the last option is currently selected. Defaults to ``true``. +- **cycle** (*Optional*, boolean): Whether or not to jump back to the first option + of the select when the last option is currently selected. Defaults to ``true``. .. _select-previous_action: @@ -166,8 +166,8 @@ a select component. Configuration variables: - **id** (**Required**, :ref:`config-id`): The ID of the select to set. -- **cycle** (**Optional**, boolean): Whether or not to jump to the last option - of the select when the first option is currently selected. Defaults to ``true``. +- **cycle** (*Optional*, boolean): Whether or not to jump to the last option + of the select when the first option is currently selected. Defaults to ``true``. .. _select-first_action: @@ -240,7 +240,7 @@ Configuration variables: ``NEXT`` (case insensitive). When writing a lambda for this field, then return one of the following enum values: ``SELECT_OP_FIRST``, ``SELECT_OP_LAST``, ``SELECT_OP_PREVIOUS`` or ``SELECT_OP_NEXT``. -- **cycle** (**Optional**, bool, :ref:`templatable `): +- **cycle** (*Optional*, bool, :ref:`templatable `): Can be used for options ``NEXT`` and ``PREVIOUS`` to specify whether or not to wrap around the options list when respectively the last or first option in the select is currently active. diff --git a/components/sensor/scd4x.rst b/components/sensor/scd4x.rst index cac3589a2..a267b5793 100644 --- a/components/sensor/scd4x.rst +++ b/components/sensor/scd4x.rst @@ -66,14 +66,14 @@ Configuration variables: is set. -- **measurement_mode** (*Optional*): Set measurement mode for scd4x. +- **measurement_mode** (*Optional*): Set measurement mode for scd4x. - - **periodic** : The sensor takes a new measurement every 5 seconds. This is the default mode. - - **low_power_periodic**: The sensor takes a new measurement every 30 seconds. Make sure ``update_interval`` is at least 30 seconds. - - **single_shot**: A measurement is started in every update interval. A measurement takes 5 seconds. This mode is only available on scd41 and useful if low power consumption is required. + - ``periodic``: The sensor takes a new measurement every 5 seconds. This is the default mode. + - ``low_power_periodic``: The sensor takes a new measurement every 30 seconds. Make sure ``update_interval`` is at least 30 seconds. + - ``single_shot``: A measurement is started in every update interval. A measurement takes 5 seconds. This mode is only available on scd41 and useful if low power consumption is required. The automatic self-calibration is optimized for single shot measurements performed every 5 minutes. To reduce noise levels, you can can perform several single shot measurements in a row and average the output values using a :ref:`sensor-filters`. - - **single_shot_rht_only**: A measurement is started in every update interval. A measurement takes 50 ms. Only humidity and temperature is measured. CO2 is reported as 0 ppm. This mode is only available on scd41 and useful if low power consumption is required. + - ``single_shot_rht_only``: A measurement is started in every update interval. A measurement takes 50 ms. Only humidity and temperature is measured. CO2 is reported as 0 ppm. This mode is only available on scd41 and useful if low power consumption is required. - **ambient_pressure_compensation_source** (*Optional*, :ref:`config-id`): Set an external pressure sensor ID used for ambient pressure compensation. diff --git a/components/sensor/sen5x.rst b/components/sensor/sen5x.rst index dd7904003..11df3d5c2 100644 --- a/components/sensor/sen5x.rst +++ b/components/sensor/sen5x.rst @@ -88,7 +88,7 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - All other options from :ref:`Sensor `. -- **auto_cleaning_interval** (Optional): Reads/Writes the interval in seconds of the periodic fan-cleaning. +- **auto_cleaning_interval** (*Optional*): Reads/Writes the interval in seconds of the periodic fan-cleaning. - **temperature** (*Optional*): Temperature.Note only available with Sen54 or Sen55. The sensor will be ignored on unsupported models. @@ -102,16 +102,16 @@ Configuration variables: - **name** (**Required**, string): The name of the sensor. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - + - **algorithm_tuning** (*Optional*): The VOC algorithm can be customized by tuning 6 different parameters. For more details see `Engineering Guidelines for SEN5x `__ - - **index_offset** (*Optional*): VOC index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. + - **index_offset** (*Optional*): VOC index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. - **learning_time_offset_hours** (*Optional*): Time constant to estimate the VOC algorithm offset from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hour - - **learning_time_gain_hours** (*Optional*): Time constant to estimate the VOC algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hours. + - **learning_time_gain_hours** (*Optional*): Time constant to estimate the VOC algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hours. - **gating_max_duration_minutes** (*Optional*): Maximum duration of gating in minutes (freeze of estimator during high VOC index signal). Zero disables the gating. Allowed values are in range 0..3000. The default value is 180 minutes - **std_initial** (*Optional*): Initial estimate for standard deviation. Lower value boosts events during initial learning period, but may result in larger device-todevice variations. Allowed values are in range 10..5000. The default value is 50. - - **gain_factor:** (*Optional*): Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1..1000. The default value is 230. - + - **gain_factor** (*Optional*): Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1..1000. The default value is 230. + - All other options from :ref:`Sensor `. - **nox** (*Optional*): NOx Index. Note: Only available with Sen54 or Sen55. The sensor will be ignored on unsupported models. @@ -120,24 +120,24 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **algorithm_tuning** (*Optional*): The NOx algorithm can be customized by tuning 5 different parameters.For more details see `Engineering Guidelines for SEN5x `__ - - - **index_offset** (*Optional*): NOx index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. + + - **index_offset** (*Optional*): NOx index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. - **learning_time_offset_hours** (*Optional*): Time constant to estimate the NOx algorithm offset from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hour - - **learning_time_gain_hours** (*Optional*): Time constant to estimate the NOx algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hours. + - **learning_time_gain_hours** (*Optional*): Time constant to estimate the NOx algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1..1000. The default value is 12 hours. - **gating_max_duration_minutes** (*Optional*): Maximum duration of gating in minutes (freeze of estimator during high NOx index signal). Zero disables the gating. Allowed values are in range 0..3000. The default value is 180 minutes - **std_initial** (*Optional*): The initial estimate for standard deviation parameter has no impact for NOx. This parameter is still in place for consistency reasons with the VOC tuning parameters command. This parameter must always be set to 50. - - **gain_factor:** (*Optional*) + - **gain_factor** (*Optional*): Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1..1000. The default value is 230. - All other options from :ref:`Sensor `. - **store_baseline** (*Optional*, boolean): Stores and retrieves the baseline VOC and NOx information for quicker startups. Defaults to ``true`` -- **temperature_compensation** (*Optional*): These parameters allow to compensate temperature effects of the design-in at customer side by applying a custom temperature offset to the ambient temperature. +- **temperature_compensation** (*Optional*): These parameters allow to compensate temperature effects of the design-in at customer side by applying a custom temperature offset to the ambient temperature. - The compensated ambient temperature is calculated as follows: + The compensated ambient temperature is calculated as follows: - T_Ambient_Compensated = T_Ambient + (slope*T_Ambient) + offset + T_Ambient_Compensated = T_Ambient + (slope*T_Ambient) + offset - Where slope and offset are the values set with this command, smoothed with the specified time constant. The time constant is how fast the slope and offset are applied. After the specified value in seconds, 63% of the new slope and offset are applied. + Where slope and offset are the values set with this command, smoothed with the specified time constant. The time constant is how fast the slope and offset are applied. After the specified value in seconds, 63% of the new slope and offset are applied. More details about the tuning of these parameters are included in the application note `Temperature Acceleration and Compensation Instructions for SEN5x. `__ @@ -146,9 +146,9 @@ Configuration variables: - **time_constant** (*Optional*): Time constant in seconds. Defaults to ``0`` - **acceleration_mode** (*Optional*): Allowed value are ``low``, ``medium`` and ``high``. (default is ``low``) - - By default, the RH/T acceleration algorithm is optimized for a sensor which is positioned in free air. If the sensor is integrated into another device, the ambient RH/T output values might not be optimal due to different thermal behavior. - This parameter can be used to adapt the RH/T acceleration behavior for the actual use-case, leading in an improvement of the ambient RH/T output accuracy. There is a limited set of different modes available. + + By default, the RH/T acceleration algorithm is optimized for a sensor which is positioned in free air. If the sensor is integrated into another device, the ambient RH/T output values might not be optimal due to different thermal behavior. + This parameter can be used to adapt the RH/T acceleration behavior for the actual use-case, leading in an improvement of the ambient RH/T output accuracy. There is a limited set of different modes available. Medium and high accelerations are particularly indicated for air quality monitors which are subjected to large temperature changes. Low acceleration is advised for stationary devices not subject to large variations in temperature - **address** (*Optional*, int): Manually specify the I²C address of the sensor. @@ -177,12 +177,12 @@ Automatic Cleaning: When the module is in Measurement-Mode an automatic fan-cleaning procedure will be triggered periodically following a defined cleaning interval. This will accelerate the fan to maximum speed for 10 seconds to blow out the accumulated dust inside the fan. -- Measurement values are not updated while the fan-cleaning is running. +- Measurement values are not updated while the fan-cleaning is running. - The cleaning interval is set to 604’800 seconds (i.e., 168 hours or 1 week). -- The interval can be configured using the Set Automatic Cleaning Interval command. -- Set the interval to 0 to disable the automatic cleaning. -- A sensor reset, resets the cleaning interval to its default value -- If the sensor is switched off, the time counter is reset to 0. Make sure to trigger a cleaning cycle at least every week if the sensor is switched off and on periodically (e.g., once per day). +- The interval can be configured using the Set Automatic Cleaning Interval command. +- Set the interval to 0 to disable the automatic cleaning. +- A sensor reset, resets the cleaning interval to its default value +- If the sensor is switched off, the time counter is reset to 0. Make sure to trigger a cleaning cycle at least every week if the sensor is switched off and on periodically (e.g., once per day). - The cleaning procedure can also be started manually with the ``start_autoclean_fan`` Action The Sen5x sensor has an automatic fan-cleaning which will accelerate the built-in fan to maximum speed for 10 seconds in order to blow out the dust accumulated inside the fan. diff --git a/components/sensor/sps30.rst b/components/sensor/sps30.rst index 9ed2ca948..f80081032 100644 --- a/components/sensor/sps30.rst +++ b/components/sensor/sps30.rst @@ -111,13 +111,13 @@ Configuration variables: - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - All other options from :ref:`Sensor `. -- **pm_size** (*Optional*): Typical particle size in μm. +- **pm_size** (*Optional*): Typical particle size in μm. - **name** (**Required**, string): The name for this sensor. - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - All other options from :ref:`Sensor `. -- **auto_cleaning_interval** (Optional): The interval in seconds of the periodic fan-cleaning. +- **auto_cleaning_interval** (*Optional*): The interval in seconds of the periodic fan-cleaning. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x69``. From 0ef630be9f6fe57fc768d5360e6afebdeb67a173 Mon Sep 17 00:00:00 2001 From: lillborje71 <44804949+lillborje71@users.noreply.github.com> Date: Wed, 8 Jun 2022 06:16:34 +0200 Subject: [PATCH 6/6] Update deep_sleep.rst (#2117) --- components/deep_sleep.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/deep_sleep.rst b/components/deep_sleep.rst index d5042d00e..a2c428b0d 100644 --- a/components/deep_sleep.rst +++ b/components/deep_sleep.rst @@ -57,7 +57,7 @@ Advanced features: wake up on multiple pins. This cannot be used together with wakeup pin. - **pins** (**Required**, list of pin numbers): The pins to wake up on. - - **mode** (*Optional*): The mode to use for the wakeup source. Must be one of ``ALL_LOW`` (wake up when + - **mode** (**Required**): The mode to use for the wakeup source. Must be one of ``ALL_LOW`` (wake up when all pins go LOW) or ``ANY_HIGH`` (wake up when any pin goes HIGH). .. note::