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 for controlling the behavior during sleep modes.
DigitalSleepConfig
Configuration for controlling the behavior of digital peripherals during sleep modes.
HpLpParam
Parameters for high-power and low-power system configurations during sleep modes.
HpParam
Parameters for high-power system configurations during sleep modes.
LowPower
Low-power management.
LpParam
Parameters for low-power system configurations during sleep modes.
ParamSleepConfig
Configuration of parameters for sleep modes
PowerDownFlags
Power domains to be powered down during sleep.
PowerSleepConfig
Configuration for controlling the power settings of high-power and low-power systems during sleep modes.
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.