Attribute Storage#

sl_zigbee_af_locate_attribute_metadata#

sl_zigbee_af_attribute_metadata_t * sl_zigbee_af_locate_attribute_metadata (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_id_t attributeId, uint8_t mask, uint16_t manufacturerCode)

Locate attribute metadata.

This function returns a pointer to the attribute metadata structure or NULL if attribute is not found.

Returns

• Returns pointer to the attribute metadata location.

sl_zigbee_af_contains_attribute#

bool sl_zigbee_af_contains_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_attribute_id_t attributeId, uint8_t mask, uint16_t manufacturerCode)

Return true if the attribute exists.

sl_zigbee_af_contains_cluster_with_mfg_code#

bool sl_zigbee_af_contains_cluster_with_mfg_code (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint16_t manufacturerCode)

Return true if an endpoint contains a cluster, checking for mfg code.

This function returns true regardless of whether the endpoint contains server, client or both. For standard libraries (when ClusterId < FC00), the manufacturerCode is ignored.

sl_zigbee_af_contains_cluster#

bool sl_zigbee_af_contains_cluster (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Return true if the endpoint contains the ZCL cluster with specified ID.

This function returns true regardless of whether the endpoint contains server, client or both in the Zigbee Cluster Library. This wraps sl_zigbee_af_contains_cluster_with_mfg_code with manufacturerCode = SL_ZIGBEE_AF_NULL_MANUFACTURER_CODE If this function is used with a manufacturer specific clusterId, it returns the first cluster that it finds in the Cluster table. It does not return any other clusters that share that ID.

sl_zigbee_af_contains_server_with_mfg_code#

bool sl_zigbee_af_contains_server_with_mfg_code (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint16_t manufacturerCode)

Return true if the endpoint has a cluster server, checking for the mfg code.

This function returns true if the endpoint contains server of a given cluster. For standard libraries (when ClusterId < FC00), the manufacturerCode is ignored.

sl_zigbee_af_contains_server#

bool sl_zigbee_af_contains_server (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Return true if the endpoint contains the ZCL server with a specified ID.

This function returns true if the endpoint contains server of a given cluster. This wraps sl_zigbee_af_contains_server with manufacturerCode = SL_ZIGBEE_AF_NULL_MANUFACTURER_CODE If this function is used with a manufacturer specific clusterId, it returns the first cluster that it finds in the Cluster table. It does not return any other clusters that share that ID.

sl_zigbee_af_contains_client_with_mfg_code#

bool sl_zigbee_af_contains_client_with_mfg_code (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint16_t manufacturerCode)

Return true if the endpoint contains the cluster client.

This function returns true if the endpoint contains client of a given cluster. For standard library clusters (when ClusterId < FC00), the manufacturerCode is ignored.

sl_zigbee_af_contains_client#

bool sl_zigbee_af_contains_client (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Return true if the endpoint contains the ZCL client with a specified ID.

This function returns true if the endpoint contains client of a given cluster. It wraps sl_zigbee_af_contains_client with manufacturerCode = SL_ZIGBEE_AF_NULL_MANUFACTURER_CODE If this function is used with a manufacturer-specific clusterId, it returns the first cluster that it finds in the Cluster table. It does not return any other clusters that share that ID.

sl_zigbee_af_write_attribute#

sl_zigbee_af_status_t sl_zigbee_af_write_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t mask, uint8_t * dataPtr, sl_zigbee_af_attribute_type_t dataType)

Write an attribute performing all checks.

This function attempts to write the attribute value from the provided pointer. It only checks that the attribute exists. If it does, it writes the value into the attribute table for the given attribute.

This function does not check if the attribute is writable since the read only / writable characteristic of an attribute only pertains to external devices writing over the air. Because this function is called locally, it assumes that the device knows what it is doing and has permission to perform the given operation.

See Also

• sl_zigbee_af_write_client_attribute, sl_zigbee_af_write_server_attribute, sl_zigbee_af_write_manufacturer_specific_client_attribute, sl_zigbee_af_write_manufacturer_specific_server_attribute

sl_zigbee_af_write_server_attribute#

sl_zigbee_af_status_t sl_zigbee_af_write_server_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t * dataPtr, sl_zigbee_af_attribute_type_t dataType)

Write a cluster server attribute.

This function is the same as sl_zigbee_af_write_attribute except that it saves having to pass the cluster mask. This is useful for code saving because the write attribute is used frequently throughout the framework

See Also

• sl_zigbee_af_write_client_attribute, sl_zigbee_af_write_manufacturer_specific_client_attribute, sl_zigbee_af_write_manufacturer_specific_server_attribute

sl_zigbee_af_write_client_attribute#

sl_zigbee_af_status_t sl_zigbee_af_write_client_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t * dataPtr, sl_zigbee_af_attribute_type_t dataType)

Write a cluster client attribute.

This function is the same as sl_zigbee_af_write_attribute except that it saves having to pass the cluster mask. This is useful for code saving because the write attribute is used frequently throughout the framework.

See Also

• sl_zigbee_af_write_server_attribute, sl_zigbee_af_write_manufacturer_specific_client_attribute, sl_zigbee_af_write_manufacturer_specific_server_attribute

sl_zigbee_af_write_manufacturer_specific_server_attribute#

sl_zigbee_af_status_t sl_zigbee_af_write_manufacturer_specific_server_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, sl_zigbee_af_attribute_type_t dataType)

Write a manufacturer-specific server attribute.

This function is the same as sl_zigbee_af_write_attribute except that it saves having to pass the cluster mask and allows passing a manufacturer code. This is useful for code saving because the write attribute is used frequently throughout the framework.

See Also

• sl_zigbee_af_write_client_attribute, sl_zigbee_af_write_server_attribute, sl_zigbee_af_write_manufacturer_specific_client_attribute

sl_zigbee_af_write_manufacturer_specific_client_attribute#

sl_zigbee_af_status_t sl_zigbee_af_write_manufacturer_specific_client_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, sl_zigbee_af_attribute_type_t dataType)

Write a manufacturer-specific client attribute.

This function is the same as sl_zigbee_af_write_attribute except that it saves having to pass the cluster mask and allows passing of a manufacturer code. This is useful for code saving because the write attribute is used frequently throughout the framework.

See Also

• sl_zigbee_af_write_client_attribute, sl_zigbee_af_write_server_attribute, sl_zigbee_af_write_manufacturer_specific_server_attribute

sl_zigbee_af_verify_attribute_write#

sl_zigbee_af_status_t sl_zigbee_af_verify_attribute_write (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t mask, uint16_t manufacturerCode, uint8_t * dataPtr, sl_zigbee_af_attribute_type_t dataType)

Test the success of attribute write.

This function returns success if the attribute write is successful. It does not actually write anything, just validates for read-only and data-type.

sl_zigbee_af_read_attribute#

sl_zigbee_af_status_t sl_zigbee_af_read_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t mask, uint8_t * dataPtr, uint8_t readLength, sl_zigbee_af_attribute_type_t * dataType)

Read the attribute value performing all the checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• sl_zigbee_af_read_client_attribute, sl_zigbee_af_read_server_attribute, sl_zigbee_af_read_manufacturer_specific_client_attribute, sl_zigbee_af_read_manufacturer_specific_server_attribute

sl_zigbee_af_read_server_attribute#

sl_zigbee_af_status_t sl_zigbee_af_read_server_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t * dataPtr, uint8_t readLength)

Read the server attribute value performing all the checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• sl_zigbee_af_read_client_attribute, sl_zigbee_af_read_manufacturer_specific_client_attribute, sl_zigbee_af_read_manufacturer_specific_server_attribute

sl_zigbee_af_read_client_attribute#

sl_zigbee_af_status_t sl_zigbee_af_read_client_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint8_t * dataPtr, uint8_t readLength)

Read the client attribute value, performing all the checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• sl_zigbee_af_read_server_attribute, sl_zigbee_af_read_manufacturer_specific_client_attribute, sl_zigbee_af_read_manufacturer_specific_server_attribute

sl_zigbee_af_read_manufacturer_specific_server_attribute#

sl_zigbee_af_status_t sl_zigbee_af_read_manufacturer_specific_server_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, uint8_t readLength)

Read the manufacturer-specific server attribute value, performing all checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• sl_zigbee_af_read_client_attribute, sl_zigbee_af_read_server_attribute, sl_zigbee_af_read_manufacturer_specific_client_attribute

sl_zigbee_af_read_manufacturer_specific_client_attribute#

sl_zigbee_af_status_t sl_zigbee_af_read_manufacturer_specific_client_attribute (uint8_t endpoint, sl_zigbee_af_cluster_id_t cluster, sl_zigbee_af_attribute_id_t attributeID, uint16_t manufacturerCode, uint8_t * dataPtr, uint8_t readLength)

Read the manufacturer-specific client attribute value, performing all checks.

This function attempts to read the attribute and store it into the pointer. It also reads the data type. Both dataPtr and dataType may be NULL, signifying that either value or type is not desired.

See Also

• sl_zigbee_af_read_client_attribute, sl_zigbee_af_read_server_attribute, sl_zigbee_af_read_manufacturer_specific_server_attribute

sl_zigbee_af_get_data_size#

uint8_t sl_zigbee_af_get_data_size (uint8_t dataType)

Return the size of the ZCL data in bytes.

Returns

• Size in bytes or 0 if invalid data type

sl_zigbee_af_get_open_network_duration_sec#

uint8_t sl_zigbee_af_get_open_network_duration_sec (void )

Return the number of seconds the network remains open.

Returns

• A return value of 0 indicates that the network is closed.

sl_zigbee_af_endpoint_from_index#

uint8_t sl_zigbee_af_endpoint_from_index (uint8_t index)

Take an index of an endpoint and return the Zigbee endpoint.

Returns

• Zigbee endpoint.

sl_zigbee_af_index_from_endpoint#

uint8_t sl_zigbee_af_index_from_endpoint (uint8_t endpoint)

Return the index of a given endpoint.

Returns

• Index of a Zigbee endpoint.

sl_zigbee_af_index_from_endpoint_including_disabled_endpoints#

uint8_t sl_zigbee_af_index_from_endpoint_including_disabled_endpoints (uint8_t endpoint)

Return the index of a given endpoint. It does not ignore disabled endpoints.

Returns

• Index of a Zigbee endpoint.

sl_zigbee_af_find_cluster_client_endpoint_index#

uint8_t sl_zigbee_af_find_cluster_client_endpoint_index (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Return the endpoint index within a given cluster (Client-side), looking only for standard clusters.

Returns

• Index of a Zigbee endpoint.

sl_zigbee_af_find_cluster_server_endpoint_index#

uint8_t sl_zigbee_af_find_cluster_server_endpoint_index (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Return the endpoint index within a given cluster (Server-side), looking only for standard clusters.

Returns

• Index of a Zigbee endpoint.

sl_zigbee_af_network_index_from_endpoint#

uint8_t sl_zigbee_af_network_index_from_endpoint (uint8_t endpoint)

Return the network index of a given endpoint.

Returns

• Network index of a Zigbee endpoint.

sl_zigbee_af_endpoint_count#

uint8_t sl_zigbee_af_endpoint_count (void )

Return the total number of endpoints (dynamic and pre-compiled).

sl_zigbee_af_fixed_endpoint_count#

uint8_t sl_zigbee_af_fixed_endpoint_count (void )

Return the number of pre-compiled endpoints.

sl_zigbee_af_get_attribute_analog_or_discrete_type#

uint8_t sl_zigbee_af_get_attribute_analog_or_discrete_type (uint8_t dataType)

Return the type of the attribute, either ANALOG, DISCRETE, or NONE.

sl_zigbee_af_is_type_signed#

bool sl_zigbee_af_is_type_signed (sl_zigbee_af_attribute_type_t dataType)

Return true if type is signed, false otherwise.

sl_zigbee_af_get_int32u#

uint32_t sl_zigbee_af_get_int32u (const uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a 32-bit integer from the message buffer.

sl_zigbee_af_get_int24u#

uint32_t sl_zigbee_af_get_int24u (const uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a 24-bit integer from the message buffer.

sl_zigbee_af_get_int16u#

uint16_t sl_zigbee_af_get_int16u (const uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a 16-bit integer from the message buffer.

sl_zigbee_af_get_string#

uint8_t * sl_zigbee_af_get_string (uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a ZCL string from the message buffer.

sl_zigbee_af_get_long_string#

uint8_t * sl_zigbee_af_get_long_string (uint8_t * message, uint16_t currentIndex, uint16_t msgLen)

Extract a ZCL long string from the message buffer.

sl_zigbee_af_get_date#

uint8_t sl_zigbee_af_get_date (uint8_t * message, uint16_t currentIndex, uint16_t msgLen, sl_zigbee_af_date_t * destination)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_copy_int16u#

void sl_zigbee_af_copy_int16u (uint8_t * data, uint16_t index, uint16_t x)

Copy a uint16_t value into a buffer.

sl_zigbee_af_copy_int24u#

void sl_zigbee_af_copy_int24u (uint8_t * data, uint16_t index, uint32_t x)

Copy a uint24_t value into a buffer.

sl_zigbee_af_copy_int32u#

void sl_zigbee_af_copy_int32u (uint8_t * data, uint16_t index, uint32_t x)

Copy a uint32_t value into a buffer.

sl_zigbee_af_copy_string#

void sl_zigbee_af_copy_string (uint8_t * dest, uint8_t * src, uint8_t size)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_copy_long_string#

void sl_zigbee_af_copy_long_string (uint8_t * dest, uint8_t * src, uint16_t size)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_string_length#

uint8_t sl_zigbee_af_string_length (const uint8_t * buffer)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_long_string_length#

uint16_t sl_zigbee_af_long_string_length (const uint8_t * buffer)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_attribute_value_size#

uint16_t sl_zigbee_af_attribute_value_size (sl_zigbee_af_attribute_type_t dataType, const uint8_t * buffer, const uint16_t bufferSize)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_is_device_enabled#

bool sl_zigbee_af_is_device_enabled (uint8_t endpoint)

Check whether the endpoint is enabled.

This function returns true if device at a given endpoint is enabled. At startup, all endpoints are enabled.

sl_zigbee_af_is_device_identifying#

bool sl_zigbee_af_is_device_identifying (uint8_t endpoint)

Check whether the endpoint is identifying.

This function returns true if the device at a given endpoint is identifying.

sl_zigbee_af_set_device_enabled#

void sl_zigbee_af_set_device_enabled (uint8_t endpoint, bool enabled)

Enable or disable an endpoint.

By calling this function, you turn off all processing of incoming traffic for a given endpoint.

sl_zigbee_wakeup_common_task#

void sl_zigbee_wakeup_common_task (void )

Set the Zigbee stack task to ready when running on an OS.

sl_zigbee_af_endpoint_enable_disable#

bool sl_zigbee_af_endpoint_enable_disable (uint8_t endpoint, bool enable)

Enable/disable endpoints.

sl_zigbee_af_endpoint_index_is_enabled#

bool sl_zigbee_af_endpoint_index_is_enabled (uint8_t index)

Determine if an endpoint at the specified index is enabled or disabled.

sl_zigbee_af_is_this_data_type_a_string_type#

bool sl_zigbee_af_is_this_data_type_a_string_type (sl_zigbee_af_attribute_type_t dataType)

Return true if a given ZCL data type is a string type.

Use this function to perform a different memory operation on a certain attribute because it is a string type. Since ZCL strings carry length as the first byte(s), it is often required to treat them differently than regular data types.

Returns

• true if data type is a string.

sl_zigbee_af_is_string_attribute_type#

bool sl_zigbee_af_is_string_attribute_type (sl_zigbee_af_attribute_type_t attributeType)

Return true if the given attribute type is a string.

sl_zigbee_af_is_long_string_attribute_type#

bool sl_zigbee_af_is_long_string_attribute_type (sl_zigbee_af_attribute_type_t attributeType)

Return true if the given attribute type is a long string.

sl_zigbee_af_next_sequence#

uint8_t sl_zigbee_af_next_sequence (void )

Increment the ZCL sequence number and return the value.

ZCL messages have sequence numbers so that they can be matched up with other messages in the transaction. To avoid conflicts with sequence numbers generated independently by the application, this API returns sequence numbers with the high bit clear. If the application generates its own sequence numbers, it should use numbers with the high bit set.

Returns

• The next ZCL sequence number.

sl_zigbee_af_get_last_sequence_number#

uint8_t sl_zigbee_af_get_last_sequence_number (void )

Retrieve the last sequence number that was used.

sl_zigbee_af_compare_values#

int8_t sl_zigbee_af_compare_values (uint8_t * val1, uint8_t * val2, uint8_t len, bool signedNumber)

Compare two values of known length as integers.Simple integer comparison function. Signed integer comparison are supported for numbers with length of 4 (bytes) or less. The integers are in native endianness.

Returns

• -1, if val1 is smaller 0, if they are the same or if two negative numbers with length greater than 4 is being compared 1, if val2 is smaller.

sl_zigbee_af_get_eui64#

void sl_zigbee_af_get_eui64 (sl_802154_long_addr_t returnEui64)

Populate the passed EUI64 with the local EUI64 MAC address.

sl_zigbee_af_get_node_id#

sl_802154_short_addr_t sl_zigbee_af_get_node_id (void )

Return the node ID of the local node.

sl_zigbee_af_generate_random_key#

sl_status_t sl_zigbee_af_generate_random_key (sl_zigbee_key_data_t * result)

Generate a random key (link, network, or master).

sl_zigbee_af_get_pan_id#

sl_802154_pan_id_t sl_zigbee_af_get_pan_id (void )

Return the PAN ID of the local node.

sl_zigbee_af_get_radio_channel#

uint8_t sl_zigbee_af_get_radio_channel (void )

Return the radioChannel of the current network.

sl_zigbee_af_network_state#

sl_zigbee_network_status_t sl_zigbee_af_network_state (void )

Return the current network state. This call caches the results on the host to prevent frequent EZSP transactions.

sl_zigbee_af_get_network_parameters#

sl_status_t sl_zigbee_af_get_network_parameters (sl_zigbee_node_type_t * nodeType, sl_zigbee_network_parameters_t * parameters)

Return the current network parameters.

sl_zigbee_af_get_node_type#

sl_status_t sl_zigbee_af_get_node_type (sl_zigbee_node_type_t * nodeType)

Return the current node type.

sl_zigbee_af_permit_join#

sl_status_t sl_zigbee_af_permit_join (uint8_t duration, bool broadcastMgmtPermitJoin)

Enable local permit join and optionally broadcast the ZDO Mgmt_Permit_Join_req message. This API can be called from any device type and still return SL_STATUS_OK. If the API is called from an end device, the permit association bit will just be left off.

Returns

• status of whether or not permit join was enabled.

sl_zigbee_af_broadcast_permit_join#

sl_status_t sl_zigbee_af_broadcast_permit_join (uint8_t duration)

Enable local permit join and broadcast the ZDO Mgmt_Permit_Join_req message. This API can be called from any device type and still return SL_STATUS_OK. If the API is called from an end device, the permit association bit will just be left off.

Returns

• status of whether or not permit join was enabled.

sl_zigbee_af_acquire_lock#

void sl_zigbee_af_acquire_lock (void )

Acquire the app framework mutex (for RTOS builds). This should be done if code run from outside of the app framework (callback) context in RTOS builds needs to call app framework APIs, as interactions between app framework and other application tasks are not otherwise designed to be thread-safe. Note that APIs relating to app framework events are included in this category of app framework APIs (so thread-safe interactions with the event queue from other tasks require the acquisition of this lock).

sl_zigbee_af_release_lock#

void sl_zigbee_af_release_lock (void )

Release the app framework mutex (for RTOS builds), allowing other application tasks (like the app framework task) waiting on this mutex to run. This should be done once the application code has finished its calls to app framework data or APIs.

sl_zigbee_zcl_schedule_tick_extended#

sl_status_t sl_zigbee_zcl_schedule_tick_extended (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, bool isClient, uint32_t delayMs, sl_zigbee_af_event_poll_control_t pollControl, sl_zigbee_af_event_sleep_control_t sleepControl)

Schedule a cluster-related event inside the application framework's event mechanism. This function provides a wrapper for the Ember stack event mechanism which allows the cluster code to access its events by their endpoint, cluster ID, and client/server identity. The passed poll and sleep controls allow the cluster to indicate whether it needs to long or short poll and whether it needs to stay awake or if it can sleep.

Returns

• SL_STATUS_OK if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_cluster_tick#

sl_status_t sl_zigbee_zcl_schedule_cluster_tick (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, bool isClient, uint32_t delayMs, sl_zigbee_af_event_sleep_control_t sleepControl)

Schedule a cluster-related event inside the application framework's event mechanism. This function is a wrapper for ::sl_zigbee_af_schedule_tick_extended. The cluster on the given endpoint will be set to long poll if sleepControl is set to SL_ZIGBEE_AF_OK_TO_HIBERNATE or will be set to short poll otherwise. It will stay awake if sleepControl is SL_ZIGBEE_AF_STAY_AWAKE and will sleep otherwise.

Returns

• SL_STATUS_OK if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_client_tick_extended#

sl_status_t sl_zigbee_zcl_schedule_client_tick_extended (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint32_t delayMs, sl_zigbee_af_event_poll_control_t pollControl, sl_zigbee_af_event_sleep_control_t sleepControl)

Schedule a cluster client event. This function is a wrapper for sl_zigbee_zcl_schedule_tick_extended.

Returns

• SL_STATUS_OK if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_client_tick#

sl_status_t sl_zigbee_zcl_schedule_client_tick (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint32_t delayMs)

Schedule a cluster client event. This function is a wrapper for sl_zigbee_zcl_schedule_client_tick_extended. It indicates that the cluster client on the given endpoint can long poll and can sleep.

Returns

• SL_STATUS_OK if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_server_tick_extended#

sl_status_t sl_zigbee_zcl_schedule_server_tick_extended (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint32_t delayMs, sl_zigbee_af_event_poll_control_t pollControl, sl_zigbee_af_event_sleep_control_t sleepControl)

Schedule a cluster server event. This function is a wrapper for sl_zigbee_zcl_schedule_tick_extended.

Returns

• SL_STATUS_OK if the event was scheduled or an error otherwise.

sl_zigbee_zcl_schedule_server_tick#

sl_status_t sl_zigbee_zcl_schedule_server_tick (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, uint32_t delayMs)

Schedule a cluster server event. This function is a wrapper for sl_zigbee_zcl_schedule_server_tick_extended. It indicates that the cluster server on the given endpoint can long poll and can sleep.

Returns

• SL_STATUS_OK if the event was scheduled or an error otherwise.

sl_zigbee_zcl_deactivate_cluster_tick#

sl_status_t sl_zigbee_zcl_deactivate_cluster_tick (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId, bool isClient)

Deactivate a cluster-related event. This function provides a wrapper for the Ember stack's event mechanism, which allows an event to be accessed by its endpoint, cluster ID, and client/server identity.

Returns

• SL_STATUS_OK if the event was deactivated or an error otherwise.

sl_zigbee_zcl_deactivate_client_tick#

sl_status_t sl_zigbee_zcl_deactivate_client_tick (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Deactivate a cluster client event. This function is a wrapper for sl_zigbee_zcl_deactivate_cluster_tick.

Returns

• SL_STATUS_OK if the event was deactivated or an error otherwise.

sl_zigbee_zcl_deactivate_server_tick#

sl_status_t sl_zigbee_zcl_deactivate_server_tick (uint8_t endpoint, sl_zigbee_af_cluster_id_t clusterId)

Deactivate a cluster server event. This function is a wrapper for sl_zigbee_zcl_deactivate_cluster_tick.

Returns

• SL_STATUS_OK if the event was deactivated or an error otherwise.

sl_zigbee_af_send_response#

sl_status_t sl_zigbee_af_send_response (void )

Send a ZCL response, based on the information that is currently in the outgoing buffer. It is expected that a complete ZCL message is present, including header. The application may use this method directly from within the message handling function and associated callbacks. However, this will result in the response being sent before the APS ACK is sent, which is not ideal.

NOTE: This will overwrite the ZCL sequence number of the message to use the LAST received sequence number.

sl_zigbee_af_send_response_with_cb#

sl_status_t sl_zigbee_af_send_response_with_cb (sl_zigbee_af_message_sent_function_t callback)

Send ZCL response with attached message sent callback.

sl_zigbee_af_send_multicast#

sl_status_t sl_zigbee_af_send_multicast (sl_zigbee_multicast_id_t multicastId, sl_802154_short_addr_t alias, uint8_t sequence, sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message)

Send a multicast message to all endpoints that share a specific multicast ID and are within a specified number of hops of the sender.

Returns

• An sl_status_t value. For any result other than SL_STATUS_OK, the message will not be sent.

sl_zigbee_af_send_multicast_to_bindings#

sl_status_t sl_zigbee_af_send_multicast_to_bindings (sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message)

Multicast the message to the group in the binding table that match the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic. Care should be taken when considering the effects of broadcasts in a network.

sl_zigbee_af_send_multicast_with_cb#

sl_status_t sl_zigbee_af_send_multicast_with_cb (sl_zigbee_multicast_id_t multicastId, sl_802154_short_addr_t alias, uint8_t sequence, sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message, sl_zigbee_af_message_sent_function_t callback)

Send multicast with attached message sent callback.

sl_zigbee_af_send_broadcast#

sl_status_t sl_zigbee_af_send_broadcast (sl_802154_short_addr_t alias, sl_802154_short_addr_t destination, uint8_t sequence, sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message)

Send a broadcast message as per the ZigBee specification.

The message will be delivered to all nodes within radius hops of the sender. A radius of zero is converted to ::SL_ZIGBEE_MAX_HOPS.

Returns

• An sl_status_t value.

sl_zigbee_af_send_broadcast_with_cb#

sl_status_t sl_zigbee_af_send_broadcast_with_cb (sl_802154_short_addr_t destination, sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message, sl_802154_short_addr_t alias, uint8_t sequence, sl_zigbee_af_message_sent_function_t callback)

Send broadcast with attached message sent callback.

sl_zigbee_af_send_unicast#

sl_status_t sl_zigbee_af_send_unicast (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message)

Send unicast.

sl_zigbee_af_send_unicast_with_cb#

sl_status_t sl_zigbee_af_send_unicast_with_cb (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message, sl_zigbee_af_message_sent_function_t callback)

Send unicast with attached message sent callback.

sl_zigbee_af_send_unicast_to_bindings#

sl_status_t sl_zigbee_af_send_unicast_to_bindings (sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message)

Unicast the message to each remote node in the binding table that matches the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic.

sl_zigbee_af_send_unicast_to_bindings_with_cb#

sl_status_t sl_zigbee_af_send_unicast_to_bindings_with_cb (sl_zigbee_aps_frame_t * apsFrame, uint16_t messageLength, uint8_t * message, sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_unicast_to_bindings with attached message sent callback.

sl_zigbee_af_send_inter_pan#

sl_status_t sl_zigbee_af_send_inter_pan (sl_802154_pan_id_t panId, const sl_802154_long_addr_t destinationLongId, sl_802154_short_addr_t destinationShortId, sl_zigbee_multicast_id_t multicastId, sl_zigbee_af_cluster_id_t clusterId, sl_zigbee_af_profile_id_t profileId, uint16_t messageLength, uint8_t * messageBytes)

Send interpan message.

sl_zigbee_af_send_command_unicast_to_bindings#

sl_status_t sl_zigbee_af_send_command_unicast_to_bindings (void )

Send the command prepared with sl_zigbee_af_fill.... macro.

This function is used to send a command that was previously prepared using the sl_zigbee_af_fill... macros from the client command API. It will be sent as unicast to each remote node in the binding table that matches the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic.

sl_zigbee_af_send_command_unicast_to_bindings_with_cb#

sl_status_t sl_zigbee_af_send_command_unicast_to_bindings_with_cb (sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_command_unicast_to_bindings with attached message sent callback.

sl_zigbee_af_send_command_multicast#

sl_status_t sl_zigbee_af_send_command_multicast (sl_zigbee_multicast_id_t multicastId, sl_802154_short_addr_t alias, uint8_t sequence)

Send the command prepared with sl_zigbee_af_fill.... macro.

This function is used to send a command that was previously prepared using the sl_zigbee_af_fill... macros from the client command API. It will be sent as multicast.

sl_zigbee_af_send_command_multicast_with_cb#

sl_status_t sl_zigbee_af_send_command_multicast_with_cb (sl_zigbee_multicast_id_t multicastId, sl_802154_short_addr_t alias, uint8_t sequence, sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_command_multicast with attached message sent callback.

sl_zigbee_af_send_command_multicast_to_bindings#

sl_status_t sl_zigbee_af_send_command_multicast_to_bindings (void )

Send the command prepared with sl_zigbee_af_fill.... macro.

This function is used to send a command that was previously prepared using the sl_zigbee_af_fill... macros from the client command API. It will be sent as multicast to the group specified in the binding table that matches the cluster and source endpoint in the APS frame. Note: if the binding table contains many matching entries, calling this API cause a significant amount of network traffic.

sl_zigbee_af_send_command_unicast#

sl_status_t sl_zigbee_af_send_command_unicast (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination)

Send the command prepared with sl_zigbee_af_fill.... macro.

This function is used to send a command that was previously prepared using the sl_zigbee_af_fill... macros from the client command API. It will be sent as unicast.

sl_zigbee_af_send_command_unicast_with_cb#

sl_status_t sl_zigbee_af_send_command_unicast_with_cb (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_command_unicast with attached message sent callback.

sl_zigbee_af_send_command_broadcast#

sl_status_t sl_zigbee_af_send_command_broadcast (sl_802154_short_addr_t destination, sl_802154_short_addr_t alias, uint8_t sequence)

Send the command prepared with sl_zigbee_af_fill.... macro.

This function is used to send a command that was previously prepared using the sl_zigbee_af_fill... macros from the client command API.

sl_zigbee_af_send_command_broadcast_with_cb#

sl_status_t sl_zigbee_af_send_command_broadcast_with_cb (sl_802154_short_addr_t destination, sl_802154_short_addr_t alias, uint8_t sequence, sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_command_broadcast with attached message sent callback.

sl_zigbee_af_send_command_inter_pan#

sl_status_t sl_zigbee_af_send_command_inter_pan (sl_802154_pan_id_t panId, const sl_802154_long_addr_t destinationLongId, sl_802154_short_addr_t destinationShortId, sl_zigbee_multicast_id_t multicastId, sl_zigbee_af_profile_id_t profileId)

Send the command prepared with sl_zigbee_af_fill.... macro.

This function is used to send a command that was previously prepared using the sl_zigbee_af_fill... macros from the client command API. It will be sent via inter-PAN. If destinationLongId is not NULL, the message will be sent to that long address using long addressing mode; otherwise, the message will be sent to destinationShortId using short address mode. IF multicastId is not zero, the message will be sent using multicast mode.

sl_zigbee_af_send_default_response#

sl_status_t sl_zigbee_af_send_default_response (const sl_zigbee_af_cluster_command_t * cmd, sl_zigbee_af_status_t status)

Send a default response to a cluster command.

This function is used to prepare and send a default response to a cluster command.

Returns

• An sl_status_t value that indicates the success or failure of sending the response.

sl_zigbee_af_send_default_response_with_cb#

sl_status_t sl_zigbee_af_send_default_response_with_cb (const sl_zigbee_af_cluster_command_t * cmd, sl_zigbee_af_status_t status, sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_default_response with attached message sent callback.

sl_zigbee_af_send_immediate_default_response#

sl_status_t sl_zigbee_af_send_immediate_default_response (sl_zigbee_af_status_t status)

Send a default response to a cluster command using the current command.

This function is used to prepare and send a default response to a cluster command.

Returns

• An sl_status_t value that indicates the success or failure of sending the response.

sl_zigbee_af_send_immediate_default_response_with_cb#

sl_status_t sl_zigbee_af_send_immediate_default_response_with_cb (sl_zigbee_af_status_t status, sl_zigbee_af_message_sent_function_t callback)

sl_zigbee_af_send_immediate_default_response with attached message sent callback.

sl_zigbee_af_maximum_aps_payload_length#

uint8_t sl_zigbee_af_maximum_aps_payload_length (sl_zigbee_outgoing_message_type_t type, uint16_t indexOrDestination, sl_zigbee_aps_frame_t * apsFrame)

Return the maximum size of the payload that the Application Support sub-layer will accept for the given message type, destination, and APS frame.

The size depends on multiple factors, including the security level in use and additional information added to the message to support the various options.

Returns

• The maximum APS payload length for the given message.

sl_zigbee_af_get_command_aps_frame#

sl_zigbee_aps_frame_t * sl_zigbee_af_get_command_aps_frame (void )

Access to client API APS frame.

sl_zigbee_af_set_command_endpoints#

void sl_zigbee_af_set_command_endpoints (uint8_t sourceEndpoint, uint8_t destinationEndpoint)

Set the source and destination endpoints in the client API APS frame.

sl_zigbee_af_find_devices_by_profile_and_cluster#

sl_status_t sl_zigbee_af_find_devices_by_profile_and_cluster (sl_802154_short_addr_t target, sl_zigbee_af_profile_id_t profileId, sl_zigbee_af_cluster_id_t clusterId, bool serverCluster, sl_zigbee_af_service_discovery_callback_t * callback)

Find devices in the network with endpoints matching a given profile ID and cluster ID in their descriptors. Target may either be a specific device, or the broadcast address SL_ZIGBEE_RX_ON_WHEN_IDLE_BROADCAST_ADDRESS.

This function initiates a service discovery. Received responses are returned by executing the callback function passed in. For unicast discoveries, the callback will be executed only once. Either the target will return a result or a timeout will occur. For broadcast discoveries, the callback may be called multiple times and after a period of time the discovery will be finished with a final call to the callback.

sl_zigbee_af_find_clusters_by_device_and_endpoint#

sl_status_t sl_zigbee_af_find_clusters_by_device_and_endpoint (sl_802154_short_addr_t target, uint8_t targetEndpoint, sl_zigbee_af_service_discovery_callback_t * callback)

Find all of the given in and out clusters implemented on a devices given endpoint. Target should only be the short address of a specific device.

This function initiates a single service discovery and the response is passed back to the passed callback.

sl_zigbee_af_find_ieee_address#

sl_status_t sl_zigbee_af_find_ieee_address (sl_802154_short_addr_t shortAddress, sl_zigbee_af_service_discovery_callback_t * callback)

Initiate a discovery for the IEEE address of the specified node ID. This will send a unicast sent to the target node ID.

sl_zigbee_af_find_node_id#

sl_status_t sl_zigbee_af_find_node_id (sl_802154_long_addr_t longAddress, sl_zigbee_af_service_discovery_callback_t * callback)

Initiate a discovery for the short ID of the specified long address. This will send a broadcast to all RX-on-when-idle devices (non-sleepies).

sl_zigbee_af_find_active_endpoints#

sl_status_t sl_zigbee_af_find_active_endpoints (sl_802154_short_addr_t target, sl_zigbee_af_service_discovery_callback_t * callback)

Initiate an Active Endpoint request ZDO message to the target node ID.

sl_zigbee_af_add_address_table_entry#

uint8_t sl_zigbee_af_add_address_table_entry (sl_802154_long_addr_t longId, sl_802154_short_addr_t shortId)

Add an entry for a remote device to the address table.

If the EUI64 already exists in the address table, the index of the existing entry will be returned. Otherwise, a new entry will be created and the new new index will be returned. The framework will remember how many times the returned index has been referenced. When the address table entry is no longer needed, the application should remove its reference by calling sl_zigbee_af_remove_address_table_entry.

Returns

• The index of the address table entry for this remove device or ::SL_ZIGBEE_NULL_ADDRESS_TABLE_INDEX if an error occurred (e.g., the address table is full).

sl_zigbee_af_set_address_table_entry#

sl_status_t sl_zigbee_af_set_address_table_entry (uint8_t index, sl_802154_long_addr_t longId, sl_802154_short_addr_t shortId)

Add an entry for a remote device to the address table at a specific location.

The framework will remember how many times an address table index has been referenced through sl_zigbee_af_add_address_table_entry. If the reference count for the index passed to this function is not zero, the entry will be not changed. When the address table entry is no longer needed, the application should remove its reference by calling sl_zigbee_af_remove_address_table_entry.

Returns

• SL_STATUS_OK if the address table entry was successfully set, SL_STATUS_ZIGBEE_ADDRESS_TABLE_ENTRY_IS_ACTIVE if any messages are being sent using the existing entry at that index or the entry is still referenced in the framework, or SL_STATUS_INVALID_RANGE if the index is out of range.

sl_zigbee_af_remove_address_table_entry#

sl_status_t sl_zigbee_af_remove_address_table_entry (uint8_t index)

Remove a specific entry from the address table.

The framework will remember how many times an address table index has been referenced through sl_zigbee_af_add_address_table_entry and sl_zigbee_af_set_address_table_entry. The address table entry at this index will not actually be removed until its reference count reaches zero.

Returns

• SL_STATUS_OK if the address table entry was successfully removed or SL_STATUS_INVALID_RANGE if the index is out of range.

sl_zigbee_af_initiate_key_establishment#

sl_status_t sl_zigbee_af_initiate_key_establishment (sl_802154_short_addr_t nodeId, uint8_t endpoint)

Initiate key establishment with a remote node. sl_zigbee_af_key_establishment_cb will be called as events occur and when key establishment completes.

Returns

• SL_STATUS_OK if key establishment was initiated successfully

sl_zigbee_af_initiate_inter_pan_key_establishment#

sl_status_t sl_zigbee_af_initiate_inter_pan_key_establishment (sl_802154_pan_id_t panId, const sl_802154_long_addr_t eui64)

Initiate key establishment with a remote node on a different PAN. sl_zigbee_af_inter_pan_key_establishment_cb will be called as events occur and when key establishment completes.

Returns

• SL_STATUS_OK if key establishment was initiated successfully

sl_zigbee_af_performing_key_establishment#

bool sl_zigbee_af_performing_key_establishment (void )

Indicate whether the device is in the process of performing key establishment.

Returns

• ::true if key establishment is in progress.

sl_zigbee_af_initiate_partner_link_key_exchange#

sl_status_t sl_zigbee_af_initiate_partner_link_key_exchange (sl_802154_short_addr_t target, uint8_t endpoint, sl_zigbee_af_partner_link_key_exchange_callback_t * callback)

Initiate partner link key exchange with a remote node.

Returns

• SL_STATUS_OK if the partner link key exchange was initiated successfully.

sl_zigbee_af_is_current_security_profile_smart_energy#

bool sl_zigbee_af_is_current_security_profile_smart_energy (void )

Use this function to determine if the security profile of the current network was set to Smart Energy. The security profile is configured in AppBuilder. @ return true if the security profile is Smart Energy or false otherwise.

sl_zigbee_subscribe_to_zcl_commands#

sl_status_t sl_zigbee_subscribe_to_zcl_commands (uint16_t cluster_id, uint16_t manufacturer_id, uint8_t direction, sl_service_function_t service_function)

Runtime subscription to specific incoming ZCL commands.

Returns

• A sl_status_t value of:

  • SL_STATUS_OK - If the subscription was successful.

  • SL_STATUS_INVALID_PARAMETER - If one or more passed parameters are invalid.

  • SL_STATUS_ALLOCATION_FAILED - If the system failed to allocate the necessary data structures.

sl_zigbee_af_form_network#

sl_status_t sl_zigbee_af_form_network (sl_zigbee_network_parameters_t * parameters)

Form a new network using the specified network parameters.

Returns

• An sl_status_t value that indicates either the successful formation of the new network or the reason that the network formation failed.

sl_zigbee_af_join_network#

sl_status_t sl_zigbee_af_join_network (sl_zigbee_network_parameters_t * parameters)

Associate with the network using the specified network parameters.

Returns

• An sl_status_t value that indicates either that the association process began successfully or the reason for failure.

sl_zigbee_af_find_unused_pan_id_and_form#

sl_status_t sl_zigbee_af_find_unused_pan_id_and_form (void )

Find an unused PAN ID and form a new network.

Returns

• An sl_status_t value that indicates either the process begin successfully or the reason for failure.

sl_zigbee_af_start_search_for_joinable_network#

sl_status_t sl_zigbee_af_start_search_for_joinable_network (void )

Find a joinable network and join it.

Returns

• An sl_status_t value that indicates either the process begin successfully or the reason for failure.

sl_zigbee_af_push_network_index#

sl_status_t sl_zigbee_af_push_network_index (uint8_t networkIndex)

Set the current network to that of the given index and add it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

sl_zigbee_af_push_callback_network_index#

sl_status_t sl_zigbee_af_push_callback_network_index (void )

Set the current network to the callback network and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

sl_zigbee_af_push_endpoint_network_index#

sl_status_t sl_zigbee_af_push_endpoint_network_index (uint8_t endpoint)

Set the current network to that of the given endpoint and adds it to the stack of networks maintained by the framework. Every call to this API must be paired with a subsequent call to sl_zigbee_af_pop_network_index.

sl_zigbee_af_pop_network_index#

sl_status_t sl_zigbee_af_pop_network_index (void )

Remove the topmost network from the stack of networks maintained by the framework and sets the current network to the new topmost network. Every call to this API must be paired with a prior call to sl_zigbee_af_push_network_index, sl_zigbee_af_push_callback_network_index, or sl_zigbee_af_push_endpoint_network_index.

sl_zigbee_af_primary_endpoint_for_network_index#

uint8_t sl_zigbee_af_primary_endpoint_for_network_index (uint8_t networkIndex)

Return the primary endpoint of the given network index or 0xFF if no endpoints belong to the network.sl_zigbee_af_status.

sl_zigbee_af_primary_endpoint_for_current_network_index#

uint8_t sl_zigbee_af_primary_endpoint_for_current_network_index (void )

Return the primary endpoint of the current network index or 0xFF if no endpoints belong to the current network.

sl_zigbee_af_cluster_is_manufacturer_specific#

#define sl_zigbee_af_cluster_is_manufacturer_specific

(cluster)

Return true if the cluster is in the manufacturer-specific range.

sl_zigbee_af_attribute_is_read_only#

#define sl_zigbee_af_attribute_is_read_only

(metadata)

Return true if the attribute is read only.

sl_zigbee_af_attribute_is_client#

#define sl_zigbee_af_attribute_is_client

(metadata)

Return true if this is a client attribute and false if if it is a server attribute.

sl_zigbee_af_attribute_is_tokenized#

#define sl_zigbee_af_attribute_is_tokenized

(metadata)

Return true if the attribute is saved to a token.

sl_zigbee_af_attribute_is_external#

#define sl_zigbee_af_attribute_is_external

(metadata)

Return true if the attribute is saved in external storage.

sl_zigbee_af_attribute_is_singleton#

#define sl_zigbee_af_attribute_is_singleton

(metadata)

Return true if the attribute is a singleton.

sl_zigbee_af_attribute_is_manufacturer_specific#

#define sl_zigbee_af_attribute_is_manufacturer_specific

(metadata)

Return true if the attribute is manufacturer specific.

sl_zigbee_af_attribute_size#

#define sl_zigbee_af_attribute_size

(metadata)

Return the size of attribute in bytes.

sl_zigbee_af_profile_id_from_index#

#define sl_zigbee_af_profile_id_from_index

(index)

Take an index of an endpoint and return the profile ID for it.

sl_zigbee_af_device_id_from_index#

#define sl_zigbee_af_device_id_from_index

(index)

Take an index of an endpoint and return the device ID for it.

sl_zigbee_af_device_version_from_index#

#define sl_zigbee_af_device_version_from_index

(index)

Take an index of an endpoint and return the device version for it.

sl_zigbee_af_network_index_from_endpoint_index#

#define sl_zigbee_af_network_index_from_endpoint_index

(index)

Take an index of an endpoint and return the network index for it.

sl_zigbee_af_primary_profile_id#

#define sl_zigbee_af_primary_profile_id

()

Return the primary profile ID.

Primary profile is the profile of a primary endpoint as defined in AppBuilder.

sl_zigbee_af_primary_endpoint#

#define sl_zigbee_af_primary_endpoint

()

Return the primary endpoint.

sl_zigbee_af_get_int8u#

#define sl_zigbee_af_get_int8u

(message, currentIndex, msgLen)

Extract a single byte out of the message.

sl_zigbee_af_copy_int8u#

#define sl_zigbee_af_copy_int8u

(data, index, x)

Copy a uint8_t from variable into buffer.

SL_ZIGBEE_AF_NEW_IMAGE_VERIFICATION#

#define SL_ZIGBEE_AF_NEW_IMAGE_VERIFICATION

true

Indicate a new image verification is taking place.

SL_ZIGBEE_AF_CONTINUE_IMAGE_VERIFY#

#define SL_ZIGBEE_AF_CONTINUE_IMAGE_VERIFY

false

Indicate the continuation of an image verification already in progress.

SL_ZIGBEE_AF_ZCL_SEQUENCE_MASK#

#define SL_ZIGBEE_AF_ZCL_SEQUENCE_MASK

0x7Fu

The mask applied by sl_zigbee_af_next_sequence when generating ZCL sequence numbers.

SL_ZIGBEE_AF_MESSAGE_TAG_MASK#

#define SL_ZIGBEE_AF_MESSAGE_TAG_MASK

0x7Fu

The mask applied to generated message tags used by the framework when sending messages via EZSP. Customers who call ezspSend functions directly must use message tags outside this mask.

SL_ZIGBEE_AF_REJOIN_DUE_TO_END_DEVICE_MOVE#

#define SL_ZIGBEE_AF_REJOIN_DUE_TO_END_DEVICE_MOVE

(cluster)

Return true if the cluster is in the manufacturer-specific range.

SL_ZIGBEE_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE#

#define SL_ZIGBEE_AF_REJOIN_DUE_TO_TC_KEEPALIVE_FAILURE

(cluster)

Return true if the cluster is in the manufacturer-specific range.

SL_ZIGBEE_AF_REJOIN_DUE_TO_CLI_COMMAND#

#define SL_ZIGBEE_AF_REJOIN_DUE_TO_CLI_COMMAND

(cluster)

Return true if the cluster is in the manufacturer-specific range.

SL_ZIGBEE_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER#

#define SL_ZIGBEE_AF_REJOIN_DUE_TO_WWAH_CONNECTIVITY_MANAGER

(cluster)

Return true if the cluster is in the manufacturer-specific range.

SL_ZIGBEE_AF_REJOIN_FIRST_REASON#

#define SL_ZIGBEE_AF_REJOIN_FIRST_REASON

(cluster)

Return true if the cluster is in the manufacturer-specific range.

SL_ZIGBEE_AF_REJOIN_LAST_REASON#

#define SL_ZIGBEE_AF_REJOIN_LAST_REASON

(cluster)

Return true if the cluster is in the manufacturer-specific range.

SL_ZIGBEE_AF_CLIENT_CLUSTER_TICK#

#define SL_ZIGBEE_AF_CLIENT_CLUSTER_TICK

true

Friendly define for use in the scheduling or canceling client events with sl_zigbee_zcl_schedule_cluster_tick() and sl_zigbee_zcl_deactivate_cluster_tick().

SL_ZIGBEE_AF_SERVER_CLUSTER_TICK#

#define SL_ZIGBEE_AF_SERVER_CLUSTER_TICK

false

Friendly define for use in the scheduling or canceling server events with sl_zigbee_zcl_schedule_cluster_tick() and sl_zigbee_zcl_deactivate_cluster_tick().

sl_zigbee_af_get_current_sleep_control#

#define sl_zigbee_af_get_current_sleep_control

()

Retrieve the most restrictive sleep control value for all scheduled events. This function is used by sl_zigbee_af_ok_to_nap and emberAfOkToHibernate to makes sure that there are no events scheduled, which will keep the device from hibernating or napping.

Returns

• The most restrictive sleep control value for all scheduled events or the value returned by sl_zigbee_af_get_default_sleep_control() if no events are currently scheduled. The default sleep control value is initialized to SL_ZIGBEE_AF_OK_TO_HIBERNATE but can be changed at any time using the sl_zigbee_af_set_default_sleep_control() function.

sl_zigbee_af_set_default_sleep_control#

#define sl_zigbee_af_set_default_sleep_control

(x)

Set the default sleep control value against which all scheduled event sleep control values will be evaluated. This can be used to keep a device awake for an extended period of time by setting the default to SL_ZIGBEE_AF_STAY_AWAKE and then resetting the value to SL_ZIGBEE_AF_OK_TO_HIBERNATE once the wake period is complete.

sl_zigbee_af_get_default_sleep_control#

#define sl_zigbee_af_get_default_sleep_control

()

Retrieve the default sleep control against which all event sleep control values are evaluated. The default sleep control value is initialized to SL_ZIGBEE_AF_OK_TO_HIBERNATE but can be changed by the application at any time using the sl_zigbee_af_set_default_sleep_control() function.

Returns

• The current default sleep control value.

SL_ZIGBEE_AF_CLIENT_CLUSTER_DISCOVERY#

#define SL_ZIGBEE_AF_CLIENT_CLUSTER_DISCOVERY

false

Friendly define for use in discovering client clusters with sl_zigbee_af_find_devices_by_profile_and_cluster().

SL_ZIGBEE_AF_SERVER_CLUSTER_DISCOVERY#

#define SL_ZIGBEE_AF_SERVER_CLUSTER_DISCOVERY

true

Friendly define for use in discovering server clusters with sl_zigbee_af_find_devices_by_profile_and_cluster().

sl_zigbee_af_current_endpoint#

#define sl_zigbee_af_current_endpoint

()

Return the current endpoint that is being served.

The purpose of this macro is mostly to access endpoint that is being served in the command callbacks.

sl_zigbee_af_invalid_image_id#

const sl_zigbee_af_ota_image_id_t sl_zigbee_af_invalid_image_id

This variable defines an invalid image ID. It is used to determine if a returned sl_zigbee_af_ota_image_id_t is valid or not by passing the data to the function sl_zigbee_af_is_ota_image_id_valid().