Sending and Receiving Messages

Data Structures

struct  InterPanHeader
 A struct for keeping track of all of the header info.

Macros

#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.
 
#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.
 
#define INTER_PAN_UNICAST   0x03
 
#define INTER_PAN_BROADCAST   0x0B
 
#define INTER_PAN_MULTICAST   0x0F
 
#define MAX_INTER_PAN_MAC_SIZE   (2 + 1 + 2 + 8 + 2 + 8)
 
#define STUB_NWK_SIZE   2
 
#define STUB_NWK_FRAME_CONTROL   0x000B
 
#define MAX_STUB_APS_SIZE   (1 + 2 + 2 + 2)
 
#define MAX_INTER_PAN_HEADER_SIZE   (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + MAX_STUB_APS_SIZE)
 
#define INTER_PAN_UNICAST   0x03
 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.
 
#define INTER_PAN_BROADCAST   0x0B
 
#define INTER_PAN_MULTICAST   0x0F
 
#define MAX_INTER_PAN_MAC_SIZE   (2 + 1 + 2 + 8 + 2 + 8)
 
#define STUB_NWK_SIZE   2
 
#define STUB_NWK_FRAME_CONTROL   0x000B
 
#define MAX_STUB_APS_SIZE   (1 + 2 + 2 + 2)
 
#define MAX_INTER_PAN_HEADER_SIZE   (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + MAX_STUB_APS_SIZE)

Functions

uint8_t emberMaximumApsPayloadLength (void)
 Returns the maximum size of the payload that the Application Support sub-layer will accept.
 
EmberStatus emberSendMulticastWithAlias (EmberApsFrame *apsFrame, uint8_t radius, uint8_t nonmemberRadius, EmberMessageBuffer message, EmberNodeId alias, uint8_t sequence)
 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.
 
EmberStatus emberSendMulticast (EmberApsFrame *apsFrame, uint8_t radius, uint8_t nonmemberRadius, EmberMessageBuffer message)
 Sends a multicast message to all endpoints that share a specific multicast ID and are within a specified number of hops of the sender.
 
EmberStatus emberSendUnicast (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame *apsFrame, EmberMessageBuffer message)
 Sends a unicast message per the Zigbee specification.
 
EmberStatus emberSendBroadcast (EmberNodeId destination, EmberApsFrame *apsFrame, uint8_t radius, EmberMessageBuffer message)
 Sends a broadcast message as per the ZigBee specification.
 
EmberStatus emberProxyBroadcast (EmberNodeId source, EmberNodeId destination, uint8_t sequence, EmberApsFrame *apsFrame, uint8_t radius, EmberMessageBuffer message)
 Proxies a broadcast message for another node.
 
EmberStatus emberProxyNextBroadcastFromLong (uint8_t *euiSource)
 Proxies a broadcast message for another node.
 
EmberStatus emberSendManyToOneRouteRequest (uint16_t concentratorType, uint8_t radius)
 Sends a route request packet that creates routes from every node in the network back to this node.
 
EmberStatus emberGetSourceRouteTableEntry (uint8_t index, EmberNodeId *destination, uint8_t *closerIndex)
 Returns the source route table entry fields.
 
uint8_t emberGetSourceRouteTableFilledSize (void)
 Returns the number of filled entries in the source route table.
 
uint8_t emberGetSourceRouteTableTotalSize (void)
 Returns the source route table total size.
 
void emberIncomingManyToOneRouteRequestHandler (EmberNodeId source, EmberEUI64 longId, uint8_t cost)
 A callback indicating that a many-to-one route to the concentrator with the given short and long ID is available for use.
 
void emberIncomingRouteErrorHandler (EmberStatus status, EmberNodeId target)
 A callback invoked when a route error message is received.
 
EmberStatus emberCancelMessage (EmberMessageBuffer message)
 DEPRECATED.
 
void emberMessageSentHandler (EmberOutgoingMessageType type, uint16_t indexOrDestination, EmberApsFrame *apsFrame, EmberMessageBuffer message, EmberStatus status)
 A callback invoked by the stack when it has completed sending a message.
 
void emberIncomingMessageHandler (EmberIncomingMessageType type, EmberApsFrame *apsFrame, EmberMessageBuffer message)
 A callback invoked by the EmberZNet stack when a message is received.
 
EmberStatus emberGetLastHopLqi (uint8_t *lastHopLqi)
 Gets the link quality from the node that last relayed the current message.
 
EmberStatus emberGetLastHopRssi (int8_t *lastHopRssi)
 Gets the receive signal strength indication (RSSI) for the current message.
 
EmberStatus emberGetLastHopTimestamp (uint32_t *lastHopTimestamp)
 Gets 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.
 
EmberNodeId emberGetSender (void)
 Returns the node ID of the sender of the current incoming message.
 
EmberStatus emberGetSenderEui64 (EmberEUI64 senderEui64)
 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.
 
EmberStatus emberSendReply (uint16_t clusterId, EmberMessageBuffer reply)
 Sends a reply for an application that has received a unicast message.
 
void emberSetReplyFragmentData (uint16_t fragmentData)
 Sets the fragment data to be used when sending a reply to a unicast message.
 
bool emberAddressTableEntryIsActive (uint8_t addressTableIndex)
 Indicates whether any messages are currently being sent using this address table entry.
 
EmberStatus emberSetAddressTableRemoteEui64 (uint8_t addressTableIndex, EmberEUI64 eui64)
 Sets the EUI64 of an address table entry.
 
void emberSetAddressTableRemoteNodeId (uint8_t addressTableIndex, EmberNodeId id)
 Sets the short ID of an address table entry.
 
void emberGetAddressTableRemoteEui64 (uint8_t addressTableIndex, EmberEUI64 eui64)
 Gets the EUI64 of an address table entry.
 
EmberNodeId emberGetAddressTableRemoteNodeId (uint8_t addressTableIndex)
 Gets the short ID of an address table entry.
 
void emberSetExtendedTimeout (EmberEUI64 remoteEui64, bool extendedTimeout)
 Tells the stack whether or not the normal interval between retransmissions of a retried unicast message should be increased by EMBER_INDIRECT_TRANSMISSION_TIMEOUT.
 
bool emberGetExtendedTimeout (EmberEUI64 remoteEui64)
 Indicates whether or not the stack will extend the normal interval between retransmissions of a retried unicast message by EMBER_INDIRECT_TRANSMISSION_TIMEOUT.
 
void emberIdConflictHandler (EmberNodeId conflictingId)
 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.
 
bool emberPendingAckedMessages (void)
 Indicates whether there are pending messages in the APS retry queue.
 
void emberBroadcastSetMinAcksNeeded (uint8_t minAcksNeeded)
 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.
 
EmberPacketAction emberPacketHandoffIncoming (EmberZigbeePacketType packetType, EmberMessageBuffer packetBuffer, uint8_t index, void *data)
 Intercepts an incoming packet from the stack and hands off to a plugin for further processing.
 
EmberPacketAction emberPacketHandoffOutgoing (EmberZigbeePacketType packetType, EmberMessageBuffer packetBuffer, uint8_t index, void *data)
 Intercepts an outgoing packet from the stack and hands off to a plugin for further processing.
 
EmberPacketAction emberAfIncomingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t *packetData, uint8_t *size_p, void *data)
 A protocol layer packet has been received by the stack.
 
EmberPacketAction emberAfOutgoingPacketFilterCallback (EmberZigbeePacketType packetType, uint8_t *packetData, uint8_t *size_p, void *data)
 The stack is preparing to send a protocol layer packet.
 
EmberMessageBuffer makeInterPanMessage (InterPanHeader *headerData, EmberMessageBuffer payload)
 Creates an interpan message suitable for passing to emberSendRawMessage().
 
uint8_t parseInterPanMessage (EmberMessageBuffer message, uint8_t startOffset, InterPanHeader *headerData)
 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.
 
uint8_t makeInterPanMessage (InterPanHeader *headerData, uint8_t *message, uint8_t maxLength, uint8_t *payload, uint8_t payloadLength)
 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.
 
uint8_t parseInterPanMessage (uint8_t *message, uint8_t messageLength, InterPanHeader *headerData)
 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.

Variables

uint16_t emberApsAckTimeoutMs
 The APS ACK timeout value. The stack waits this amount of time between resends of APS retried messages. The default value is:
 
EmberMulticastTableEntryemberMulticastTable
 The multicast table.
 
uint8_t emberMulticastTableSize
 The number of entries in the multicast table.

Detailed Description

See message.h for source code.

See also ami-inter-pan.h for source code.

See also ami-inter-pan-host.h for source code.

Macro Definition Documentation

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

◆ INTER_PAN_BROADCAST [1/2]

#define INTER_PAN_BROADCAST   0x0B

◆ INTER_PAN_BROADCAST [2/2]

#define INTER_PAN_BROADCAST   0x0B

◆ INTER_PAN_MULTICAST [1/2]

#define INTER_PAN_MULTICAST   0x0F

◆ INTER_PAN_MULTICAST [2/2]

#define INTER_PAN_MULTICAST   0x0F

◆ INTER_PAN_UNICAST [1/2]

#define INTER_PAN_UNICAST   0x03

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.

◆ INTER_PAN_UNICAST [2/2]

#define INTER_PAN_UNICAST   0x03

◆ MAX_INTER_PAN_HEADER_SIZE [1/2]

#define MAX_INTER_PAN_HEADER_SIZE   (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + MAX_STUB_APS_SIZE)

◆ MAX_INTER_PAN_HEADER_SIZE [2/2]

#define MAX_INTER_PAN_HEADER_SIZE   (MAX_INTER_PAN_MAC_SIZE + STUB_NWK_SIZE + MAX_STUB_APS_SIZE)

◆ MAX_INTER_PAN_MAC_SIZE [1/2]

#define MAX_INTER_PAN_MAC_SIZE   (2 + 1 + 2 + 8 + 2 + 8)

◆ MAX_INTER_PAN_MAC_SIZE [2/2]

#define MAX_INTER_PAN_MAC_SIZE   (2 + 1 + 2 + 8 + 2 + 8)

◆ MAX_STUB_APS_SIZE [1/2]

#define MAX_STUB_APS_SIZE   (1 + 2 + 2 + 2)

◆ MAX_STUB_APS_SIZE [2/2]

#define MAX_STUB_APS_SIZE   (1 + 2 + 2 + 2)

◆ STUB_NWK_FRAME_CONTROL [1/2]

#define STUB_NWK_FRAME_CONTROL   0x000B

◆ STUB_NWK_FRAME_CONTROL [2/2]

#define STUB_NWK_FRAME_CONTROL   0x000B

◆ STUB_NWK_SIZE [1/2]

#define STUB_NWK_SIZE   2

◆ STUB_NWK_SIZE [2/2]

#define STUB_NWK_SIZE   2

Function Documentation

◆ emberAddressTableEntryIsActive()

bool emberAddressTableEntryIsActive ( uint8_t  addressTableIndex)

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
addressTableIndexThe index of an address table entry.
Returns
True if the address table entry is active, false otherwise.

◆ emberAfIncomingPacketFilterCallback()

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

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
packetTypeThe type of packet received. See EmberZigbeePacketType.
packetDataA flat buffer containing the packet contents the buffer starts with the command id followed by the payload
size_pa pointer to the size of the packet data
dataThis 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

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

Parameters
packetTypeThe type of packet received. See EmberZigbeePacketType.
packetDataA flat buffer containing the packet contents the buffer starts with the command id followed by the payload
size_pa pointer to the size of the packet data
dataThis 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

◆ emberBroadcastSetMinAcksNeeded()

void emberBroadcastSetMinAcksNeeded ( uint8_t  minAcksNeeded)

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
minAcksNeededThe minimum number of acknowledgments (re-broadcasts) to wait for until deeming the broadcast transmission complete.
Returns
None.

◆ emberCancelMessage()

EmberStatus emberCancelMessage ( EmberMessageBuffer  message)

DEPRECATED.

Parameters
messageA message.
Returns
Always returns EMBER_SUCCESS.

◆ emberGetAddressTableRemoteEui64()

void emberGetAddressTableRemoteEui64 ( uint8_t  addressTableIndex,
EmberEUI64  eui64 
)

Gets the EUI64 of an address table entry.

Parameters
addressTableIndexThe index of an address table entry.
eui64The EUI64 of the address table entry is copied to this location.

◆ emberGetAddressTableRemoteNodeId()

EmberNodeId emberGetAddressTableRemoteNodeId ( uint8_t  addressTableIndex)

Gets the short ID of an address table entry.

Parameters
addressTableIndexThe 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.

◆ emberGetExtendedTimeout()

bool emberGetExtendedTimeout ( EmberEUI64  remoteEui64)

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

Parameters
remoteEui64The 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.

◆ emberGetLastHopLqi()

EmberStatus emberGetLastHopLqi ( uint8_t *  lastHopLqi)

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

Note
This function may only be called from within 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
lastHopLqiThe link quality for the last incoming message processed.
Returns
This function always returns EMBER_SUCCESS. It is not necessary to check this return value.

◆ emberGetLastHopRssi()

EmberStatus emberGetLastHopRssi ( int8_t *  lastHopRssi)

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: 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
lastHopRssiThe RSSI for the last incoming message processed.
Returns
This function always returns EMBER_SUCCESS. It is not necessary to check this return value.

◆ emberGetLastHopTimestamp()

EmberStatus emberGetLastHopTimestamp ( uint32_t *  lastHopTimestamp)

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

(On EM3xx devices, the hardware MAC timer is 20 bits and ticks roughly every microsecond for a range of around 1 second. Dumbo ticks every 2us while other 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:

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.

Parameters
lastHopTimestampThe timestamp for the last incoming message processed.
Returns
This function always returns EMBER_SUCCESS. It is not necessary to check this return value.

◆ emberGetSender()

EmberNodeId emberGetSender ( void  )

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.

◆ emberGetSenderEui64()

EmberStatus emberGetSenderEui64 ( EmberEUI64  senderEui64)

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
senderEui64The EUI64 of the sender.
Returns
An EmberStatus value:

◆ emberGetSourceRouteTableEntry()

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

Returns the source route table entry fields.

Parameters
indexThe index of the source route table entry.
destinationThe value of the destination field in that entry.
closerIndexThe value of the closer index entry field in that entry.

◆ emberGetSourceRouteTableFilledSize()

uint8_t emberGetSourceRouteTableFilledSize ( void  )

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

◆ emberGetSourceRouteTableTotalSize()

uint8_t emberGetSourceRouteTableTotalSize ( void  )

Returns the source route table total size.

◆ emberIdConflictHandler()

void emberIdConflictHandler ( EmberNodeId  conflictingId)

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
conflictingIdThe short ID for which a conflict was detected.

◆ emberIncomingManyToOneRouteRequestHandler()

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

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
sourceThe short ID of the concentrator that initiated the many-to-one route request.
longIdThe EUI64 of the concentrator.
costThe path cost to the concentrator.

◆ emberIncomingMessageHandler()

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

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

The following functions may be called from emberIncomingMessageHandler():

Parameters
typeThe type of the incoming message. One of the following:
apsFrameThe APS frame from the incoming message.
messageThe message that was sent.

◆ emberIncomingRouteErrorHandler()

void emberIncomingRouteErrorHandler ( EmberStatus  status,
EmberNodeId  target 
)

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
statusEMBER_SOURCE_ROUTE_FAILURE, EMBER_MANY_TO_ONE_ROUTE_FAILURE, EMBER_MAC_INDIRECT_TIMEOUT
targetThe short ID of the remote node.

◆ emberMaximumApsPayloadLength()

uint8_t emberMaximumApsPayloadLength ( void  )

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.

◆ emberMessageSentHandler()

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

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

Parameters
typeThe type of message sent.
indexOrDestinationThe 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.
apsFrameThe APS frame for the message.
messageThe message that was sent.
statusAn EmberStatus value of EMBER_SUCCESS if an ACK was received from the destination or EMBER_DELIVERY_FAILED if no ACK was received.

◆ emberPacketHandoffIncoming()

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

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

Parameters
packetTypeThe type of packet and the target stack layer. See EmberZigbeePacketType.
packetBufferThe 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.
dataAuxiliary data pointer
Returns
See EmberPacketAction

◆ emberPacketHandoffOutgoing()

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

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

Parameters
packetTypeThe type of packet and the source stack layer. See EmberZigbeePacketType.
packetBufferThe EmberMessageBuffer containing the packet.
indexThe starting index of the relevant packet data. The plugin\ will receive a flat copy of the packet starting from this index.
dataAuxiliary data pointer
Returns
See EmberPacketAction

◆ emberPendingAckedMessages()

bool emberPendingAckedMessages ( void  )

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.

◆ emberProxyBroadcast()

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

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
sourceThe source from which to send the broadcast.
destinationThe destination to which to send the broadcast. This must be one of three ZigBee broadcast addresses.
sequenceThe NWK sequence number for the message.
apsFrameThe APS frame data to be included in the message.
radiusThe maximum number of hops the message will be relayed.
messageThe actual message to be sent.
Returns
An EmberStatus value.

◆ emberProxyNextBroadcastFromLong()

EmberStatus emberProxyNextBroadcastFromLong ( uint8_t *  euiSource)

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
euiSourceThe long source from which to send the broadcast.
Returns
An EmberStatus value.

◆ emberSendBroadcast()

EmberStatus emberSendBroadcast ( EmberNodeId  destination,
EmberApsFrame apsFrame,
uint8_t  radius,
EmberMessageBuffer  message 
)

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
destinationThe destination to which to send the broadcast. This must be one of three ZigBee broadcast addresses.
apsFrameThe APS frame data to be included in the message.
radiusThe maximum number of hops the message will be relayed.
messageThe actual message to be sent.
Returns
An EmberStatus value.

◆ emberSendManyToOneRouteRequest()

EmberStatus emberSendManyToOneRouteRequest ( uint16_t  concentratorType,
uint8_t  radius 
)

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
concentratorTypeMust 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.
radiusThe 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.

◆ emberSendMulticast()

EmberStatus emberSendMulticast ( EmberApsFrame apsFrame,
uint8_t  radius,
uint8_t  nonmemberRadius,
EmberMessageBuffer  message 
)

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
apsFrameThe APS frame for the message. The multicast will be sent to the groupId in this frame.
radiusThe 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.
nonmemberRadiusThe 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.
messageA message.
Returns
An EmberStatus value. For any result other than EMBER_SUCCESS, the message will not be sent.

◆ emberSendMulticastWithAlias()

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

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
apsFrameThe APS frame for the message. The multicast will be sent to the groupId in this frame.
radiusThe 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.
nonmemberRadiusThe 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.
messageA message.
aliasThe alias from which to send the multicast.
sequenceThe NWK sequence number for the message.
Returns
An EmberStatus value. For any result other than EMBER_SUCCESS, the message will not be sent.

◆ emberSendReply()

EmberStatus emberSendReply ( uint16_t  clusterId,
EmberMessageBuffer  reply 
)

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
clusterIdThe cluster ID to use for the reply.
replyA reply message.
Returns
An EmberStatus value. For any result other than EMBER_SUCCESS, the message will not be sent.

◆ emberSendUnicast()

EmberStatus emberSendUnicast ( EmberOutgoingMessageType  type,
uint16_t  indexOrDestination,
EmberApsFrame apsFrame,
EmberMessageBuffer  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
typeSpecifies the outgoing message type. Must be one of EMBER_OUTGOING_DIRECT, EMBER_OUTGOING_VIA_ADDRESS_TABLE, or EMBER_OUTGOING_VIA_BINDING.
indexOrDestinationDepending 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.
apsFrameThe APS frame which is to be added to the message.
messageContents of the message.
Returns
An EmberStatus value. For any result other than EMBER_SUCCESS, the message will not be sent.

◆ emberSetAddressTableRemoteEui64()

EmberStatus emberSetAddressTableRemoteEui64 ( uint8_t  addressTableIndex,
EmberEUI64  eui64 
)

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
addressTableIndexThe index of an address table entry.
eui64The 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.

◆ emberSetAddressTableRemoteNodeId()

void emberSetAddressTableRemoteNodeId ( uint8_t  addressTableIndex,
EmberNodeId  id 
)

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
addressTableIndexThe index of an address table entry.
idThe 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.

◆ emberSetExtendedTimeout()

void emberSetExtendedTimeout ( EmberEUI64  remoteEui64,
bool  extendedTimeout 
)

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
remoteEui64The address of the node for which the timeout is to be set.
extendedTimeoutTrue if the retry interval should be increased by EMBER_INDIRECT_TRANSMISSION_TIMEOUT. False if the normal retry interval should be used.

◆ emberSetReplyFragmentData()

void emberSetReplyFragmentData ( uint16_t  fragmentData)

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
fragmentDataThe low byte is the block number of the reply. The high byte is the ACK bitfield of the reply.

◆ makeInterPanMessage() [1/2]

EmberMessageBuffer makeInterPanMessage ( InterPanHeader headerData,
EmberMessageBuffer  payload 
)

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

◆ makeInterPanMessage() [2/2]

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

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.

◆ parseInterPanMessage() [1/2]

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

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.

◆ parseInterPanMessage() [2/2]

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

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.

Variable Documentation

◆ emberApsAckTimeoutMs

uint16_t emberApsAckTimeoutMs

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)

◆ emberMulticastTable

EmberMulticastTableEntry* emberMulticastTable

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.

◆ emberMulticastTableSize

uint8_t emberMulticastTableSize

The number of entries in the multicast table.