Stack Callbacks#

sl_zigbee_af_incoming_message_cb#

void sl_zigbee_af_incoming_message_cb (sl_zigbee_incoming_message_type_t type, sl_zigbee_aps_frame_t * apsFrame, sl_zigbee_rx_packet_info_t * packetInfo, uint8_t messageLength, uint8_t * message)

A callback invoked when receiving a message.

sl_zigbee_af_mark_buffers_cb#

void sl_zigbee_af_mark_buffers_cb (void )

A callback that allows marking application buffers.

sl_zigbee_af_incoming_mfg_test_message_cb#

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

incomingMfgTestMessageHandler

sl_zigbee_af_override_append_source_route_cb#

uint8_t sl_zigbee_af_override_append_source_route_cb (sl_802154_short_addr_t destination, sli_buffer_manager_buffer_t * header, bool * consumed)

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

Returns

• Added bytes

sl_zigbee_af_stack_status_cb#

void sl_zigbee_af_stack_status_cb (sl_status_t status)

A callback invoked when the status of the stack changes. If the status parameter equals SL_STATUS_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.

sl_zigbee_af_redirect_outgoing_message_cb#

void sl_zigbee_af_redirect_outgoing_message_cb (uint8_t mac_index, uint8_t packet_length, uint8_t * packet_contents, uint8_t priority)

A callback that allows the app to redirect the packet.

sl_zigbee_af_energy_scan_result_cb#

void sl_zigbee_af_energy_scan_result_cb (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.

sl_zigbee_af_network_found_cb#

void sl_zigbee_af_network_found_cb (sl_zigbee_zigbee_network_t * 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.

sl_zigbee_af_scan_complete_cb#

void sl_zigbee_af_scan_complete_cb (uint8_t channel, sl_status_t status)

Returns the status of the current scan of type SL_ZIGBEE_ENERGY_SCAN or SL_ZIGBEE_ACTIVE_SCAN. SL_STATUS_OK signals that the scan has completed. Other error conditions signify a failure to scan on the channel specified.

sl_zigbee_af_unused_pan_id_found_cb#

void sl_zigbee_af_unused_pan_id_found_cb (sl_802154_pan_id_t panId, uint8_t channel)

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

sl_zigbee_af_child_join_cb#

void sl_zigbee_af_child_join_cb (uint8_t index, bool joining, sl_802154_short_addr_t childId, sl_802154_long_addr_t childEui64, sl_zigbee_node_type_t childType)

Indicates that a child has joined or left.

sl_zigbee_af_duty_cycle_cb#

void sl_zigbee_af_duty_cycle_cb (uint8_t channelPage, uint8_t channel, sl_zigbee_duty_cycle_state_t state, uint8_t totalDevices, sl_zigbee_per_device_duty_cycle_t * arrayOfDeviceDutyCycles)

Callback fires when the duty cycle state has changed.

sl_zigbee_af_remote_set_binding_cb#

void sl_zigbee_af_remote_set_binding_cb (sl_zigbee_binding_table_entry_t * entry, sl_zigbee_zdo_status_t 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.

sl_zigbee_af_remote_delete_binding_cb#

void sl_zigbee_af_remote_delete_binding_cb (uint8_t index, sl_zigbee_zdo_status_t 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.

sl_zigbee_af_poll_complete_cb#

void sl_zigbee_af_poll_complete_cb (sl_status_t status)

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

sl_zigbee_af_poll_cb#

void sl_zigbee_af_poll_cb (sl_802154_short_addr_t childId, bool transmitExpected)

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

sl_zigbee_af_debug_cb#

void sl_zigbee_af_debug_cb (uint8_t messageLength, uint8_t * messageContents)

debugHandler

sl_zigbee_af_incoming_many_to_one_route_request_cb#

void sl_zigbee_af_incoming_many_to_one_route_request_cb (sl_802154_short_addr_t source, sl_802154_long_addr_t 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.

sl_zigbee_af_incoming_route_error_cb#

void sl_zigbee_af_incoming_route_error_cb (sl_status_t status, sl_802154_short_addr_t 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.

sl_zigbee_af_incoming_network_status_cb#

void sl_zigbee_af_incoming_network_status_cb (uint8_t errorCode, sl_802154_short_addr_t 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.

sl_zigbee_af_incoming_route_record_cb#

void sl_zigbee_af_incoming_route_record_cb (sl_zigbee_rx_packet_info_t * packetInfo, uint8_t relayCount, uint8_t * relayList, relayListIndex)

Reports the arrival of a route record command frame.

sl_zigbee_af_id_conflict_cb#

void sl_zigbee_af_id_conflict_cb (sl_802154_short_addr_t 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.

sl_zigbee_af_mac_passthrough_message_cb#

void sl_zigbee_af_mac_passthrough_message_cb (sl_zigbee_mac_passthrough_type_t messageType, sl_zigbee_rx_packet_info_t * packetInfo, uint8_t messageLength, uint8_t * messageContents)

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

sl_zigbee_af_stack_token_changed_cb#

void sl_zigbee_af_stack_token_changed_cb (uint16_t tokenAddress)

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

sl_zigbee_af_timer_cb#

void sl_zigbee_af_timer_cb (uint8_t timerId)

A callback from the timer.

sl_zigbee_af_counter_rollover_cb#

void sl_zigbee_af_counter_rollover_cb (sl_zigbee_counter_type_t type)

This call is fired when a counter exceeds its threshold.

sl_zigbee_af_raw_transmit_complete_cb#

void sl_zigbee_af_raw_transmit_complete_cb (uint8_t messageLength, uint8_t * messageContents, sl_status_t status)

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

sl_zigbee_af_switch_network_key_cb#

void sl_zigbee_af_switch_network_key_cb (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.

sl_zigbee_af_zigbee_key_establishment_cb#

void sl_zigbee_af_zigbee_key_establishment_cb (sl_802154_long_addr_t partner, sl_zigbee_key_status_t status)

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

sl_zigbee_af_generate_cbke_keys_cb#

void sl_zigbee_af_generate_cbke_keys_cb (sl_status_t status, sl_zigbee_public_key_data_t * 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.

sl_zigbee_af_calculate_smacs_cb#

void sl_zigbee_af_calculate_smacs_cb (sl_status_t status, sl_zigbee_smac_data_t * initiatorSmac, sl_zigbee_smac_data_t * 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 sl_zigbee_clear_temporary_data_maybe_store_link_key().

Returns

• initiatorSmac The calculated value of the initiator's SMAC

• responderSmac The calculated value of the responder's SMAC

sl_zigbee_af_dsa_sign_cb#

void sl_zigbee_af_dsa_sign_cb (sl_status_t 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.

sl_zigbee_af_dsa_verify_cb#

void sl_zigbee_af_dsa_verify_cb (sl_status_t status)

This callback is executed by the stack when the DSA verification has completed and has a result. If the result is SL_STATUS_OK, the signature is valid. If the result is SL_STATUS_ZIGBEE_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.

sl_zigbee_af_incoming_bootload_message_cb#

void sl_zigbee_af_incoming_bootload_message_cb (sl_802154_long_addr_t longId, sl_zigbee_rx_packet_info_t * packetInfo, uint8_t messageLength, uint8_t * messageContents)

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

sl_zigbee_af_bootload_transmit_complete_cb#

void sl_zigbee_af_bootload_transmit_complete_cb (sl_status_t status, uint8_t messageLength, uint8_t * messageContents)

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

sl_zigbee_af_zll_network_found_cb#

void sl_zigbee_af_zll_network_found_cb (bool isDeviceInfoNull, sl_zigbee_rx_packet_info_t * packetInfo, const sl_zigbee_zll_network_t * networkInfo, const sl_zigbee_zll_device_info_record_t * deviceInfo)

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

Returns

• networkInfo Information about the network.

• deviceInfo Device specific information.

sl_zigbee_af_zll_scan_complete_cb#

void sl_zigbee_af_zll_scan_complete_cb (sl_status_t status)

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

sl_zigbee_af_zll_address_assignment_cb#

void sl_zigbee_af_zll_address_assignment_cb (const sl_zigbee_zll_address_assignment_t * addressInfo, sl_zigbee_rx_packet_info_t * packetInfo)

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.

sl_zigbee_af_zll_touch_link_target_cb#

void sl_zigbee_af_zll_touch_link_target_cb (const sl_zigbee_zll_network_t * networkInfo)

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

Returns

• networkInfo Information about the network.

sl_zigbee_af_mac_filter_match_message_cb#

void sl_zigbee_af_mac_filter_match_message_cb (uint8_t filterIndexMatch, sl_zigbee_mac_passthrough_type_t messageType, sl_zigbee_rx_packet_info_t * packetInfo, 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.

sl_zigbee_af_d_gp_sent_cb#

void sl_zigbee_af_d_gp_sent_cb (sl_status_t status, uint8_t gpepHandle)

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

sl_zigbee_af_pan_id_conflict_cb#

sl_status_t sl_zigbee_af_pan_id_conflict_cb (int8_t conflictCount)

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

Returns

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

sl_zigbee_af_orphan_notification_cb#

void sl_zigbee_af_orphan_notification_cb (sl_802154_long_addr_t 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.

sl_zigbee_af_counters_cb#

void sl_zigbee_af_counters_cb (sl_zigbee_counter_type_t type, sl_zigbee_counter_info_t Info)

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

sl_zigbee_af_mac_passthrough_filter_cb#

bool sl_zigbee_af_mac_passthrough_filter_cb (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.

sl_zigbee_af_generate_cbke_keys_283k1_handler_cb#

void sl_zigbee_af_generate_cbke_keys_283k1_handler_cb (sl_status_t status, sl_zigbee_public_key_283k1_data_t * 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.

sl_zigbee_af_calculate_smacs_283k1_handler_cb#

void sl_zigbee_af_calculate_smacs_283k1_handler_cb (sl_status_t status, sl_zigbee_smac_data_t * initiatorSmac, sl_zigbee_smac_data_t * 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 sl_zigbee_clear_temporary_data_maybe_store_link_key().

Returns

• initiatorSmac The calculated value of the initiator's SMAC

• responderSmac The calculated value of the responder's SMAC

sl_zigbee_af_gpep_incoming_message_cb#

void sl_zigbee_af_gpep_incoming_message_cb (sl_zigbee_gp_status_t status, uint8_t gpdLink, uint8_t sequenceNumber, sl_zigbee_gp_address_t * addr, sl_zigbee_gp_security_level_t gpdfSecurityLevel, sl_zigbee_gp_key_type_t 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.

sl_zigbee_af_rtos_stack_wakeup_isr_cb#

void sl_zigbee_af_rtos_stack_wakeup_isr_cb (void )

Rtos Stack Wakeup Isr Handler.

sl_zigbee_af_radio_needs_calibrating_cb#

void sl_zigbee_af_radio_needs_calibrating_cb (void )

RadioNeedsCalibratingHandler.

sl_zigbee_af_scan_error_cb#

void sl_zigbee_af_scan_error_cb (sl_status_t status)

scanErrorHandler

sl_zigbee_af_support_incoming_message_cb#

bool sl_zigbee_af_support_incoming_message_cb (sl_zigbee_aps_frame_t * 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.