ESP8266_RTOS_SDK v1.4.0

- Main Page
- Modules
- Data Structures
- Files

- File List

esp_wps.h
1 /*
2 * ESPRSSIF MIT License
3 *
4 * Copyright (c) 2015 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
5 *
6 * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
7 * it is free of charge, to any person obtaining a copy of this software and associated
8 * documentation files (the "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
11 * to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all copies or
14 * substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 *
23 */
24
25 #ifndef __ESPWPS_H__
26 #define __ESPWPS_H__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
51 typedef enum wps_type {
52 WPS_TYPE_DISABLE = 0,
53 WPS_TYPE_PBC,
54 WPS_TYPE_PIN,
55 WPS_TYPE_DISPLAY,
56 WPS_TYPE_MAX,
57 } WPS_TYPE_t;
58
59 enum wps_cb_status {
60 WPS_CB_ST_SUCCESS = 0,
61 WPS_CB_ST_FAILED,
62 WPS_CB_ST_TIMEOUT,
63 WPS_CB_ST_WEP,
64 WPS_CB_ST_SCAN_ERR,
65 };
66
77 bool wifi_wps_enable(WPS_TYPE_t wps_type);
78
87 bool wifi_wps_disable(void);
88
99 bool wifi_wps_start(void);
100
113 typedef void (*wps_st_cb_t)(int status);
114
125 bool wifi_set_wps_cb(wps_st_cb_t cb);
126
135 #ifdef __cplusplus
136 }
137 #endif
138
139 #endif
WPS_CB_ST_SCAN_ERR
Definition: esp_wps.h:64
WPS_CB_ST_TIMEOUT
Definition: esp_wps.h:62
WPS_CB_ST_FAILED
Definition: esp_wps.h:61
wifi_wps_start
bool wifi_wps_start(void)
WPS starts to work.
wps_st_cb_t
void(* wps_st_cb_t)(int status)
WPS callback.
Definition: esp_wps.h:113
WPS_CB_ST_WEP
Definition: esp_wps.h:63
wifi_wps_enable
bool wifi_wps_enable(WPS_TYPE_t wps_type)
Enable Wi-Fi WPS function.
wifi_wps_disable
bool wifi_wps_disable(void)
Disable Wi-Fi WPS function and release resource it taken.
WPS_CB_ST_SUCCESS
Definition: esp_wps.h:60
wps_cb_status
wps_cb_status
Definition: esp_wps.h:59
wifi_set_wps_cb
bool wifi_set_wps_cb(wps_st_cb_t cb)
Set WPS callback.