mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-11-03 22:08:28 +00:00 
			
		
		
		
	Doc:update wifi api docs
* Add documents related to espnow config rate * Optimization set dns server api description
This commit is contained in:
		@@ -571,9 +571,10 @@ esp_err_t esp_netif_dhcps_stop(esp_netif_t *esp_netif);
 | 
				
			|||||||
 *
 | 
					 *
 | 
				
			||||||
 *   If DHCP server is enabled, the Main DNS Server setting is used by the DHCP server to provide a DNS Server option
 | 
					 *   If DHCP server is enabled, the Main DNS Server setting is used by the DHCP server to provide a DNS Server option
 | 
				
			||||||
 *   to DHCP clients (Wi-Fi stations).
 | 
					 *   to DHCP clients (Wi-Fi stations).
 | 
				
			||||||
 *   - The default Main DNS server is typically the IP of the Wi-Fi AP interface itself.
 | 
					 *   - The default Main DNS server is typically the IP of the DHCP server itself.
 | 
				
			||||||
 *   - This function can override it by setting server type ESP_NETIF_DNS_MAIN.
 | 
					 *   - This function can override it by setting server type ESP_NETIF_DNS_MAIN.
 | 
				
			||||||
 *   - Other DNS Server types are not supported for the Wi-Fi AP interface.
 | 
					 *   - Other DNS Server types are not supported for the DHCP server.
 | 
				
			||||||
 | 
					 *   - To propagate the DNS info to client, please stop the DHCP server before using this API.
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @param[in]  esp_netif Handle to esp-netif instance
 | 
					 * @param[in]  esp_netif Handle to esp-netif instance
 | 
				
			||||||
 * @param[in]  type Type of DNS Server to set: ESP_NETIF_DNS_MAIN, ESP_NETIF_DNS_BACKUP, ESP_NETIF_DNS_FALLBACK
 | 
					 * @param[in]  type Type of DNS Server to set: ESP_NETIF_DNS_MAIN, ESP_NETIF_DNS_BACKUP, ESP_NETIF_DNS_FALLBACK
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,16 +1,8 @@
 | 
				
			|||||||
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
 | 
					/*
 | 
				
			||||||
//
 | 
					 * SPDX-FileCopyrightText: 2019-2022 Espressif Systems (Shanghai) CO LTD
 | 
				
			||||||
// Licensed under the Apache License, Version 2.0 (the "License");
 | 
					 *
 | 
				
			||||||
// you may not use this file except in compliance with the License.
 | 
					 * SPDX-License-Identifier: Apache-2.0
 | 
				
			||||||
// 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_NOW_H__
 | 
					#ifndef __ESP_NOW_H__
 | 
				
			||||||
#define __ESP_NOW_H__
 | 
					#define __ESP_NOW_H__
 | 
				
			||||||
@@ -237,6 +229,20 @@ esp_err_t esp_now_del_peer(const uint8_t *peer_addr);
 | 
				
			|||||||
  */
 | 
					  */
 | 
				
			||||||
esp_err_t esp_now_mod_peer(const esp_now_peer_info_t *peer);
 | 
					esp_err_t esp_now_mod_peer(const esp_now_peer_info_t *peer);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/**
 | 
				
			||||||
 | 
					  * @brief      Config ESPNOW rate of specified interface
 | 
				
			||||||
 | 
					  *
 | 
				
			||||||
 | 
					  * @attention  1. This API should be called after esp_wifi_start().
 | 
				
			||||||
 | 
					  *
 | 
				
			||||||
 | 
					  * @param      ifx  Interface to be configured.
 | 
				
			||||||
 | 
					  * @param      rate Phy rate to be configured.
 | 
				
			||||||
 | 
					  *
 | 
				
			||||||
 | 
					  * @return
 | 
				
			||||||
 | 
					  *    - ESP_OK: succeed
 | 
				
			||||||
 | 
					  *    - others: failed
 | 
				
			||||||
 | 
					  */
 | 
				
			||||||
 | 
					esp_err_t esp_wifi_config_espnow_rate(wifi_interface_t ifx, wifi_phy_rate_t rate);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
  * @brief     Get a peer whose MAC address matches peer_addr from peer list
 | 
					  * @brief     Get a peer whose MAC address matches peer_addr from peer list
 | 
				
			||||||
  *
 | 
					  *
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1218,20 +1218,6 @@ esp_err_t esp_wifi_ftm_resp_set_offset(int16_t offset_cm);
 | 
				
			|||||||
  */
 | 
					  */
 | 
				
			||||||
esp_err_t esp_wifi_config_11b_rate(wifi_interface_t ifx, bool disable);
 | 
					esp_err_t esp_wifi_config_11b_rate(wifi_interface_t ifx, bool disable);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					 | 
				
			||||||
  * @brief      Config ESPNOW rate of specified interface
 | 
					 | 
				
			||||||
  *
 | 
					 | 
				
			||||||
  * @attention  1. This API should be called after esp_wifi_init() and before esp_wifi_start().
 | 
					 | 
				
			||||||
  *
 | 
					 | 
				
			||||||
  * @param      ifx  Interface to be configured.
 | 
					 | 
				
			||||||
  * @param      rate Phy rate to be configured.
 | 
					 | 
				
			||||||
  *
 | 
					 | 
				
			||||||
  * @return
 | 
					 | 
				
			||||||
  *    - ESP_OK: succeed
 | 
					 | 
				
			||||||
  *    - others: failed
 | 
					 | 
				
			||||||
  */
 | 
					 | 
				
			||||||
esp_err_t esp_wifi_config_espnow_rate(wifi_interface_t ifx, wifi_phy_rate_t rate);
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
  * @brief      Set interval for station to wake up periodically at disconnected.
 | 
					  * @brief      Set interval for station to wake up periodically at disconnected.
 | 
				
			||||||
  *
 | 
					  *
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -81,6 +81,11 @@ Receiving ESP-NOW Data
 | 
				
			|||||||
Call ``esp_now_register_recv_cb`` to register receiving callback function.  Call the receiving callback function when receiving ESP-NOW. The receiving callback function also runs from the Wi-Fi task. So, do not do lengthy operations in the callback function. 
 | 
					Call ``esp_now_register_recv_cb`` to register receiving callback function.  Call the receiving callback function when receiving ESP-NOW. The receiving callback function also runs from the Wi-Fi task. So, do not do lengthy operations in the callback function. 
 | 
				
			||||||
Instead, post the necessary data to a queue and handle it from a lower priority task.
 | 
					Instead, post the necessary data to a queue and handle it from a lower priority task.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Config ESP-NOW Rate
 | 
				
			||||||
 | 
					-------------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Call ``esp_wifi_config_espnow_rate`` to config ESPNOW rate of specified interface. Make sure that the interface is enabled before config rate. This API should be called after ``esp_wifi_start()``.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
API Reference
 | 
					API Reference
 | 
				
			||||||
-------------
 | 
					-------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -81,6 +81,11 @@ ESP-NOW 采用 CCMP 方法保护供应商特定动作帧的安全,具体可参
 | 
				
			|||||||
调用 ``esp_now_register_recv_cb`` 注册接收回调函数。当接收 ESP-NOW 数据时,需要调用接收回调函数。接收回调函数也在 Wi-Fi 任务任务中运行。因此,不要在回调函数中执行冗长的操作。
 | 
					调用 ``esp_now_register_recv_cb`` 注册接收回调函数。当接收 ESP-NOW 数据时,需要调用接收回调函数。接收回调函数也在 Wi-Fi 任务任务中运行。因此,不要在回调函数中执行冗长的操作。
 | 
				
			||||||
相反,将必要的数据发布到队列,并交给优先级较低的任务处理。
 | 
					相反,将必要的数据发布到队列,并交给优先级较低的任务处理。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					配置 ESP-NOW 速率
 | 
				
			||||||
 | 
					----------------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					调用 ``esp_wifi_config_espnow_rate`` 配置指定接口的 ESPNOW 速率。确保在配置速率之前使能接口。这个 API 应该在 ``esp_wifi_start()`` 之后调用。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
API 参考
 | 
					API 参考
 | 
				
			||||||
-------------
 | 
					-------------
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user