Add documentation for deep-sleep wakeup from esp32 touch sensor event (#1483)

This commit is contained in:
Christian Taedcke 2021-09-20 10:12:46 +02:00 committed by GitHub
parent 1f05c9e4e0
commit 4b921ed194
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 0 deletions

View File

@ -95,6 +95,10 @@ Configuration variables:
- **id** (*Optional*, - **id** (*Optional*,
:ref:`config-id`): Manually specify :ref:`config-id`): Manually specify
the ID used for code generation. the ID used for code generation.
- **wakeup_threshold** (*Optional*, int): The threshold to use to detect touch events to wakeup from deep
sleep. Smaller values mean a higher probability that the pad is being touched. All touch pad sensors that
should trigger a wakeup from deep sleep must specify this value. The :ref:`deep_sleep-component` must also
be configured to enable a wakeup from a touch event. Note that no filter is active during deep sleep.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`. - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
Touch Pad Pins Touch Pad Pins

View File

@ -1,3 +1,5 @@
.. _deep_sleep-component:
Deep Sleep Component Deep Sleep Component
==================== ====================
@ -33,6 +35,8 @@ Configuration variables:
- **run_duration** (*Optional*, :ref:`config-time`): The time duration the node should be active, i.e. run code. - **run_duration** (*Optional*, :ref:`config-time`): The time duration the node should be active, i.e. run code.
- **sleep_duration** (*Optional*, :ref:`config-time`): The time duration to stay in deep sleep mode. - **sleep_duration** (*Optional*, :ref:`config-time`): The time duration to stay in deep sleep mode.
- **touch_wakeup** (*Optional*, boolean): Only on ESP32. Use a touch event to wakeup from deep sleep. To be able
to wakeup from a touch event, :ref:`esp32-touch-binary-sensor` must be configured properly.
- **wakeup_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): Only on ESP32. A pin to wake up to once - **wakeup_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): Only on ESP32. A pin to wake up to once
in deep sleep mode. Use the inverted property to wake up to LOW signals. in deep sleep mode. Use the inverted property to wake up to LOW signals.
- **wakeup_pin_mode** (*Optional*): Only on ESP32. Specify how to handle waking up from a ``wakeup_pin`` if - **wakeup_pin_mode** (*Optional*): Only on ESP32. Specify how to handle waking up from a ``wakeup_pin`` if