Enum WakeupSource 

pub enum WakeupSource {
    Ext0 = 0,
    Ext1 = 1,
    Gpio = 2,
    Timer = 3,
    Wifi = 5,
    Uart0 = 6,
    Uart1 = 7,
    Touch = 8,
    UlpRiscv = 11,
    UlpRiscvTrap = 13,
}

A source that can wake the chip from sleep.

Each variant models a single bit in the wakeup registers. Internal representation shared by [WakeTriggers][crate::rtc_cntl::sleep::WakeTriggers] (the sources configured to end a sleep) and WakeupReason (the source(s) that caused the most recent wakeup, see wakeup_cause)

The available variants depend on the target chip.

Variants

Ext0 = 0

EXT0 wakeup

Ext1 = 1

EXT1 wakeup, via one or more RTC GPIOs (RTC_CNTL).

Gpio = 2

GPIO wakeup.

Timer = 3

Timer wakeup.

Wifi = 5

Wi-Fi (MAC) wakeup.

Uart0 = 6

UART0 wakeup.

Uart1 = 7

UART1 wakeup.

Touch = 8

Touch sensor wakeup.

UlpRiscv = 11

ULP RISC-V coprocessor wakeup.

UlpRiscvTrap = 13

ULP RISC-V coprocessor trap (crash) wakeup.

Implementations

impl WakeupSource

pub fn enable_with_hooks( self, entry: Option<SleepEntryHook>, exit: Option<SleepExitHook>, )

Available on crate feature unstable only.

Enables this source and registers the hooks that run around a sleep.

A source has one slot for each kind of hook, so a second call replaces the hooks of the first call. One driver owns each source, so only that driver can replace its own hooks. A call for a source that is already enabled does this.

Both hooks run with the flash accessible, so they need no ram attribute. The entry hook runs before esp-hal writes the sleep configuration to hardware, and the exit hook runs after the wake sequence restores it. Both hooks are part of sleep entry, so keep them short.

Only the driver that owns the source calls this. esp-hal owns the sources of its own drivers, for example the timer source. A call for such a source replaces the hooks of that driver, and the driver then does not work through a sleep.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn disable(self)

Available on crate feature unstable only.

Disables this source, and removes its hooks.

Only the driver that owns the source calls this, as for Self::enable_with_hooks.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations

impl<O: Into<EnumSet<WakeupSource>>> BitAnd<O> for WakeupSource

Available on crate feature unstable only.

type Output = EnumSet<WakeupSource>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> EnumSet<WakeupSource>

Performs the & operation.

impl<O: Into<EnumSet<WakeupSource>>> BitOr<O> for WakeupSource

Available on crate feature unstable only.

type Output = EnumSet<WakeupSource>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> EnumSet<WakeupSource>

Performs the | operation.

impl<O: Into<EnumSet<WakeupSource>>> BitXor<O> for WakeupSource

Available on crate feature unstable only.

type Output = EnumSet<WakeupSource>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> EnumSet<WakeupSource>

Performs the ^ operation.

impl Clone for WakeupSource

Available on crate feature unstable only.

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for WakeupSource

Available on crate feature unstable only.

impl Debug for WakeupSource

Available on crate feature unstable only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl EnumSetConstHelper for WakeupSource

Available on crate feature unstable only.

const CONST_INIT_HELPER: __EnumSetInitHelper = __EnumSetInitHelper

The instance of the ConstInitHelper.

const CONST_OP_HELPER: __EnumSetOpHelper = __EnumSetOpHelper

The instance of the ConstOpHelper.

type ConstInitHelper = __EnumSetInitHelper

A helper type used to convert values to EnumSets at compile-time.

type ConstOpHelper = __EnumSetOpHelper

A helper type used to implement compile-time operations on enums.

impl EnumSetType for WakeupSource

Available on crate feature unstable only.

impl EnumSetTypePrivate for WakeupSource

Available on crate feature unstable only.

const ALL_BITS: <Self as EnumSetTypePrivate>::Repr = 10735

A mask of bits that are valid in the bitset.

const BIT_WIDTH: u32 = 14u32

The largest bit used in the bitset.

const VARIANT_COUNT: u32 = 10u32

The number of variants in the bitset.

type Repr = u16

The underlying type used to store the bitset.

fn enum_into_u32(self) -> u32

Converts an enum of this type into its bit position.

unsafe fn enum_from_u32(val: u32) -> Self

Converts a bit position into an enum value.

unsafe fn enum_from_u32_checked(val: u32) -> Self

Converts a bit position into an enum value, with a debug_assert.

impl Eq for WakeupSource

Available on crate feature unstable only.

impl Not for WakeupSource

Available on crate feature unstable only.

type Output = EnumSet<WakeupSource>

The resulting type after applying the ! operator.

fn not(self) -> EnumSet<WakeupSource>

Performs the unary ! operation.

impl PartialEq for WakeupSource

Available on crate feature unstable only.

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<EnumSet<WakeupSource>> for WakeupSource

Available on crate feature unstable only.

fn eq(&self, other: &EnumSet<WakeupSource>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<O: Into<EnumSet<WakeupSource>>> Sub<O> for WakeupSource

Available on crate feature unstable only.

type Output = EnumSet<WakeupSource>

The resulting type after applying the - operator.

fn sub(self, other: O) -> EnumSet<WakeupSource>

Performs the - operation.