Idle/Sleep Callbacks#

These callbacks are contributed by the Idle/Sleep plugin.

Functions#

bool
emberAfPluginIdleSleepOkToSleepCallback(uint32_t durationMs)

Ok To Sleep.

void
emberAfPluginIdleSleepWakeUpCallback(uint32_t durationMs)

Wake Up.

bool
emberAfPluginIdleSleepRtosCallback(uint32_t *durationMs, bool sleepOk)

RTOS idle/sleep.

bool
emberAfPluginIdleSleepPreEm4ResetCallback(uint32_t *sleepDurationMs)

Active.

Function Documentation#

emberAfPluginIdleSleepOkToSleepCallback#

bool emberAfPluginIdleSleepOkToSleepCallback (uint32_t durationMs)

Ok To Sleep.

Parameters
N/AdurationMs

The maximum duration in milliseconds that the device will sleep. Ver.: always

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.


Definition at line 584 of file ./app/ncp/doc/callback.doc

emberAfPluginIdleSleepWakeUpCallback#

void emberAfPluginIdleSleepWakeUpCallback (uint32_t durationMs)

Wake Up.

Parameters
N/AdurationMs

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

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


Definition at line 596 of file ./app/ncp/doc/callback.doc

emberAfPluginIdleSleepOkToIdleCallback#

bool emberAfPluginIdleSleepOkToIdleCallback (void )

Ok To Idle.

Parameters
N/A

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.


Definition at line 607 of file ./app/ncp/doc/callback.doc

emberAfPluginIdleSleepActiveCallback#

void emberAfPluginIdleSleepActiveCallback (void )

Active.

Parameters
N/A

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


Definition at line 617 of file ./app/ncp/doc/callback.doc

emberAfPluginIdleSleepRtosCallback#

bool emberAfPluginIdleSleepRtosCallback (uint32_t * durationMs, bool sleepOk)

RTOS idle/sleep.

Parameters
N/AdurationMs

A pointer to the allowed idle/sleep duration in milliseconds. Ver.: always

N/AsleepOk

A boolean indicating whether sleep is allowed.

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.


Definition at line 632 of file ./app/ncp/doc/callback.doc

emberAfPluginIdleSleepPreEm4ResetCallback#

bool emberAfPluginIdleSleepPreEm4ResetCallback (uint32_t * sleepDurationMs)

Active.

Parameters
N/AsleepDurationMs

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


Definition at line 643 of file ./app/ncp/doc/callback.doc