low_power::ArduinoLowPowerESP32 Class Reference

Low Power Management for ESP32: More...

#include <LowPowerESP32.h>

Inheritance diagram for low_power::ArduinoLowPowerESP32:

Public Member Functions
bool	isProcessingOnSleep (sleep_mode_enum_t sleep_mode)
	Returns true if processing is possible in the current sleep mode.
bool	sleep (void) override
	sets processor into sleep mode
bool	setSleepTime (uint32_t time, time_unit_t time_unit) override
	Defines the sleep time.
bool	addWakeupPin (int pin, pin_change_t change_type) override
	Defines the wakup pin.
bool	addWakeupTouchPin (int pin, int touch_threshold=TOUCH_THREASHOLD)
	Wakup by touch pin.
void	setWakeupType (wakeup_t wakeup)
	There are two types for ESP32, ext0 and ext1 . ext0 uses RTC_IO to wakeup thus requires RTC peripherals to be on while ext1 uses RTC Controller so does not need peripherals to be powered on. Note that using internal pullups/pulldowns also requires RTC peripherals to be turned on.
bool	isModeSupported (sleep_mode_enum_t sleep_mode) override
	Provides information if the indicated mode is supported.
void	clear () override
	Reset to the initial state.
void	setCpuFrequencyMhz (int mhz)
virtual bool	sleepFor (uint32_t time, time_unit_t time_unit_type)
	sets mc into sleep mode to sleep for indicated millis
virtual void	setActive (bool flag)
	sets the flag to be active
virtual void	setActiveTime (uint32_t time, time_unit_t time_unit_type)
	Defiles the active time.
virtual bool	isActive ()
	Checks if we are active (not sleeping)
virtual	operator bool ()
	same as isActive()
virtual bool	setSleepMode (sleep_mode_enum_t mode)
	Defines the sleep mode.
virtual void	process ()
	Triggers the processing to be active or sleeping based on the set definitions.
virtual bool	isProcessingOnSleep ()
	Returns true if processing is possible in the current sleep mode.

Protected Member Functions
void	wifiSetPS (wifi_ps_type_t type)
bool	isTouchPin (int pin)
uint64_t	toUs (uint64_t time, time_unit_t time_unit)

Protected Attributes
wakeup_t	wakeup_type = wakeup_t::ext1
uint32_t	sleep_time_us = 0
std::vector< int >	touch_pins
uint32_t	pin_mask = 0
bool	is_active = true
uint32_t	timeout_end = 0
uint32_t	timeout_us = 0
time_unit_t	time_unit = time_unit_t::ms
sleep_mode_enum_t	sleep_mode = sleep_mode_enum_t::deepSleep

Detailed Description

Low Power Management for ESP32:

• In Modem-sleep mode, ESP32 will close the Wi-Fi module circuit between the two DTIM Beacon intervals in order to save power.
• In Light-sleep mode, the digital peripherals, most of the RAM, and CPUs are clock-gated and their supply voltage is reduced.
• In Deep-sleep mode, the CPUs, most of the RAM, and all digital peripherals that are clocked from APB_CLK are powered off.

Additional ESP32 specific functionality/features:

• wakeup by touch pin
• supports multiple wakup sources
• supports modemSleep

Attention: at wakup of deep sleep we restart in setup.

Author

Phil Schatzmann for details see

• https://docs.espressif.com/projects/arduino-esp32/en/latest/api/deepsleep.html

---

The documentation for this class was generated from the following file:

• src/LowPowerESP32.h