summaryrefslogtreecommitdiff
path: root/docs/library/esp32.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/esp32.rst')
-rw-r--r--docs/library/esp32.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/library/esp32.rst b/docs/library/esp32.rst
index e5f39c7f5..84f33f46e 100644
--- a/docs/library/esp32.rst
+++ b/docs/library/esp32.rst
@@ -43,6 +43,15 @@ Functions
.. note:: This is only available for boards that have ext1 support.
+.. function:: wake_on_gpio(pins, level)
+
+ Configure how GPIO wakes the device from sleep. *pins* can be ``None``
+ or a tuple/list of valid Pin objects. *level* should be ``esp32.WAKEUP_ALL_LOW``
+ or ``esp32.WAKEUP_ANY_HIGH``.
+
+ .. note:: Some boards don't support waking on GPIO from deep sleep,
+ on those boards, the pins set here can only be used to wake from light sleep.
+
.. function:: gpio_deep_sleep_hold(enable)
Configure whether non-RTC GPIO pin configuration is retained during