esp_light_sleep_start() function

Enter light sleep with the configured wakeup options

Syntax

Show:

Summary

Declaration

Definition

from esp_sleep.h:602

esp_err_t esp_light_sleep_start(void);

Implemented in sleep_modes.c:1360

Return value

- ESP_OK on success (returned after wakeup) - ESP_ERR_SLEEP_REJECT sleep request is rejected(wakeup source set before the sleep request) - ESP_ERR_SLEEP_TOO_SHORT_SLEEP_DURATION after deducting the sleep flow overhead, the final sleep duration is too short to cover the minimum sleep duration of the chip, when rtc timer wakeup source enabled

Examples

esp_light_sleep_start() is referenced by 4 libraries and example projects:

References

from examples

esp_light_sleep_start() function

Syntax

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle