Raw Message APIs and Handlers#

emberMacPassthroughFlags#

EmberMacPassthroughType emberMacPassthroughFlags

Applications wishing to receive MAC passthrough messages must set this to indicate the types of messages they wish to receive.

emberEmbernetPassthroughSourceAddress#

EmberNodeId emberEmbernetPassthroughSourceAddress

Applications wishing to receive EmberNet messages filtered by source address must set this to the desired source address, as well as setting the EMBER_MAC_PASSTHROUGH_EMBERNET_SOURCE bit in emberMacPassthroughFlags.

emberSetMacFilterMatchList#

EmberStatus emberSetMacFilterMatchList (const EmberMacFilterMatchData *macFilterMatchList)

This function allows the application to configure the stack to accept raw MAC data messages that it normally would not accept. When the stack receives a message matching one of the filters it will call emberMacFilterMatchMessageHandler(). This function should point to a list of ::EmberMacFilterMatchData or NULL to clear all filters. The passed value must point to a valiable in GLOBAL memory.

Returns

• EMBER_SUCCESS if the MAC filter match list has been configured correctly. EMBER_BAD_ARGUMENT if one of the filters matches a Zigbee MAC header and cannot be used.

emberMacFilterMatchMessageHandler#

void emberMacFilterMatchMessageHandler (const EmberMacFilterMatchStruct *macFilterMatchStruct)

This function is called when the stack has received a raw MAC message that has matched one of the application's configured MAC filters.

emberMacPassthroughFilterHandler#

bool emberMacPassthroughFilterHandler (uint8_t *macHeader)

A callback invoked by the EmberZNet stack to filter out incoming application MAC passthrough messages. If this returns true for a message the complete message will be passed to emberMacPassthroughMessageHandler() with a type of EMBER_MAC_PASSTHROUGH_APPLICATION.

Note that this callback may be invoked in ISR context and should execute as quickly as possible.

Note that this callback may be called more than once per incoming message. Therefore the callback code should not depend on being called only once, and should return the same value each time it is called with a given header.

If the application includes this callback, it must define EMBER_APPLICATION_HAS_MAC_PASSTHROUGH_FILTER_HANDLER in its CONFIGURATION_HEADER.

Returns

• true if the messages is an application MAC passthrough message.

emberSendRawMessageExtended#

EmberStatus emberSendRawMessageExtended (EmberMessageBuffer message, EmberTransmitPriority priority, bool useCca)

Sends the given message over the air without higher layer network headers.

The first two bytes are interpreted as the 802.15.4 frame control field. If the Ack Request bit is set, the packet will be retried as necessary. Completion is reported via emberRawTransmitCompleteHandler(). Note that the sequence number specified in this packet is not taken into account by the MAC layer. The MAC layer overwrites the sequence number field with the next available sequence number.

Returns

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

emberRawTransmitCompleteHandler#

void emberRawTransmitCompleteHandler (EmberMessageBuffer message, EmberStatus status)

A callback invoked by the EmberZNet stack when the MAC has finished transmitting a raw message.

If the application includes this callback, it must define EMBER_APPLICATION_HAS_RAW_HANDLER in its CONFIGURATION_HEADER.

emberMacPassthroughMessageHandler#

void emberMacPassthroughMessageHandler (EmberMacPassthroughType messageType, EmberMessageBuffer message)

A callback invoked by the EmberZNet stack when a MAC passthrough message is received. These are messages that applications may wish to receive but that do not follow the normal ZigBee format.

Examples of MAC passthrough messages are Embernet messages and first generation (v1) standalone bootloader messages, and SE (Smart Energy) InterPAN messages. These messages are handed directly to the application and are not otherwise handled by the EmberZNet stack. Other uses of this API are not tested or supported at this time. If the application includes this callback, it must define EMBER_APPLICATION_HAS_MAC_PASSTHROUGH_HANDLER in its CONFIGURATION_HEADER and set emberMacPassthroughFlags to indicate the kind(s) of messages that the application wishes to receive.

emberSendRawMessage#

#define emberSendRawMessage

(message)

Sends the given message over the air without higher layer network headers.

The first two bytes are interpreted as the 802.15.4 frame control field. If the Ack Request bit is set, the packet will be retried as necessary. Completion is reported via emberRawTransmitCompleteHandler(). Note that the sequence number specified in this packet is not taken into account by the MAC layer. The MAC layer overwrites the sequence number field with the next available sequence number.

Returns

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