Stack Callbacks#

Functions#

void
emberAfIncomingMessageCallback(EmberIncomingMessageType type, EmberApsFrame *apsFrame, EmberMessageBuffer message)

A callback invoked when receiving a message.

void

A callback that allows marking application buffers.

void
emberAfIncomingMfgTestMessageCallback(uint8_t messageType, uint8_t dataLength, uint8_t *data)

incomingMfgTestMessageHandler

uint8_t
emberAfOverrideAppendSourceRouteCallback(EmberNodeId destination, EmberMessageBuffer *header, bool *consumed)

Allow the application to decide if it wants to append a source route to packet header itself.

void
emberAfStackStatusCallback(EmberStatus status)

A callback invoked when the status of the stack changes. If the status parameter equals EMBER_NETWORK_UP, then the getNetworkParameters command can be called to obtain the new network parameters. If any of the parameters are being stored in nonvolatile memory by the Host, the stored values should be updated.

void
emberAfRedirectOutgoingMessageCallback(uint8_t mac_index, EmberMessageBuffer header, uint8_t priority)

A callback that allows the app to redirect the packet.

void
emberAfEnergyScanResultCallback(uint8_t channel, int8_t maxRssiValue)

Reports the result of an energy scan for a single channel. The scan is not complete until the scanCompleteHandler callback is called.

void
emberAfNetworkFoundCallback(EmberZigbeeNetwork *networkFound, uint8_t lqi, int8_t rssi)

Reports that a network was found as a result of a prior call to startScan. Gives the network parameters useful for deciding which network to join.

void
emberAfScanCompleteCallback(uint8_t channel, EmberStatus status)

Returns the status of the current scan of type EMBER_ENERGY_SCAN or EMBER_ACTIVE_SCAN. EMBER_SUCCESS signals that the scan has completed. Other error conditions signify a failure to scan on the channel specified.

void
emberAfUnusedPanIdFoundCallback(EmberPanId panId, uint8_t channel)

This function returns an unused panID and channel pair found via the find unused panId scan procedure.

void
emberAfChildJoinCallback(uint8_t index, bool joining)

Indicates that a child has joined or left.

void
emberAfDutyCycleCallback(uint8_t channelPage, uint8_t channel, EmberDutyCycleState state)

Callback fires when the duty cycle state has changed.

void
emberAfRemoteSetBindingCallback(EmberBindingTableEntry *entry, EmberZdoStatus status)

The NCP used the external binding modification policy to decide how to handle a remote set binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.

void
emberAfRemoteDeleteBindingCallback(uint8_t index, EmberZdoStatus status)

The NCP used the external binding modification policy to decide how to handle a remote delete binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.

void
emberAfPollCompleteCallback(EmberStatus status)

Indicates the result of a data poll to the parent of the local node.

void
emberAfPollCallback(EmberNodeId childId, bool transmitExpected)

Indicates that the local node received a data poll from a child.

void
emberAfDebugCallback(uint8_t messageLength, uint8_t *messageContents)

debugHandler

void
emberAfIncomingManyToOneRouteRequestCallback(EmberNodeId source, EmberEUI64 longId, uint8_t cost)

A callback indicating that a many-to-one route to the concentrator with the given short and long ID is available for use.

void
emberAfIncomingRouteErrorCallback(EmberStatus status, EmberNodeId target)

A callback invoked when a route error message is received. The error indicates that a problem routing to or from the target node was encountered.

void
emberAfIncomingNetworkStatusCallback(uint8_t errorCode, EmberNodeId target)

A callback invoked when a network status/route error message is received. The error indicates that there was a problem sending/receiving messages from the target node.

void
emberAfIncomingRouteRecordCallback(EmberNodeId source, EmberEUI64 sourceEui, uint8_t relayCount, EmberMessageBuffer header, uint8_t relayListIndex)

Reports the arrival of a route record command frame.

void
emberAfIdConflictCallback(EmberNodeId conflictingId)

A callback invoked by the EmberZNet stack when an id conflict is discovered, that is, two different nodes in the network were found to be using the same short id. The stack automatically removes the conflicting short id from its internal tables (address, binding, route, neighbor, and child tables). The application should discontinue any other use of the id.

void
emberAfMacPassthroughMessageCallback(EmberMacPassthroughType messageType, uint8_t lastHopLqi, int8_t lastHopRssi, uint8_t messageLength, uint8_t *messageContents)

A callback invoked by the EmberZNet stack when a MAC passthrough message is received.

void
emberAfStackTokenChangedCallback(uint16_t tokenAddress)

A callback invoked to inform the application that a stack token has changed.

void
emberAfTimerCallback(uint8_t timerId)

A callback from the timer.

void
emberAfCounterRolloverCallback(EmberCounterType type)

This call is fired when a counter exceeds its threshold.

void
emberAfRawTransmitCompleteCallback(EmberMessageBuffer message, EmberStatus status)

A callback invoked by the EmberZNet stack when the MAC has finished transmitting a raw message.

void
emberAfSwitchNetworkKeyCallback(uint8_t sequenceNumber)

A callback to inform the application that the Network Key has been updated and the node has been switched over to use the new key. The actual key being used is not passed up, but the sequence number is.

void
emberAfZigbeeKeyEstablishmentCallback(EmberEUI64 partner, EmberKeyStatus status)

This is a callback that indicates the success or failure of an attempt to establish a key with a partner device.

void
emberAfGenerateCbkeKeysCallback(EmberStatus status, EmberPublicKeyData *ephemeralPublicKey)

A callback by the Crypto Engine indicating that a new ephemeral public/private key pair has been generated. The public/private key pair is stored on the NCP, but only the associated public key is returned to the host. The node's associated certificate is also returned.

void
emberAfCalculateSmacsCallback(EmberStatus status, EmberSmacData *initiatorSmac, EmberSmacData *responderSmac)

A callback to indicate that the NCP has finished calculating the Secure Message Authentication Codes (SMAC) for both the initiator and responder. The associated link key is kept in temporary storage until the host tells the NCP to store or discard the key via emberClearTemporaryDataMaybeStoreLinkKey().

void
emberAfDsaSignCallback(EmberStatus status, uint8_t messageLength, uint8_t *messageContents)

The handler that returns the results of the signing operation. On success, the signature will be appended to the original message (including the signature type indicator that replaced the startIndex field for the signing) and both are returned via this callback.

void
emberAfDsaVerifyCallback(EmberStatus status)

This callback is executed by the stack when the DSA verification has completed and has a result. If the result is EMBER_SUCCESS, the signature is valid. If the result is EMBER_SIGNATURE_VERIFY_FAILURE then the signature is invalid. If the result is anything else then the signature verify operation failed and the validity is unknown.

void
emberAfIncomingBootloadMessageCallback(EmberEUI64 longId, uint8_t lastHopLqi, int8_t lastHopRssi, uint8_t messageLength, uint8_t *messageContents)

A callback invoked by the EmberZNet stack when a bootload message is received.

void
emberAfBootloadTransmitCompleteCallback(EmberStatus status, uint8_t messageLength, uint8_t *messageContents)

A callback invoked by the EmberZNet stack when the MAC has finished transmitting a bootload message.

void
emberAfZllNetworkFoundCallback(bool isDeviceInfoNull, uint8_t lastHopLqi, int8_t lastHopRssi, const EmberZllNetwork *networkInfo, const EmberZllDeviceInfoRecord *deviceInfo)

This callback is invoked when a ZLL network scan finds a ZLL network.

void
emberAfZllScanCompleteCallback(EmberStatus status)

This callback is invoked when a ZLL network scan is complete.

void
emberAfZllAddressAssignmentCallback(uint8_t lastHopLqi, int8_t lastHopRssi, const EmberZllAddressAssignment *addressInfo)

This callback is invoked when network and group addresses are assigned to a remote mode in a network start or network join request.

void
emberAfZllTouchLinkTargetCallback(const EmberZllNetwork *networkInfo)

This callback is invoked when the device is a target of a touch link.

void
emberAfMacFilterMatchMessageCallback(uint8_t filterIndexMatch, EmberMacPassthroughType messageType, uint8_t lastHopLqi, int8_t lastHopRssi, uint8_t messageLength, uint8_t *messageContents)

A callback invoked by the EmberZNet stack when a raw MAC message that has matched one of the application's configured MAC filters.

void
emberAfDGpSentCallback(EmberStatus status, uint8_t gpepHandle)

A callback to the GP endpoint to indicate the result of the GPDF transmission.

EmberStatus
emberAfPanIdConflictCallback(int8_t conflictCount)

This handler is called by the stack to report the number of conflict reports exceeds EMBER_PAN_ID_CONFLICT_REPORT_THRESHOLD within a period of 1 minute )

void

Inform the application that an orphan notification has been received. This is generally not useful for applications. It could be useful in testing and is included for this purpose.

void
emberAfCounterCallback(EmberCounterType type, EmberCounterInfo Info)

This handler is called when the value of a counter has changed.

bool

This handler is called for messages that need to be matched against mac passthrough filter.

void
emberAfGenerateCbkeKeysHandler283k1Callback(EmberStatus status, EmberPublicKey283k1Data *ephemeralPublicKey)

A callback by the Crypto Engine indicating that a new ephemeral public/private key pair has been generated. The public/private key pair is stored on the NCP, but only the associated public key is returned to the host. The node's associated certificate is also returned.

void
emberAfCalculateSmacsHandler283k1Callback(EmberStatus status, EmberSmacData *initiatorSmac, EmberSmacData *responderSmac)

A callback to indicate that the NCP has finished calculating the Secure Message Authentication Codes (SMAC) for both the initiator and responder. The associated link key is kept in temporary storage until the host tells the NCP to store or discard the key via emberClearTemporaryDataMaybeStoreLinkKey().

void
emberAfGpepIncomingMessageCallback(EmberStatus status, uint8_t gpdLink, uint8_t sequenceNumber, EmberGpAddress *addr, EmberGpSecurityLevel gpdfSecurityLevel, EmberGpKeyType gpdfSecurityKeyType, bool autoCommissioning, uint8_t bidirectionalInfo, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint32_t mic, uint8_t proxyTableIndex, uint8_t gpdCommandPayloadLength, uint8_t *gpdCommandPayload)

A callback invoked by the ZigBee GP stack when a GPDF is received.

void

Rtos Stack Wakeup Isr Handler.

void

RadioNeedsCalibratingHandler.

void
emberAfScanErrorCallback(EmberStatus status)

scanErrorHandler

bool
emberAfSupportIncomingMessageCallback(EmberApsFrame *apsFrame)

A callback invoked when receiving a message. Used when AF Support component is enabled on NCP. User can use apsFrame to filter for which ZCL messages they want to process on NCP. If this function returns true then the message is being processed on NCP, otherwise it will be forwarded to the Host.

Function Documentation#

emberAfIncomingMessageCallback#

void emberAfIncomingMessageCallback (EmberIncomingMessageType type, EmberApsFrame * apsFrame, EmberMessageBuffer message)

A callback invoked when receiving a message.

Parameters
N/Atype

Incoming message type

N/AapsFrame

The aps Frame

N/Amessage

message


Definition at line 33 of file app/framework/common/zigbee_app_framework_callback.h

emberAfMarkBuffersCallback#

void emberAfMarkBuffersCallback (void )

A callback that allows marking application buffers.

Parameters
N/A

Definition at line 44 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIncomingMfgTestMessageCallback#

void emberAfIncomingMfgTestMessageCallback (uint8_t messageType, uint8_t dataLength, uint8_t * data)

incomingMfgTestMessageHandler

Parameters
N/AmessageType
N/AdataLength
N/Adata

Definition at line 49 of file app/framework/common/zigbee_app_framework_callback.h

emberAfOverrideAppendSourceRouteCallback#

uint8_t emberAfOverrideAppendSourceRouteCallback (EmberNodeId destination, EmberMessageBuffer * header, bool * consumed)

Allow the application to decide if it wants to append a source route to packet header itself.

Parameters
N/Adestination
N/Aheader
N/Aconsumed

Returns

  • Added bytes


Definition at line 61 of file app/framework/common/zigbee_app_framework_callback.h

emberAfStackStatusCallback#

void emberAfStackStatusCallback (EmberStatus status)

A callback invoked when the status of the stack changes. If the status parameter equals EMBER_NETWORK_UP, then the getNetworkParameters command can be called to obtain the new network parameters. If any of the parameters are being stored in nonvolatile memory by the Host, the stored values should be updated.

Parameters
N/Astatus

Stack status


Definition at line 76 of file app/framework/common/zigbee_app_framework_callback.h

emberAfRedirectOutgoingMessageCallback#

void emberAfRedirectOutgoingMessageCallback (uint8_t mac_index, EmberMessageBuffer header, uint8_t priority)

A callback that allows the app to redirect the packet.

Parameters
N/Amac_index

The mac index used to redirect messages

N/Aheader

Packet buffer header

N/Apriority

Transmit priority


Definition at line 86 of file app/framework/common/zigbee_app_framework_callback.h

emberAfEnergyScanResultCallback#

void emberAfEnergyScanResultCallback (uint8_t channel, int8_t maxRssiValue)

Reports the result of an energy scan for a single channel. The scan is not complete until the scanCompleteHandler callback is called.

Parameters
N/Achannel

The 802.15.4 channel number that was scanned.

N/AmaxRssiValue

The maximum RSSI value found on the channel.


Definition at line 100 of file app/framework/common/zigbee_app_framework_callback.h

emberAfNetworkFoundCallback#

void emberAfNetworkFoundCallback (EmberZigbeeNetwork * networkFound, uint8_t lqi, int8_t rssi)

Reports that a network was found as a result of a prior call to startScan. Gives the network parameters useful for deciding which network to join.

Parameters
N/AnetworkFound

The parameters associated with the network found.

N/Alqi

The link quality indication of the network found.

N/Arssi

The received signal strength indication of the network found.


Definition at line 113 of file app/framework/common/zigbee_app_framework_callback.h

emberAfScanCompleteCallback#

void emberAfScanCompleteCallback (uint8_t channel, EmberStatus status)

Returns the status of the current scan of type EMBER_ENERGY_SCAN or EMBER_ACTIVE_SCAN. EMBER_SUCCESS signals that the scan has completed. Other error conditions signify a failure to scan on the channel specified.

Parameters
N/Achannel

The channel on which the current error occurred. Undefined for the case of EMBER_SUCCESS.

N/Astatus

The error condition that occurred on the current channel. Value will be EMBER_SUCCESS when the scan has completed.


Definition at line 130 of file app/framework/common/zigbee_app_framework_callback.h

emberAfUnusedPanIdFoundCallback#

void emberAfUnusedPanIdFoundCallback (EmberPanId panId, uint8_t channel)

This function returns an unused panID and channel pair found via the find unused panId scan procedure.

Parameters
N/ApanId

The unused panID which has been found.

N/Achannel

The channel that the unused panID was found on.


Definition at line 144 of file app/framework/common/zigbee_app_framework_callback.h

emberAfChildJoinCallback#

void emberAfChildJoinCallback (uint8_t index, bool joining)

Indicates that a child has joined or left.

Parameters
N/Aindex

The index of the child of interest.

N/Ajoining

True if the child is joining. False the child is leaving.


Definition at line 155 of file app/framework/common/zigbee_app_framework_callback.h

emberAfDutyCycleCallback#

void emberAfDutyCycleCallback (uint8_t channelPage, uint8_t channel, EmberDutyCycleState state)

Callback fires when the duty cycle state has changed.

Parameters
N/AchannelPage

The channel page whose duty cycle state has changed.

N/Achannel

The channel number whose duty cycle state has changed.

N/Astate

The current duty cycle state.


Definition at line 167 of file app/framework/common/zigbee_app_framework_callback.h

emberAfRemoteSetBindingCallback#

void emberAfRemoteSetBindingCallback (EmberBindingTableEntry * entry, EmberZdoStatus status)

The NCP used the external binding modification policy to decide how to handle a remote set binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.

Parameters
N/Aentry

The contents of the binding entry.

N/Astatus

ZDO status.


Definition at line 182 of file app/framework/common/zigbee_app_framework_callback.h

emberAfRemoteDeleteBindingCallback#

void emberAfRemoteDeleteBindingCallback (uint8_t index, EmberZdoStatus status)

The NCP used the external binding modification policy to decide how to handle a remote delete binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.

Parameters
N/Aindex

The index of the binding whose deletion was requested.

N/Astatus

ZDO status


Definition at line 195 of file app/framework/common/zigbee_app_framework_callback.h

emberAfPollCompleteCallback#

void emberAfPollCompleteCallback (EmberStatus status)

Indicates the result of a data poll to the parent of the local node.

Parameters
N/Astatus

An EmberStatus value: EMBER_SUCCESS - Data was received in response to the poll. EMBER_MAC_NO_DATA - No data was pending. EMBER_DELIVERY_FAILED - The poll message could not be sent. EMBER_MAC_NO_ACK_RECEIVED - The poll message was sent but not acknowledged by the parent.


Definition at line 209 of file app/framework/common/zigbee_app_framework_callback.h

emberAfPollCallback#

void emberAfPollCallback (EmberNodeId childId, bool transmitExpected)

Indicates that the local node received a data poll from a child.

Parameters
N/AchildId

The node ID of the child that is requesting data.

N/AtransmitExpected

True if transmit expected, false otherwise.


Definition at line 222 of file app/framework/common/zigbee_app_framework_callback.h

emberAfDebugCallback#

void emberAfDebugCallback (uint8_t messageLength, uint8_t * messageContents)

debugHandler

Parameters
N/AmessageLength

debug message length

N/AmessageContents

debug message


Definition at line 233 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIncomingManyToOneRouteRequestCallback#

void emberAfIncomingManyToOneRouteRequestCallback (EmberNodeId source, EmberEUI64 longId, uint8_t cost)

A callback indicating that a many-to-one route to the concentrator with the given short and long ID is available for use.

Parameters
N/Asource

The short id of the concentrator.

N/AlongId

The EUI64 of the concentrator.

N/Acost

The path cost to the concentrator. The cost may decrease as additional route request packets for this discovery arrive, but the callback is made only once.


Definition at line 248 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIncomingRouteErrorCallback#

void emberAfIncomingRouteErrorCallback (EmberStatus status, EmberNodeId target)

A callback invoked when a route error message is received. The error indicates that a problem routing to or from the target node was encountered.

Parameters
N/Astatus

EMBER_SOURCE_ROUTE_FAILURE or EMBER_MANY_TO_ONE_ROUTE_FAILURE.

N/Atarget

The short id of the remote node.


Definition at line 264 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIncomingNetworkStatusCallback#

void emberAfIncomingNetworkStatusCallback (uint8_t errorCode, EmberNodeId target)

A callback invoked when a network status/route error message is received. The error indicates that there was a problem sending/receiving messages from the target node.

Parameters
N/AerrorCode

One byte over-the-air error code from network status message

N/Atarget

The short ID of the remote node


Definition at line 277 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIncomingRouteRecordCallback#

void emberAfIncomingRouteRecordCallback (EmberNodeId source, EmberEUI64 sourceEui, uint8_t relayCount, EmberMessageBuffer header, uint8_t relayListIndex)

Reports the arrival of a route record command frame.

Parameters
N/Asource

The source of the route record.

N/AsourceEui

The EUI64 of the source.

N/ArelayCount

The number of relays in relayList.

N/Aheader

Header.

N/ArelayListIndex

The relay List Index.


Definition at line 291 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIdConflictCallback#

void emberAfIdConflictCallback (EmberNodeId conflictingId)

A callback invoked by the EmberZNet stack when an id conflict is discovered, that is, two different nodes in the network were found to be using the same short id. The stack automatically removes the conflicting short id from its internal tables (address, binding, route, neighbor, and child tables). The application should discontinue any other use of the id.

Parameters
N/AconflictingId

The short id for which a conflict was detected


Definition at line 311 of file app/framework/common/zigbee_app_framework_callback.h

emberAfMacPassthroughMessageCallback#

void emberAfMacPassthroughMessageCallback (EmberMacPassthroughType messageType, uint8_t lastHopLqi, int8_t lastHopRssi, uint8_t messageLength, uint8_t * messageContents)

A callback invoked by the EmberZNet stack when a MAC passthrough message is received.

Parameters
N/AmessageType

The type of MAC passthrough message received.

N/AlastHopLqi

last hop LQI.

N/AlastHopRssi

last hop RSSI.

N/AmessageLength

message length.

N/AmessageContents

The raw message that was received.


Definition at line 324 of file app/framework/common/zigbee_app_framework_callback.h

emberAfStackTokenChangedCallback#

void emberAfStackTokenChangedCallback (uint16_t tokenAddress)

A callback invoked to inform the application that a stack token has changed.

Parameters
N/AtokenAddress

The address of the stack token that has changed.


Definition at line 340 of file app/framework/common/zigbee_app_framework_callback.h

emberAfTimerCallback#

void emberAfTimerCallback (uint8_t timerId)

A callback from the timer.

Parameters
N/AtimerId

Which timer generated the callback (0 or 1).


Definition at line 348 of file app/framework/common/zigbee_app_framework_callback.h

emberAfCounterRolloverCallback#

void emberAfCounterRolloverCallback (EmberCounterType type)

This call is fired when a counter exceeds its threshold.

Parameters
N/Atype

Type of Counter


Definition at line 356 of file app/framework/common/zigbee_app_framework_callback.h

emberAfRawTransmitCompleteCallback#

void emberAfRawTransmitCompleteCallback (EmberMessageBuffer message, EmberStatus status)

A callback invoked by the EmberZNet stack when the MAC has finished transmitting a raw message.

Parameters
N/Amessage

message, message always returns EMBER_NULL_MESSAGE_BUFFER on host

N/Astatus

EMBER_SUCCESS if the transmission was successful, or EMBER_DELIVERY_FAILED if not


Definition at line 368 of file app/framework/common/zigbee_app_framework_callback.h

emberAfSwitchNetworkKeyCallback#

void emberAfSwitchNetworkKeyCallback (uint8_t sequenceNumber)

A callback to inform the application that the Network Key has been updated and the node has been switched over to use the new key. The actual key being used is not passed up, but the sequence number is.

Parameters
N/AsequenceNumber

The sequence number of the new network key.


Definition at line 381 of file app/framework/common/zigbee_app_framework_callback.h

emberAfZigbeeKeyEstablishmentCallback#

void emberAfZigbeeKeyEstablishmentCallback (EmberEUI64 partner, EmberKeyStatus status)

This is a callback that indicates the success or failure of an attempt to establish a key with a partner device.

Parameters
N/Apartner

This is the IEEE address of the partner that the device successfully established a key with. This value is all zeros on a failure.

N/Astatus

This is the status indicating what was established or why the key establishment failed.


Definition at line 393 of file app/framework/common/zigbee_app_framework_callback.h

emberAfGenerateCbkeKeysCallback#

void emberAfGenerateCbkeKeysCallback (EmberStatus status, EmberPublicKeyData * ephemeralPublicKey)

A callback by the Crypto Engine indicating that a new ephemeral public/private key pair has been generated. The public/private key pair is stored on the NCP, but only the associated public key is returned to the host. The node's associated certificate is also returned.

Parameters
N/Astatus

The result of the CBKE operation.

N/AephemeralPublicKey

Returns

  • ephemeralPublicKey The generated ephemeral public key.


Definition at line 409 of file app/framework/common/zigbee_app_framework_callback.h

emberAfCalculateSmacsCallback#

void emberAfCalculateSmacsCallback (EmberStatus status, EmberSmacData * initiatorSmac, EmberSmacData * responderSmac)

A callback to indicate that the NCP has finished calculating the Secure Message Authentication Codes (SMAC) for both the initiator and responder. The associated link key is kept in temporary storage until the host tells the NCP to store or discard the key via emberClearTemporaryDataMaybeStoreLinkKey().

Parameters
N/Astatus

The Result of the CBKE operation.

N/AinitiatorSmac
N/AresponderSmac

Returns

  • initiatorSmac The calculated value of the initiator's SMAC

  • responderSmac The calculated value of the responder's SMAC


Definition at line 424 of file app/framework/common/zigbee_app_framework_callback.h

emberAfDsaSignCallback#

void emberAfDsaSignCallback (EmberStatus status, uint8_t messageLength, uint8_t * messageContents)

The handler that returns the results of the signing operation. On success, the signature will be appended to the original message (including the signature type indicator that replaced the startIndex field for the signing) and both are returned via this callback.

Parameters
N/Astatus

The result of the DSA signing operation.

N/AmessageLength

The length of message.

N/AmessageContents

The message and attached which includes the original message and the appended signature.


Definition at line 442 of file app/framework/common/zigbee_app_framework_callback.h

emberAfDsaVerifyCallback#

void emberAfDsaVerifyCallback (EmberStatus status)

This callback is executed by the stack when the DSA verification has completed and has a result. If the result is EMBER_SUCCESS, the signature is valid. If the result is EMBER_SIGNATURE_VERIFY_FAILURE then the signature is invalid. If the result is anything else then the signature verify operation failed and the validity is unknown.

Parameters
N/Astatus

The result of the DSA verification operation.


Definition at line 459 of file app/framework/common/zigbee_app_framework_callback.h

emberAfIncomingBootloadMessageCallback#

void emberAfIncomingBootloadMessageCallback (EmberEUI64 longId, uint8_t lastHopLqi, int8_t lastHopRssi, uint8_t messageLength, uint8_t * messageContents)

A callback invoked by the EmberZNet stack when a bootload message is received.

Parameters
N/AlongId

The EUI64 of the sending node.

N/AlastHopLqi

last hop LQI.

N/AlastHopRssi

last hop RSSI.

N/AmessageLength

message length.

N/AmessageContents

The bootload message that was sent.


Definition at line 471 of file app/framework/common/zigbee_app_framework_callback.h

emberAfBootloadTransmitCompleteCallback#

void emberAfBootloadTransmitCompleteCallback (EmberStatus status, uint8_t messageLength, uint8_t * messageContents)

A callback invoked by the EmberZNet stack when the MAC has finished transmitting a bootload message.

Parameters
N/Astatus

An EmberStatus value of EMBER_SUCCESS if an ACK was received from the destination or EMBER_DELIVERY_FAILED if no ACK was received.

N/AmessageLength

message length.

N/AmessageContents

The bootload message that was sent.


Definition at line 491 of file app/framework/common/zigbee_app_framework_callback.h

emberAfZllNetworkFoundCallback#

void emberAfZllNetworkFoundCallback (bool isDeviceInfoNull, uint8_t lastHopLqi, int8_t lastHopRssi, const EmberZllNetwork * networkInfo, const EmberZllDeviceInfoRecord * deviceInfo)

This callback is invoked when a ZLL network scan finds a ZLL network.

Parameters
N/AisDeviceInfoNull

Used to interpret deviceInfo field.

N/AlastHopLqi

The link quality from the node that last relayed the message.

N/AlastHopRssi

The energy level (in units of dBm) observed during reception.

N/AnetworkInfo
N/AdeviceInfo

Returns

  • networkInfo Information about the network.

  • deviceInfo Device specific information.


Definition at line 510 of file app/framework/common/zigbee_app_framework_callback.h

emberAfZllScanCompleteCallback#

void emberAfZllScanCompleteCallback (EmberStatus status)

This callback is invoked when a ZLL network scan is complete.

Parameters
N/Astatus

Status of the operation.


Definition at line 526 of file app/framework/common/zigbee_app_framework_callback.h

emberAfZllAddressAssignmentCallback#

void emberAfZllAddressAssignmentCallback (uint8_t lastHopLqi, int8_t lastHopRssi, const EmberZllAddressAssignment * addressInfo)

This callback is invoked when network and group addresses are assigned to a remote mode in a network start or network join request.

Parameters
N/AlastHopLqi

The link quality from the node that last relayed the message.

N/AlastHopRssi

The energy level (in units of dBm) observed during reception.

N/AaddressInfo

Returns

  • addressInfo Address assignment information.


Definition at line 539 of file app/framework/common/zigbee_app_framework_callback.h

emberAfZllTouchLinkTargetCallback#

void emberAfZllTouchLinkTargetCallback (const EmberZllNetwork * networkInfo)

This callback is invoked when the device is a target of a touch link.

Parameters
N/AnetworkInfo

Returns

  • networkInfo Information about the network.


Definition at line 551 of file app/framework/common/zigbee_app_framework_callback.h

emberAfMacFilterMatchMessageCallback#

void emberAfMacFilterMatchMessageCallback (uint8_t filterIndexMatch, EmberMacPassthroughType messageType, uint8_t lastHopLqi, int8_t lastHopRssi, uint8_t messageLength, uint8_t * messageContents)

A callback invoked by the EmberZNet stack when a raw MAC message that has matched one of the application's configured MAC filters.

Parameters
N/AfilterIndexMatch

filter index match.

N/AmessageType

message type.

N/AlastHopLqi

last hop LQI.

N/AlastHopRssi

last hop RSSI.

N/AmessageLength

message length.

N/AmessageContents

message contents.


Definition at line 565 of file app/framework/common/zigbee_app_framework_callback.h

emberAfDGpSentCallback#

void emberAfDGpSentCallback (EmberStatus status, uint8_t gpepHandle)

A callback to the GP endpoint to indicate the result of the GPDF transmission.

Parameters
N/Astatus

An EmberStatus value indicating success or the reason for failure.

N/AgpepHandle

The handle of the GPDF.


Definition at line 585 of file app/framework/common/zigbee_app_framework_callback.h

emberAfPanIdConflictCallback#

EmberStatus emberAfPanIdConflictCallback (int8_t conflictCount)

This handler is called by the stack to report the number of conflict reports exceeds EMBER_PAN_ID_CONFLICT_REPORT_THRESHOLD within a period of 1 minute )

Parameters
N/AconflictCount

Returns

  • An EmberStatus value indicating success or the reason for failure.


Definition at line 597 of file app/framework/common/zigbee_app_framework_callback.h

emberAfOrphanNotificationCallback#

void emberAfOrphanNotificationCallback (EmberEUI64 longId)

Inform the application that an orphan notification has been received. This is generally not useful for applications. It could be useful in testing and is included for this purpose.

Parameters
N/AlongId

The 8 byte EUI64 of the sender.


Definition at line 607 of file app/framework/common/zigbee_app_framework_callback.h

emberAfCounterCallback#

void emberAfCounterCallback (EmberCounterType type, EmberCounterInfo Info)

This handler is called when the value of a counter has changed.

Parameters
N/Atype

Type of Counter

N/AInfo

Counter Info and value


Definition at line 616 of file app/framework/common/zigbee_app_framework_callback.h

emberAfMacPassthroughFilterCallback#

bool emberAfMacPassthroughFilterCallback (uint8_t * macHeader)

This handler is called for messages that need to be matched against mac passthrough filter.

Parameters
N/AmacHeader

Returns

  • True if mac passthrough filter was matched. False otherwise.


Definition at line 628 of file app/framework/common/zigbee_app_framework_callback.h

emberAfGenerateCbkeKeysHandler283k1Callback#

void emberAfGenerateCbkeKeysHandler283k1Callback (EmberStatus status, EmberPublicKey283k1Data * ephemeralPublicKey)

A callback by the Crypto Engine indicating that a new ephemeral public/private key pair has been generated. The public/private key pair is stored on the NCP, but only the associated public key is returned to the host. The node's associated certificate is also returned.

Parameters
N/Astatus

The result of the CBKE operation.

N/AephemeralPublicKey

Returns

  • ephemeralPublicKey The generated ephemeral public key.


Definition at line 640 of file app/framework/common/zigbee_app_framework_callback.h

emberAfCalculateSmacsHandler283k1Callback#

void emberAfCalculateSmacsHandler283k1Callback (EmberStatus status, EmberSmacData * initiatorSmac, EmberSmacData * responderSmac)

A callback to indicate that the NCP has finished calculating the Secure Message Authentication Codes (SMAC) for both the initiator and responder. The associated link key is kept in temporary storage until the host tells the NCP to store or discard the key via emberClearTemporaryDataMaybeStoreLinkKey().

Parameters
N/Astatus

The Result of the CBKE operation.

N/AinitiatorSmac
N/AresponderSmac

Returns

  • initiatorSmac The calculated value of the initiator's SMAC

  • responderSmac The calculated value of the responder's SMAC


Definition at line 655 of file app/framework/common/zigbee_app_framework_callback.h

emberAfGpepIncomingMessageCallback#

void emberAfGpepIncomingMessageCallback (EmberStatus status, uint8_t gpdLink, uint8_t sequenceNumber, EmberGpAddress * addr, EmberGpSecurityLevel gpdfSecurityLevel, EmberGpKeyType gpdfSecurityKeyType, bool autoCommissioning, uint8_t bidirectionalInfo, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint32_t mic, uint8_t proxyTableIndex, uint8_t gpdCommandPayloadLength, uint8_t * gpdCommandPayload)

A callback invoked by the ZigBee GP stack when a GPDF is received.

Parameters
N/Astatus

The status of the GPDF receive.

N/AgpdLink

The gpdLink value of the received GPDF.

N/AsequenceNumber

The GPDF sequence number.

N/Aaddr

The address of the source GPD.

N/AgpdfSecurityLevel

The security level of the received GPDF.

N/AgpdfSecurityKeyType

The securityKeyType used to decrypt/authenticate the incoming GPDF.

N/AautoCommissioning

Whether the incoming GPDF had the auto-commissioning bit set.

N/AbidirectionalInfo

Bidirectional information represented in bitfields, where bit0 holds the rxAfterTx of incoming gpdf and bit1 holds if tx queue is available for outgoing gpdf.

N/AgpdSecurityFrameCounter

The security frame counter of the incoming GDPF.

N/AgpdCommandId

The gpdCommandId of the incoming GPDF.

N/Amic

The received MIC of the GPDF.

N/AproxyTableIndex

The proxy table index of the corresponding proxy table entry to the incoming GPDF.

N/AgpdCommandPayloadLength

The length of the GPD command payload.

N/AgpdCommandPayload

The GPD command payload.


Definition at line 686 of file app/framework/common/zigbee_app_framework_callback.h

emberAfRtosStackWakeupIsrCallback#

void emberAfRtosStackWakeupIsrCallback (void )

Rtos Stack Wakeup Isr Handler.

Parameters
N/A

Definition at line 722 of file app/framework/common/zigbee_app_framework_callback.h

emberAfRadioNeedsCalibratingCallback#

void emberAfRadioNeedsCalibratingCallback (void )

RadioNeedsCalibratingHandler.

Parameters
N/A

Definition at line 727 of file app/framework/common/zigbee_app_framework_callback.h

emberAfScanErrorCallback#

void emberAfScanErrorCallback (EmberStatus status)

scanErrorHandler

Parameters
N/Astatus

The error status of a scan


Definition at line 733 of file app/framework/common/zigbee_app_framework_callback.h

emberAfSupportIncomingMessageCallback#

bool emberAfSupportIncomingMessageCallback (EmberApsFrame * apsFrame)

A callback invoked when receiving a message. Used when AF Support component is enabled on NCP. User can use apsFrame to filter for which ZCL messages they want to process on NCP. If this function returns true then the message is being processed on NCP, otherwise it will be forwarded to the Host.

Parameters
N/AapsFrame

The aps Frame


Definition at line 745 of file app/framework/common/zigbee_app_framework_callback.h