EmberZNet API for sending and receiving RAW messages, which do not go out over the Zigbee network. These messages have MAC headers formatted by the application.
See raw-message for documentation.
License#
Copyright 2018 Silicon Laboratories Inc. www.silabs.com
The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.
/***************************************************************************/
#ifndef SILABS_RAW_MESSAGE_H
#define SILABS_RAW_MESSAGE_H
#include "mac-header.h"
EmberStatus emberSetMacFilterMatchList(const EmberMacFilterMatchData* macFilterMatchList);
void emberMacFilterMatchMessageHandler(const EmberMacFilterMatchStruct* macFilterMatchStruct);
bool emberMacPassthroughFilterHandler(uint8_t *macHeader);
EmberStatus emberSendRawMessageExtended(EmberMessageBuffer message, EmberTransmitPriority priority, bool useCca);
#define emberSendRawMessage(message) \
(emberSendRawMessageExtended(message, EMBER_MAC_TRANSMIT_PRIORITY_NORMAL, true))
void emberRawTransmitCompleteHandler(EmberMessageBuffer message,
EmberStatus status);
// Old APIs
void emberMacPassthroughMessageHandler(EmberMacPassthroughType messageType,
EmberMessageBuffer message);
extern EmberMacPassthroughType emberMacPassthroughFlags;
extern EmberNodeId emberEmbernetPassthroughSourceAddress;
#endif // SILABS_RAW_MESSAGE_H
Macros#
Sends the given message over the air without higher layer network headers.
Variables#
Applications wishing to receive MAC passthrough messages must set this to indicate the types of messages they wish to receive.
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.
Functions#
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.
This function is called when the stack has received a raw MAC message that has matched one of the application's configured MAC filters.
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.
Sends the given message over the air without higher layer network headers.
A callback invoked by the EmberZNet stack when the MAC has finished transmitting a raw 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.
Macro Definition Documentation#
emberSendRawMessage#
#define emberSendRawMessageValue:
(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.
121 of file stack/include/raw-message.hVariable Documentation#
emberMacPassthroughFlags#
EmberMacPassthroughType emberMacPassthroughFlags
Applications wishing to receive MAC passthrough messages must set this to indicate the types of messages they wish to receive.
164 of file stack/include/raw-message.hemberEmbernetPassthroughSourceAddress#
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.
171 of file stack/include/raw-message.hFunction Documentation#
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.
| N/A | macFilterMatchList | A pointer to a list of ::EmberMacFilterMatchData values. The last value should set the bit EMBER_MAC_FILTER_MATCH_END and nothing else. |
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.
52 of file stack/include/raw-message.hemberMacFilterMatchMessageHandler#
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.
| N/A | macFilterMatchStruct | This is a pointer to a structure containing information about the matching message, including the index of the filter that was matched, and the actual data of the message. |
61 of file stack/include/raw-message.hemberMacPassthroughFilterHandler#
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.
| N/A | macHeader | A pointer to the initial portion of the incoming MAC header. This contains the MAC frame control and addressing fields. Subsequent MAC fields, and the MAC payload, may not be present. |
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.
85 of file stack/include/raw-message.hemberSendRawMessageExtended#
EmberStatus emberSendRawMessageExtended (EmberMessageBuffer message, EmberTransmitPriority priority, bool useCca)
Sends the given message over the air without higher layer network headers.
| N/A | message | The message to transmit. priority transmit priority useCca flag should the CCA stay on or not |
| N/A | priority | |
| N/A | useCca |
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.
104 of file stack/include/raw-message.hemberRawTransmitCompleteHandler#
void emberRawTransmitCompleteHandler (EmberMessageBuffer message, EmberStatus status)
A callback invoked by the EmberZNet stack when the MAC has finished transmitting a raw message.
| N/A | message | The raw message that was sent. |
| N/A | status | EMBER_SUCCESS if the transmission was successful, or EMBER_DELIVERY_FAILED if not. |
If the application includes this callback, it must define EMBER_APPLICATION_HAS_RAW_HANDLER in its CONFIGURATION_HEADER.
134 of file stack/include/raw-message.hemberMacPassthroughMessageHandler#
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.
| N/A | messageType | The type of MAC passthrough message received. |
| N/A | message | The MAC passthrough message that was received. |
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.
158 of file stack/include/raw-message.h