Stack Callbacks#

emberAfIncomingMessageCallback#

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

A callback invoked when receiving a message.

emberAfMarkBuffersCallback#

void emberAfMarkBuffersCallback (void)

A callback that allows marking application buffers.

emberAfIncomingMfgTestMessageCallback#

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

incomingMfgTestMessageHandler

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.

Returns

• Added bytes

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.

emberAfRedirectOutgoingMessageCallback#

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

A callback that allows the app to redirect the packet.

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.

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.

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.

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.

emberAfChildJoinCallback#

void emberAfChildJoinCallback (uint8_t index, bool joining)

Indicates that a child has joined or left.

emberAfDutyCycleCallback#

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

Callback fires when the duty cycle state has changed.

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.

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.

emberAfPollCompleteCallback#

void emberAfPollCompleteCallback (EmberStatus status)

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

emberAfPollCallback#

void emberAfPollCallback (EmberNodeId childId, bool transmitExpected)

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

emberAfDebugCallback#

void emberAfDebugCallback (uint8_t messageLength, uint8_t *messageContents)

debugHandler

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.

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.

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.

emberAfIncomingRouteRecordCallback#

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

Reports the arrival of a route record command frame.

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.

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.

emberAfStackTokenChangedCallback#

void emberAfStackTokenChangedCallback (uint16_t tokenAddress)

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

emberAfTimerCallback#

void emberAfTimerCallback (uint8_t timerId)

A callback from the timer.

emberAfCounterRolloverCallback#

void emberAfCounterRolloverCallback (EmberCounterType type)

This call is fired when a counter exceeds its threshold.

emberAfRawTransmitCompleteCallback#

void emberAfRawTransmitCompleteCallback (EmberMessageBuffer message, EmberStatus status)

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

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.

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.

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.

Returns

• ephemeralPublicKey The generated ephemeral public key.

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().

Returns

• initiatorSmac The calculated value of the initiator's SMAC

• responderSmac The calculated value of the responder's SMAC

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.

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.

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.

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.

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.

Returns

• networkInfo Information about the network.

• deviceInfo Device specific information.

emberAfZllScanCompleteCallback#

void emberAfZllScanCompleteCallback (EmberStatus status)

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

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.

Returns

• addressInfo Address assignment information.

emberAfZllTouchLinkTargetCallback#

void emberAfZllTouchLinkTargetCallback (const EmberZllNetwork *networkInfo)

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

Returns

• networkInfo Information about the network.

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.

emberAfDGpSentCallback#

void emberAfDGpSentCallback (EmberStatus status, uint8_t gpepHandle)

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

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 )

Returns

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

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.

emberAfCounterCallback#

void emberAfCounterCallback (EmberCounterType type, EmberCounterInfo Info)

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

emberAfMacPassthroughFilterCallback#

bool emberAfMacPassthroughFilterCallback (uint8_t *macHeader)

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

Returns

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

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.

Returns

• ephemeralPublicKey The generated ephemeral public key.

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().

Returns

• initiatorSmac The calculated value of the initiator's SMAC

• responderSmac The calculated value of the responder's SMAC

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.

emberAfRtosStackWakeupIsrCallback#

void emberAfRtosStackWakeupIsrCallback (void)

Rtos Stack Wakeup Isr Handler.

emberAfRadioNeedsCalibratingCallback#

void emberAfRadioNeedsCalibratingCallback (void)

RadioNeedsCalibratingHandler.

emberAfScanErrorCallback#

void emberAfScanErrorCallback (EmberStatus status)

scanErrorHandler

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.