esp_sleep_enable_uart_wakeup() function

Enable wakeup from light sleep using UART Use uart_set_wakeup_threshold function to configure UART wakeup threshold. Wakeup from light sleep takes some time, so not every character sent to the UART can be received by the application.

Syntax

Show:

Summary

Declaration

Definition

from esp_sleep.h:490

esp_err_t esp_sleep_enable_uart_wakeup(int uart_num);

Implemented in sleep_modes.c:2118

Arguments

Argument

Description

uart_num

UART port to wake up from

Return value

- ESP_OK on success - ESP_ERR_INVALID_ARG if wakeup from given UART is not supported

Notes

ESP32 does not support wakeup from UART2.

Examples

esp_sleep_enable_uart_wakeup() is referenced by 3 libraries and example projects:

References

from examples

esp_sleep_enable_uart_wakeup() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle