Raw Message APIs and Handlers#

sl_zigbee_set_mac_filter_match_list#

sl_status_t sl_zigbee_set_mac_filter_match_list (const sl_zigbee_mac_filter_match_data_t * macFilterMatchList, uint8_t listLength)

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 sl_802154_filter_match_message_handler(). This function should point to a list of ::sl_zigbee_mac_filter_match_data_t. To clear all filters, call this function with listLength equal to 0.

Returns

• ::SL_STATUS_OK if the MAC filter match list has been configured correctly. ::SL_STATUS_INVALID_PARAMETER if one of the filters matches a Zigbee MAC header and cannot be used, or if the filter list exceeds the supported length.

sl_802154_filter_match_message_handler#

void sl_802154_filter_match_message_handler (uint8_t filterIndexMatch, uint8_t legacyPassthroughType, sl_zigbee_rx_packet_info_t * packetInfo, uint8_t messageLength, uint8_t * messageContents)

Called when the stack has received a raw MAC message that has matched one of the application's configured MAC filters.

sl_802154_internal_passthrough_filter_handler#

bool sl_802154_internal_passthrough_filter_handler (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 sl_802154_passthrough_message_handler() with a type of SL_802154_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 SL_ZIGBEE_APPLICATION_HAS_MAC_PASSTHROUGH_FILTER_HANDLER in its CONFIGURATION_HEADER.

Returns

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

sl_zigbee_send_raw_message#

sl_status_t sl_zigbee_send_raw_message (const uint8_t * message, uint8_t message_length, sl_zigbee_transmit_priority_t priority, bool useCca)

Send 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 sl_zigbee_raw_transmit_complete_handler(). 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

• ::SL_STATUS_OK if the message was successfully submitted to the transmit queue, and ::SL_STATUS_FAIL otherwise.

sl_zigbee_raw_transmit_complete_handler#

void sl_zigbee_raw_transmit_complete_handler (uint8_t message, uint8_t * messageContents, sl_status_t 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 SL_ZIGBEE_APPLICATION_HAS_RAW_HANDLER in its CONFIGURATION_HEADER.

sl_802154_passthrough_message_handler#

void sl_802154_passthrough_message_handler (sl_zigbee_mac_passthrough_type_t messageType, sl_zigbee_rx_packet_info_t * packetInfo, uint8_t messageLength, uint8_t * messageContents)

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 SL_ZIGBEE_APPLICATION_HAS_MAC_PASSTHROUGH_HANDLER in its CONFIGURATION_HEADER and call sl_zigbee_set_mac_passthrough_flags() to indicate the kind(s) of messages that the application wishes to receive.

sl_zigbee_get_mac_passthrough_flags#

sl_zigbee_mac_passthrough_type_t sl_zigbee_get_mac_passthrough_flags (void )

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

sl_zigbee_set_mac_passthrough_flags#

void sl_zigbee_set_mac_passthrough_flags (sl_zigbee_mac_passthrough_type_t type)

sl_zigbee_get_embernet_passthrough_source_address#

sl_802154_short_addr_t sl_zigbee_get_embernet_passthrough_source_address (void )

Applications wishing to receive EmberNet messages filtered by source address must set this to the desired source address, as well as setting the SL_802154_PASSTHROUGH_EMBERNET_SOURCE bit when using sl_zigbee_set_mac_passthrough_flags().

sl_zigbee_set_embernet_passthrough_source_address#

void sl_zigbee_set_embernet_passthrough_source_address (sl_802154_short_addr_t address)