idfxx::sleep::deep_sleep_gpio_wake Class Reference

Wakes the chip from deep sleep on levels of one or more pins. More...

Public Member Functions
constexpr	deep_sleep_gpio_wake (std::initializer_list< idfxx::gpio > pins, deep_sleep_gpio_mode mode) noexcept
	Specifies a deep-sleep GPIO wake on a set of pins.
constexpr	deep_sleep_gpio_wake (uint64_t pin_mask, deep_sleep_gpio_mode mode) noexcept
	Specifies a deep-sleep GPIO wake on a mask of pins.
constexpr uint64_t	pin_mask () const noexcept
	Bit mask of GPIO numbers to wake on.
constexpr deep_sleep_gpio_mode	mode () const noexcept
	Whether high or low levels trigger the wake.

Detailed Description

Wakes the chip from deep sleep on levels of one or more pins.

Available on chips without EXT0/EXT1 support (e.g. ESP32-C3), where it is the only pin-based deep-sleep wake-up source. Only deep-sleep-capable pins may be selected (typically the low-numbered GPIOs; see the chip datasheet). Reported as wakeup_source::gpio.

Note

Only available on chips with deep-sleep GPIO wake-up support (SOC_GPIO_SUPPORT_DEEPSLEEP_WAKEUP).

Definition at line 239 of file sleep.hpp.

Constructor & Destructor Documentation

deep_sleep_gpio_wake() [1/2]

constexpr idfxx::sleep::deep_sleep_gpio_wake::deep_sleep_gpio_wake ( std::initializer_list< idfxx::gpio >  pins, deep_sleep_gpio_mode  mode  )

inlineconstexprnoexcept

Specifies a deep-sleep GPIO wake on a set of pins.

Parameters

pins	The pins to wake on; each must be deep-sleep wake capable and connected, or arming the specification fails.
mode	Whether high or low levels trigger the wake.

Definition at line 248 of file sleep.hpp.

deep_sleep_gpio_wake() [2/2]

constexpr idfxx::sleep::deep_sleep_gpio_wake::deep_sleep_gpio_wake ( uint64_t  pin_mask, deep_sleep_gpio_mode  mode  )

inlineconstexprnoexcept

Specifies a deep-sleep GPIO wake on a mask of pins.

Parameters

pin_mask	Bit mask of GPIO numbers to wake on (bit n selects GPIO n).
mode	Whether high or low levels trigger the wake.

Definition at line 258 of file sleep.hpp.

Member Function Documentation

mode()

constexpr deep_sleep_gpio_mode idfxx::sleep::deep_sleep_gpio_wake::mode ( ) const

inlineconstexprnoexcept

Whether high or low levels trigger the wake.

Definition at line 266 of file sleep.hpp.

pin_mask()

constexpr uint64_t idfxx::sleep::deep_sleep_gpio_wake::pin_mask ( ) const

inlineconstexprnoexcept

Bit mask of GPIO numbers to wake on.

Definition at line 263 of file sleep.hpp.

---

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

• idfxx_sleep/include/idfxx/sleep.hpp