Global Callbacks#

sl_zigbee_af_add_to_current_app_tasks_cb#

void sl_zigbee_af_add_to_current_app_tasks_cb (sl_zigbee_af_application_task_t tasks)

Add To Current App Tasks.

This function is only useful to sleepy end devices. This function will note the passed item as part of a set of tasks the application has outstanding (e.g. message sent requiring APS acknwoledgement). This will affect how the application behaves with regard to sleeping and polling. Until the outstanding task is completed, the device may poll more frequently and sleep less often.

sl_zigbee_af_allow_network_write_attribute_cb#

sl_zigbee_af_attribute_write_permission_t sl_zigbee_af_allow_network_write_attribute_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_id_t attributeId, int8u mask, int16u manufacturerCode, int8u * value, int8u type)

Allow Network Write Attribute.

This function is called by the application framework before it writes an attribute in response to a write attribute request from an external device. The value passed into this callback is the value to which the attribute is to be set by the framework. Example: In mirroring simple metering data on an Energy Services Interface (ESI) (formerly called Energy Service Portal (ESP) in SE 1.0).), a mirrored simple meter needs to write read-only attributes on its mirror. The-meter-mirror sample application, located in app/projects/testing, uses this callback to allow the mirrored device to write simple metering attributes on the mirror regardless of the fact that most simple metering attributes are defined as read-only by the ZigBee specification. Note: The ZCL specification does not (as of this writing) specify any permission-level security for writing writeable attributes. As far as the ZCL specification is concerned, if an attribute is writeable, any device that has a link key for the device should be able to write that attribute. Furthermore if an attribute is read only, it should not be written over the air. Thus, if you implement permissions for writing attributes as a feature, you MAY be operating outside the specification. This is unlikely to be a problem for writing read-only attributes, but it may be a problem for attributes that are writeable according to the specification but restricted by the application implementing this callback.

sl_zigbee_af_attribute_read_access_cb#

bool sl_zigbee_af_attribute_read_access_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, int16u manufacturerCode, int16u attributeId)

Attribute Read Access.

This function is called whenever the Application Framework needs to check access permission for an attribute read.

sl_zigbee_af_attribute_write_access_cb#

bool sl_zigbee_af_attribute_write_access_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, int16u manufacturerCode, int16u attributeId)

Attribute Write Access.

This function is called whenever the Application Framework needs to check access permission for an attribute write.

sl_zigbee_af_clear_report_table_cb#

sl_status_t sl_zigbee_af_clear_report_table_cb (void )

Clear Report Table.

This function is called by the framework when the application should clear the report table.

sl_zigbee_af_cluster_init_cb#

void sl_zigbee_af_cluster_init_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId)

Cluster Init.

This function is called when a specific cluster is initialized. It gives the application an opportunity to take care of cluster initialization procedures. It is called exactly once for each endpoint where cluster is present.

sl_zigbee_af_cluster_security_custom_cb#

bool sl_zigbee_af_cluster_security_custom_cb (sl_zigbee_af_profile_id_t profileId, sl_zigbee_af_cluster_id_t clusterId, bool incoming, int8u commandId)

Cluster Security Custom.

This callback is fired when determining if APS encryption is required for a cluster outside of the specification's required clusters. In other words, for the Smart Energy profile this would be a cluster beyond the list that normally requires APS encryption.

sl_zigbee_af_configure_reporting_command_cb#

bool sl_zigbee_af_configure_reporting_command_cb (const sl_zigbee_af_cluster_command_t * cmd)

Configure Reporting Command.

This function is called by the application framework when a Configure Reporting command is received from an external device. The Configure Reporting command contains a series of attribute reporting configuration records. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_configure_reporting_response_cb#

bool sl_zigbee_af_configure_reporting_response_cb (sl_zigbee_af_cluster_id_t clusterId, int8u * buffer, int16u bufLen)

Configure Reporting Response.

This function is called by the application framework when a Configure Reporting Response command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_default_response_cb#

bool sl_zigbee_af_default_response_cb (sl_zigbee_af_cluster_id_t clusterId, int8u commandId, sl_zigbee_af_status_t status)

Default Response.

This function is called by the application framework when a Default Response command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_discover_attributes_response_cb#

bool sl_zigbee_af_discover_attributes_response_cb (sl_zigbee_af_cluster_id_t clusterId, bool discoveryComplete, int8u * buffer, int16u bufLen, bool extended)

Discover Attributes Response.

This function is called by the application framework when a Discover Attributes Response or Discover Attributes Extended Response command is received from an external device. The Discover Attributes Response command contains a bool indicating if discovery is complete and a list of zero or more attribute identifier/type records. The final argument indicates whether the response is in the extended format or not. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_discover_commands_generated_response_cb#

bool sl_zigbee_af_discover_commands_generated_response_cb (sl_zigbee_af_cluster_id_t clusterId, int16u manufacturerCode, bool discoveryComplete, int8u * commandIds, int16u commandIdCount)

Discover Commands Generated Response.

This function is called by the framework when Discover Commands Generated Response is received.

sl_zigbee_af_discover_commands_received_response_cb#

bool sl_zigbee_af_discover_commands_received_response_cb (sl_zigbee_af_cluster_id_t clusterId, int16u manufacturerCode, bool discoveryComplete, int8u * commandIds, int16u commandIdCount)

Discover Commands Received Response.

This function is called by the framework when Discover Commands Received Response is received.

sl_zigbee_af_eeprom_init_cb#

void sl_zigbee_af_eeprom_init_cb (void )

Eeprom Init.

Tells the system to initialize the EEPROM if it is not already initialized.

sl_zigbee_af_eeprom_note_initialized_state_cb#

void sl_zigbee_af_eeprom_note_initialized_state_cb (bool state)

Eeprom Note Initialized State.

Records the state of the EEPROM so that an intelligent driver (like the EEPROM plugin) can re-initialize the driver prior to any calls to it.

sl_zigbee_af_eeprom_shutdown_cb#

void sl_zigbee_af_eeprom_shutdown_cb (void )

Eeprom Shutdown.

Tells the system to shutdown the EEPROM if it is not already shutdown.

sl_zigbee_af_external_attribute_read_cb#

sl_zigbee_af_status_t sl_zigbee_af_external_attribute_read_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_metadata_t * attributeMetadata, int16u manufacturerCode, int8u * buffer, int16u maxReadLength)

External Attribute Read.

Like sl_zigbee_af_external_attribute_write_cb above, this function is called when the framework needs to read an attribute that is not stored within the Application Framework's data structures. All of the important information about the attribute itself is passed as a pointer to an sl_zigbee_af_attribute_metadata_t struct, which is stored within the application and used to manage the attribute. A complete description of the sl_zigbee_af_attribute_metadata_t struct is provided in app/framework/include/af-types.h This function assumes that the application is able to read the attribute, write it into the passed buffer, and return immediately. Any attributes that require a state machine for reading and writing are not really candidates for externalization at the present time. The Application Framework does not currently include a state machine for reading or writing attributes that must take place across a series of application ticks. Attributes that cannot be read in a timely manner should be stored within the Application Framework and updated occasionally by the application code from within the sl_zigbee_af_main_tick_cb. If the application was successfully able to read the attribute and write it into the passed buffer, it should return a value of SL_ZIGBEE_ZCL_STATUS_SUCCESS. Ensure that the size of the externally managed attribute value is smaller than what the buffer can hold. In the case of a buffer overflow throw an appropriate error such as SL_ZIGBEE_ZCL_STATUS_INSUFFICIENT_SPACE. Any other return value indicates the application was not able to read the attribute.

sl_zigbee_af_external_attribute_write_cb#

sl_zigbee_af_status_t sl_zigbee_af_external_attribute_write_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_metadata_t * attributeMetadata, int16u manufacturerCode, int8u * buffer)

External Attribute Write.

This function is called whenever the Application Framework needs to write an attribute which is not stored within the data structures of the Application Framework itself. One of the new features in Version 2 is the ability to store attributes outside the Framework. This is particularly useful for attributes that do not need to be stored because they can be read off the hardware when they are needed, or are stored in some central location used by many modules within the system. In this case, you can indicate that the attribute is stored externally. When the framework needs to write an external attribute, it makes a call to this callback. This callback is very useful for host micros which need to store attributes in persistent memory. Because each host micro (used with an Ember NCP) has its own type of persistent memory storage, the Application Framework does not include the ability to mark attributes as stored in flash the way that it does for an SoC architecture. On a host micro, any attributes that need to be stored in persistent memory should be marked as external and accessed through the external read and write callbacks. Any host code associated with the persistent storage should be implemented within this callback. All of the important information about the attribute itself is passed as a pointer to an sl_zigbee_af_attribute_metadata_t struct, which is stored within the application and used to manage the attribute. A complete description of the sl_zigbee_af_attribute_metadata_t struct is provided in app/framework/include/af-types.h. This function assumes that the application is able to write the attribute and return immediately. Any attributes that require a state machine for reading and writing are not candidates for externalization at the present time. The Application Framework does not currently include a state machine for reading or writing attributes that must take place across a series of application ticks. Attributes that cannot be written immediately should be stored within the Application Framework and updated occasionally by the application code from within the sl_zigbee_af_main_tick_cb. If the application was successfully able to write the attribute, it returns a value of SL_ZIGBEE_ZCL_STATUS_SUCCESS. Any other return value indicates the application was not able to write the attribute.

sl_zigbee_af_find_unused_pan_id_and_form_cb#

sl_status_t sl_zigbee_af_find_unused_pan_id_and_form_cb (void )

Find Unused Pan Id And Form.

This function is called by the framework to search for an unused PAN id and form a new network. The application should return SL_STATUS_OK if the operation was initiated successfully.

sl_zigbee_af_get_current_app_tasks_cb#

sl_zigbee_af_application_task_t sl_zigbee_af_get_current_app_tasks_cb (void )

Get Current App Tasks.

This function is only useful to sleepy end devices. This function will return the set of tasks the application has outstanding. These tasks affect how the application behaves with regard to sleeping and polling.

sl_zigbee_af_get_current_poll_control_cb#

sl_zigbee_af_event_poll_control_t sl_zigbee_af_get_current_poll_control_cb (void )

Get Current Poll Control.

This function will retrieve the current poll control that the system is using for the current network. This is determined by examining all the scheduled events and obtaining the most restrictive poll control context across all events. The most restrictive poll control is SL_ZIGBEE_AF_SHORT_POLL followed by SL_ZIGBEE_AF_LONG_POLL.

sl_zigbee_af_get_current_poll_interval_ms_cb#

int32u sl_zigbee_af_get_current_poll_interval_ms_cb (void )

Get Current Poll Interval Ms.

This function is only useful to end devices. This function will return the current poll interval (in milliseconds) for the current network. This interval is the maximum amount of time a child is currently waiting between polls of its parent.

sl_zigbee_af_get_current_poll_interval_qs_cb#

int32u sl_zigbee_af_get_current_poll_interval_qs_cb (void )

Get Current Poll Interval Qs.

This function is only useful to end devices. This function will return the current poll interval (in quarter seconds) for the current network. This interval is the maximum amount of time a child is currently waiting between polls of its parent.

sl_zigbee_af_get_current_sleep_control_cb#

sl_zigbee_af_event_sleep_control_t sl_zigbee_af_get_current_sleep_control_cb (void )

Get Current Sleep Control.

This function will retrieve the current sleep control that the system is using. This is determined by examining all the scheduled events and obtaining the most restrictive sleep control context across all events. The most restrictive sleep control is SL_ZIGBEE_AF_STAY_AWAKE followed by SL_ZIGBEE_AF_OK_TO_SLEEP.

sl_zigbee_af_get_current_time_cb#

int32u sl_zigbee_af_get_current_time_cb (void )

Get Current Time.

This callback is called when device attempts to get current time from the hardware. If this device has means to retrieve exact time, then this method should implement it. If the callback can't provide the exact time it should return 0 to indicate failure. Default action is to return 0, which indicates that device does not have access to real time.

sl_zigbee_af_get_default_poll_control_cb#

sl_zigbee_af_event_poll_control_t sl_zigbee_af_get_default_poll_control_cb (void )

Get Default Poll Control.

This function will retrieve the default poll control for the current network as previously set by sl_zigbee_af_set_default_poll_control_cb(). The default poll control will limit whether the network can long poll.

sl_zigbee_af_get_default_sleep_control_cb#

sl_zigbee_af_event_sleep_control_t sl_zigbee_af_get_default_sleep_control_cb (void )

Get Default Sleep Control.

This function will retrieve the default sleep control the system is using as previously set by sl_zigbee_af_set_default_sleep_control_cb(). The default sleep control will limit whether the device can sleep.

sl_zigbee_af_get_endpoint_by_index_cb#

bool sl_zigbee_af_get_endpoint_by_index_cb (int8u index, int8u * endpointReturn)

Get Endpoint By Index.

Get the endpoint number based on the passed index. By default the framework handles this by managing endpoints based on the precompiled configuration defined in AppBuilder. This callback can override this behavior at runtime and provide additional endpoints or different data than the compiled values. If the index is overridden than the callback shall return true and set the endpointReturn parameter accordingly. A value of 0xFF means the endpoint doesn't exist at that index. Otherwise false must be returned by the callback and the default framework behavior will be executed. This is only applicable to the SOC devices.

sl_zigbee_af_get_endpoint_description_cb#

bool sl_zigbee_af_get_endpoint_description_cb (int8u endpoint, sl_zigbee_endpoint_description_t * result)

Get Endpoint Description.

This callback is called by the framework whenever it receives a ZDO request to enumerate the details about an endpoint. By default the framework provides the information based on the precompiled endpoint information as defined in AppBuilder. This callback can override that behavior at runtime and return different information. If the endpoint information is being overridden then the callback must return true. Otherwise it should return false, which allows the framework to perform its default behavior. This is only applicable to SOC devices.

sl_zigbee_af_get_endpoint_info_cb#

bool sl_zigbee_af_get_endpoint_info_cb (int8u endpoint, int8u * returnNetworkIndex, sl_zigbee_af_endpoint_info_struct_t * returnEndpointInfo)

Get Endpoint Info.

This function is a callback to an application implemented endpoint that operates outside the normal application framework. When the framework wishes to perform operations with that endpoint it uses this callback to retrieve the endpoint's information. If the endpoint exists and the application can provide data then true shall be returned. Otherwise the callback must return false.

sl_zigbee_af_get_form_and_join_extended_pan_id_cb#

void sl_zigbee_af_get_form_and_join_extended_pan_id_cb (int8u * resultLocation)

Get Form And Join Extended Pan Id.

This callback is called by the framework to get the extended PAN ID used by the current network for forming and joining. The extended PAN ID used for forming and joining is not necessarily the same extended PAN ID actually in use on the network.

sl_zigbee_af_get_long_poll_interval_ms_cb#

int32u sl_zigbee_af_get_long_poll_interval_ms_cb (void )

Get Long Poll Interval Ms.

This function is only useful to end devices. This function will return the long poll interval (in milliseconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is not expecting data.

sl_zigbee_af_get_long_poll_interval_qs_cb#

int32u sl_zigbee_af_get_long_poll_interval_qs_cb (void )

Get Long Poll Interval Qs.

This function is only useful to end devices. This function will return the long poll interval (in quarter seconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is not expecting data.

sl_zigbee_af_get_short_poll_interval_ms_cb#

int16u sl_zigbee_af_get_short_poll_interval_ms_cb (void )

Get Short Poll Interval Ms.

This function is only useful to sleepy end devices. This function will return the short poll interval (in milliseconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is expecting data.

sl_zigbee_af_get_short_poll_interval_qs_cb#

int16u sl_zigbee_af_get_short_poll_interval_qs_cb (void )

Get Short Poll Interval Qs.

This function is only useful to sleepy end devices. This function will return the short poll interval (in quarter seconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is expecting data.

sl_zigbee_af_get_source_route_overhead_cb#

int8u sl_zigbee_af_get_source_route_overhead_cb (sl_802154_short_addr_t destination)

Get Source Route Overhead.

This function is called by the framework to determine the overhead required in the network frame for source routing to a particular destination.

Returns

• source route overhead or SL_ZIGBEE_SOURCE_ROUTE_OVERHEAD_UNKNOWN (no source route overhead) Ver.: always

sl_zigbee_af_get_wake_timeout_bitmask_cb#

sl_zigbee_af_application_task_t sl_zigbee_af_get_wake_timeout_bitmask_cb (void )

Get Wake Timeout Bitmask.

This function is only useful to sleepy end devices. This function will return the wake timeout bitmask for the current network. The bitmask determines which tasks will timeout automatically and which tasks require manual removal from the task list.

sl_zigbee_af_get_wake_timeout_ms_cb#

int16u sl_zigbee_af_get_wake_timeout_ms_cb (void )

Get Wake Timeout Ms.

This function is only useful to sleepy end devices. This function will return the wake timeout (in milliseconds) for the current network. This timeout is the maximum amount of time a child will wait for a task in the wake bitmask to finish. While waiting, the device will short poll.

sl_zigbee_af_get_wake_timeout_qs_cb#

int16u sl_zigbee_af_get_wake_timeout_qs_cb (void )

Get Wake Timeout Qs.

This function is only useful to sleepy end devices. This function will return the wake timeout (in quarter seconds) for the current network. This timeout is the maximum amount of time a child will wait for a task in the wake bitmask to finish. While waiting, the device will short poll.

sl_zigbee_af_hal_button_isr_cb#

void sl_zigbee_af_hal_button_isr_cb (int8u button, int8u state)

Hal Button Isr.

This callback is called by the framework whenever a button is pressed on the device. This callback is called within ISR context.

sl_zigbee_af_incoming_packet_filter_cb#

sl_zigbee_packet_action_t sl_zigbee_af_incoming_packet_filter_cb (sl_zigbee_zigbee_packet_type_t packetType, int8u * packetData, int8u * size_p, void * data)

Incoming Packet Filter.

** REQUIRES INCLUDING THE PACKET-HANDOFF PLUGIN **

 This is called by

the Packet Handoff plugin when the stack receives a packet from one of the protocol layers specified in ::sl_zigbee_zigbee_packet_type_t.

 The packetType

argument is one of the values of the ::sl_zigbee_zigbee_packet_type_t enum. If the stack receives an 802.15.4 MAC beacon, it will call this function with the packetType argument set to ::SL_ZIGBEE_ZIGBEE_PACKET_TYPE_BEACON.

 The

implementation of this callback may alter the data contained in packetData, modify options and flags in the auxillary data, or consume the packet itself, either sending the message, or discarding it as it sees fit.

sl_zigbee_af_initiate_inter_pan_key_establishment_cb#

sl_status_t sl_zigbee_af_initiate_inter_pan_key_establishment_cb (sl_802154_pan_id_t panId, const sl_802154_long_addr_t eui64)

Initiate Inter Pan Key Establishment.

This function is called by the framework to initiate key establishment with a remote device on a different PAN. The application should return SL_STATUS_OK if key establishment was initiated successfully. The application should call sl_zigbee_af_inter_pan_key_establishment_cb as events occur.

sl_zigbee_af_initiate_key_establishment_cb#

sl_status_t sl_zigbee_af_initiate_key_establishment_cb (sl_802154_short_addr_t nodeId, int8u endpoint)

Initiate Key Establishment.

This function is called by the framework to initiate key establishment with a remote device. The application should return SL_STATUS_OK if key establishment was initiated successfully. The application should call sl_zigbee_af_key_establishment_cb as events occur.

sl_zigbee_af_initiate_partner_link_key_exchange_cb#

sl_status_t sl_zigbee_af_initiate_partner_link_key_exchange_cb (sl_802154_short_addr_t target, int8u endpoint, sl_zigbee_af_partner_link_key_exchange_callback_t * callback)

Initiate Partner Link Key Exchange.

This function is called by the framework to initiate a partner link key exchange with a remote device. The application should return SL_STATUS_OK if the partner link key exchange was initiated successfully. When the partner link key exchange completes, the application should call the given callback.

sl_zigbee_af_inter_pan_key_establishment_cb#

bool sl_zigbee_af_inter_pan_key_establishment_cb (sl_zigbee_af_key_establishment_notify_message_t status, bool amInitiator, sl_802154_pan_id_t panId, const sl_802154_long_addr_t eui64, int8u delayInSeconds)

Inter Pan Key Establishment.

A callback by the key-establishment code to indicate an event has occurred. For error codes this is purely a notification. For non-error status codes (besides LINK_KEY_ESTABLISHED), it is the application's chance to allow or disallow the operation. If the application returns true then the key establishment is allowed to proceed. If it returns false, then key establishment is aborted. LINK_KEY_ESTABLISHED is a notification of success.

sl_zigbee_af_interpan_send_message_cb#

sl_status_t sl_zigbee_af_interpan_send_message_cb (sl_zigbee_af_interpan_header_t * header, int16u messageLength, int8u * message)

Interpan Send Message.

This function will send a raw MAC message with interpan frame format using the passed parameters.

sl_zigbee_af_key_establishment_cb#

bool sl_zigbee_af_key_establishment_cb (sl_zigbee_af_key_establishment_notify_message_t status, bool amInitiator, sl_802154_short_addr_t partnerShortId, int8u delayInSeconds)

Key Establishment.

A callback by the key-establishment code to indicate an event has occurred. For error codes this is purely a notification. For non-error status codes (besides LINK_KEY_ESTABLISHED), it is the application's chance to allow or disallow the operation. If the application returns true then the key establishment is allowed to proceed. If it returns false, then key establishment is aborted. LINK_KEY_ESTABLISHED is a notification of success.

sl_zigbee_af_main_init_cb#

void sl_zigbee_af_main_init_cb (void )

Main Init.

This function is called from the application's main function. It gives the application a chance to do any initialization required at system startup. Any code that you would normally put into the top of the application's main() routine should be put into this function. This is called before the clusters, plugins, and the network are initialized so some functionality is not yet available. Note: No callback in the Application Framework is associated with resource cleanup. If you are implementing your application on a Unix host where resource cleanup is a consideration, we expect that you will use the standard Posix system calls, including the use of atexit() and handlers for signals such as SIGTERM, SIGINT, SIGCHLD, SIGPIPE and so on. If you use the signal() function to register your signal handler, please mind the returned value which may be an Application Framework function. If the return value is non-null, please make sure that you call the returned function from your handler to avoid negating the resource cleanup of the Application Framework itself.

sl_zigbee_af_main_start_cb#

bool sl_zigbee_af_main_start_cb (int * returnCode, int argc, char ** argv)

Main Start.

This function is called at the start of main after the HAL has been initialized. The standard main function arguments of argc and argv are passed in. However not all platforms have support for main() function arguments. Those that do not are passed NULL for argv, therefore argv should be checked for NULL before using it. If the callback determines that the program must exit, it should return true. The value returned by main() will be the value written to the returnCode pointer. Otherwise the callback should return false to let normal execution continue.

sl_zigbee_af_main_tick_cb#

void sl_zigbee_af_main_tick_cb (void )

Main Tick.

Whenever main application tick is called, this callback will be called at the end of the main tick execution.

sl_zigbee_af_message_sent_cb#

bool sl_zigbee_af_message_sent_cb (sl_zigbee_outgoing_message_type_t type, int16u indexOrDestination, sl_zigbee_aps_frame_t * apsFrame, int16u msgLen, int8u * message, sl_status_t status)

Message Sent.

This function is called by the application framework from the message sent handler, when it is informed by the stack regarding the message sent status. All of the values passed to the sl_zigbee_message_sent_handler are passed on to this callback. This provides an opportunity for the application to verify that its message has been sent successfully and take the appropriate action. This callback should return a bool value of true or false. A value of true indicates that the message sent notification has been handled and should not be handled by the application framework.

sl_zigbee_af_ncp_init_cb#

void sl_zigbee_af_ncp_init_cb (void )

Ncp Init.

This function is always called when the network coprocessor is being initialized, either at startup or upon reset. It provides applications an opportunity to perform additional configuration of the NCP. For example, tables on the NCP can be resized and populated. This callback issue EZSP commands to configure memory layout on the ncp and is not called on SoCs.

sl_zigbee_af_ncp_is_awake_isr_cb#

void sl_zigbee_af_ncp_is_awake_isr_cb (void )

Ncp Is Awake Isr.

This function is called IN ISR CONTEXT. It notes that the NCP is awake after sleeping. Care should be taken to do minimal processing in this ISR handler function.

sl_zigbee_af_network_key_update_complete_cb#

void sl_zigbee_af_network_key_update_complete_cb (sl_status_t status)

Network Key Update Complete.

This is called by the framework when a network key update operation started by the trust center is complete.

sl_zigbee_af_ota_bootload_cb#

int8u sl_zigbee_af_ota_bootload_cb (const sl_zigbee_af_ota_image_id_t * id, int16u ncpUpgradeTagId)

Ota Bootload.

The platform specific routine to bootload the device from a ZigBee over-the-air upgrade file.

sl_zigbee_af_ota_client_bootload_cb#

void sl_zigbee_af_ota_client_bootload_cb (const sl_zigbee_af_ota_image_id_t * id)

Ota Client Bootload.

This callback is fired when the OTA Client recevies a command to bootload the newly downloaded OTA image. This callback will perform the platform specific to bootload their device.

sl_zigbee_af_ota_client_custom_verify_cb#

sl_zigbee_af_image_verify_status_t sl_zigbee_af_ota_client_custom_verify_cb (bool newVerification, const sl_zigbee_af_ota_image_id_t * id)

Ota Client Custom Verify.

This callback is executed by the OTA client after the signature verification has successfully completed. It allows the device to do its own custom verification of the image (such as verifying that the EBL is intact).

sl_zigbee_af_ota_client_download_complete_cb#

bool sl_zigbee_af_ota_client_download_complete_cb (sl_zigbee_af_ota_download_result_t success, const sl_zigbee_af_ota_image_id_t * id)

Ota Client Download Complete.

This callback indicates that the OTA client has completed the download of a file. If the file has been completely downloaded and cryptographic checks have been turned on, then those will be performed prior to this callback and that outcome included in the 'success' result. On failure, this callback is merely informative, and the return type is ignored. On succesful download, this callback allows the client to perform any additional verification of the downloaded image and return that result to the OTA server.

sl_zigbee_af_ota_client_incoming_message_raw_cb#

sl_zigbee_af_zcl_request_status_t sl_zigbee_af_ota_client_incoming_message_raw_cb (sl_zigbee_af_cluster_command_t * message)

Ota Client Incoming Message Raw.

This callback is for processing incoming messages for the Over-the-air bootload cluster client. ZCL will not process the message and instead hand the raw over the air data to the callback for its own processing.

sl_zigbee_af_ota_client_start_cb#

void sl_zigbee_af_ota_client_start_cb (void )

Ota Client Start.

This callback should be called when the profile specific registration has completed successfully. It will start the client's state machine that will find the OTA server, query it for the next image, download the image, wait for the bootload message, and kick off the bootload.

sl_zigbee_af_ota_client_version_info_cb#

void sl_zigbee_af_ota_client_version_info_cb (sl_zigbee_af_ota_image_id_t * currentImageInfo, int16u * hardwareVersion)

Ota Client Version Info.

This function is called by the OTA client when a new query will occur to the server asking what the next version of firmware is. The client can inform the cluster software as to what information to use in the query (and subsequent download).

sl_zigbee_af_ota_page_request_server_policy_cb#

int8u sl_zigbee_af_ota_page_request_server_policy_cb (void )

Ota Page Request Server Policy.

This callback is called by the OTA server page request code when it wants to determine if it is allowed for an OTA client to make a page request. It is only called if page request support has been enabled on the server. It should return SL_ZIGBEE_ZCL_STATUS_SUCCESS if it allows the page request, and SL_ZIGBEE_ZCL_STATUS_UNSUP_COMMAND if it does not want to allow it.

sl_zigbee_af_ota_server_block_size_cb#

int8u sl_zigbee_af_ota_server_block_size_cb (sl_802154_short_addr_t clientNodeId)

Ota Server Block Size.

This function provides a way for the server to adjust the block size of its response to an Image block request by a client.

sl_zigbee_af_ota_server_incoming_message_raw_cb#

sl_zigbee_af_zcl_request_status_t sl_zigbee_af_ota_server_incoming_message_raw_cb (sl_zigbee_af_cluster_command_t * message)

Ota Server Incoming Message Raw.

This callback is for processing incoming messages for the Over-the-air bootload cluster server. ZCL will not process the message and instead hand the raw over the air data to the callback for its own processing.

sl_zigbee_af_ota_server_query_cb#

int8u sl_zigbee_af_ota_server_query_cb (const sl_zigbee_af_ota_image_id_t * currentImageId, int16u * hardwareVersion, sl_zigbee_af_ota_image_id_t * nextUpgradeImageId)

Ota Server Query.

This callback is fired when the OTA server receives a query request by the client. The callback lets the server application indicate to the client what the 'next' version of software is for the device, or if there is not one available.

sl_zigbee_af_ota_server_send_image_notify_cb#

bool sl_zigbee_af_ota_server_send_image_notify_cb (sl_802154_short_addr_t dest, int8u endpoint, int8u payloadType, int8u queryJitter, const sl_zigbee_af_ota_image_id_t * id)

Ota Server Send Image Notify.

This callback is an indication to the OTA server that it should send out notification about an OTA file that is available for download.

sl_zigbee_af_ota_server_upgrade_end_request_cb#

bool sl_zigbee_af_ota_server_upgrade_end_request_cb (sl_802154_short_addr_t source, int8u status, int32u * returnValue, const sl_zigbee_af_ota_image_id_t * imageId)

Ota Server Upgrade End Request.

This function is called when the OTA server receives a request an upgrade end request. If the request indicated a successful download by the client, the server must tell the client when and if to upgrade to the downloaded image.

sl_zigbee_af_ota_storage_check_temp_data_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_check_temp_data_cb (int32u * currentOffset, int32u * totalImageSize, sl_zigbee_af_ota_image_id_t * newFileInfo)

Ota Storage Check Temp Data.

This callback will validate temporary data in the storage device to determine whether it is a complete file, a partially downloaded file, or there is no file present. When a complete or partial file is found it will return SL_ZIGBEE_AF_OTA_STORAGE_SUCCESS or SL_ZIGBEE_AF_OTA_STORAGE_PARTIAL_FILE_FOUND, respectively. In that case, the currentOffset, totalImageSize, and newFileInfo will be populated with data. When SL_ZIGBEE_AF_OTA_STORAGE_ERROR is returned, no temporary data is present.

sl_zigbee_af_ota_storage_clear_temp_data_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_clear_temp_data_cb (void )

Ota Storage Clear Temp Data.

This function clears any existing temp data that was downloaed. It is used immediately prior to downloading a raw image over the air.

sl_zigbee_af_ota_storage_close_cb#

void sl_zigbee_af_ota_storage_close_cb (void )

Ota Storage Close.

This callback shuts down the ZigBee Over-the-air storage module.

sl_zigbee_af_ota_storage_driver_download_finish_cb#

void sl_zigbee_af_ota_storage_driver_download_finish_cb (int32u offset)

Ota Storage Driver Download Finish.

This callback defines the low-level means by which a device records the final offset value of the download image.

sl_zigbee_af_ota_storage_driver_init_cb#

bool sl_zigbee_af_ota_storage_driver_init_cb (void )

Ota Storage Driver Init.

The initialization code for the OTA storage driver.

sl_zigbee_af_ota_storage_driver_invalidate_image_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_driver_invalidate_image_cb (void )

Ota Storage Driver Invalidate Image.

This callback invalidates the image stored on disk so that it will not be bootloaded, and it will not be a valid image that is in the middle of downloading.

sl_zigbee_af_ota_storage_driver_prepare_to_resume_download_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_driver_prepare_to_resume_download_cb (void )

Ota Storage Driver Prepare To Resume Download.

This callback allows the underlying storage driver to prepare to resume the OTA file download. For example, the driver may exceute a page erase to insure the next page is ready to be written to.

sl_zigbee_af_ota_storage_driver_read_cb#

bool sl_zigbee_af_ota_storage_driver_read_cb (int32u offset, int32u length, int8u * returnData)

Ota Storage Driver Read.

This callback defines the low-level means by which a device reads from the OTA storage device.

sl_zigbee_af_ota_storage_driver_retrieve_last_stored_offset_cb#

int32u sl_zigbee_af_ota_storage_driver_retrieve_last_stored_offset_cb (void )

Ota Storage Driver Retrieve Last Stored Offset.

This callback defines the low-level means by which a device retrieves the last persistently recorded download offset. This may be different than last actual download offset.

sl_zigbee_af_ota_storage_driver_write_cb#

bool sl_zigbee_af_ota_storage_driver_write_cb (const int8u * dataToWrite, int32u offset, int32u length)

Ota Storage Driver Write.

This callback defines the low-level means by which a device reads from the OTA storage device.

sl_zigbee_af_ota_storage_finish_download_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_finish_download_cb (int32u offset)

Ota Storage Finish Download.

This function indicates to the storage module that the download has finished.

sl_zigbee_af_ota_storage_get_count_cb#

int8u sl_zigbee_af_ota_storage_get_count_cb (void )

Ota Storage Get Count.

This callback returns the total number of ZigBee Over-the-air upgrade images stored in the storage module.

sl_zigbee_af_ota_storage_get_full_header_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_get_full_header_cb (const sl_zigbee_af_ota_image_id_t * id, sl_zigbee_af_ota_header_t * returnData)

Ota Storage Get Full Header.

This callback populates the sl_zigbee_af_ota_header_t structure pointed to by the returnData with data about the OTA file stored in the storage module.

sl_zigbee_af_ota_storage_get_total_image_size_cb#

int32u sl_zigbee_af_ota_storage_get_total_image_size_cb (const sl_zigbee_af_ota_image_id_t * id)

Ota Storage Get Total Image Size.

This function returns the total size of the ZigBee Over-the-air file with the passed parameters. If no file is found with those parameters, 0 is returned.

sl_zigbee_af_ota_storage_init_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_init_cb (void )

Ota Storage Init.

This callback initializes the ZigBee Over-the-air storage module.

sl_zigbee_af_ota_storage_iterator_first_cb#

sl_zigbee_af_ota_image_id_t sl_zigbee_af_ota_storage_iterator_first_cb (void )

Ota Storage Iterator First.

This callback lets you walk through the list of all OTA files by jumping to the first file in the list maintained by the storage module. If there is no file then sl_zigbee_af_ota_invalid_image_id is returned.

sl_zigbee_af_ota_storage_iterator_next_cb#

sl_zigbee_af_ota_image_id_t sl_zigbee_af_ota_storage_iterator_next_cb (void )

Ota Storage Iterator Next.

This callback lets you walk through the list of all OTA files by jumping to the next file in the list maintained by the storage module. If there is no next file then sl_zigbee_af_ota_invalid_image_id is returned.

sl_zigbee_af_ota_storage_read_image_data_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_read_image_data_cb (const sl_zigbee_af_ota_image_id_t * id, int32u offset, int32u length, int8u * returnData, int32u * returnedLength)

Ota Storage Read Image Data.

This callback reads data from the specified OTA file and returns that data to the caller.

sl_zigbee_af_ota_storage_search_cb#

sl_zigbee_af_ota_image_id_t sl_zigbee_af_ota_storage_search_cb (int16u manufacturerId, int16u imageTypeId, const int16u * hardwareVersion)

Ota Storage Search.

This callback searches through the list of all images for one that matches the passed parameters. On success an image identifier is returned with a matching image. On failure sl_zigbee_af_invalid_image_id is returned.

sl_zigbee_af_ota_storage_write_temp_data_cb#

sl_zigbee_af_ota_storage_status_t sl_zigbee_af_ota_storage_write_temp_data_cb (int32u offset, int32u length, const int8u * data)

Ota Storage Write Temp Data.

This function writes to the temporary data in the storage device at the specified offset. It is used when downloading a raw image over the air.

sl_zigbee_af_outgoing_packet_filter_cb#

sl_zigbee_packet_action_t sl_zigbee_af_outgoing_packet_filter_cb (sl_zigbee_zigbee_packet_type_t packetType, int8u * packetData, int8u * size_p, void * data)

Outgoing Packet Filter.

** REQUIRES INCLUDING THE PACKET-HANDOFF PLUGIN **

 This is called by

the Packet Handoff plugin when the stack prepares to send a packet from one of the protocol layers specified in ::sl_zigbee_zigbee_packet_type_t.

 The

packetType argument is one of the values of the ::sl_zigbee_zigbee_packet_type_t enum. If the stack receives an 802.15.4 MAC beacon, it will call this function with the packetType argument set to ::SL_ZIGBEE_ZIGBEE_PACKET_TYPE_BEACON.

The implementation of this callback may alter the data contained in packetData, modify options and flags in the auxillary data, or consume the packet itself, either sending the message, or discarding it as it sees fit.

sl_zigbee_af_partner_link_key_exchange_request_cb#

sl_zigbee_zdo_status_t sl_zigbee_af_partner_link_key_exchange_request_cb (sl_802154_long_addr_t partner)

Partner Link Key Exchange Request.

This function is called by the framework on SOC platforms when a remote node requests a partner link key exchange. The application should return SL_STATUS_OK to accept the request or any other status to reject it. On network coprocessor platforms, this function will not be called because the NCP handles partner link key exchange requests based on the binding policy.

sl_zigbee_af_partner_link_key_exchange_response_cb#

void sl_zigbee_af_partner_link_key_exchange_response_cb (sl_802154_short_addr_t sender, sl_zigbee_zdo_status_t status)

Partner Link Key Exchange Response.

This function is called by the framework when a remote node requests a partner link key exchange. The application should return true to accept the request or false to reject it. On network coprocessor platforms, this function will not be called because the NCP handles partner link key exchange requests based on the binding policy.

sl_zigbee_af_performing_key_establishment_cb#

bool sl_zigbee_af_performing_key_establishment_cb (void )

Performing Key Establishment.

This function is called by the framework to determine if the device is performing key establishment. The application should return true if key establishment is in progress.

sl_zigbee_af_post_attribute_change_cb#

void sl_zigbee_af_post_attribute_change_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_id_t attributeId, int8u mask, int16u manufacturerCode, int8u type, int8u size, int8u * value)

Post Attribute Change.

This function is called by the application framework after it changes an attribute value. The value passed into this callback is the value to which the attribute was set by the framework.

sl_zigbee_af_post_em4_reset_cb#

void sl_zigbee_af_post_em4_reset_cb (void )

Post Em4 Reset.

A callback called by application framework, and implemented by em4 plugin

sl_zigbee_af_pre_attribute_change_cb#

sl_zigbee_af_status_t sl_zigbee_af_pre_attribute_change_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_id_t attributeId, int8u mask, int16u manufacturerCode, int8u type, int8u size, int8u * value)

Pre Attribute Change.

This function is called by the application framework before it changes an attribute value. The value passed into this callback is the value to which the attribute is to be set by the framework. The application should return SL_ZIGBEE_ZCL_STATUS_SUCCESS to permit the change or any other sl_zigbee_af_status_t to reject it.

sl_zigbee_af_pre_cli_send_cb#

bool sl_zigbee_af_pre_cli_send_cb (sl_zigbee_aps_frame_t * apsFrame, sl_802154_short_addr_t source, sl_802154_short_addr_t destination, int8u * message, int16u messageLength)

Pre Cli Send.

This function is called by the framework when it is about to pass a message constructed over CLI to the stack primitives for sending. If the function returns true it is assumed that the callback has consumed and processed the message. The framework will not do any further processing on the message.

If the function returns false then it is assumed that the callback has

not processed the message and the framework will continue to process accordingly.

sl_zigbee_af_pre_command_received_cb#

bool sl_zigbee_af_pre_command_received_cb (sl_zigbee_af_cluster_command_t * cmd)

Pre Command Received.

This callback is the second in the Application Framework's message processing chain. At this point in the processing of incoming over-the-air messages, the application has determined that the incoming message is a ZCL command. It parses enough of the message to populate an sl_zigbee_af_cluster_command_t struct. The Application Framework defines this struct value in a local scope to the command processing but also makes it available through a global pointer called sl_zigbee_af_current_command, in app/framework/util/util.c. When command processing is complete, this pointer is cleared.

sl_zigbee_af_pre_message_received_cb#

bool sl_zigbee_af_pre_message_received_cb (sl_zigbee_af_incoming_message_t * incomingMessage)

Pre Message Received.

This callback is the first in the Application Framework's message processing chain. The Application Framework calls it when a message has been received over the air but has not yet been parsed by the ZCL command-handling code. If you wish to parse some messages that are completely outside the ZCL specification or are not handled by the Application Framework's command handling code, you should intercept them for parsing in this callback.

This callback returns a Boolean value indicating whether or not the message has been handled. If the callback returns a value of true, then the Application Framework assumes that the message has been handled and it does nothing else with it. If the callback returns a value of false, then the application framework continues to process the message as it would with any incoming message.

sl_zigbee_af_pre_message_send_cb#

bool sl_zigbee_af_pre_message_send_cb (sl_zigbee_af_message_struct_t * messageStruct, sl_status_t * status)

Pre Message Send.

This function is called by the framework when it is about to pass a message to the stack primitives for sending. This message may or may not be ZCL, ZDO, or some other protocol. This is called prior to any ZigBee fragmentation that may be done. If the function returns true it is assumed the callback has consumed and processed the message. The callback must also set the sl_status_t status code to be passed back to the caller. The framework will do no further processing on the message. If the function returns false then it is assumed that the callback has not processed the mesasge and the framework will continue to process accordingly.

sl_zigbee_af_pre_ncp_reset_cb#

void sl_zigbee_af_pre_ncp_reset_cb (void )

Pre Ncp Reset.

This function will be called prior to the reset of the NCP by the host.

sl_zigbee_af_pre_zdo_message_received_cb#

bool sl_zigbee_af_pre_zdo_message_received_cb (sl_802154_short_addr_t sl_zigbee_node_id, sl_zigbee_aps_frame_t * apsFrame, int8u * message, int16u length)

Pre ZDO Message Received.

This function passes the application an incoming ZDO message and gives the appictation the opportunity to handle it. By default, this callback returns false indicating that the incoming ZDO message has not been handled and should be handled by the Application Framework.

sl_zigbee_af_read_attributes_response_cb#

bool sl_zigbee_af_read_attributes_response_cb (sl_zigbee_af_cluster_id_t clusterId, int8u * buffer, int16u bufLen)

Read Attributes Response.

This function is called by the application framework when a Read Attributes Response command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_read_reporting_configuration_command_cb#

bool sl_zigbee_af_read_reporting_configuration_command_cb (const sl_zigbee_af_cluster_command_t * cmd)

Read Reporting Configuration Command.

This function is called by the application framework when a Read Reporting Configuration command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_read_reporting_configuration_response_cb#

bool sl_zigbee_af_read_reporting_configuration_response_cb (sl_zigbee_af_cluster_id_t clusterId, int8u * buffer, int16u bufLen)

Read Reporting Configuration Response.

This function is called by the application framework when a Read Reporting Configuration Response command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_registration_abort_cb#

void sl_zigbee_af_registration_abort_cb (void )

Registration Abort.

This callback is called when the device should abort the registration process.

sl_zigbee_af_registration_cb#

void sl_zigbee_af_registration_cb (bool success)

Registration.

This callback is called when the device joins a network and the process of registration is complete. This callback provides a success value of true if the registration process was successful and a value of false if registration failed.

sl_zigbee_af_registration_start_cb#

sl_status_t sl_zigbee_af_registration_start_cb (void )

Registration Start.

This callback is called when the device joins a network and the registration process should begin. The application should return SL_STATUS_OK if the registration process started successfully. When registration is complete, the application should call sl_zigbee_af_registration_cb with an indication of success or failure.

sl_zigbee_af_remote_delete_binding_permission_cb#

sl_status_t sl_zigbee_af_remote_delete_binding_permission_cb (int8u index)

Remote Delete Binding Permission.

This function is called by the framework to request permission to service the remote delete binding request. Return SL_STATUS_OK to allow request, anything else to disallow request. This function is a privileged callback running as part of the stack's task context.

sl_zigbee_af_remote_set_binding_permission_cb#

sl_status_t sl_zigbee_af_remote_set_binding_permission_cb (const sl_zigbee_binding_table_entry_t * entry)

Remote Set Binding Permission.

This function is called by the framework to request permission to service the remote set binding request. Return SL_STATUS_OK to allow request, anything else to disallow request. This function is a privileged callback that runs as part of the stack's task context, so interactions of it with application code are not thread-safe.

sl_zigbee_af_remove_from_current_app_tasks_cb#

void sl_zigbee_af_remove_from_current_app_tasks_cb (sl_zigbee_af_application_task_t tasks)

Remove From Current App Tasks.

This function is only useful to sleepy end devices. This function will remove the passed item from the set of tasks the application has outstanding (e.g. message sent requiring APS acknwoledgement). This will affect how the application behaves with regard to sleeping and polling. Removing the item from the list of outstanding tasks may allow the device to sleep longer and poll less frequently. If there are other outstanding tasks the system may still have to stay away and poll more often.

sl_zigbee_af_report_attributes_cb#

bool sl_zigbee_af_report_attributes_cb (sl_zigbee_af_cluster_id_t clusterId, int8u * buffer, int16u bufLen)

Report Attributes.

This function is called by the application framework when a Report Attributes command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_reporting_attribute_change_cb#

void sl_zigbee_af_reporting_attribute_change_cb (int8u endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_id_t attributeId, int8u mask, int16u manufacturerCode, sl_zigbee_af_attribute_type_t type, int8u * data)

Reporting Attribute Change.

This function is called by the framework when an attribute managed by the framework changes. The application should call this function when an externally-managed attribute changes. The application should use the change notification to inform its reporting decisions.

sl_zigbee_af_security_init_cb#

void sl_zigbee_af_security_init_cb (sl_zigbee_initial_security_state_t * state, sl_zigbee_extended_security_bitmask_t * extended, bool trustCenter)

Security Init.

This callback is called by the framework to give the application a chance to modify the security settings of the node during network initialization. Depending on the context when this callback is called, the pointer to the initial security state may be NULL, which means the initial security state can no longer be modified as the node is already operating on the network.

sl_zigbee_af_set_default_poll_control_cb#

void sl_zigbee_af_set_default_poll_control_cb (sl_zigbee_af_event_poll_control_t control)

Set Default Poll Control.

This function will set the default poll control for the current network to control whether or not it can long poll.

sl_zigbee_af_set_default_sleep_control_cb#

void sl_zigbee_af_set_default_sleep_control_cb (sl_zigbee_af_event_sleep_control_t control)

Set Default Sleep Control.

This function will set the default behavior of a sleeping device to control whether or not it must stay awake. A device that stays awake does not sleep at all. Otherwise, the device can sleep between events when appropriate.

sl_zigbee_af_set_form_and_join_extended_pan_id_cb#

void sl_zigbee_af_set_form_and_join_extended_pan_id_cb (const int8u * extendedPanId)

Set Form And Join Extended Pan Id.

This callback is called by the framework to set the extended PAN ID used by the current network for forming and joining. The extended PAN ID used for forming and joining is not necessarily the same extended PAN ID actually in use on the network.

sl_zigbee_af_set_long_poll_interval_ms_cb#

void sl_zigbee_af_set_long_poll_interval_ms_cb (int32u longPollIntervalMs)

Set Long Poll Interval Ms.

This function is only useful to end devices. This function will set the long poll interval (in milliseconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is not expecting data.

sl_zigbee_af_set_long_poll_interval_qs_cb#

void sl_zigbee_af_set_long_poll_interval_qs_cb (int32u longPollIntervalQs)

Set Long Poll Interval Qs.

This function is only useful to end devices. This function will set the long poll interval (in quarter seconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is not expecting data.

sl_zigbee_af_set_short_poll_interval_ms_cb#

void sl_zigbee_af_set_short_poll_interval_ms_cb (int16u shortPollIntervalMs)

Set Short Poll Interval Ms.

This function is only useful to sleepy end devices. This function will set the short poll interval (in milliseconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is expecting data.

sl_zigbee_af_set_short_poll_interval_qs_cb#

void sl_zigbee_af_set_short_poll_interval_qs_cb (int16u shortPollIntervalQs)

Set Short Poll Interval Qs.

This function is only useful to sleepy end devices. This function will set the short poll interval (in quarter seconds) for the current network. This interval is the maximum amount of time a child will wait between polls of its parent when it is expecting data.

sl_zigbee_af_set_source_route_overhead_cb#

void sl_zigbee_af_set_source_route_overhead_cb (sl_802154_short_addr_t destination, int8u overhead)

Set Source Route Overhead.

This function is called by the framework when it has information about the source route overhead to a particular destination. The application may use this information to cache the source route overhead.

sl_zigbee_af_set_time_cb#

void sl_zigbee_af_set_time_cb (int32u utcTime)

Set Time.

This callback should be implemented, if the device has access to real time clock, and has an ability to update that clock. The application framework expects to be passed the utcTime which is the number of seconds since the year 2000. Default implementation does nothing. Note: This function used to take time in year, month, day, hour, min, sec. We have changed this to utcTime in order to conserve code space.

sl_zigbee_af_set_wake_timeout_bitmask_cb#

void sl_zigbee_af_set_wake_timeout_bitmask_cb (sl_zigbee_af_application_task_t tasks)

Set Wake Timeout Bitmask.

This function is only useful to sleepy end devices. This function will set the wake timeout bitmask for the current network. The bitmask determines which tasks will timeout automatically and which tasks require manual removal from the task list.

sl_zigbee_af_set_wake_timeout_ms_cb#

void sl_zigbee_af_set_wake_timeout_ms_cb (int16u wakeTimeoutMs)

Set Wake Timeout Ms.

This function is only useful to sleepy end devices. This function will set the wake timeout (in milliseconds) for the current network. This timeout is the maximum amount of time a child will wait for a task in the wake bitmask to finish. While waiting, the device will short poll.

sl_zigbee_af_set_wake_timeout_qs_cb#

void sl_zigbee_af_set_wake_timeout_qs_cb (int16u wakeTimeoutQs)

Set Wake Timeout Qs.

This function is only useful to sleepy end devices. This function will set the wake timeout (in quarter seconds) for the current network. This timeout is the maximum amount of time a child will wait for a task in the wake bitmask to finish. While waiting, the device will short poll.

sl_zigbee_af_start_move_cb#

bool sl_zigbee_af_start_move_cb (void )

Start Move.

This function is called to initiate the process for a device to move (rejoin) to a new parent.

sl_zigbee_af_start_search_for_joinable_network_cb#

sl_status_t sl_zigbee_af_start_search_for_joinable_network_cb (void )

Start Search For Joinable Network.

This function is called by the framework to search for joinable networks and join a network. The application should return SL_STATUS_OK if the operation was initiated successfully.

sl_zigbee_af_stop_move_cb#

void sl_zigbee_af_stop_move_cb (void )

Stop Move.

This function is called to cancel a previously scheduled move (rejoin) to a new parent.

sl_zigbee_af_trust_center_join_cb#

void sl_zigbee_af_trust_center_join_cb (sl_802154_short_addr_t newNodeId, sl_802154_long_addr_t newNodeEui64, sl_802154_short_addr_t parentOfNewNode, sl_zigbee_device_update_t status, sl_zigbee_join_decision_t decision)

Trust Center Join.

This callback is called from within the application framework's implementation of sl_zigbee_internal_trust_center_join_handler or sl_zigbee_ezsp_trust_center_join_handler. This callback provides the same arguments passed to the TrustCenterJoinHandler. For more information about the TrustCenterJoinHandler please see documentation included in stack/include/trust-center.h.

sl_zigbee_af_trust_center_keepalive_abort_cb#

void sl_zigbee_af_trust_center_keepalive_abort_cb (void )

Trust Center Keepalive Abort.

This callback is called when the device should abort the trust center keepalive process.

sl_zigbee_af_trust_center_keepalive_update_cb#

void sl_zigbee_af_trust_center_keepalive_update_cb (bool registrationComplete)

Trust Center Keepalive Update.

This callback is called when the device finishes registration (successfully or otherwise) and the trust center keepalive process must be updated. If the keepalive process has not been started, then it is started. Otherwise if the keepalive is in the process of searching for the TC, it will process the result of that Trust Center search operation.

sl_zigbee_af_write_attributes_response_cb#

bool sl_zigbee_af_write_attributes_response_cb (sl_zigbee_af_cluster_id_t clusterId, int8u * buffer, int16u bufLen)

Write Attributes Response.

This function is called by the application framework when a Write Attributes Response command is received from an external device. The application should return true if the message was processed or false if it was not.

sl_zigbee_af_get_diff_cb#

sl_zigbee_af_difference_type_t sl_zigbee_af_get_diff_cb (sl_zigbee_af_difference_type_t value1, sl_zigbee_af_difference_type_t value2, sl_zigbee_af_attribute_type_t dataType)

Retrieves the difference between the two passed values.

This function assumes that the two values have the same endianness. Currently only single precision floats are supported. Semi/Double-precision requires a special method to convert to the corresponding data type, calculate the distance and return it as sl_zigbee_af_difference_type_t.

sl_zigbee_af_detect_report_changed_cb#

bool sl_zigbee_af_detect_report_changed_cb (sl_zigbee_af_difference_type_t threshold, sl_zigbee_af_difference_type_t diff, sl_zigbee_af_attribute_type_t dataType)

Detect a reportable change that could trigger report generation.