forked from espressif/esp-idf
		
	esp32: remove esp_wps.h
not support now
This commit is contained in:
		@@ -1,131 +0,0 @@
 | 
			
		||||
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
 | 
			
		||||
//
 | 
			
		||||
// Licensed under the Apache License, Version 2.0 (the "License");
 | 
			
		||||
// you may not use this file except in compliance with the License.
 | 
			
		||||
// You may obtain a copy of the License at
 | 
			
		||||
 | 
			
		||||
//     http://www.apache.org/licenses/LICENSE-2.0
 | 
			
		||||
//
 | 
			
		||||
// Unless required by applicable law or agreed to in writing, software
 | 
			
		||||
// distributed under the License is distributed on an "AS IS" BASIS,
 | 
			
		||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
			
		||||
// See the License for the specific language governing permissions and
 | 
			
		||||
// limitations under the License.
 | 
			
		||||
 | 
			
		||||
#ifndef __ESP_WPS_H__
 | 
			
		||||
#define __ESP_WPS_H__
 | 
			
		||||
 | 
			
		||||
#include <stdbool.h>
 | 
			
		||||
 | 
			
		||||
#ifdef __cplusplus
 | 
			
		||||
extern "C" {
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
/** \defgroup WiFi_APIs WiFi Related APIs
 | 
			
		||||
  * @brief WiFi APIs
 | 
			
		||||
  */
 | 
			
		||||
 | 
			
		||||
/** @addtogroup WiFi_APIs
 | 
			
		||||
  * @{
 | 
			
		||||
  */
 | 
			
		||||
 | 
			
		||||
/** \defgroup WPS_APIs  WPS APIs
 | 
			
		||||
  * @brief ESP32 WPS APIs
 | 
			
		||||
  *
 | 
			
		||||
  * WPS can only be used when ESP32 station is enabled.
 | 
			
		||||
  *
 | 
			
		||||
  */
 | 
			
		||||
 | 
			
		||||
/** @addtogroup WPS_APIs
 | 
			
		||||
  * @{
 | 
			
		||||
  */
 | 
			
		||||
 | 
			
		||||
typedef enum wps_type {
 | 
			
		||||
    WPS_TYPE_DISABLE = 0,
 | 
			
		||||
    WPS_TYPE_PBC,
 | 
			
		||||
    WPS_TYPE_PIN,
 | 
			
		||||
    WPS_TYPE_DISPLAY,
 | 
			
		||||
    WPS_TYPE_MAX,
 | 
			
		||||
} WPS_TYPE_t;
 | 
			
		||||
 | 
			
		||||
enum wps_cb_status {
 | 
			
		||||
    WPS_CB_ST_SUCCESS = 0,     /**< WPS succeed */
 | 
			
		||||
    WPS_CB_ST_FAILED,          /**< WPS fail */
 | 
			
		||||
    WPS_CB_ST_TIMEOUT,         /**< WPS timeout, fail */
 | 
			
		||||
    WPS_CB_ST_WEP,             /**< WPS failed because that WEP is not supported */
 | 
			
		||||
    WPS_CB_ST_SCAN_ERR,        /**< can not find the target WPS AP */
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @brief     Enable Wi-Fi WPS function.
 | 
			
		||||
  *
 | 
			
		||||
  * @attention WPS can only be used when ESP32 station is enabled.
 | 
			
		||||
  *
 | 
			
		||||
  * @param     WPS_TYPE_t wps_type : WPS type, so far only WPS_TYPE_PBC is supported
 | 
			
		||||
  *
 | 
			
		||||
  * @return    true  : succeed
 | 
			
		||||
  * @return    false : fail
 | 
			
		||||
  */
 | 
			
		||||
bool wifi_wps_enable(WPS_TYPE_t wps_type);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @brief  Disable Wi-Fi WPS function and release resource it taken.
 | 
			
		||||
  *
 | 
			
		||||
  * @param  null
 | 
			
		||||
  *
 | 
			
		||||
  * @return true  : succeed
 | 
			
		||||
  * @return false : fail
 | 
			
		||||
  */
 | 
			
		||||
bool wifi_wps_disable(void);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @brief     WPS starts to work.
 | 
			
		||||
  *
 | 
			
		||||
  * @attention WPS can only be used when ESP32 station is enabled.
 | 
			
		||||
  *
 | 
			
		||||
  * @param     null
 | 
			
		||||
  *
 | 
			
		||||
  * @return    true  : WPS starts to work successfully, but does not mean WPS succeed.
 | 
			
		||||
  * @return    false : fail
 | 
			
		||||
  */
 | 
			
		||||
bool wifi_wps_start(void);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @brief  WPS callback.
 | 
			
		||||
  *
 | 
			
		||||
  * @param  int status : status of WPS, enum wps_cb_status.
 | 
			
		||||
  *    -  If parameter status == WPS_CB_ST_SUCCESS in WPS callback, it means WPS got AP's
 | 
			
		||||
  *       information, user can call wifi_wps_disable to disable WPS and release resource,
 | 
			
		||||
  *       then call wifi_station_connect to connect to target AP.
 | 
			
		||||
  *    -  Otherwise, it means that WPS fail, user can create a timer to retry WPS by
 | 
			
		||||
  *       wifi_wps_start after a while, or call wifi_wps_disable to disable WPS and release resource.
 | 
			
		||||
  *
 | 
			
		||||
  * @return null
 | 
			
		||||
  */
 | 
			
		||||
typedef void (*wps_st_cb_t)(int status);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @brief     Set WPS callback.
 | 
			
		||||
  *
 | 
			
		||||
  * @attention WPS can only be used when ESP32 station is enabled.
 | 
			
		||||
  *
 | 
			
		||||
  * @param     wps_st_cb_t cb : callback.
 | 
			
		||||
  *
 | 
			
		||||
  * @return    true  : WPS starts to work successfully, but does not mean WPS succeed.
 | 
			
		||||
  * @return    false : fail
 | 
			
		||||
  */
 | 
			
		||||
bool wifi_set_wps_cb(wps_st_cb_t cb);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @}
 | 
			
		||||
  */
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
  * @}
 | 
			
		||||
  */
 | 
			
		||||
 | 
			
		||||
#ifdef __cplusplus
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#endif /* __ESP_WPS_H__ */
 | 
			
		||||
		Reference in New Issue
	
	Block a user