Sending and Receiving Messages

EmberZNet Stack API Reference

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.

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

The three types of inter-PAN messages. The values are actually 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.

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

Parameters

addressTableIndex

The index of an address table entry.

Returns

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

A protocol layer packet has been received by the stack.

This is called 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 auxillary data, or consume the packet itself, either sending the message, or discarding it as it sees fit.

Parameters

packetType	The type of packet received. See EmberZigbeePacketType .
packetData	A flat buffer containing the packet contents the buffer starts with the command id followed by the payload
size_p	a pointer to the size of the packet data
data	This is a pointer to auxiliary data for the command.

Returns

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

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 auxillary data, or consume the packet itself, either sending the message, or discarding it as it sees fit.

Parameters

packetType	The type of packet received. See EmberZigbeePacketType .
packetData	A flat buffer containing the packet contents the buffer starts with the command id followed by the payload
size_p	a pointer to the size of the packet data
data	This is a pointer to auxiliary data for the command. ZDO commands pass the EmberApsFrame associated with the packet here. Otherwise, this value is NULL.

Returns

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

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.

Parameters

destination	The network destination of the message.
header	The message buffer containing the partially complete packet header. The application appends the source route frame to this header.

Returns

The size in bytes of the source route frame, or zero if one isn't available.

Sets the number of broadcast passive acknowledgements 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.

Parameters

minAcksNeeded

The minimum number of acknowledgments (re-broadcasts) to wait for until deeming the broadcast transmission complete.

Returns

None.

DEPRECATED.

Parameters

message

A message.

Returns

Always returns EMBER_SUCCESS .

Updates the source route entry based on new information about the change of the child's parent and status.

Parameters

newChildId	The short address of the child
newParentId	The short address of the parent of the child
ourChild	True if the child is associated to the local node
deviceLeft	True if device has left network

Gets the EUI64 of an address table entry.

Parameters

addressTableIndex	The index of an address table entry.
eui64	The EUI64 of the address table entry is copied to this location.

Gets the short ID of an address table entry.

Parameters

addressTableIndex

The index 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.

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

Parameters

remoteEui64

The address of the node for which the timeout is to be returned.

Returns

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

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

Note

This function may only be called from within

• emberIncomingMessageHandler()
• emberNetworkFoundHandler()
• emberIncomingRouteRecordHandler()
• ::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.

Parameters

lastHopLqi

The link quality for the last incoming message processed.

Returns

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

Gets 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()
• emberIncomingRouteRecordHandler()
• ::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.

Parameters

lastHopRssi

The RSSI for the last incoming message processed.

Returns

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

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

Returns 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() .

Parameters

senderEui64

The EUI64 of the sender.

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.

Returns the source route table entry fields.

Parameters

index	The index of the source route table entry.
destination	The value of the destination field in that entry.
closerIndex	The value of the closer index entry field in that entry.

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

Returns the source route table total size.

A callback invoked 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.

Parameters

conflictingId

The short ID for which a conflict was detected.

A callback indicating 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.

Parameters

source	The short ID of the concentrator that initiated the many-to-one route request.
longId	The EUI64 of the concentrator.
cost	The path cost to the concentrator.

A callback invoked by the EmberZNet stack when a message is received.

The following functions may be called from emberIncomingMessageHandler() :

• emberGetLastHopLqi()
• emberGetLastHopRssi()
• emberGetSender()
• emberGetSenderEui64()
• emberGetBindingIndex()
• emberSendReply() (for incoming APS retried unicasts only)
• emberSetReplyBinding()
• emberNoteSendersBinding()

Parameters

type	The type of the incoming message. One of the following: EMBER_INCOMING_UNICAST EMBER_INCOMING_UNICAST_REPLY EMBER_INCOMING_MULTICAST EMBER_INCOMING_MULTICAST_LOOPBACK EMBER_INCOMING_BROADCAST EMBER_INCOMING_BROADCAST_LOOPBACK
apsFrame	The APS frame from the incoming message.
message	The message that was sent.

A callback invoked 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.

Parameters

status	EMBER_SOURCE_ROUTE_FAILURE , EMBER_MANY_TO_ONE_ROUTE_FAILURE , EMBER_MAC_INDIRECT_TIMEOUT
target	The short ID of the remote node.

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 initiate source routed messages. The application must define EMBER_APPLICATION_HAS_SOURCE_ROUTING in its configuration header to use this.

Parameters

source	The ID of the node that initiated the route record.
sourceEui	The EUI64 of the node that initiated the route record.
relayCount	The number of relays in the list.
header	The message buffer containing the route record frame.
relayListIndex	The starting index of the relay list. The relay closest to the source is listed first, and the relay closest to the local device is listed last. Short IDs are stored low byte first. Be careful to use buffer-boundary-safe APIs to read the list.

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

A callback invoked by the stack when it has completed sending a message.

Parameters

type	The type of message sent.
indexOrDestination	The destination to which the message was sent. For direct unicasts, the destination to which the message was sent; for other unicasts, the address table or binding index to which the message was sent. The value is unspecified for multicasts and broadcasts.
apsFrame	The APS frame for the message.
message	The message that was sent.
status	An EmberStatus value of EMBER_SUCCESS if an ACK was received from the destination or EMBER_DELIVERY_FAILED if no ACK was received.

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

Parameters

packetType	The type of packet and the target stack layer. See EmberZigbeePacketType .
packetBuffer	The EmberMessageBuffer containing the packet. index The starting index of the relevant packet data. The plugin\ will receive a flat copy of the packet starting from this index.
data	Auxiliary data pointer

Returns

See EmberPacketAction

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

Parameters

packetType	The type of packet and the source stack layer. See EmberZigbeePacketType .
packetBuffer	The EmberMessageBuffer containing the packet.
index	The starting index of the relevant packet data. The plugin\ will receive a flat copy of the packet starting from this index.
data	Auxiliary data pointer

Returns

See EmberPacketAction

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

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

Parameters

source	The source from which to send the broadcast.
destination	The destination to which to send the broadcast. This must be one of three ZigBee broadcast addresses.
sequence	The NWK sequence number for the message.
apsFrame	The APS frame data to be included in the message.
radius	The maximum number of hops the message will be relayed.
message	The actual message to be sent.

Returns

An EmberStatus value.

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

Parameters

euiSource

The long source from which to send the broadcast.

Returns

An EmberStatus value.

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

Parameters

destination	The destination to which to send the broadcast. This must be one of three ZigBee broadcast addresses.
apsFrame	The APS frame data to be included in the message.
radius	The maximum number of hops the message will be relayed.
message	The actual message to be sent.

Returns

An EmberStatus value.

Sends 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 wishes 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.

Parameters

concentratorType

Must be either EMBER_HIGH_RAM_CONCENTRATOR or EMBER_LOW_RAM_CONCENTRATOR . The former is used when the caller has enough memory to store source routes for the whole network. In that case, remote nodes stop sending route records once the concentrator has successfully received one. The latter is used when the concentrator has insufficient RAM to store all outbound source routes. In that case, route records are sent to the concentrator prior to every inbound APS unicast.

radius

The maximum number of hops the route request will be relayed. A radius of zero is converted to EMBER_MAX_HOPS .

Returns

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

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

Parameters

apsFrame	The APS frame for the message. The multicast will be sent to the groupId in this frame.
radius	The message will be delivered to all nodes within this number of hops of the sender. A value of zero is converted to EMBER_MAX_HOPS.
nonmemberRadius	The number of hops that the message will be forwarded by devices that are not members of the group. A value of 7 or greater is treated as infinite.
message	A message.

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.

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

Parameters

apsFrame	The APS frame for the message. The multicast will be sent to the groupId in this frame.
radius	The message will be delivered to all nodes within this number of hops of the sender. A value of zero is converted to EMBER_MAX_HOPS.
nonmemberRadius	The number of hops that the message will be forwarded by devices that are not members of the group. A value of 7 or greater is treated as infinite.
message	A message.
alias	The alias from which to send the multicast.
sequence	The NWK sequence number for the message.

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.

Sends 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() .

Parameters

clusterId	The cluster ID to use for the reply.
reply	A reply message.

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.

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

Parameters

type	Specifies the outgoing message type. Must be one of EMBER_OUTGOING_DIRECT , EMBER_OUTGOING_VIA_ADDRESS_TABLE , or EMBER_OUTGOING_VIA_BINDING .
indexOrDestination	Depending on the type of addressing used, this is either the EmberNodeId of the destination, an index into the address table, or an index into the binding table.
apsFrame	The APS frame which is to be added to the message.
message	Contents of the message.

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.

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

Parameters

addressTableIndex	The index of an address table entry.
eui64	The EUI64 to use for the address table entry.

Returns

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

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

Parameters

addressTableIndex	The index of an address table entry.
id	The short ID corresponding to the remote node whose EUI64 is stored in the address table at the given index or EMBER_TABLE_ENTRY_UNUSED_NODE_ID which indicates that the entry stored in the address table at the given index is not in use.

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

Parameters

remoteEui64	The address of the node for which the timeout is to be set.
extendedTimeout	True if the retry interval should be increased by EMBER_INDIRECT_TRANSMISSION_TIMEOUT . False if the normal retry interval should be used.

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

Note

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

Parameters

fragmentData

The low byte is the block number of the reply. The high byte is the ACK bitfield of the reply.

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

Create an interpan message. 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.

This is 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.

This is 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.

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)

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.

The number of entries in the multicast table.