Sending and Receiving Messages#

emberMaximumApsPayloadLength#

uint8_t emberMaximumApsPayloadLength (void )

Return the maximum size of the payload that the Application Support sub-layer will accept.

The size depends on the security level in use. The value is the same as that found in the node descriptor.

Returns

• The maximum APS payload length.

sl_zigbee_get_aps_ack_timeout_ms#

uint16_t sl_zigbee_get_aps_ack_timeout_ms (void )

Return the APS ACK timeout value. The stack waits this amount of time between resends of APS retried messages. The default value is:

  ((EMBER_APSC_MAX_ACK_WAIT_HOPS_MULTIPLIER_MS
    * EMBER_MAX_HOPS)
   + EMBER_APSC_MAX_ACK_WAIT_TERMINAL_SECURITY_MS)

sl_zigbee_set_aps_ack_timeout_ms#

void sl_zigbee_set_aps_ack_timeout_ms (uint16_t timeout)

Set the APS ACK timeout value.

emberSendMulticastWithAlias#

EmberStatus emberSendMulticastWithAlias (EmberApsFrame * apsFrame, uint8_t radius, uint8_t nonmemberRadius, EmberMessageBuffer message, EmberNodeId alias, uint8_t sequence)

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

Returns

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

  • EMBER_SUCCESS - The message has been submitted for transmission.

  • EMBER_INVALID_BINDING_INDEX - The bindingTableIndex refers to a non-multicast binding.

  • EMBER_NETWORK_DOWN - The node is not part of a network.

  • EMBER_MESSAGE_TOO_LONG - The message is too large to fit in a MAC layer frame.

  • EMBER_NO_BUFFERS - The free packet buffer pool is empty.

  • EMBER_NETWORK_BUSY - Insufficient resources available in Network or MAC layers to send message.

emberSendMulticast#

EmberStatus emberSendMulticast (EmberApsFrame * apsFrame, uint8_t radius, uint8_t nonmemberRadius, EmberMessageBuffer 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 EmberStatus value. For any result other than EMBER_SUCCESS, the message will not be sent.

  • EMBER_SUCCESS - The message has been submitted for transmission.

  • EMBER_INVALID_BINDING_INDEX - The bindingTableIndex refers to a non-multicast binding.

  • EMBER_NETWORK_DOWN - The node is not part of a network.

  • EMBER_MESSAGE_TOO_LONG - The message is too large to fit in a MAC layer frame.

  • EMBER_NO_BUFFERS - The free packet buffer pool is empty.

  • EMBER_NETWORK_BUSY - Insufficient resources available in Network or MAC layers to send message.

emberSendUnicast#

EmberStatus emberSendUnicast (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, EmberMessageBuffer message)

Send a unicast message per the Zigbee specification.

The message will arrive at its destination only if there is a known route to the destination node. Setting the ::ENABLE_ROUTE_DISCOVERY option will cause a route to be discovered if none is known. Setting the ::FORCE_ROUTE_DISCOVERY option will force route discovery. Routes to end-device children of the local node are always known.

Setting the APS_RETRY option will cause the message to be retransmitted until either a matching acknowledgment is received or three transmissions have been made.

Note

• Using the ::FORCE_ROUTE_DISCOVERY option will cause the first transmission to be consumed by a route request as part of discovery, so the application payload of this packet will not reach its destination on the first attempt. For the packet to reach its destination, the APS_RETRY option must be set so that another attempt is made to transmit the message with its application payload after the route has been constructed.

Setting the ::DESTINATION_EUI64 option will cause the long ID of the destination to be included in the network header. This is the only way to absolutely guarantee that the message is delivered to the correct node. Without it, a message may on occasion be delivered to the wrong destination in the event of an ID conflict that has not yet been detected and resolved by the network layer.

Note

• When sending fragmented messages, the stack will only assign a new APS sequence number for the first fragment of the message (i.e., EMBER_APS_OPTION_FRAGMENT is set and the low-order byte of the groupId field in the APS frame is zero). For all subsequent fragments of the same message, the application must set the sequence number field in the APS frame to the sequence number assigned by the stack to the first fragment.

Returns

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

  • EMBER_SUCCESS - The message has been submitted for transmission.

  • EMBER_INVALID_BINDING_INDEX - The bindingTableIndex refers to a non-unicast binding.

  • EMBER_NETWORK_DOWN - The node is not part of a network.

  • EMBER_MESSAGE_TOO_LONG - The message is too large to fit in a MAC layer frame.

  • EMBER_MAX_MESSAGE_LIMIT_REACHED - The EMBER_APS_UNICAST_MESSAGE_COUNT limit has been reached.

emberSendBroadcast#

EmberStatus emberSendBroadcast (EmberNodeId destination, EmberApsFrame * apsFrame, uint8_t radius, EmberMessageBuffer 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 EMBER_MAX_HOPS.

Returns

• An EmberStatus value.

emberProxyBroadcast#

EmberStatus emberProxyBroadcast (EmberNodeId source, EmberNodeId destination, uint8_t sequence, EmberApsFrame * apsFrame, uint8_t radius, EmberMessageBuffer message)

Proxy a broadcast message for another node.

The message will be delivered to all nodes within radius hops of the local node. A radius of zero is converted to EMBER_MAX_HOPS.

Returns

• An EmberStatus value.

emberProxyNextBroadcastFromLong#

EmberStatus emberProxyNextBroadcastFromLong (uint8_t * euiSource)

Proxy a broadcast message for another node.

The function is used in conjunction with emberProxyBroadcast, which proxies a message from a short ID. This function is used where a long source is also specified in the NWK frame control.

Returns

• An EmberStatus value.

emberSendManyToOneRouteRequest#

EmberStatus emberSendManyToOneRouteRequest (uint16_t concentratorType, uint8_t radius)

Send a route request packet that creates routes from every node in the network back to this node.

This function should be called by an application that wants to communicate with many nodes, for example, a gateway, central monitor, or controller. A device using this function was referred to as an "aggregator" in EmberZNet 2.x and earlier, and is referred to as a "concentrator" in the ZigBee specification and EmberZNet 3.

This function enables large scale networks because the other devices do not have to individually perform bandwidth-intensive route discoveries. Instead, when a remote node sends an APS unicast to a concentrator, its network layer automatically delivers a special route record packet first, which lists the network IDs of all intermediate relays. The concentrator can then use source routing to send outbound APS unicasts. (A source routed message is one in which the entire route is listed in the network layer header.) This allows the concentrator to communicate with thousands of devices without requiring large route tables on neighboring nodes.

This function is only available in ZigBee Pro (stack profile 2), and cannot be called on end devices. Any router can be a concentrator (not just the coordinator), and there can be multiple concentrators on a network.

Note that a concentrator does not automatically obtain routes to all network nodes after calling this function. Remote applications must first initiate an inbound APS unicast.

Many-to-one routes are not repaired automatically. Instead, the concentrator application must call this function to rediscover the routes as necessary, for example, upon failure of a retried APS message. This is necessary because there is no scalable one-size-fits-all route repair strategy. A common and recommended strategy is for the concentrator application to refresh the routes by calling this function periodically.

Returns

• EMBER_SUCCESS if the route request was successfully submitted to the transmit queue, and EMBER_ERR_FATAL otherwise.

emberGetSourceRouteTableEntry#

EmberStatus emberGetSourceRouteTableEntry (uint8_t index, EmberNodeId * destination, uint8_t * closerIndex)

Return the source route table entry fields.

emberGetSourceRouteTableFilledSize#

uint8_t emberGetSourceRouteTableFilledSize (void )

Return the number of filled entries in the source route table.

emberGetSourceRouteTableTotalSize#

uint8_t emberGetSourceRouteTableTotalSize (void )

Return the source route table total size.

emberIncomingManyToOneRouteRequestHandler#

void emberIncomingManyToOneRouteRequestHandler (EmberNodeId source, EmberEUI64 longId, uint8_t cost)

Indicate that a many-to-one route to the concentrator with the given short and long ID is available for use.

The application must define EMBER_APPLICATION_HAS_INCOMING_MANY_TO_ONE_ROUTE_REQUEST_HANDLER in its configuration header to use this.

emberIncomingRouteErrorHandler#

void emberIncomingRouteErrorHandler (EmberStatus status, EmberNodeId target)

Invoke when a route error message is received.

A status of EMBER_SOURCE_ROUTE_FAILURE indicates that a source-routed unicast sent from this node encountered a broken link. Note that this case occurs only if this node is a concentrator using many-to-one routing for inbound messages and source-routing for outbound messages. The node prior to the broken link generated the route error message and returned it to us along the many-to-one route.

A status of EMBER_MANY_TO_ONE_ROUTE_FAILURE also occurs only if the local device is a concentrator, and indicates that a unicast sent to the local device along a many-to-one route encountered a broken link. The node prior to the broken link generated the route error message and forwarded it to the local device via a randomly chosen neighbor, taking advantage of the many-to-one nature of the route.

A status of EMBER_MAC_INDIRECT_TIMEOUT indicates that a message sent to the target end device could not be delivered by the parent because the indirect transaction timer expired. Upon receipt of the route error, the stack sets the extended timeout for the target node in the address table, if present. It then calls this handler to indicate receipt of the error.

Note that if the original unicast data message is sent using the EMBER_APS_OPTION_RETRY option, a new route error message is generated for each failed retry. Therefore, it is not unusual to receive three route error messages in succession for a single failed retried APS unicast. On the other hand, it is also not guaranteed that any route error messages will be delivered successfully at all. The only sure way to detect a route failure is to use retried APS messages and to check the status of the emberMessageSentHandler().

If the application includes this callback, it must define EMBER_APPLICATION_HAS_INCOMING_ROUTE_ERROR_HANDLER in its configuration header.

emberIncomingNetworkStatusHandler#

void emberIncomingNetworkStatusHandler (uint8_t errorCode, EmberNodeId target)

Invoke when a network status message is received that informs the application of the Over-the-Air error codes for the specific destination.

Note: Network analyzer may flag this message as "route error" which is the old name for the "network status" command.

This handler is a superset of emberIncomingRouteErrorHandler. The old API was only invoking the handler for a couple of the possible error codes and these were being translated into EmberStatus.

To make the API more generic and extensible in future, the new API emberIncomingNetworkStatusHandler simply copies the OTA error code as is. If the application includes this callback, it must define EMBER_APPLICATION_HAS_INCOMING_NETWORK_STATUS_HANDLER in its configuration header.

emberOverrideIncomingRouteRecordHandler#

void emberOverrideIncomingRouteRecordHandler (EmberNodeId source, EmberEUI64 sourceEui, uint8_t relayCount, EmberMessageBuffer header, uint8_t relayListIndex, bool * consumed)

SoC only. It reports the arrival of a route record command frame to the application.

The route record command frame lists the short IDs of the relays that were used along the route from the source to us. This information is used by aggregators to be able to initiate source routed messages. The application must define EMBER_APPLICATION_HAS_OVERRIDE_SOURCE_ROUTING in its configuration header to use this.

emberOverrideAppendSourceRouteHandler#

uint8_t emberOverrideAppendSourceRouteHandler (EmberNodeId destination, EmberMessageBuffer * header, bool * consumed)

SoC only. The application can implement this callback to supply source routes to outgoing messages.

The application must define :EMBER_APPLICATION_HAS_OVERRIDE_SOURCE_ROUTING in its configuration header to use this. The application uses the supplied destination to look up a source route. If available, the application appends the source route to the supplied header using the proper frame format, as described in section 3.4.1.9 "Source Route Subframe Field" of the ZigBee specification. If a source route is appended, the stack takes care of setting the proper flag in the network frame control field. See app/util/source-route.c for a sample implementation.

If header is :EMBER_NULL_MESSAGE_BUFFER the only action is to return the size of the source route frame needed to the destination.

Returns

• The size in bytes of the source route frame, or zero if there is not one available.

emberIncomingRouteRecordHandler#

void emberIncomingRouteRecordHandler (EmberNodeId source, EmberEUI64 sourceEui, uint8_t relayCount, EmberMessageBuffer header, uint8_t relayListIndex)

DEPRECTAED emberOverrideIncomingRouteRecordHandler should be used Reports the arrival of a route record command frame to the application.

The route record command frame lists the short IDs of the relays that were used along the route from the source to us. This information is used by aggregators to be able to initiate source routed messages. The application must define EMBER_APPLICATION_HAS_SOURCE_ROUTING in its configuration header to use this.

emberAppendSourceRouteHandler#

uint8_t emberAppendSourceRouteHandler (EmberNodeId destination, EmberMessageBuffer header)

DEPRECATED emberOverrideAppendSourceRouteHandler should be used The application can implement this callback to supply source routes to outgoing messages.

The application must define :EMBER_APPLICATION_HAS_SOURCE_ROUTING in its configuration header to use this. The application uses the supplied destination to look up a source route. If available, the application appends the source route to the supplied header using the proper frame format, as described in section 3.4.1.9 "Source Route Subframe Field" of the ZigBee specification. If a source route is appended, the stack takes care of setting the proper flag in the network frame control field. See app/util/source-route.c for a sample implementation.

If header is :EMBER_NULL_MESSAGE_BUFFER the only action is to return the size of the source route frame needed to the destination.

Returns

• The size in bytes of the source route frame, or zero if there is not one available.

emberCancelMessage#

EmberStatus emberCancelMessage (EmberMessageBuffer message)

DEPRECATED.

Returns

• Always returns EMBER_SUCCESS.

emberMessageSentHandler#

void emberMessageSentHandler (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame * apsFrame, EmberMessageBuffer message, EmberStatus status)

Invoke by the stack when it has completed sending a message.

emberIncomingMessageHandler#

void emberIncomingMessageHandler (EmberIncomingMessageType type, EmberApsFrame * apsFrame, EmberMessageBuffer message)

Invoke by the EmberZNet stack when a message is received.

The following functions may be called from emberIncomingMessageHandler():

• emberGetLastHopLqi()

• emberGetLastHopRssi()

• emberGetLastHopTimestamp()

• emberGetSender()

• emberGetSenderEui64()

• emberGetBindingIndex()

• emberSendReply() (for incoming APS retried unicasts only)

• emberSetReplyBinding()

• emberNoteSendersBinding()

emberGetLastHopLqi#

EmberStatus emberGetLastHopLqi (uint8_t * lastHopLqi)

Get the link quality from the node that last relayed the current message.

Note

• This function may only be called from within

  • emberIncomingMessageHandler()

  • emberNetworkFoundHandler()

  • ::sli_zigbee_incoming_route_record()

  • emberMacPassthroughMessageHandler()

  • emberIncomingBootloadMessageHandler()

  When this function is called from within one of these handler functions, the link quality reported corresponds to the header being processed in that hander function. If this function is called outside of these handler functions, the link quality reported will correspond to a message that was processed earlier.

This function is not available from within emberPollHandler() or emberPollCompleteHandler(). The link quality information of interest during the emberPollHandler() is from the data request packet itself. This message must be handled quickly due to strict 15.4 timing requirements, and the link quality information is not recorded by the stack. The link quality information of interest during the emberPollCompleteHandler() is from the ACK to the data request packet. The ACK is handled by the hardware and the link quality information does not make it up to the stack.

Returns

• This function always returns EMBER_SUCCESS. It is not necessary to check this return value.

emberGetLastHopRssi#

EmberStatus emberGetLastHopRssi (int8_t * lastHopRssi)

Get the receive signal strength indication (RSSI) for the current message.

After a successful call to this function, the quantity referenced by lastHopRssi will contain the energy level (in units of dBm) observed during the last packet received. Note

• This function may only be called from within:

  • emberIncomingMessageHandler()

  • emberNetworkFoundHandler()

  • ::sli_zigbee_incoming_route_record()

  • emberMacPassthroughMessageHandler()

  • emberIncomingBootloadMessageHandler()

  When this function is called from within one of these handler functions, the RSSI reported corresponds to the header being processed in that handler function. If this function is called outside of these handler functions, the RSSI reported will correspond to a message that was processed earlier.

This function is not available from within emberPollHandler() or emberPollCompleteHandler(). The RSSI information of interest during the emberPollHandler() is from the data request packet itself. This message must be handled quickly due to strict 15.4 timing requirements, and the RSSI information is not recorded by the stack. The RSSI information of interest during the emberPollCompleteHandler() is from the ACK to the data request packet. The ACK is handled by the hardware and the RSSI information does not make it up to the stack.

Returns

• This function always returns EMBER_SUCCESS. It is not necessary to check this return value.

emberGetLastHopTimestamp#

EmberStatus emberGetLastHopTimestamp (uint32_t * lastHopTimestamp)

Get the receive timestamp (value of the MAC timer; ticks since up) of the moment when the Start Frame Delimiter (SFD) was received for the current message.

Note: This API is mainly intended for use on EFR devices.

RAIL timers tick every microsecond. ::RAIL_GetTime can provide the value of the current RAIL timebase (this wraps after ~4095 seconds.)

The timestamp provided by this API is a 24-bit value passed up from the PHY to the MAC layer, with a range of ~16.8 seconds. So, to calculate relative time using this timestamp, make sure to mask off the lower 24 bits provided by ::Rail_GetTime.

(EFR32xG1 ticks every 2us while other EFR32 platforms tick at 0.5us rate. Make sure to adjust the relative timestamp value accordingly.)

After a successful call to this function, the quantity referenced by lastHopTimestamp will contain the value of the MAC timer observed during the last packet received. Note

• This function may only be called from within:

  • emberIncomingMessageHandler()

  • emberNetworkFoundHandler()

  • ::sli_zigbee_incoming_route_record()

  • emberMacPassthroughMessageHandler()

  • emberIncomingBootloadMessageHandler()

When this function is called from within one of these handler functions, the timestamp reported corresponds to the header being processed in that handler function. If this function is called outside of these handler functions, the timestamp reported will correspond to a message that was processed earlier.

This function is not available from within emberPollHandler() or emberPollCompleteHandler(). The timestamp of interest during the emberPollHandler() is from the data request packet itself. This message must be handled quickly due to strict 15.4 timing requirements, and the timestamp is not recorded by the stack. The timestamp of interest during the emberPollCompleteHandler() is from the ACK to the data request packet. The ACK is handled by the hardware and the timestamp does not make it up to the stack.

Returns

• This function always returns EMBER_SUCCESS. It is not necessary to check this return value.

emberGetSender#

EmberNodeId emberGetSender (void )

Return the node ID of the sender of the current incoming message.

Note

• This function can be called only from within emberIncomingMessageHandler().

Returns

• The sender of the current incoming message.

emberGetSenderEui64#

EmberStatus emberGetSenderEui64 (EmberEUI64 senderEui64)

Return the EUI64 of the sender of the current incoming message if the sender chose to include this information in the message. The EMBER_APS_OPTION_SOURCE_EUI64 bit in the options field of the APS frame of the incoming message indicates that the EUI64 is present in the message.

Note

• This function can be called only from within emberIncomingMessageHandler().

Returns

• An EmberStatus value:

  • EMBER_SUCCESS - senderEui64 has been set to the EUI64 of the sender of the current incoming message.

  • EMBER_INVALID_CALL - Either:

    1. This function was called outside of the context of the emberIncomingMessageHandler() callback

    2. It was called in the context of emberIncomingMessageHandler() but the incoming message did not include the EUI64 of the sender.

emberSendReply#

EmberStatus emberSendReply (uint16_t clusterId, EmberMessageBuffer reply)

Send a reply for an application that has received a unicast message.

The reply will be included with the ACK that the stack automatically sends back. Note

• This function may be called only from within emberIncomingMessageHandler().

Returns

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

  • EMBER_SUCCESS - The message has been submitted for transmission.

  • EMBER_INVALID_CALL - Either:

    1. This function was called outside of the context of the emberIncomingMessageHandler() callback

    2. It was called in the context of emberIncomingMessageHandler() but the incoming message was not a unicast

    3. It was called more than once in the context of emberIncomingMessageHandler().

  • EMBER_NETWORK_BUSY - Either:

    1. No route available.

    2. Insufficient resources available in Network or MAC layers to send message.

emberSetReplyFragmentData#

void emberSetReplyFragmentData (uint16_t fragmentData)

Set the fragment data to be used when sending a reply to a unicast message.

Note

• This function may be called only from within emberIncomingMessageHandler().

emberAddressTableEntryIsActive#

bool emberAddressTableEntryIsActive (uint8_t addressTableIndex)

Indicate whether any messages are currently being sent using this address table entry.

Note that this function does not indicate whether the address table entry is unused. To determine whether an address table entry is unused, check the remote node ID. The remote node ID will have the value EMBER_TABLE_ENTRY_UNUSED_NODE_ID when the address table entry is not in use.

Returns

• True if the address table entry is active, false otherwise.

emberSetAddressTableRemoteEui64#

EmberStatus emberSetAddressTableRemoteEui64 (uint8_t addressTableIndex, EmberEUI64 eui64)

Set the EUI64 of an address table entry.

This function will also check other address table entries, the child table and the neighbor table to see if the node ID for the given EUI64 is already known. If known, this function will also set the node ID. If not known, it will set the node ID to EMBER_UNKNOWN_NODE_ID.

Returns

• EMBER_SUCCESS if the EUI64 was successfully set, and EMBER_ADDRESS_TABLE_ENTRY_IS_ACTIVE otherwise.

emberSetAddressTableRemoteNodeId#

void emberSetAddressTableRemoteNodeId (uint8_t addressTableIndex, EmberNodeId id)

Set the short ID of an address table entry.

Usually the application will not need to set the short ID in the address table. Once the remote EUI64 is set, the stack is capable of figuring out the short ID on its own. However, in cases where the application does set the short ID, the application must set the remote EUI64 prior to setting the short ID.

emberGetAddressTableRemoteEui64#

void emberGetAddressTableRemoteEui64 (uint8_t addressTableIndex, EmberEUI64 eui64)

Get the EUI64 of an address table entry.

emberGetAddressTableRemoteNodeId#

EmberNodeId emberGetAddressTableRemoteNodeId (uint8_t addressTableIndex)

Get the short ID of an address table entry.

Returns

• One of the following:

  • The short ID corresponding to the remote node whose EUI64 is stored in the address table at the given index.

  • EMBER_UNKNOWN_NODE_ID - Indicates that the EUI64 stored in the address table at the given index is valid but the short ID is currently unknown.

  • EMBER_DISCOVERY_ACTIVE_NODE_ID - Indicates that the EUI64 stored in the address table at the given location is valid and network address discovery is underway.

  • EMBER_TABLE_ENTRY_UNUSED_NODE_ID - Indicates that the entry stored in the address table at the given index is not in use.

emberSetExtendedTimeout#

void emberSetExtendedTimeout (EmberEUI64 remoteEui64, bool extendedTimeout)

Tell the stack whether or not the normal interval between retransmissions of a retried unicast message should be increased by EMBER_INDIRECT_TRANSMISSION_TIMEOUT.

The interval needs to be increased when sending to a sleepy node so that the message is not retransmitted until the destination has had time to wake up and poll its parent. The stack will automatically extend the timeout:

• For our own sleepy children.

• When an address response is received from a parent on behalf of its child.

• When an indirect transaction expiry route error is received.

• When an end device announcement is received from a sleepy node.

emberGetExtendedTimeout#

bool emberGetExtendedTimeout (EmberEUI64 remoteEui64)

Indicate whether or not the stack will extend the normal interval between retransmissions of a retried unicast message by EMBER_INDIRECT_TRANSMISSION_TIMEOUT.

Returns

• true if the retry interval will be increased by EMBER_INDIRECT_TRANSMISSION_TIMEOUT and false if the normal retry interval will be used.

emberIdConflictHandler#

void emberIdConflictHandler (EmberNodeId conflictingId)

Invoke by the EmberZNet stack when an ID conflict is discovered, that is, two different nodes in the network were found to be using the same short ID.

The stack automatically removes the conflicting short ID from its internal tables (address, binding, route, neighbor, and child tables). The application should discontinue any other use of the ID. If the application includes this callback, it must define ::EMBER_APPLICATION_HAS_ID_CONFLICT_HANDLER in its configuration header.

emberPendingAckedMessages#

bool emberPendingAckedMessages (void )

Indicate whether there are pending messages in the APS retry queue.

Returns

• True if there is at least a pending message belonging to the current network in the APS retry queue, false otherwise.

sl_zigbee_get_multicast_table#

EmberMulticastTableEntry * sl_zigbee_get_multicast_table (void )

Returns the multicast table.

Each entry contains a multicast ID and an endpoint, indicating that the endpoint is a member of the multicast group. Only devices with an endpoint in a multicast group will receive messages sent to that multicast group.

Entries with with an endpoint of 0 are ignored (the ZDO does not a member of any multicast groups). All endpoints are initialized to 0 on startup.

sl_zigbee_set_multicast_table#

sl_status_t sl_zigbee_set_multicast_table (EmberMulticastTableEntry * entry)

Sets the multicast table pointer.

sl_zigbee_get_multicast_table_size#

uint8_t sl_zigbee_get_multicast_table_size (void )

Return the number of entries in the multicast table.

sl_zigbee_set_multicast_table_size#

sl_status_t sl_zigbee_set_multicast_table_size (uint8_t size)

Set the number of entries in the multicast table.

sl_zigbee_set_passive_ack_config#

EmberStatus sl_zigbee_set_passive_ack_config (sl_passive_ack_config_enum_t config, uint8_t minAcksNeeded)

Allows the higher layers to control the broadcast behavior of a routing device. The originating device will rebroadcast the maximum number of times and The configurations below only restrict the number of broadcasts from neighboring routers. The configuration settings must be done on each node.

SL_PASSIVE_ACK_THRESHOLD_NO_REBROADCAST - All non originating configured nodes check for passive acks from minAcksNeeded neighbors. They will not rebroadcast received message if all passive acks have been received. If no passive acks received it will rebroadcast max times. SL_PASSIVE_ACK_THRESHOLD_WITH_REBROADCAST_ALL_NODES - This configuration is for both originating and relaying (non originating nodes). All configured nodes check for passive acks from minAcksNeeded neighbors. They will not rebroadcast received message if all passive acks have been received. If no passive acks received it will rebroadcast max times if minAcksNeeded is not set to 0

Returns

• EMBER_SUCCESS if set passive ack success; EMBER_BAD_ARGUMENT when pass wrong config argument

emberPacketHandoffIncomingHandler#

EmberPacketAction emberPacketHandoffIncomingHandler (EmberZigbeePacketType packetType, EmberMessageBuffer packetBuffer, uint8_t index, void * data)

Intercept an incoming packet from the stack and hands off to a plugin for further processing.

Returns

• See EmberPacketAction

emberPacketHandoffOutgoingHandler#

EmberPacketAction emberPacketHandoffOutgoingHandler (EmberZigbeePacketType packetType, EmberMessageBuffer packetBuffer, uint8_t index, void * data)

Intercept an outgoing packet from the stack and hands off to a plugin for further processing.

Returns

• See EmberPacketAction

emberRedirectOutgoingMessageHandler#

void emberRedirectOutgoingMessageHandler (uint8_t mac_index, EmberMessageBuffer header, uint8_t priority)

Intercept an outgoing packet from the Zigbee stack and hands it off to the relevant plugins for possible further processing and forwarding to non 15.4 interfaces.

emberAfIncomingPacketFilterCallback#

EmberPacketAction emberAfIncomingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t * packetData, uint8_t * size_p, void * data)

Call when the stack receives a packet that is meant for one of the protocol layers specified in EmberZigbeePacketType.

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

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

Returns

• a EmberPacketAction indicating what action should be taken for the packet, EMBER_ACCEPT_PACKET, EMBER_DROP_PACKET, or EMBER_MANGLE_PACKET

emberAfOutgoingPacketFilterCallback#

EmberPacketAction emberAfOutgoingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t * packetData, uint8_t * size_p, void * data)

The stack is preparing to send a protocol layer packet.

This is called when the stack is preparing to send a packet from one of the protocol layers specified in EmberZigbeePacketType.

The packetType argument is one of the values of the EmberZigbeePacketType enum. If the stack is preparing to send an 802.15.4 MAC beacon, it will call this function with the packetType argument set to EMBER_ZIGBEE_PACKET_TYPE_BEACON.

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

Returns

• a EmberPacketAction indicating what action should be taken for the packet, EMBER_ACCEPT_PACKET, EMBER_DROP_PACKET, or EMBER_MANGLE_PACKET

slx_zigbee_add_to_incoming_network_queue#

EmberStatus slx_zigbee_add_to_incoming_network_queue (int8_t rssi, uint8_t lqi, const sl_nwk_packet_exchange_t * nwk_packet)

Add a network packet into the incoming network queue.

Quality: Experimental API for prototyping.

The content of the networkPacket follows the formats below: -—Encrypted NWK Packet-— NWK Header (8 bytes) NWK Security (14 bytes) APS Header (8 bytes) APS Payload (Variable) NWK MIC (4 bytes)

-—Unencrypted NWK Packet-— NWK Header (8 bytes) APS Header (8 bytes) APS Payload (Variable)

Noted: This function does not free up the memory pointed by the networkPacket pointer. Users may need to free up the memory after calling this function. The network packet should not be larger than 115 bytes (TRANSMIT_BUFFER_SIZE 126 bytes - PACKET_HEADER_OVERHEAD 11 bytes).

Returns

• EMBER_SUCCESS if the network packet was successfully added into the network queue, otherwise EMBER_NO_BUFFERS or EMBER_MESSAGE_TOO_LONG.

makeInterPanMessage#

EmberMessageBuffer makeInterPanMessage (InterPanHeader * headerData, EmberMessageBuffer payload)

Create an interpan message suitable for passing to emberSendRawMessage().

parseInterPanMessage#

uint8_t parseInterPanMessage (EmberMessageBuffer message, uint8_t startOffset, InterPanHeader * headerData)

Meant to be called on the message and offset values passed to emberMacPassthroughMessageHandler(...). The header is parsed and the various fields are written to the InterPanHeader. The returned value is the offset of the payload in the message, or 0 if the message is not a correctly formed AMI interPAN message.

makeInterPanMessage#

uint8_t makeInterPanMessage (InterPanHeader * headerData, uint8_t * message, uint8_t maxLength, uint8_t * payload, uint8_t payloadLength)

Create an interpan message. The message needs to have enough space for the message contents. Upon return, the return value will be the length of the message, or 0 in case of error.

parseInterPanMessage#

uint8_t parseInterPanMessage (uint8_t * message, uint8_t messageLength, InterPanHeader * headerData)

Meant to be called on the message passed to emberMacPassthroughMessageHandler(...). The header is parsed and the various fields are written to the InterPanHeader. The returned value is the offset of the payload in the message, or 0 if the message is not a correctly formed AMI interPAN message.

EMBER_APSC_MAX_ACK_WAIT_HOPS_MULTIPLIER_MS#

#define EMBER_APSC_MAX_ACK_WAIT_HOPS_MULTIPLIER_MS

50

The per-hop delay allowed for in the calculation of the APS ACK timeout value. This is defined in the Zigbee specification. This times the maximum number of hops (EMBER_MAX_HOPS) plus the terminal encrypt/decrypt time is the timeout between retries of an APS ACKed message in milliseconds.

EMBER_APSC_MAX_ACK_WAIT_TERMINAL_SECURITY_MS#

#define EMBER_APSC_MAX_ACK_WAIT_TERMINAL_SECURITY_MS

100

The terminal encrypt/decrypt time allowed for in the calculation of the APS ACK timeout value. This is defined in the ZigBee specification.

emberBroadcastSetMinAcksNeeded#

#define emberBroadcastSetMinAcksNeeded

(minAcksNeeded)

Set the number of broadcast passive acknowledgments required before terminating a broadcast transmission. A value of 0xFF causes the node to wait for all neighbors to re-broadcast the packet before terminating the transmission. The default value is 0xFF. API is kept for backwards compatibility.

Returns

• EMBER_SUCCESS if set passive ack success; EMBER_BAD_ARGUMENT when pass wrong config argument

INTER_PAN_UNICAST#

#define INTER_PAN_UNICAST

0x03

INTER_PAN_BROADCAST#

#define INTER_PAN_BROADCAST

0x0B

INTER_PAN_MULTICAST#

#define INTER_PAN_MULTICAST

0x0F

MAX_INTER_PAN_MAC_SIZE#

#define MAX_INTER_PAN_MAC_SIZE

(2 + 1 + 2 + 8 + 2 + 8)

STUB_NWK_SIZE#

#define STUB_NWK_SIZE

2

STUB_NWK_FRAME_CONTROL#

#define STUB_NWK_FRAME_CONTROL

0x000B

MAX_STUB_APS_SIZE#

#define MAX_STUB_APS_SIZE

(1 + 2 + 2 + 2)

MAX_INTER_PAN_HEADER_SIZE#

#define MAX_INTER_PAN_HEADER_SIZE

  (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + MAX_STUB_APS_SIZE)

INTER_PAN_UNICAST#

#define INTER_PAN_UNICAST

0x03

The three types of inter-PAN messages. The values are the corresponding APS frame controls. 0x03 is the special interPAN message type. Unicast mode is 0x00, broadcast mode is 0x08, and multicast mode is 0x0C.

INTER_PAN_BROADCAST#

#define INTER_PAN_BROADCAST

0x0B

INTER_PAN_MULTICAST#

#define INTER_PAN_MULTICAST

0x0F

MAX_INTER_PAN_MAC_SIZE#

#define MAX_INTER_PAN_MAC_SIZE

(2 + 1 + 2 + 8 + 2 + 8)

STUB_NWK_SIZE#

#define STUB_NWK_SIZE

2

STUB_NWK_FRAME_CONTROL#

#define STUB_NWK_FRAME_CONTROL

0x000B

MAX_STUB_APS_SIZE#

#define MAX_STUB_APS_SIZE

(1 + 2 + 2 + 2)

MAX_INTER_PAN_HEADER_SIZE#

#define MAX_INTER_PAN_HEADER_SIZE

  (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + MAX_STUB_APS_SIZE)