Application Framework Common#
Application framework common.
Declare all required application framework globals, initialize the Connect stack, and dispatch stack callbacks calls as needed to the application components.
Callbacks#
Application Framework Initialization Callback.
Application Framework Tick Callback.
Application framework equivalent of emberStackStatusHandler.
Application framework equivalent of emberIncomingMessageHandler.
Application framework equivalent of emberIncomingMacMessageHandler.
Application framework equivalent of emberMessageSentHandler.
Application framework equivalent of emberMacMessageSentHandler.
Application framework equivalent of emberChildJoinHandler.
Application framework equivalent of emberActiveScanCompleteHandler.
Application framework equivalent of emberEnergyScanCompleteHandler.
Application framework equivalent of ::emberMarkApplicationBuffersHandler.
Application framework equivalent of emberIncomingBeaconHandler.
Application framework equivalent of emberFrequencyHoppingStartClientCompleteHandler.
Application framework equivalent of emberRadioNeedsCalibratingHandler.
Application framework equivalent of emberStackIdleHandler.
Application framework Low Power notification Callback.
Functions#
Get the last reset cause mask.
Allocate a new event to the app event table.
Callbacks Documentation#
emberAfInitCallback#
void emberAfInitCallback (void )
Application Framework Initialization Callback.
N/A |
A callback invoked once during the initialization. It is called after the stack and plugins initialization.
53
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfTickCallback#
void emberAfTickCallback (void )
Application Framework Tick Callback.
N/A |
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.
64
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfStackStatusCallback#
void emberAfStackStatusCallback (EmberStatus status)
Application framework equivalent of emberStackStatusHandler.
N/A | status |
68
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfIncomingMessageCallback#
void emberAfIncomingMessageCallback (EmberIncomingMessage * message)
Application framework equivalent of emberIncomingMessageHandler.
N/A | message |
72
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfIncomingMacMessageCallback#
void emberAfIncomingMacMessageCallback (EmberIncomingMacMessage * message)
Application framework equivalent of emberIncomingMacMessageHandler.
N/A | message |
76
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfMessageSentCallback#
void emberAfMessageSentCallback (EmberStatus status, EmberOutgoingMessage * message)
Application framework equivalent of emberMessageSentHandler.
N/A | status | |
N/A | message |
80
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfMacMessageSentCallback#
void emberAfMacMessageSentCallback (EmberStatus status, EmberOutgoingMacMessage * message)
Application framework equivalent of emberMacMessageSentHandler.
N/A | status | |
N/A | message |
85
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfChildJoinCallback#
void emberAfChildJoinCallback (EmberNodeType nodeType, EmberNodeId nodeId)
Application framework equivalent of emberChildJoinHandler.
N/A | nodeType | |
N/A | nodeId |
Warnings
Requires the parent support plugin installed.
91
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfActiveScanCompleteCallback#
void emberAfActiveScanCompleteCallback (void )
Application framework equivalent of emberActiveScanCompleteHandler.
N/A |
96
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfEnergyScanCompleteCallback#
void emberAfEnergyScanCompleteCallback (int8_t mean, int8_t min, int8_t max, uint16_t variance)
Application framework equivalent of emberEnergyScanCompleteHandler.
N/A | mean | |
N/A | min | |
N/A | max | |
N/A | variance |
100
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfMarkApplicationBuffersCallback#
void emberAfMarkApplicationBuffersCallback (void )
Application framework equivalent of ::emberMarkApplicationBuffersHandler.
N/A |
107
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
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.
N/A | panId | |
N/A | source | |
N/A | rssi | |
N/A | permitJoining | |
N/A | beaconFieldsLength | |
N/A | beaconFields | |
N/A | beaconPayloadLength | |
N/A | beaconPayload |
111
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfFrequencyHoppingStartClientCompleteCallback#
void emberAfFrequencyHoppingStartClientCompleteCallback (EmberStatus status)
Application framework equivalent of emberFrequencyHoppingStartClientCompleteHandler.
N/A | status |
122
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfRadioNeedsCalibratingCallback#
void emberAfRadioNeedsCalibratingCallback (void )
Application framework equivalent of emberRadioNeedsCalibratingHandler.
N/A |
126
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfStackIdleCallback#
bool emberAfStackIdleCallback (uint32_t * idleTimeMs)
Application framework equivalent of emberStackIdleHandler.
N/A | idleTimeMs |
130
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
emberAfCommonOkToEnterLowPowerCallback#
bool emberAfCommonOkToEnterLowPowerCallback (bool enter_em2, uint32_t duration_ms)
Application framework Low Power notification Callback.
[in] | enter_em2 | true if the system is about to sleep or false to idle. |
[in] | duration_ms | Duration of the low power period. Time to the next event. |
A callback invoked when the system is about to go sleeping.
Returns
true if the application allows the system to go to sleep.
142
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h
Function Documentation#
emberAfGetResetCause#
uint32_t emberAfGetResetCause (void )
Get the last reset cause mask.
N/A |
Returns
A reset cause mask.
Note
This API replaces halGetResetInfo() or halGetExtendedResetInfo. emberAfGetResetCause() is a RMU_ResetCauseGet() overhaul. See the reference manual of the EMLIB RMU for a description of the returned reset cause mask.
62
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_common.h
emberAfAllocateEvent#
EmberStatus emberAfAllocateEvent (EmberEventControl ** control, void(*)(void) handler)
Allocate a new event to the app event table.
[out] | control | The EmberEventControl to allocate |
[in] | handler | Pointer to the handler function associated to the event |
Returns
An EmberStatus value of:
EMBER_SUCCESS if the event was successfully allocated.
EMBER_TABLE_FULL if no more event could be allocated.
See Also
77
of file /mnt/raid/workspaces/ws.Q8qnkBLX2/overlay/gsdk/protocol/flex/app-framework-common/app_framework_common.h