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 sl_zigbee_af_network_find_join_cb. To extend the functionality to sub-GHz channels, also enable the Network Find (Sub-GHz) component.
Modules#
API#
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.
Return All or preferred channel mask for a given page.
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.
Return the current search mode.
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#
sl_zigbee_af_set_form_and_join_channel_mask#
sl_status_t sl_zigbee_af_set_form_and_join_channel_mask (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.
| N/A | page | |
| N/A | mask |
65 of file app/framework/plugin/network-find/network-find.hsl_zigbee_af_form_and_join_get_channel_mask#
uint32_t sl_zigbee_af_form_and_join_get_channel_mask (uint8_t page, bool allChannels)
Return All or preferred channel mask for a given page.
| N/A | page | The page to retrieve channel mask |
| N/A | allChannels | 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.
83 of file app/framework/plugin/network-find/network-find.hsl_zigbee_af_set_form_and_join_search_mode#
sl_status_t sl_zigbee_af_set_form_and_join_search_mode (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.
| N/A | mode |
89 of file app/framework/plugin/network-find/network-find.hsl_zigbee_af_get_form_and_join_search_mode#
uint8_t sl_zigbee_af_get_form_and_join_search_mode (void )
Return the current search mode.
| N/A |
93 of file app/framework/plugin/network-find/network-find.hsl_zigbee_af_get_form_and_join_channel_mask#
#define sl_zigbee_af_get_form_and_join_channel_maskValue:
(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.
72 of file app/framework/plugin/network-find/network-find.h