Application Framework Common
Application framework common. More...
Functions |
|
| EmberStatus | emberAfAllocateEvent ( EmberEventControl **control, void(*handler)(void)) |
|
Allocate a new event to the app event table.
More...
|
|
Callbacks |
|
| void | emberAfInitCallback (void) |
|
Application Framework Initialization Callback.
More...
|
|
| void | emberAfTickCallback (void) |
|
Application Framework Tick Callback.
More...
|
|
| void | emberAfStackStatusCallback ( EmberStatus status) |
|
Application framework equivalent of
emberStackStatusHandler
.
More...
|
|
| void | emberAfIncomingMessageCallback ( EmberIncomingMessage *message) |
|
Application framework equivalent of
emberIncomingMessageHandler
.
More...
|
|
| void | emberAfIncomingMacMessageCallback ( EmberIncomingMacMessage *message) |
|
Application framework equivalent of
emberIncomingMacMessageHandler
.
More...
|
|
| void | emberAfMessageSentCallback ( EmberStatus status, EmberOutgoingMessage *message) |
|
Application framework equivalent of
emberMessageSentHandler
.
More...
|
|
| void | emberAfMacMessageSentCallback ( EmberStatus status, EmberOutgoingMacMessage *message) |
|
Application framework equivalent of
emberMacMessageSentHandler
.
More...
|
|
| void | emberAfChildJoinCallback ( EmberNodeType nodeType, EmberNodeId nodeId) |
|
Application framework equivalent of
emberChildJoinHandler
.
More...
|
|
| void | emberAfActiveScanCompleteCallback (void) |
|
Application framework equivalent of
emberActiveScanCompleteHandler
.
More...
|
|
| void | emberAfEnergyScanCompleteCallback (int8_t mean, int8_t min, int8_t max, uint16_t variance) |
|
Application framework equivalent of
emberEnergyScanCompleteHandler
.
More...
|
|
| void | emberAfMarkApplicationBuffersCallback (void) |
|
Application framework equivalent of
emberMarkApplicationBuffersHandler
.
More...
|
|
| void | emberAfIncomingBeaconCallback ( EmberPanId panId, EmberMacAddress *source, int8_t rssi, bool permitJoining, uint8_t beaconFieldsLength, uint8_t *beaconFields, uint8_t beaconPayloadLength, uint8_t *beaconPayload) |
|
Application framework equivalent of
emberIncomingBeaconHandler
.
More...
|
|
| void | emberAfFrequencyHoppingStartClientCompleteCallback ( EmberStatus status) |
|
Application framework equivalent of
emberFrequencyHoppingStartClientCompleteHandler
.
More...
|
|
| void | emberAfRadioNeedsCalibratingCallback (void) |
|
Application framework equivalent of
emberRadioNeedsCalibratingHandler
.
More...
|
|
| bool | emberAfStackIdleCallback (uint32_t *idleTimeMs) |
|
Application framework equivalent of
emberStackIdleHandler
.
More...
|
|
| bool | emberAfCommonOkToEnterLowPowerCallback (bool enter_em2, uint32_t duration_ms) |
|
Application framework Low Power notification Callback.
More...
|
|
Detailed Description
Application framework common.
Declares all the required application framework globals, initializes the Connect stack and dispatches stack callbacks calls as needed to the application components.
Function Documentation
◆ emberAfActiveScanCompleteCallback()
| void emberAfActiveScanCompleteCallback | ( | void |
|
) |
Application framework equivalent of emberActiveScanCompleteHandler .
◆ emberAfAllocateEvent()
| EmberStatus emberAfAllocateEvent | ( | EmberEventControl ** |
control,
|
| void(*)(void) |
handler
|
||
| ) |
Allocate a new event to the app event table.
- Parameters
-
[out] controlThe EmberEventControl to allocate [in] handlerPointer to the handler function associated to the event
- Returns
-
An
EmberStatusvalue of:- EMBER_SUCCESS if the event was successfully allocated.
- EMBER_TABLE_FULL if no more event could be allocated.
- See also
- emberAfAllocateEvent()
◆ emberAfChildJoinCallback()
| void emberAfChildJoinCallback | ( | EmberNodeType |
nodeType,
|
| EmberNodeId |
nodeId
|
||
| ) |
Application framework equivalent of emberChildJoinHandler .
- Warning
- Requires the parent support plugin installed.
◆ emberAfCommonOkToEnterLowPowerCallback()
| bool emberAfCommonOkToEnterLowPowerCallback | ( | bool |
enter_em2,
|
| uint32_t |
duration_ms
|
||
| ) |
Application framework Low Power notification Callback.
A callback invoked when the system is about to go sleeping.
- Parameters
-
[in] enter_em2true if the system is about to sleep or false to idle. [in] duration_msDuration of the low power period. Time to the next event.
- Returns
- true if the application allows the system to go to sleep.
◆ emberAfEnergyScanCompleteCallback()
| void emberAfEnergyScanCompleteCallback | ( | int8_t |
mean,
|
| int8_t |
min,
|
||
| int8_t |
max,
|
||
| uint16_t |
variance
|
||
| ) |
Application framework equivalent of emberEnergyScanCompleteHandler .
◆ emberAfFrequencyHoppingStartClientCompleteCallback()
| void emberAfFrequencyHoppingStartClientCompleteCallback | ( | EmberStatus |
status
|
) |
Application framework equivalent of emberFrequencyHoppingStartClientCompleteHandler .
◆ emberAfIncomingBeaconCallback()
| void emberAfIncomingBeaconCallback | ( | EmberPanId |
panId,
|
| EmberMacAddress * |
source,
|
||
| int8_t |
rssi,
|
||
| bool |
permitJoining,
|
||
| uint8_t |
beaconFieldsLength,
|
||
| uint8_t * |
beaconFields,
|
||
| uint8_t |
beaconPayloadLength,
|
||
| uint8_t * |
beaconPayload
|
||
| ) |
Application framework equivalent of emberIncomingBeaconHandler .
◆ emberAfIncomingMacMessageCallback()
| void emberAfIncomingMacMessageCallback | ( | EmberIncomingMacMessage * |
message
|
) |
Application framework equivalent of emberIncomingMacMessageHandler .
◆ emberAfIncomingMessageCallback()
| void emberAfIncomingMessageCallback | ( | EmberIncomingMessage * |
message
|
) |
Application framework equivalent of emberIncomingMessageHandler .
◆ emberAfInitCallback()
| void emberAfInitCallback | ( | void |
|
) |
Application Framework Initialization Callback.
A callback invoked once during the initialization. It is called after the stack and plugins initialization.
◆ emberAfMacMessageSentCallback()
| void emberAfMacMessageSentCallback | ( | EmberStatus |
status,
|
| EmberOutgoingMacMessage * |
message
|
||
| ) |
Application framework equivalent of emberMacMessageSentHandler .
◆ emberAfMarkApplicationBuffersCallback()
| void emberAfMarkApplicationBuffersCallback | ( | void |
|
) |
Application framework equivalent of emberMarkApplicationBuffersHandler .
◆ emberAfMessageSentCallback()
| void emberAfMessageSentCallback | ( | EmberStatus |
status,
|
| EmberOutgoingMessage * |
message
|
||
| ) |
Application framework equivalent of emberMessageSentHandler .
◆ emberAfRadioNeedsCalibratingCallback()
| void emberAfRadioNeedsCalibratingCallback | ( | void |
|
) |
Application framework equivalent of emberRadioNeedsCalibratingHandler .
◆ emberAfStackIdleCallback()
| bool emberAfStackIdleCallback | ( | uint32_t * |
idleTimeMs
|
) |
Application framework equivalent of emberStackIdleHandler .
◆ emberAfStackStatusCallback()
| void emberAfStackStatusCallback | ( | EmberStatus |
status
|
) |
Application framework equivalent of emberStackStatusHandler .
◆ emberAfTickCallback()
| void emberAfTickCallback | ( | void |
|
) |
Application Framework Tick Callback.
A callback invoked in each iteration of the application super loop and can be used to perform periodic functions. The frequency with which this function is called depends on how quickly the main loop runs. If the application blocks at any time during the main loop, this function will not be called until execution resumes.