Skip to main content

Module sleep

esp_hal::rtc_cntl

Module sleep 

Source
Available on crate feature unstable only.
Expand description

§RTC Control Sleep Module

§Overview

The sleep module allows configuring various wakeup sources and setting up the sleep behavior based on those sources. The supported wakeup sources include:

  • GPIO pins - light sleep only
  • timers
  • SDIO (Secure Digital Input/Output) - light sleep only
  • MAC (Media Access Control) wake - light sleep only
  • UART0 - light sleep only
  • UART1 - light sleep only
  • touch
  • ULP (Ultra-Low Power) wake
  • BT (Bluetooth) wake - light sleep only

Structs§

AnalogSleepConfig
Configuration controlling the analog behavior during sleep.
DigitalSleepConfig
Configuration controlling digital peripherals during sleep.
HpLpParam
Shared HP/LP sleep timing parameters.
HpParam
High-power system sleep timing parameters (pmu_hp_param_t subset).
LowPower
Low-power management.
LpParam
Low-power system sleep timing parameters (pmu_lp_param_t subset).
ParamSleepConfig
Sleep timing parameter configuration (pmu_sleep_param_config_t).
PowerDownFlags
Power domains to be powered down during sleep.
PowerSleepConfig
Configuration controlling the power state of the HP and LP systems during sleep.
RtcSleepConfig
Configuration for the RTC sleep behavior.
WrappedSleepConfig
The sleep configuration, as the entry hook of a wakeup source can see it.

Enums§

LightSleep
The result of a light sleep.

Type Aliases§

SleepEntryHook
Runs at sleep entry, before the sleep configuration reaches hardware.
SleepExitHook
Runs after a light sleep.