alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/doc_wifi_default_init' into 'master'

Browse Source 
esp_netif: Update documentation on deinitialization of wifi default netif

Closes IDFGH-4692

See merge request espressif/esp-idf!12300
This commit is contained in:
David Čermák 2021-02-11 14:15:51 +08:00
commit c665bcf733
2 changed files with 42 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
components/esp_netif/test/test_esp_netif.c
View File

@ -310,3 +310,42 @@ TEST_CASE("esp_netif: convert ip address from string", "[esp_netif]")
TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_netif_str_to_ip6(NULL, &ipv6));
TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_netif_str_to_ip6(ipv6_src[0], NULL));
}
TEST_CASE("esp_netif: create and destroy default wifi interfaces", "[esp_netif][leaks=0]")
{
// Helper constants to refer default STA and AP's params
static const esp_netif_inherent_config_t default_sta_cfg = ESP_NETIF_INHERENT_DEFAULT_WIFI_STA();
static const esp_netif_inherent_config_t default_ap_cfg = ESP_NETIF_INHERENT_DEFAULT_WIFI_AP();
// create default station
esp_netif_t *sta = esp_netif_create_default_wifi_sta();
// check it gets created and has default params
TEST_ASSERT_NOT_NULL(sta);
TEST_ASSERT_EQUAL_STRING(default_sta_cfg.if_desc, esp_netif_get_desc(sta));
TEST_ASSERT_EQUAL(default_sta_cfg.route_prio, esp_netif_get_route_prio(sta));
// create default access point
esp_netif_t *ap = esp_netif_create_default_wifi_ap();
// check it gets created and has default params
TEST_ASSERT_NOT_NULL(ap);
TEST_ASSERT_EQUAL_STRING(default_ap_cfg.if_desc, esp_netif_get_desc(ap));
TEST_ASSERT_EQUAL(default_ap_cfg.route_prio, esp_netif_get_route_prio(ap));
// destroy the station
esp_wifi_clear_default_wifi_driver_and_handlers(sta);
esp_netif_destroy(sta);
// destroy the AP
esp_wifi_clear_default_wifi_driver_and_handlers(ap);
esp_netif_destroy(ap);
// quick check on create-destroy cycle of the default station again
sta = NULL;
sta = esp_netif_create_default_wifi_sta();
TEST_ASSERT_NOT_NULL(sta);
esp_wifi_clear_default_wifi_driver_and_handlers(sta);
esp_netif_destroy(sta);
}

4
docs/en/api-reference/network/esp_netif.rst
View File

@ -160,7 +160,9 @@ such as softAP and station, are provided in two separate APIs to facilitate simp
Please note that these functions return the ``esp_netif`` handle, i.e. a pointer to a network interface object allocated and
configured with default settings, which as a consequence, means that:
* The created object has to be destroyed if a network de-initialization is provided by an application.
* The created object has to be destroyed if a network de-initialization is provided by an application. The de-initialization should be performed in the two steps:
- :cpp:func:`esp_wifi_clear_default_wifi_driver_and_handlers()` -- To unregister default wifi handlers and detach the created object from the wifi
- :cpp:func:`esp_netif_destroy()` -- To destroy the ``esp_netif`` object.
* These *default* interfaces must not be created multiple times, unless the created handle is deleted using :cpp:func:`esp_netif_destroy()`.
* When using Wifi in ``AP+STA`` mode, both these interfaces has to be created.