Messaging#

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_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.

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP

zcl msg disp [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]

• Command description for DisplayMessage

  • messageId - INT32U

  • messageControl - MessagingControlMask [BITMAP8]

  • startTime - UTC_TIME

  • durationInMinutes - INT16U

  • message - CHAR_STRING

  • optionalExtendedMessageControl - MessagingExtendedControlMask [BITMAP8]

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CANCEL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CANCEL

zcl msg cancel [messageId:4] [messageControl:1]

• The CancelMessage command provides the ability to cancel the sending or acceptance of previously sent messages.

  • messageId - INT32U

  • messageControl - MessagingControlMask [BITMAP8]

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP_PROTD#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_DISP_PROTD

zcl msg disp-protd [messageId:4] [messageControl:1] [startTime:4] [durationInMinutes:2] [message:-1] [optionalExtendedMessageControl:1]

• The DisplayProtected Message command is for use with messages that are protected by a password or PIN.

  • messageId - INT32U

  • messageControl - MessagingControlMask [BITMAP8]

  • startTime - UTC_TIME

  • durationInMinutes - INT16U

  • message - CHAR_STRING

  • optionalExtendedMessageControl - MessagingExtendedControlMask [BITMAP8]

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_X_ALL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_X_ALL

zcl msg x-all [implementationDateTime:4]

• The CancelAllMessages command indicates to a client device that it should cancel all display messages currently held by it.

  • implementationDateTime - UTC_TIME

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET

zcl msg get

• Command description for GetLastMessage

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CONFIRM#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_CONFIRM

zcl msg confirm [messageId:4] [confirmationTime:4] [messageConfirmationControl:1] [messageResponse:-1]

• The Message Confirmation command provides an indication that a Utility Customer has acknowledged and/or accepted the contents of a previously sent message. Enhanced Message Confirmation commands shall contain an answer of 'NO', 'YES' and/or a message confirmation string.

  • messageId - INT32U

  • confirmationTime - UTC_TIME

  • messageConfirmationControl - BITMAP8

  • messageResponse - OCTET_STRING

EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET_MSG_X#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_MESSAGING_GET_MSG_X

zcl msg get-msg-x [earliestImplementationTime:4]

• This command initiates the return of the first (and maybe only) Cancel All Messages command held on the associated server, and which has an implementation time equal to or later than the value indicated in the payload.

  • earliestImplementationTime - UTC_TIME