blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 01:29:21 -04:00
Code Issues Projects Releases Wiki Activity

wifi_provisioning: Update API documentation to highlight argument validity while providing sec_params argument.

Browse Source
This commit is contained in:
Aditya Patwardhan 2022-08-11 10:12:56 +05:30
parent 4532e6e0b2
commit 2f99d2e37f
3 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/protocomm/include/common/protocomm.h
View File

@ -192,6 +192,8 @@ esp_err_t protocomm_req_handle(protocomm_t *pc, const char *ep_name, uint32_t se
* For protocomm security version 1 and 2 * For protocomm security version 1 and 2
* sec_params should contain pointer to struct of type * sec_params should contain pointer to struct of type
* protocomm_security1_params_t and protocmm_security2_params_t respectively. * protocomm_security1_params_t and protocmm_security2_params_t respectively.
* The contents of this pointer must be valid till the security session
* has been running and is not closed.
* @return * @return
* - ESP_OK : Success * - ESP_OK : Success
* - ESP_FAIL : Error adding endpoint / Endpoint with this name already exists * - ESP_FAIL : Error adding endpoint / Endpoint with this name already exists

2
components/wifi_provisioning/include/wifi_provisioning/manager.h
View File

@ -301,6 +301,8 @@ esp_err_t wifi_prov_mgr_is_provisioned(bool *provisioned);
* This pointer should hold the struct of type * This pointer should hold the struct of type
* wifi_prov_security1_params_t for protocomm security 1 * wifi_prov_security1_params_t for protocomm security 1
* and wifi_prov_security2_params_t for protocomm security 2 respectively. * and wifi_prov_security2_params_t for protocomm security 2 respectively.
* This pointer and its contents should be valid till the provisioning service is
* running and has not been stopped or de-inited.
* @param[in] service_name Unique name of the service. This translates to: * @param[in] service_name Unique name of the service. This translates to:
* - Wi-Fi SSID when provisioning mode is softAP * - Wi-Fi SSID when provisioning mode is softAP
* - Device name when provisioning mode is BLE * - Device name when provisioning mode is BLE

3
examples/provisioning/wifi_prov_mgr/main/app_main.c
View File

@ -336,6 +336,9 @@ void app_main(void)
* - NULL if not used * - NULL if not used
*/ */
const char *pop = "abcd1234"; const char *pop = "abcd1234";
/* If the pop is allocated dynamically, then it should be valid till the provisioning process is running.
* it can be only freed when the WIFI_PROV_END event is triggered */
/* This is the structure for passing security parameters /* This is the structure for passing security parameters
* for the protocomm security 1. * for the protocomm security 1.
* This does not need not be static i.e. could be dynamically allocated * This does not need not be static i.e. could be dynamically allocated