idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches
idfxx::sleep::ext1_wake Class Reference

Wakes the chip on levels of one or more RTC-capable pins (EXT1). More...

Public Member Functions

constexpr ext1_wake (std::initializer_list< idfxx::gpio > pins, enum ext1_mode mode) noexcept
 Specifies an EXT1 wake on a set of pins.
 
constexpr ext1_wake (uint64_t pin_mask, enum ext1_mode mode) noexcept
 Specifies an EXT1 wake on a mask of pins.
 
constexpr uint64_t pin_mask () const noexcept
 Bit mask of GPIO numbers to wake on.
 
constexpr enum ext1_mode mode () const noexcept
 Whether high or low levels trigger the wake.
 

Detailed Description

Wakes the chip on levels of one or more RTC-capable pins (EXT1).

Works in both light and deep sleep. Reported as wakeup_source::ext1; the triggering pins are available from ext1_wakeup_status.

Note
Floating pins need a pull resistor (external, or an RTC pull held across sleep) to avoid spurious wakes.
Only available on chips with EXT1 wake-up support (SOC_PM_SUPPORT_EXT1_WAKEUP).

Definition at line 181 of file sleep.hpp.

Constructor & Destructor Documentation

◆ ext1_wake() [1/2]

constexpr idfxx::sleep::ext1_wake::ext1_wake ( std::initializer_list< idfxx::gpio pins,
enum ext1_mode  mode 
)
inlineconstexprnoexcept

Specifies an EXT1 wake on a set of pins.

Parameters
pinsThe pins to wake on; each must be RTC-capable and connected, or arming the specification fails.
modeWhether high or low levels trigger the wake.

Definition at line 190 of file sleep.hpp.

◆ ext1_wake() [2/2]

constexpr idfxx::sleep::ext1_wake::ext1_wake ( uint64_t  pin_mask,
enum ext1_mode  mode 
)
inlineconstexprnoexcept

Specifies an EXT1 wake on a mask of pins.

Parameters
pin_maskBit mask of GPIO numbers to wake on (bit n selects GPIO n); every selected pin must be RTC-capable.
modeWhether high or low levels trigger the wake.

Definition at line 201 of file sleep.hpp.

Member Function Documentation

◆ mode()

constexpr enum ext1_mode idfxx::sleep::ext1_wake::mode ( ) const
inlineconstexprnoexcept

Whether high or low levels trigger the wake.

Definition at line 209 of file sleep.hpp.

◆ pin_mask()

constexpr uint64_t idfxx::sleep::ext1_wake::pin_mask ( ) const
inlineconstexprnoexcept

Bit mask of GPIO numbers to wake on.

Definition at line 206 of file sleep.hpp.


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