mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

docs: Change ESP_ERR_CHECK to ESP_ERROR_CHECK in provisioning examples 

Closes IDFGH-5222
Closes IDFGH-5221
Closes https://github.com/espressif/esp-idf/pull/6995
Closes https://github.com/espressif/esp-idf/issues/6994
pull/7041/head
Alex Henrie 2021-05-06 13:05:52 -06:00 zatwierdzone przez Mahavir Jain
rodzic 9afd57057d
commit 22964d2065
1 zmienionych plików z 4 dodań i 4 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

8
docs/en/api-reference/provisioning/wifi_provisioning.rst
Wyświetl plik

@ -22,7 +22,7 @@ Initialization
.scheme_event_handler = WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BTDM .scheme_event_handler = WIFI_PROV_SCHEME_BLE_EVENT_HANDLER_FREE_BTDM
}; };
ESP_ERR_CHECK( wifi_prov_mgr_init(config) ); ESP_ERROR_CHECK( wifi_prov_mgr_init(config) );
The configuration structure ``wifi_prov_mgr_config_t`` has a few fields to specify the behavior desired of the manager : The configuration structure ``wifi_prov_mgr_config_t`` has a few fields to specify the behavior desired of the manager :
@ -105,7 +105,7 @@ If provisioning state needs to be reset, any of the following approaches may be
:: ::
bool provisioned = false; bool provisioned = false;
ESP_ERR_CHECK( wifi_prov_mgr_is_provisioned(&provisioned) ); ESP_ERROR_CHECK( wifi_prov_mgr_is_provisioned(&provisioned) );
Start Provisioning Service Start Provisioning Service
@ -133,7 +133,7 @@ See :doc:`Provisioning<provisioning>` for details about the security features.
wifi_prov_security_t security = WIFI_PROV_SECURITY_1; wifi_prov_security_t security = WIFI_PROV_SECURITY_1;
const char *pop = "abcd1234"; const char *pop = "abcd1234";
ESP_ERR_CHECK( wifi_prov_mgr_start_provisioning(security, pop, service_name, service_key) ); ESP_ERROR_CHECK( wifi_prov_mgr_start_provisioning(security, pop, service_name, service_key) );
The provisioning service will automatically finish only if it receives valid Wi-Fi AP credentials followed by successfully connection of device to the AP (IP obtained). Regardless of that, the provisioning service can be stopped at any moment by making a call to :cpp:func:`wifi_prov_mgr_stop_provisioning()`. The provisioning service will automatically finish only if it receives valid Wi-Fi AP credentials followed by successfully connection of device to the AP (IP obtained). Regardless of that, the provisioning service can be stopped at any moment by making a call to :cpp:func:`wifi_prov_mgr_stop_provisioning()`.
@ -155,7 +155,7 @@ There are two ways for making this possible. The simpler way is to use a blockin
:: ::
// Start provisioning service // Start provisioning service
ESP_ERR_CHECK( wifi_prov_mgr_start_provisioning(security, pop, service_name, service_key) ); ESP_ERROR_CHECK( wifi_prov_mgr_start_provisioning(security, pop, service_name, service_key) );
// Wait for service to complete // Wait for service to complete
wifi_prov_mgr_wait(); wifi_prov_mgr_wait();