Idle/Sleep Callbacks
Functions | |
bool | emberAfPluginIdleSleepOkToSleepCallback (uint32_t durationMs) |
Ok To Sleep. | |
void | emberAfPluginIdleSleepWakeUpCallback (uint32_t durationMs) |
Wake Up. | |
bool | emberAfPluginIdleSleepOkToIdleCallback (uint32_t durationMs) |
Ok To Idle. | |
void | emberAfPluginIdleSleepActiveCallback (uint32_t durationMs) |
Active. |
Detailed Description
These callbacks are contributed by the Idle/Sleep plugin.
Function Documentation
void emberAfPluginIdleSleepActiveCallback | ( | uint32_t | durationMs | ) |
This function is called by the Idle/Sleep plugin after idling.
- Parameters
-
durationMs
The duration in milliseconds that the device idled.
bool emberAfPluginIdleSleepOkToIdleCallback | ( | uint32_t | durationMs | ) |
This function is called by the Idle/Sleep plugin before idling. It is called with interrupts disabled. The application should return true if the device may idle or false otherwise.
- Parameters
-
durationMs
The maximum duration in milliseconds that the device will idle.
bool emberAfPluginIdleSleepOkToSleepCallback | ( | uint32_t | durationMs | ) |
This function is called by the Idle/Sleep plugin before sleeping. It is called with interrupts disabled. The application should return true if the device may sleep or false otherwise.
- Parameters
-
durationMs
The maximum duration in milliseconds that the device will sleep.
void emberAfPluginIdleSleepWakeUpCallback | ( | uint32_t | durationMs | ) |
This function is called by the Idle/Sleep plugin after sleeping.
- Parameters
-
durationMs
The duration in milliseconds that the device slept.