Idle/Sleep Callbacks
Zigbee NCP API Reference > Zigbee NCP Application Framework Callbacks

Functions

bool emberAfPluginIdleSleepOkToSleepCallback (uint32_t durationMs)
Ok To Sleep.
void emberAfPluginIdleSleepWakeUpCallback (uint32_t durationMs)
Wake Up.
bool emberAfPluginIdleSleepOkToIdleCallback (void)
Ok To Idle.
void emberAfPluginIdleSleepActiveCallback (void)
Active.
bool emberAfPluginIdleSleepRtosCallback (uint32_t *durationMs, bool sleepOk)
RTOS idle/sleep.
bool emberAfPluginIdleSleepPreEm4ResetCallback (uint32_t *sleepDurationMs)
Active.

Detailed Description

These callbacks are contributed by the Idle/Sleep plugin.

Function Documentation

◆ emberAfPluginIdleSleepActiveCallback()

void emberAfPluginIdleSleepActiveCallback ( void )

Active.

This function is called by the Idle/Sleep plugin after idling.

◆ emberAfPluginIdleSleepOkToIdleCallback()

bool emberAfPluginIdleSleepOkToIdleCallback ( void )

Ok To Idle.

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.

◆ emberAfPluginIdleSleepOkToSleepCallback()

bool emberAfPluginIdleSleepOkToSleepCallback ( uint32_t durationMs )

Ok To Sleep.

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. Ver.: always

◆ emberAfPluginIdleSleepPreEm4ResetCallback()

bool emberAfPluginIdleSleepPreEm4ResetCallback ( uint32_t * sleepDurationMs )

Active.

This function is called by the Idle/Sleep plugin before em4 reset, and it is implemented by EM4 plugin.

◆ emberAfPluginIdleSleepRtosCallback()

bool emberAfPluginIdleSleepRtosCallback ( uint32_t * durationMs,
bool sleepOk
)

RTOS idle/sleep.

This function is called by the Idle/Sleep plugin before idling or sleeping. If it returns true, the RTOS is handling the MCU idling/sleeping, if it returns false the idle/sleep shall manage the actual MCU idling/sleeping.

Parameters
durationMs A pointer to the allowed idle/sleep duration in milliseconds. Ver.: always
sleepOk A boolean indicating whether sleep is allowed.

◆ emberAfPluginIdleSleepWakeUpCallback()

void emberAfPluginIdleSleepWakeUpCallback ( uint32_t durationMs )

Wake Up.

This function is called by the Idle/Sleep plugin after sleeping.

Parameters
durationMs The duration in milliseconds that the device slept. Ver.: always