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#

void

Application Framework Initialization Callback.

void

Application Framework Tick Callback.

void
emberAfStackStatusCallback(EmberStatus status)

Application framework equivalent of emberStackStatusHandler.

void
emberAfIncomingMessageCallback(EmberIncomingMessage *message)

Application framework equivalent of emberIncomingMessageHandler.

void
emberAfIncomingMacMessageCallback(EmberIncomingMacMessage *message)

Application framework equivalent of emberIncomingMacMessageHandler.

void
emberAfMessageSentCallback(EmberStatus status, EmberOutgoingMessage *message)

Application framework equivalent of emberMessageSentHandler.

void
emberAfMacMessageSentCallback(EmberStatus status, EmberOutgoingMacMessage *message)

Application framework equivalent of emberMacMessageSentHandler.

void
emberAfChildJoinCallback(EmberNodeType nodeType, EmberNodeId nodeId)

Application framework equivalent of emberChildJoinHandler.

void

Application framework equivalent of emberActiveScanCompleteHandler.

void
emberAfEnergyScanCompleteCallback(int8_t mean, int8_t min, int8_t max, uint16_t variance)

Application framework equivalent of emberEnergyScanCompleteHandler.

void

Application framework equivalent of ::emberMarkApplicationBuffersHandler.

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.

void
bool
emberAfStackIdleCallback(uint32_t *idleTimeMs)

Application framework equivalent of emberStackIdleHandler.

bool
emberAfCommonOkToEnterLowPowerCallback(bool enter_em2, uint32_t duration_ms)

Application framework Low Power notification Callback.

Functions#

uint32_t

Get the last reset cause mask.

emberAfAllocateEvent(EmberEventControl **control, void(*handler)(void))

Allocate a new event to the app event table.

Callbacks Documentation#

emberAfInitCallback#

void emberAfInitCallback (void)

Application Framework Initialization Callback.

Parameters
N/A

A callback invoked once during the initialization. It is called after the stack and plugins initialization.


Definition at line 53 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfTickCallback#

void emberAfTickCallback (void)

Application Framework Tick Callback.

Parameters
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.


Definition at line 64 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfStackStatusCallback#

void emberAfStackStatusCallback (EmberStatus status)

Application framework equivalent of emberStackStatusHandler.

Parameters
N/Astatus

Definition at line 68 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfIncomingMessageCallback#

void emberAfIncomingMessageCallback (EmberIncomingMessage *message)

Application framework equivalent of emberIncomingMessageHandler.

Parameters
N/Amessage

Definition at line 72 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfIncomingMacMessageCallback#

void emberAfIncomingMacMessageCallback (EmberIncomingMacMessage *message)

Application framework equivalent of emberIncomingMacMessageHandler.

Parameters
N/Amessage

Definition at line 76 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfMessageSentCallback#

void emberAfMessageSentCallback (EmberStatus status, EmberOutgoingMessage *message)

Application framework equivalent of emberMessageSentHandler.

Parameters
N/Astatus
N/Amessage

Definition at line 80 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfMacMessageSentCallback#

void emberAfMacMessageSentCallback (EmberStatus status, EmberOutgoingMacMessage *message)

Application framework equivalent of emberMacMessageSentHandler.

Parameters
N/Astatus
N/Amessage

Definition at line 85 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfChildJoinCallback#

void emberAfChildJoinCallback (EmberNodeType nodeType, EmberNodeId nodeId)

Application framework equivalent of emberChildJoinHandler.

Parameters
N/AnodeType
N/AnodeId

Warnings

  • Requires the parent support plugin installed.


Definition at line 91 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfActiveScanCompleteCallback#

void emberAfActiveScanCompleteCallback (void)

Application framework equivalent of emberActiveScanCompleteHandler.

Parameters
N/A

Definition at line 96 of file /mnt/raid/workspaces/ws.04isO4uyE/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.

Parameters
N/Amean
N/Amin
N/Amax
N/Avariance

Definition at line 100 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfMarkApplicationBuffersCallback#

void emberAfMarkApplicationBuffersCallback (void)

Application framework equivalent of ::emberMarkApplicationBuffersHandler.

Parameters
N/A

Definition at line 107 of file /mnt/raid/workspaces/ws.04isO4uyE/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.

Parameters
N/ApanId
N/Asource
N/Arssi
N/ApermitJoining
N/AbeaconFieldsLength
N/AbeaconFields
N/AbeaconPayloadLength
N/AbeaconPayload

Definition at line 111 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfFrequencyHoppingStartClientCompleteCallback#

void emberAfFrequencyHoppingStartClientCompleteCallback (EmberStatus status)

Application framework equivalent of emberFrequencyHoppingStartClientCompleteHandler.

Parameters
N/Astatus

Definition at line 122 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfRadioNeedsCalibratingCallback#

void emberAfRadioNeedsCalibratingCallback (void)

Application framework equivalent of emberRadioNeedsCalibratingHandler.

Parameters
N/A

Definition at line 126 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

emberAfStackIdleCallback#

bool emberAfStackIdleCallback (uint32_t *idleTimeMs)

Application framework equivalent of emberStackIdleHandler.

Parameters
N/AidleTimeMs

Definition at line 130 of file /mnt/raid/workspaces/ws.04isO4uyE/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.

Parameters
[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.


Definition at line 142 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_callback.h

Function Documentation#

emberAfGetResetCause#

uint32_t emberAfGetResetCause (void)

Get the last reset cause mask.

Parameters
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.


Definition at line 62 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_common.h

emberAfAllocateEvent#

EmberStatus emberAfAllocateEvent (EmberEventControl **control, void(*handler)(void))

Allocate a new event to the app event table.

Parameters
[out]control

The EmberEventControl to allocate

[in]handler

Pointer to the handler function associated to the event

Returns

See Also


Definition at line 77 of file /mnt/raid/workspaces/ws.04isO4uyE/overlay/gsdk/protocol/flex/app-framework-common/app_framework_common.h