Application Framework Types#
This documentation describes the types used by the Zigbee Application Framework.
Modules#
sli_cluster_function_structure_t
sl_zigbee_af_default_attribute_value_t
sl_zigbee_af_attribute_min_max_value_t
sl_zigbee_af_default_or_min_max_attribute_value_t
sl_zigbee_af_attribute_metadata_t
sl_zigbee_af_attribute_search_record_t
sl_zigbee_af_manufacturer_code_entry_t
sl_zigbee_af_incoming_message_t
sl_zigbee_af_interpan_header_t
sl_zigbee_af_allowed_inter_pan_message_t
sl_zigbee_af_cluster_command_t
sl_zigbee_af_security_profile_data_t
sl_zigbee_af_defined_endpoint_t
sl_zigbee_af_load_control_event_t
sl_zigbee_af_service_discovery_result_t
sl_zigbee_af_group_table_entry_t
sl_zigbee_af_scene_table_entry_t
sl_zigbee_af_plugin_messaging_client_message_t
sl_zigbee_af_plugin_price_client_price_t
sl_zigbee_af_plugin_reporting_entry_t
sl_zigbee_af_plugin_zll_commissioning_group_information_record_t
sl_zigbee_af_plugin_zll_commissioning_endpoint_information_record_t
sl_zigbee_af_image_block_request_callback_struct_t
sl_zigbee_af_link_key_backup_data_t
sl_zigbee_af_trust_center_backup_data_t
sl_zigbee_af_standalone_bootloader_query_response_data_t
sl_zigbee_af_command_metadata_t
sl_zigbee_af_device_management_tenancy_t
sl_zigbee_af_device_management_supplier_t
sl_zigbee_af_device_management_supply_t
sl_zigbee_af_device_management_site_id_t
sl_zigbee_af_device_management_c_i_n_t
sl_zigbee_af_device_management_supply_status_flags_t
sl_zigbee_af_device_management_uncontrolled_flow_threshold_t
sl_zigbee_af_device_management_supply_status_t
sl_zigbee_af_device_management_password_t
sl_zigbee_af_device_management_info_t
sl_zigbee_af_device_management_attribute_range_t
sl_zigbee_af_device_management_attribute_table_t
sl_zigbee_af_gbz_message_data_t
sl_zigbee_af_remote_cluster_struct_t
sl_zigbee_af_remote_binding_struct_t
sl_zigbee_af_endpoint_info_struct_t
sl_zigbee_af_device_database_iterator_t
Enumerations#
Indicate the result of the service discovery. Unicast discoveries are completed as soon as a response is received. Broadcast discoveries wait a period of time for multiple responses to be received.
Control how the device will poll for a given active cluster-related event. When the event is scheduled, the application can pass a poll control value which will be stored along with the event. The processor is only allowed to poll according to the most restrictive value for all active event. For example, if two events are active, one with SL_ZIGBEE_AF_LONG_POLL and the other with SL_ZIGBEE_AF_SHORT_POLL, the processor will short poll until the second event is deactivated.
Control how the device will sleep for a given active cluster related event. When the event is scheduled, the scheduling code can pass a sleep control value which will be stored along with the event. The processor is only allowed to sleep according to the most restrictive sleep control value for any active event. For example, if two events are active, one with SL_ZIGBEE_AF_OK_TO_HIBERNATE and the other with SL_ZIGBEE_AF_OK_TO_NAP, the processor will only be allowed to sleep until the second event is deactivated.
Track tasks that the Application framework cares about. These are intended to be tasks that should keep the device out of hibernation like an application level request / response. If the response does not come in as a data ACK, the application needs to stay out of hibernation to wait and poll for it.
Specifies CPP Authorization values.
Status codes used by the ZLL Commissioning plugin.
The list of options possible for the image block request/response.
Contain the success or error code of an OTA storage device operation.
Contain the success or error code of an OTA download operation.
Indicate the state of an OTA bootload image undergoing verification. This is used both for cryptographic verification and manufacturer-specific verification.
CBKE Library types.
Typedefs#
Refer to the Zigbee application profile ID.
Refer to the ZCL attribute ID.
Refer to the ZCL cluster ID.
Refer to the ZCL attribute type.
User for the cluster mask.
User for the attribute mask.
Use for either of the cluster functions.
Interpan Message type: unicast, broadcast, or multicast.
The options for sending/receiving interpan messages.
The options for what interpan messages are allowed.
Bitmask data type for storing one bit of information for each ESI in the ESI table.
Define a callback where a code element or cluster can be informed as to the result of a service discovery they have requested. For each match, the callback is fired with all the resulting matches from that source. If the discovery was unicast to a specific device, the callback is only fired once with either MATCH_FOUND or COMPLETE (no matches found). If the discovery is broadcast, multiple callbacks may be fired with SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_RESPONSE_RECEIVED. After a few seconds, the callback is fired with SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_RESPONSE or SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_EMPTY_RESPONSE as the result.
Define a callback where a code element or cluster can be informed as to the result of a request to initiate a partner link key exchange. The callback will be triggered with success equal to true if the exchange completed successfully.
Refer to the handler for network events.
Refer to the handler for endpoint events.
Refer to the tick callback for cluster.
Refer to the init callback for cluster.
Refer to the attribute changed callback function.
Refer to the manufacturer-specific attribute changed callback function.
Refer to the pre-attribute changed callback function.
Refer to the default response callback function.
Refer to the message sent callback function.
Zigbee Internet Client/Server Remote Cluster Types.
Macros#
A distinguished manufacturer code that is used to indicate the absence of a manufacturer-specific profile, cluster, command, or attribute.
An invalid profile ID This is a reserved profileId.
A simple way to determine if the service discovery callback has a response.
Indicate the absence of a Group table entry.
Value used when setting or getting the endpoint in a Group table entry. It indicates that the entry is not in use.
Maximum length of Group names, not including the length byte.
Indicates the absence of a Scene table entry.
Value used when setting or getting the endpoint in a Scene table entry. It indicates that the entry is not in use.
Maximum length of Scene names, not including the length byte.
The group identifier for the global scene.
The scene identifier for the global scene.
Use when setting or getting the endpoint in a report table entry. It indicates that the entry is not in use.
The maximum size of the string that is present in the header of the Zigbee Over-the-air file format.
The length of the hardware tag in the Ember Bootloader Query Response.
Device Management plugin types.
Permit join times.
The overhead of the ZDO response. 1 byte for the sequence and 1 byte for the status code.
Enumeration Documentation#
sl_zigbee_af_security_profile_t#
sl_zigbee_af_security_profile_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_SECURITY_PROFILE_NONE | |
| SL_ZIGBEE_AF_SECURITY_PROFILE_HA | |
| SL_ZIGBEE_AF_SECURITY_PROFILE_HA12 | |
| SL_ZIGBEE_AF_SECURITY_PROFILE_SE_TEST | |
| SL_ZIGBEE_AF_SECURITY_PROFILE_SE_FULL | |
| SL_ZIGBEE_AF_SECURITY_PROFILE_Z3 | |
| SL_ZIGBEE_AF_SECURITY_PROFILE_CUSTOM | |
sl_zigbee_af_service_discovery_status_t#
sl_zigbee_af_service_discovery_status_t
Indicate the result of the service discovery. Unicast discoveries are completed as soon as a response is received. Broadcast discoveries wait a period of time for multiple responses to be received.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE | |
| SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_RESPONSE_RECEIVED | |
| SL_ZIGBEE_AF_UNICAST_SERVICE_DISCOVERY_TIMEOUT | |
| SL_ZIGBEE_AF_UNICAST_SERVICE_DISCOVERY_COMPLETE_WITH_RESPONSE | |
| SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_RESPONSE | |
| SL_ZIGBEE_AF_UNICAST_SERVICE_DISCOVERY_COMPLETE_WITH_EMPTY_RESPONSE | |
| SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_EMPTY_RESPONSE | |
sl_zigbee_af_event_poll_control_t#
sl_zigbee_af_event_poll_control_t
Control how the device will poll for a given active cluster-related event. When the event is scheduled, the application can pass a poll control value which will be stored along with the event. The processor is only allowed to poll according to the most restrictive value for all active event. For example, if two events are active, one with SL_ZIGBEE_AF_LONG_POLL and the other with SL_ZIGBEE_AF_SHORT_POLL, the processor will short poll until the second event is deactivated.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_LONG_POLL | |
| SL_ZIGBEE_AF_SHORT_POLL | |
sl_zigbee_af_event_sleep_control_t#
sl_zigbee_af_event_sleep_control_t
Control how the device will sleep for a given active cluster related event. When the event is scheduled, the scheduling code can pass a sleep control value which will be stored along with the event. The processor is only allowed to sleep according to the most restrictive sleep control value for any active event. For example, if two events are active, one with SL_ZIGBEE_AF_OK_TO_HIBERNATE and the other with SL_ZIGBEE_AF_OK_TO_NAP, the processor will only be allowed to sleep until the second event is deactivated.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_OK_TO_SLEEP | |
| SL_ZIGBEE_AF_OK_TO_HIBERNATE | Deprecated |
| SL_ZIGBEE_AF_OK_TO_NAP | Deprecated |
| SL_ZIGBEE_AF_STAY_AWAKE | |
sl_zigbee_af_application_task_t#
sl_zigbee_af_application_task_t
Track tasks that the Application framework cares about. These are intended to be tasks that should keep the device out of hibernation like an application level request / response. If the response does not come in as a data ACK, the application needs to stay out of hibernation to wait and poll for it.
Some tasks do not necessarily have a response. For example, a ZDO request may or may not have a response. In this case, the application framework cannot rely on the fact that a response will come in to end the wake cycle, so the Application framework must time out the wake cycle if no expected response is received or no other event can be relied upon to end the wake cycle.
Add these types of tasks to the wake timeout mask by calling sl_zigbee_af_set_wake_timeout_bitmask_cb so that they can be governed by a timeout instead of a request / response.
The current tasks bitmask is an uint32_t bitmask used to track which tasks are active at any given time. The bottom 16 bits, values 0x01 - 0x8000 are reserved for Ember's use. The top 16 bits are reserved for the customer, values 0x10000 - 0x80000000
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_WAITING_FOR_DATA_ACK | |
| SL_ZIGBEE_AF_LAST_POLL_GOT_DATA | |
| SL_ZIGBEE_AF_WAITING_FOR_SERVICE_DISCOVERY | |
| SL_ZIGBEE_AF_WAITING_FOR_ZDO_RESPONSE | |
| SL_ZIGBEE_AF_WAITING_FOR_ZCL_RESPONSE | |
| SL_ZIGBEE_AF_WAITING_FOR_REGISTRATION | |
| SL_ZIGBEE_AF_WAITING_FOR_PARTNER_LINK_KEY_EXCHANGE | |
| SL_ZIGBEE_AF_FORCE_SHORT_POLL | |
| SL_ZIGBEE_AF_FRAGMENTATION_IN_PROGRESS | |
| SL_ZIGBEE_AF_FORCE_SHORT_POLL_FOR_PARENT_CONNECTIVITY | |
| SL_ZIGBEE_AF_WAITING_FOR_TC_KEY_UPDATE | |
sl_zigbee_af_plugin_price_cpp_auth_t#
sl_zigbee_af_plugin_price_cpp_auth_t
Specifies CPP Authorization values.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_PLUGIN_PRICE_CPP_AUTH_PENDING | |
| SL_ZIGBEE_AF_PLUGIN_PRICE_CPP_AUTH_ACCEPTED | |
| SL_ZIGBEE_AF_PLUGIN_PRICE_CPP_AUTH_REJECTED | |
| SL_ZIGBEE_AF_PLUGIN_PRICE_CPP_AUTH_FORCED | |
| SL_ZIGBEE_AF_PLUGIN_PRICE_CPP_AUTH_RESERVED | |
sl_zigbee_af_plugin_tunneling_client_status_t#
sl_zigbee_af_plugin_tunneling_client_status_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_SUCCESS | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_BUSY | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_NO_MORE_TUNNEL_IDS | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_PROTOCOL_NOT_SUPPORTED | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_FLOW_CONTROL_NOT_SUPPORTED | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_IEEE_ADDRESS_REQUEST_FAILED | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_IEEE_ADDRESS_NOT_FOUND | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_ADDRESS_TABLE_FULL | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_LINK_KEY_EXCHANGE_REQUEST_FAILED | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_LINK_KEY_EXCHANGE_FAILED | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_REQUEST_TUNNEL_FAILED | |
| SL_ZIGBEE_AF_PLUGIN_TUNNELING_CLIENT_REQUEST_TUNNEL_TIMEOUT | |
sl_zigbee_af_zll_commissioning_status_t#
sl_zigbee_af_zll_commissioning_status_t
Status codes used by the ZLL Commissioning plugin.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_ZLL_ABORTED_BY_APPLICATION | |
| SL_ZIGBEE_AF_ZLL_CHANNEL_CHANGE_FAILED | |
| SL_ZIGBEE_AF_ZLL_JOINING_FAILED | |
| SL_ZIGBEE_AF_ZLL_NO_NETWORKS_FOUND | |
| SL_ZIGBEE_AF_ZLL_PREEMPTED_BY_STACK | |
| SL_ZIGBEE_AF_ZLL_SENDING_START_JOIN_FAILED | |
| SL_ZIGBEE_AF_ZLL_SENDING_DEVICE_INFORMATION_REQUEST_FAILED | |
| SL_ZIGBEE_AF_ZLL_SENDING_IDENTIFY_REQUEST_FAILED | |
| SL_ZIGBEE_AF_ZLL_SENDING_RESET_TO_FACTORY_NEW_REQUEST_FAILED | |
| SL_ZIGBEE_AF_ZLL_NETWORK_FORMATION_FAILED | |
| SL_ZIGBEE_AF_ZLL_NETWORK_UPDATE_OPERATION | |
sl_zigbee_af_image_block_request_options_t#
sl_zigbee_af_image_block_request_options_t
The list of options possible for the image block request/response.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_IMAGE_BLOCK_REQUEST_OPTIONS_NONE | |
| SL_ZIGBEE_AF_IMAGE_BLOCK_REQUEST_MIN_BLOCK_REQUEST_SUPPORTED_BY_CLIENT | |
| SL_ZIGBEE_AF_IMAGE_BLOCK_REQUEST_MIN_BLOCK_REQUEST_SUPPORTED_BY_SERVER | |
| SL_ZIGBEE_AF_IMAGE_BLOCK_REQUEST_SIMULATED_FROM_PAGE_REQUEST | |
sl_zigbee_af_ota_storage_status_t#
sl_zigbee_af_ota_storage_status_t
Contain the success or error code of an OTA storage device operation.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_OTA_STORAGE_SUCCESS | |
| SL_ZIGBEE_AF_OTA_STORAGE_ERROR | |
| SL_ZIGBEE_AF_OTA_STORAGE_RETURN_DATA_TOO_LONG | |
| SL_ZIGBEE_AF_OTA_STORAGE_PARTIAL_FILE_FOUND | |
| SL_ZIGBEE_AF_OTA_STORAGE_OPERATION_IN_PROGRESS | |
sl_zigbee_af_ota_download_result_t#
sl_zigbee_af_ota_download_result_t
Contain the success or error code of an OTA download operation.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_OTA_DOWNLOAD_AND_VERIFY_SUCCESS | |
| SL_ZIGBEE_AF_OTA_DOWNLOAD_TIME_OUT | |
| SL_ZIGBEE_AF_OTA_VERIFY_FAILED | |
| SL_ZIGBEE_AF_OTA_SERVER_ABORTED | |
| SL_ZIGBEE_AF_OTA_CLIENT_ABORTED | |
| SL_ZIGBEE_AF_OTA_ERASE_FAILED | |
sl_zigbee_af_key_establishment_notify_message_t#
sl_zigbee_af_key_establishment_notify_message_t
| Enumerator | |
|---|---|
| NO_APP_MESSAGE | |
| RECEIVED_PARTNER_CERTIFICATE | |
| GENERATING_EPHEMERAL_KEYS | |
| GENERATING_SHARED_SECRET | |
| KEY_GENERATION_DONE | |
| GENERATE_SHARED_SECRET_DONE | |
| LINK_KEY_ESTABLISHED | LINK_KEY_ESTABLISHED indicates Success, key establishment done. |
| NO_LOCAL_RESOURCES | Error codes: Transient failures where Key Establishment could be retried. |
| PARTNER_NO_RESOURCES | |
| TIMEOUT_OCCURRED | |
| INVALID_APP_COMMAND | |
| MESSAGE_SEND_FAILURE | |
| PARTNER_SENT_TERMINATE | |
| INVALID_PARTNER_MESSAGE | |
| PARTNER_SENT_DEFAULT_RESPONSE_ERROR | |
| BAD_CERTIFICATE_ISSUER | Fatal Errors: These results are not worth retrying because the outcome will not change. |
| KEY_CONFIRM_FAILURE | |
| BAD_KEY_ESTABLISHMENT_SUITE | |
| KEY_TABLE_FULL | |
| NO_ESTABLISHMENT_ALLOWED | Neither initiator nor responder is an ESP/TC so the key establishment is not allowed per the spec. |
| INVALID_CERTIFICATE_KEY_USAGE | |
sl_zigbee_af_image_verify_status_t#
sl_zigbee_af_image_verify_status_t
Indicate the state of an OTA bootload image undergoing verification. This is used both for cryptographic verification and manufacturer-specific verification.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_IMAGE_GOOD | |
| SL_ZIGBEE_AF_IMAGE_BAD | |
| SL_ZIGBEE_AF_IMAGE_VERIFY_IN_PROGRESS | |
sl_zigbee_af_cbke_key_establishment_suite_t#
sl_zigbee_af_cbke_key_establishment_suite_t
CBKE Library types.
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_INVALID_KEY_ESTABLISHMENT_SUITE | |
| SL_ZIGBEE_AF_CBKE_KEY_ESTABLISHMENT_SUITE_163K1 | |
| SL_ZIGBEE_AF_CBKE_KEY_ESTABLISHMENT_SUITE_283K1 | |
sl_zigbee_af_device_management_password_type_t#
sl_zigbee_af_device_management_password_type_t
| Enumerator | |
|---|---|
| UNUSED_PASSWORD | |
| SERVICE_PASSWORD | |
| CONSUMER_PASSWORD | |
sl_zigbee_af_device_management_change_pending_flags_t#
sl_zigbee_af_device_management_change_pending_flags_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_DEVICE_MANAGEMENT_CHANGE_OF_TENANCY_PENDING_MASK | |
| SL_ZIGBEE_AF_DEVICE_MANAGEMENT_CHANGE_OF_SUPPLIER_PENDING_MASK | |
| SL_ZIGBEE_AF_DEVICE_MANAGEMENT_UPDATE_SITE_ID_PENDING_MASK | |
| SL_ZIGBEE_AF_DEVICE_MANAGEMENT_UPDATE_CIN_PENDING_MASK | |
| SL_ZIGBEE_AF_DEVICE_MANAGEMENT_UPDATE_SERVICE_PASSWORD_PENDING_MASK | |
| SL_ZIGBEE_AF_DEVICE_MANAGEMENT_UPDATE_CONSUMER_PASSWORD_PENDING_MASK | |
sl_zigbee_af_device_discovery_status_t#
sl_zigbee_af_device_discovery_status_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_NONE | |
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_NEW | |
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_FIND_ENDPOINTS | |
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_FIND_CLUSTERS | |
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_FIND_STACK_REVISION | |
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_DONE | |
| SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_FAILED | |
Typedef Documentation#
sl_zigbee_af_profile_id_t#
typedef uint16_t sl_zigbee_af_profile_id_t
Refer to the Zigbee application profile ID.
sl_zigbee_af_attribute_id_t#
typedef uint16_t sl_zigbee_af_attribute_id_t
Refer to the ZCL attribute ID.
sl_zigbee_af_attribute_type_t#
typedef uint8_t sl_zigbee_af_attribute_type_t
Refer to the ZCL attribute type.
sl_zigbee_af_attribute_mask_t#
typedef uint8_t sl_zigbee_af_attribute_mask_t
User for the attribute mask.
sl_zigbee_af_generic_cluster_function_t#
typedef void(* sl_zigbee_af_generic_cluster_function_t) (void) )(void)
Use for either of the cluster functions.
This type is used for the array of the cluster functions and should always be cast into one of the specific functions before being called.
sl_zigbee_af_difference_type_t#
typedef uint64_t sl_zigbee_af_difference_type_t
Compare two ZCL attribute values. The size of this data type depends on the platform.
sl_zigbee_af_interpan_message_type_t#
typedef uint8_t sl_zigbee_af_interpan_message_type_t
Interpan Message type: unicast, broadcast, or multicast.
sl_zigbee_af_interpan_options_t#
typedef uint16_t sl_zigbee_af_interpan_options_t
The options for sending/receiving interpan messages.
sl_zigbee_af_allowed_interpan_options_t#
typedef uint8_t sl_zigbee_af_allowed_interpan_options_t
The options for what interpan messages are allowed.
sl_zigbee_af_tc_link_key_request_policy_t#
typedef sl_zigbee_tc_link_key_request_policy_t sl_zigbee_af_tc_link_key_request_policy_t
sl_zigbee_af_app_link_key_request_policy_t#
typedef sl_zigbee_app_link_key_request_policy_t sl_zigbee_af_app_link_key_request_policy_t
sl_zigbee_af_plugin_esi_management_bitmask_t#
typedef uint8_t sl_zigbee_af_plugin_esi_management_bitmask_t
Bitmask data type for storing one bit of information for each ESI in the ESI table.
sl_zigbee_af_service_discovery_callback_t#
typedef void() sl_zigbee_af_service_discovery_callback_t(const sl_zigbee_af_service_discovery_result_t *result) (const sl_zigbee_af_service_discovery_result_t *result)
Define a callback where a code element or cluster can be informed as to the result of a service discovery they have requested. For each match, the callback is fired with all the resulting matches from that source. If the discovery was unicast to a specific device, the callback is only fired once with either MATCH_FOUND or COMPLETE (no matches found). If the discovery is broadcast, multiple callbacks may be fired with SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_RESPONSE_RECEIVED. After a few seconds, the callback is fired with SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_RESPONSE or SL_ZIGBEE_AF_BROADCAST_SERVICE_DISCOVERY_COMPLETE_WITH_EMPTY_RESPONSE as the result.
sl_zigbee_af_partner_link_key_exchange_callback_t#
typedef void() sl_zigbee_af_partner_link_key_exchange_callback_t(bool success) (bool success)
Define a callback where a code element or cluster can be informed as to the result of a request to initiate a partner link key exchange. The callback will be triggered with success equal to true if the exchange completed successfully.
sl_zigbee_af_network_event_handler_t#
typedef void(* sl_zigbee_af_network_event_handler_t) (void) )(void)
Refer to the handler for network events.
sl_zigbee_af_endpoint_event_handler_t#
typedef void(* sl_zigbee_af_endpoint_event_handler_t) (uint8_t endpoint) )(uint8_t endpoint)
Refer to the handler for endpoint events.
sl_zigbee_af_tick_function_t#
typedef void(* sl_zigbee_af_tick_function_t) (uint8_t endpoint) )(uint8_t endpoint)
Refer to the tick callback for cluster.
Tick function will be called once for each tick for each endpoint in the cluster. The rate of tick is determined by the metadata of the cluster.
sl_zigbee_af_init_function_t#
typedef void(* sl_zigbee_af_init_function_t) (uint8_t endpoint) )(uint8_t endpoint)
Refer to the init callback for cluster.
Init function is called when the application starts up, once for each cluster/endpoint combination.
sl_zigbee_af_cluster_attribute_changed_callback_t#
typedef void(* sl_zigbee_af_cluster_attribute_changed_callback_t) (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId) )(uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId)
Refer to the attribute changed callback function.
This function is called just after an attribute changes.
sl_zigbee_af_manufacturer_specific_cluster_attribute_changed_callback_t#
typedef void(* sl_zigbee_af_manufacturer_specific_cluster_attribute_changed_callback_t) (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, uint16_t manufacturerCode) )(uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, uint16_t manufacturerCode)
Refer to the manufacturer-specific attribute changed callback function.
This function is called just after a manufacturer-specific attribute changes.
sl_zigbee_af_cluster_pre_attribute_changed_callback_t#
typedef sl_zigbee_af_status_t(* sl_zigbee_af_cluster_pre_attribute_changed_callback_t) (uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, sl_zigbee_af_attribute_type_t attributeType, uint8_t size, uint8_t *value) )(uint8_t endpoint, sl_zigbee_af_attribute_id_t attributeId, sl_zigbee_af_attribute_type_t attributeType, uint8_t size, uint8_t *value)
Refer to the pre-attribute changed callback function.
This function is called before an attribute changes.
sl_zigbee_af_default_response_function_t#
typedef void(* sl_zigbee_af_default_response_function_t) (uint8_t endpoint, uint8_t commandId, sl_zigbee_af_status_t status) )(uint8_t endpoint, uint8_t commandId, sl_zigbee_af_status_t status)
Refer to the default response callback function.
This function is called when default response is received, before the global callback. Global callback is called immediately afterwards.
sl_zigbee_af_message_sent_function_t#
typedef void(* sl_zigbee_af_message_sent_function_t) (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_aps_frame_t *apsFrame, uint16_t msgLen, uint8_t *message, sl_status_t status) )(sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_aps_frame_t *apsFrame, uint16_t msgLen, uint8_t *message, sl_status_t status)
Refer to the message sent callback function.
This function is called when a message is sent.
sl_zigbee_af_remote_cluster_type_t#
typedef uint16_t sl_zigbee_af_remote_cluster_type_t
Zigbee Internet Client/Server Remote Cluster Types.