Network Find#

API and Callbacks for the Network Find Component.

NOTE: This component is deprecated in Zigbee 3.0, but is still used for Zigbee Smart Energy requirements. See the Network Creator and Network Steering components instead for Zigbee 3.0-compliant implementations of this behavior. This component provides legacy Zigbee Home Automation (pre-3.0) implementation of routines for finding and joining any viable network via scanning, rather than joining a specific network. If the application will be deployed in an environment with potentially a lot of open networks, consider implementing a mechanism for network deny listing. Network deny listing may be accomplished by implementing the emberAfPluginNetworkFindJoinCallback. To extend the functionality to sub-GHz channels, also enable the Network Find (Sub-GHz) component.

Modules#

Network Find

API#

EmberStatus
emberAfSetFormAndJoinChannelMask(uint8_t page, uint32_t mask)

Set the channel mask for "find unused" and "find joinable". Permitted pages are 0 and, if Sub-GHz channels are included, then also 28-31.

uint32_t
emberAfFormAndJoinGetChannelMask(uint8_t page, bool allChannels)

Return All or preferred channel mask for a given page.

EmberStatus
emberAfSetFormAndJoinSearchMode(uint8_t mode)

Set the search mode for "find unused" and "find joinable". Mode is a bitmask. Permitted values are set by the FIND_AND_JOIN_MODE_... macros.

uint8_t
emberAfGetFormAndJoinSearchMode(void)

Return the current search mode.

#define
emberAfGetFormAndJoinChannelMask (page)

Return the preferred channel mask for a given page. Only the bottom 27 bits can be set. The top 5 bits are reserved for the page number and are always zero in a returned channel mask. That leaves the value 0xFFFFFFFF free to indicate an invalid page error.

API Documentation#

emberAfSetFormAndJoinChannelMask#

EmberStatus emberAfSetFormAndJoinChannelMask (uint8_t page, uint32_t mask)

Set the channel mask for "find unused" and "find joinable". Permitted pages are 0 and, if Sub-GHz channels are included, then also 28-31.

Parameters
N/Apage
N/Amask

Definition at line 65 of file app/framework/plugin/network-find/network-find.h

emberAfFormAndJoinGetChannelMask#

uint32_t emberAfFormAndJoinGetChannelMask (uint8_t page, bool allChannels)

Return All or preferred channel mask for a given page.

Parameters
N/Apage

The page to retrieve channel mask

N/AallChannels

All or preferred channel mask

Only the bottom 27 bits can be set. The top 5 bits are reserved for the page number and are always zero in a returned channel mask. That leaves the value 0xFFFFFFFF free to indicate an invalid page error.


Definition at line 83 of file app/framework/plugin/network-find/network-find.h

emberAfSetFormAndJoinSearchMode#

EmberStatus emberAfSetFormAndJoinSearchMode (uint8_t mode)

Set the search mode for "find unused" and "find joinable". Mode is a bitmask. Permitted values are set by the FIND_AND_JOIN_MODE_... macros.

Parameters
N/Amode

Definition at line 89 of file app/framework/plugin/network-find/network-find.h

emberAfGetFormAndJoinSearchMode#

uint8_t emberAfGetFormAndJoinSearchMode (void )

Return the current search mode.

Parameters
N/A

Definition at line 93 of file app/framework/plugin/network-find/network-find.h

emberAfGetFormAndJoinChannelMask#

#define emberAfGetFormAndJoinChannelMask
Value:
(page)

Return the preferred channel mask for a given page. Only the bottom 27 bits can be set. The top 5 bits are reserved for the page number and are always zero in a returned channel mask. That leaves the value 0xFFFFFFFF free to indicate an invalid page error.


Definition at line 72 of file app/framework/plugin/network-find/network-find.h