Event Scheduling#

emEventControlSetActive#

void emEventControlSetActive (EmberEventControl * event)

Sets this EmberEventControl to run at the next available opportunity.

emEventControlSetDelayMS#

void emEventControlSetDelayMS (EmberEventControl * event, uint32_t delay)

Sets this EmberEventControl to run "delay" milliseconds in the future. NOTE: To avoid rollover errors in event calculation, the delay must be less than EMBER_MAX_EVENT_CONTROL_DELAY_MS.

emEventControlGetRemainingMS#

uint32_t emEventControlGetRemainingMS (EmberEventControl * event)

Returns The amount of milliseconds remaining before the event is scheduled to run. If the event is inactive, MAX_INT32U_VALUE is returned.

emberRunEvents#

void emberRunEvents (EmberEventData * events)

An application typically creates an array of events along with their handlers.

The main loop passes the array to emberRunEvents() in order to call the handlers of any events whose time has arrived.

emberRunTask#

void emberRunTask (EmberTaskId taskid)

If an application has initialized a task via emberTaskInit, it should call emberRunTask() instead of emberRunEvents() to run the events associated with that task.

emberMsToNextEvent#

uint32_t emberMsToNextEvent (EmberEventData * events, uint32_t maxMs)

Returns the number of milliseconds before the next event is scheduled to expire, or maxMs if no event is scheduled to expire within that time. NOTE: If any events are modified within an interrupt, it must be called with interrupts disabled or from within an ATOMIC() block in order to guarantee the accuracy of this API.

emberMsToNextEventExtended#

uint32_t emberMsToNextEventExtended (EmberEventData * events, uint32_t maxMs, uint8_t * returnIndex)

This function does the same as emberMsToNextEvent() with the following addition. If the returnIndex is non-NULL, it will set the value pointed to by the pointer to be equal to the index of the event that is ready to fire next. If no events are active, then it returns 0xFF.

emberMsToNextStackEvent#

uint32_t emberMsToNextStackEvent (void )

Returns the number of milliseconds before the next stack event is scheduled to expire.

emberTaskInit#

EmberTaskId emberTaskInit (EmberEventData * events)

Initializes a task to be used for managing events and processor idling state. Returns the EmberTaskId, which represents the newly created task.

emberMarkTaskIdle#

bool emberMarkTaskIdle (EmberTaskId taskid)

Indicates that a task has nothing to do (unless any events are pending) and that it would be safe to idle the CPU if all other tasks also have nothing to do. This API should always be called with interrupts disabled. It will forcibly re-enable interrupts before returning. Returns true if the processor was idled, false if idling was not permitted because some other task has something to do.

emTaskEnableIdling#

void emTaskEnableIdling (bool allow)

emMarkTaskActive#

void emMarkTaskActive (EmberTaskId taskid)

emGetCurrentlyRunningEventControl#

EmberEventControl* emGetCurrentlyRunningEventControl (void )

Returns the event control pointer of the currently running event. NULL if no event is running.

emberEventControlSetInactive#

#define emberEventControlSetInactive

(control)

Sets this EmberEventControl as inactive (no pending event).

emberEventControlGetActive#

#define emberEventControlGetActive

(control)

Returns true if the event is active, false otherwise.

emberEventControlSetActive#

#define emberEventControlSetActive

(control)

Sets this EmberEventControl to run at the next available opportunity.

EMBER_MAX_EVENT_CONTROL_DELAY_MS#

#define EMBER_MAX_EVENT_CONTROL_DELAY_MS

(HALF_MAX_INT32U_VALUE - 1)

The maximum delay that may be passed to emberEventControlSetDelayMS.

emberEventControlSetDelayMS#

#define emberEventControlSetDelayMS

(control, delay)

Sets this EmberEventControl to run "delay" milliseconds in the future. NOTE: To avoid rollover errors in event calculation, the delay must be less than EMBER_MAX_EVENT_CONTROL_DELAY_MS.

EMBER_MAX_EVENT_CONTROL_DELAY_QS#

#define EMBER_MAX_EVENT_CONTROL_DELAY_QS

(EMBER_MAX_EVENT_CONTROL_DELAY_MS >> 8)

The maximum delay that may be passed to emberEventControlSetDelayQS.

emberEventControlSetDelayQS#

#define emberEventControlSetDelayQS

(control, delay)

Sets this EmberEventControl to run "delay" quarter seconds in the future. The 'quarter seconds' are actually 256 milliseconds long. NOTE: To avoid rollover errors in event calculation, the delay must be less than EMBER_MAX_EVENT_CONTROL_DELAY_QS.

EMBER_MAX_EVENT_CONTROL_DELAY_MINUTES#

#define EMBER_MAX_EVENT_CONTROL_DELAY_MINUTES

(EMBER_MAX_EVENT_CONTROL_DELAY_MS >> 16)

The maximum delay that may be passed to emberEventControlSetDelayMinutes.

emberEventControlSetDelayMinutes#

#define emberEventControlSetDelayMinutes

(control, delay)

Sets this EmberEventControl to run "delay" minutes in the future. The 'minutes' are actually 65536 (0x10000) milliseconds long. NOTE: To avoid rollover errors in event calculation, the delay must be less than EMBER_MAX_EVENT_CONTROL_DELAY_MINUTES.

emberEventControlGetRemainingMS#

#define emberEventControlGetRemainingMS

(control)

Returns The amount of milliseconds remaining before the event is scheduled to run. If the event is inactive, MAX_INT32U_VALUE is returned.

emberTaskEnableIdling#

#define emberTaskEnableIdling

(allow)

Call this to indicate that an application supports processor idling.

emberMarkTaskActive#

#define emberMarkTaskActive

(taskid)

Indicates that a task has something to do, so the CPU should not be idled until emberMarkTaskIdle is next called on this task.