ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <protocomm.h>
#include <protocomm_security.h>
#include "wifi_provisioning/manager.h"
#include "wifi_provisioning/wifi_config.h"
#include "wifi_provisioning/wifi_scan.h"
#include "wifi_ctrl.h"
wifi_prov_mgr_done();
wifi_prov_mgr_wifi_scan_start(bool, bool, uint8_t, uint32_t);
wifi_prov_mgr_wifi_scan_finished();
wifi_prov_mgr_wifi_scan_result_count();
wifi_prov_mgr_wifi_scan_result(uint16_t);
get_wifi_prov_handlers(wifi_prov_config_handlers_t *);
get_wifi_scan_handlers(wifi_prov_scan_handlers_t *);
get_wifi_ctrl_handlers(wifi_ctrl_handlers_t *);
wifi_prov_mgr_get_remaining_conn_attempts(uint32_t *);
Files
ESP-IDF
components
app_trace
app_update
bootloader_support
bt
cmock
console
cxx
driver
efuse
esp_adc
esp_app_format
esp_bootloader_format
esp_coex
esp_common
esp_driver_ana_cmpr
esp_driver_cam
esp_driver_dac
esp_driver_gpio
esp_driver_gptimer
esp_driver_i2c
esp_driver_i2s
esp_driver_jpeg
esp_driver_ledc
esp_driver_mcpwm
esp_driver_parlio
esp_driver_pcnt
esp_driver_rmt
esp_driver_sdio
esp_driver_sdm
esp_driver_sdmmc
esp_driver_sdspi
esp_driver_spi
esp_driver_tsens
esp_driver_uart
esp_driver_usb_serial_jtag
esp_eth
esp_event
esp_gdbstub
esp_hid
esp_http_client
esp_http_server
esp_https_ota
esp_https_server
esp_hw_support
esp_lcd
esp_local_ctrl
esp_mm
esp_netif
esp_partition
esp_phy
esp_pm
esp_psram
esp_ringbuf
esp_rom
esp_security
esp_system
esp_timer
esp_vfs_console
esp_wifi
esp-tls
espcoredump
hal
heap
http_parser
ieee802154
log
mqtt
newlib
nvs_flash
nvs_sec_provider
openthread
perfmon
protobuf-c
protocomm
pthread
rt
sdmmc
soc
spi_flash
spiffs
tcp_transport
ulp
unity
vfs
wear_levelling
wifi_provisioning
include
proto-c
src
handlers.c
manager.c
scheme_ble.c
scheme_console.c
scheme_softap.c
wifi_config.c
wifi_ctrl.c
wifi_ctrl.h
wifi_provisioning_priv.h
wifi_scan.c
wpa_supplicant
xtensa
examples
lwIP
FreeRTOS
cJSON
mbedTLS
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/wifi_provisioning/src/wifi_provisioning_priv.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include <protocomm.h> #include <protocomm_security.h> #include "wifi_provisioning/manager.h" #include "wifi_provisioning/wifi_config.h" #include "wifi_provisioning/wifi_scan.h" #include "wifi_ctrl.h"6 includes /** * @brief Notify manager that provisioning is done * * Stops the provisioning. This is called by the get_status_handler() * when the status is connected. This has no effect if main application * has disabled auto stop on completion by calling * wifi_prov_mgr_disable_auto_stop() * * @return * - ESP_OK : Provisioning will be stopped * - ESP_FAIL : Failed to stop provisioning *//* ... */ esp_err_t wifi_prov_mgr_done(void); /** * @brief Start Wi-Fi AP Scan * * @param[in] blocking Set true to return only after scanning is complete * @param[in] passive Set true to perform passive scan instead of default active scan * @param[in] group_channels Number of channels to scan in one go * (set to 0 for scanning all channels in one go) * @param[in] period_ms Scan time (in milli-seconds) on each channel * * @return * - ESP_OK : Successfully started Wi-Fi scanning * - ESP_FAIL : Provisioning app not running *//* ... */ esp_err_t wifi_prov_mgr_wifi_scan_start(bool blocking, bool passive, uint8_t group_channels, uint32_t period_ms); /** * @brief Use to query the state of Wi-Fi scan * * @return * - true : Scan finished * - false : Scan running *//* ... */ bool wifi_prov_mgr_wifi_scan_finished(void); /** * @brief Get the count of results in the scan list * * @return * - count : Number of Wi-Fi Access Points detected while scanning *//* ... */ uint16_t wifi_prov_mgr_wifi_scan_result_count(void); /** * @brief Get AP record for a particular index in the scan list result * * @param[out] index Index of the result to fetch * * @return * - result : Pointer to Access Point record *//* ... */ const wifi_ap_record_t *wifi_prov_mgr_wifi_scan_result(uint16_t index); /** * @brief Get protocomm handlers for wifi_config provisioning endpoint * * @param[out] ptr pointer to structure to be set * * @return * - ESP_OK : success * - ESP_ERR_INVALID_ARG : null argument *//* ... */ esp_err_t get_wifi_prov_handlers(wifi_prov_config_handlers_t *ptr); /** * @brief Get protocomm handlers for wifi_scan provisioning endpoint * * @param[out] ptr pointer to structure to be set * * @return * - ESP_OK : success * - ESP_ERR_INVALID_ARG : null argument *//* ... */ esp_err_t get_wifi_scan_handlers(wifi_prov_scan_handlers_t *ptr); /** * @brief Get protocomm handlers for wifi_ctrl provisioning endpoint * * @param[in] ptr pointer to structure to be set * * @return * - ESP_OK : success * - ESP_ERR_INVALID_ARG : null argument *//* ... */ esp_err_t get_wifi_ctrl_handlers(wifi_ctrl_handlers_t *ptr); /** * @brief Retrieve the remaining number of Wi-Fi connection attempts * * This function provides the number of connection attempts left for * the Wi-Fi provisioning manager before reaching the maximum retry limit. * * @param[out] attempts_remaining Pointer to store the remaining connection attempts * * @return * - ESP_OK: Success * - ESP_ERR_INVALID_ARG: Null pointer provided for attempts_remaining * - ESP_FAIL: Failed to retrieve the remaining attempts *//* ... */ esp_err_t wifi_prov_mgr_get_remaining_conn_attempts(uint32_t *attempts_remaining);
Details
Show:
from
Types: Columns: