summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/esp32.rst
diff options
context:
space:
mode:
authorJonathan Hogg <me@jonathanhogg.com>2022-03-07 09:22:00 +0000
committerDamien George <damien@micropython.org>2022-03-21 23:59:07 +1100
commit21d0599bd10aa567e3fdee5e39da1fe9a9f816e6 (patch)
tree8077890e02e6ec38fcefbb26b2970c809f46f2aa /docs/library/esp32.rst
parent7684c996bc2b2521fa4bd023e4fa24622092cd5f (diff)
downloadmicropython-21d0599bd10aa567e3fdee5e39da1fe9a9f816e6.tar.gz
micropython-21d0599bd10aa567e3fdee5e39da1fe9a9f816e6.zip
esp32/modesp32: Add new gpio_deep_sleep_hold function.
Add a new function to control whether held pins will retain their function through deep-sleep. Also document this function and explain how to use this in quickref to retain pin configuration during deep-sleep.
Diffstat (limited to 'docs/library/esp32.rst')
-rw-r--r--docs/library/esp32.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/library/esp32.rst b/docs/library/esp32.rst
index da5fa8c3cb..3348003499 100644
--- a/docs/library/esp32.rst
+++ b/docs/library/esp32.rst
@@ -30,6 +30,11 @@ Functions
or a tuple/list of valid Pin objects. *level* should be ``esp32.WAKEUP_ALL_LOW``
or ``esp32.WAKEUP_ANY_HIGH``.
+.. function:: gpio_deep_sleep_hold(enable)
+
+ Configure whether non-RTC GPIO pin configuration is retained during
+ deep-sleep mode for held pads. *enable* should be a boolean value.
+
.. function:: raw_temperature()
Read the raw value of the internal temperature sensor, returning an integer.