Modules#

MAC Address Filtering#

API and Callbacks for the MAC Address Filtering Component.

This plugin artificially limits what the stack hears by filtering the packets just above the lower MAC. The plugin can be configured on the fly via CLI with the short or long address of devices whose packets will be dropped or allowed. There are two lists, a short address list (2-byte node ID) and a long address list (8-byte IEEE address). Each list may be configured as either an allow list or block list. The default is a block list with no addresses configured (accept all packets normally). A separate option allows or drops packets with no address information (e.g., Beacon Requests). NOTE: The radio will still generate and process MAC ACKs for packets. This plugin cannot be used to effect the behavior of MAC ACKs, which are handled by the RAIL library and radio hardware.

API#

void

emberAfPluginMacAddressFilteringPrintConfigCommand(SL_CLI_COMMAND_ARG)

Print configuration command.

void

emberAfPluginMacAddressFilteringFilterNoAddressCommand(SL_CLI_COMMAND_ARG)

Filter out the no address command.

void

emberAfPluginMacAddressFilteringAddShortAddressCommand(SL_CLI_COMMAND_ARG)

Add the short address command.

void

emberAfPluginMacAddressFilteringSetShortAddressListType(SL_CLI_COMMAND_ARG)

Set the short address list type.

void

emberAfPluginMacAddressFilteringSetLongAddressListType(SL_CLI_COMMAND_ARG)

Set the long address list type.

void

emberAfPluginMacAddressFilteringAddLongAddressCommand(SL_CLI_COMMAND_ARG)

Add long address.

void

emberAfPluginMacAddressFilteringClearShortAddressList(SL_CLI_COMMAND_ARG)

Clear the short address list.

void

emberAfPluginMacAddressFilteringClearLongAddressList(SL_CLI_COMMAND_ARG)

Clear the long address list.

void

emberAfPluginMacAddressFilteringAddPanIdCommand(SL_CLI_COMMAND_ARG)

Add panID.

void

emberAfPluginMacAddressFilteringPanIdDeleteEntry(SL_CLI_COMMAND_ARG)

Delete a panID entry.

void

emberAfPluginMacAddressFilteringClearPanIdList(SL_CLI_COMMAND_ARG)

Clear the panID list.

void

emberAfPluginMacAddressFilteringSetPanIdListType(SL_CLI_COMMAND_ARG)

Set the list type for panID list.

void

emberAfPluginMacAddressFilteringReset(SL_CLI_COMMAND_ARG)

MAC address filtering reset.

void

emberAfPluginMacAddressFilteringClearAll(void)

Clear all lists for MAC address filtering.

void

emberAfPluginMacAddressFilteringShortAddressDeleteEntry(SL_CLI_COMMAND_ARG)

Delete an entry from short address list.

void

emberAfPluginMacAddressFilteringLongAddressDeleteEntry(SL_CLI_COMMAND_ARG)

Delete an entry from long address list.

EmberStatus

emberAfPluginMacAddressFilteringGetStatsForShortAddress(uint8_t index, uint32_t *matchCountForIndexPtr)

Get stats for a short address.

void

emberAfPluginMacAddressFilteringGetStats(bool shortMode, uint32_t *allowedPacketCountPtr, uint32_t *droppedPacketCountPtr, uint32_t *totalPacketCountPtr)

Get MAC address filtering stats. Get the allowed, dropped and total packet counts.

API Documentation#

emberAfPluginMacAddressFilteringPrintConfigCommand#

void emberAfPluginMacAddressFilteringPrintConfigCommand (SL_CLI_COMMAND_ARG )

Print configuration command.

Parameters

N/A

Ver.: always

Definition at line 52 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringFilterNoAddressCommand#

void emberAfPluginMacAddressFilteringFilterNoAddressCommand (SL_CLI_COMMAND_ARG )

Filter out the no address command.

Parameters

N/A

Ver.: always

Definition at line 59 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringAddShortAddressCommand#

void emberAfPluginMacAddressFilteringAddShortAddressCommand (SL_CLI_COMMAND_ARG )

Add the short address command.

Parameters

N/A

Ver.: always

Definition at line 66 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringSetShortAddressListType#

void emberAfPluginMacAddressFilteringSetShortAddressListType (SL_CLI_COMMAND_ARG )

Set the short address list type.

Parameters

N/A

Ver.: always

Definition at line 73 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringSetLongAddressListType#

void emberAfPluginMacAddressFilteringSetLongAddressListType (SL_CLI_COMMAND_ARG )

Set the long address list type.

Parameters

N/A

Ver.: always

Definition at line 80 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringAddLongAddressCommand#

void emberAfPluginMacAddressFilteringAddLongAddressCommand (SL_CLI_COMMAND_ARG )

Add long address.

Parameters

N/A

Ver.: always

Definition at line 87 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringClearShortAddressList#

void emberAfPluginMacAddressFilteringClearShortAddressList (SL_CLI_COMMAND_ARG )

Clear the short address list.

Parameters

N/A

Ver.: always

Definition at line 94 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringClearLongAddressList#

void emberAfPluginMacAddressFilteringClearLongAddressList (SL_CLI_COMMAND_ARG )

Clear the long address list.

Parameters

N/A

Ver.: always

Definition at line 101 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringAddPanIdCommand#

void emberAfPluginMacAddressFilteringAddPanIdCommand (SL_CLI_COMMAND_ARG )

Add panID.

Parameters

N/A

Ver.: always

Definition at line 108 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringPanIdDeleteEntry#

void emberAfPluginMacAddressFilteringPanIdDeleteEntry (SL_CLI_COMMAND_ARG )

Delete a panID entry.

Parameters

N/A

Ver.: always

Definition at line 115 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringClearPanIdList#

void emberAfPluginMacAddressFilteringClearPanIdList (SL_CLI_COMMAND_ARG )

Clear the panID list.

Parameters

N/A

Ver.: always

Definition at line 122 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringSetPanIdListType#

void emberAfPluginMacAddressFilteringSetPanIdListType (SL_CLI_COMMAND_ARG )

Set the list type for panID list.

Parameters

N/A

Ver.: always

Definition at line 129 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringReset#

void emberAfPluginMacAddressFilteringReset (SL_CLI_COMMAND_ARG )

MAC address filtering reset.

Parameters

N/A

Ver.: always

Definition at line 136 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringClearAll#

void emberAfPluginMacAddressFilteringClearAll (void )

Clear all lists for MAC address filtering.

Parameters

N/A

Ver.: always

Definition at line 143 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringShortAddressDeleteEntry#

void emberAfPluginMacAddressFilteringShortAddressDeleteEntry (SL_CLI_COMMAND_ARG )

Delete an entry from short address list.

Parameters

N/A

Ver.: always

Definition at line 150 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringLongAddressDeleteEntry#

void emberAfPluginMacAddressFilteringLongAddressDeleteEntry (SL_CLI_COMMAND_ARG )

Delete an entry from long address list.

Parameters

N/A

Ver.: always

Definition at line 157 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringGetStatsForShortAddress#

EmberStatus emberAfPluginMacAddressFilteringGetStatsForShortAddress (uint8_t index, uint32_t * matchCountForIndexPtr)

Get stats for a short address.

Parameters

N/A	index	Ver.: always
N/A	matchCountForIndexPtr	Ver.: always

Returns

EmberStatus status code

Definition at line 167 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h

emberAfPluginMacAddressFilteringGetStats#

void emberAfPluginMacAddressFilteringGetStats (bool shortMode, uint32_t * allowedPacketCountPtr, uint32_t * droppedPacketCountPtr, uint32_t * totalPacketCountPtr)

Get MAC address filtering stats. Get the allowed, dropped and total packet counts.

Parameters

N/A	shortMode	Ver.: always
N/A	allowedPacketCountPtr	Ver.: always
N/A	droppedPacketCountPtr	Ver.: always
N/A	totalPacketCountPtr	Ver.: always

Definition at line 177 of file app/framework/plugin-soc/mac-address-filtering/mac-address-filtering.h