Merge branch 'bugfix/wifi_correct_modem_sleep_api_description' into 'master'

correct modem sleep API description

See merge request idf/esp-idf!2548
This commit is contained in:
Jiang Jiang Jian 2018-06-14 15:50:08 +08:00
commit 768f880b04

View file

@ -428,24 +428,24 @@ esp_err_t esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_re
esp_err_t esp_wifi_sta_get_ap_info(wifi_ap_record_t *ap_info);
/**
* @brief Set current power save type
* @brief Set current WiFi power save type
*
* @attention Default power save type is WIFI_PS_NONE.
* @attention Default power save type is WIFI_PS_MIN_MODEM.
*
* @param type power save type
*
* @return ESP_ERR_NOT_SUPPORTED: not supported yet
* @return ESP_OK: succeed
*/
esp_err_t esp_wifi_set_ps(wifi_ps_type_t type);
/**
* @brief Get current power save type
* @brief Get current WiFi power save type
*
* @attention Default power save type is WIFI_PS_NONE.
* @attention Default power save type is WIFI_PS_MIN_MODEM.
*
* @param[out] type: store current power save type
*
* @return ESP_ERR_NOT_SUPPORTED: not supported yet
* @return ESP_OK: succeed
*/
esp_err_t esp_wifi_get_ps(wifi_ps_type_t *type);