Skip to content

Commit

Permalink
Merge branch 'bugfix/modify_wifi_max_conn_num' into 'master'
Browse files Browse the repository at this point in the history
esp_wifi: modify wifi max conn num

Closes IDFGH-7960, WIFI-4176, IDFGH-8431, and WIFI-5004

See merge request espressif/esp-idf!19367
  • Loading branch information
jack0c committed Nov 22, 2022
2 parents 4867928 + fbbb762 commit d89a512
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 31 deletions.
15 changes: 15 additions & 0 deletions components/esp_wifi/Kconfig
Expand Up @@ -385,4 +385,19 @@ menu "Wi-Fi"
Delta timeout time for rf phy off, When the beacon is lost, the next rf phy off will
be delayed for the time specified by the configuration item. Unit: 1024 microsecond.

config ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM
int "Maximum espnow encrypt peers number"
range 0 4 if IDF_TARGET_ESP32C2
range 0 16 if (!IDF_TARGET_ESP32C2)
default 2 if IDF_TARGET_ESP32C2
default 6 if !IDF_TARGET_ESP32C2
help
Maximum number of encrypted peers supported by espnow.
The number of hardware keys for encryption is fixed. And the espnow and SoftAP share the same
hardware keys. So this configuration will affect the maximum connection number of SoftAP.
Maximum espnow encrypted peers number + maximum number of connections of SoftAP = Max hardware keys number.

When using ESP mesh, this value should be set to a maximum of 6.


endmenu # Wi-Fi
23 changes: 9 additions & 14 deletions components/esp_wifi/include/esp_mesh_internal.h
@@ -1,16 +1,8 @@
// Copyright 2017-2018 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.
/*
* SPDX-FileCopyrightText: 2017-2021 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/

#ifndef __ESP_MESH_INTERNAL_H__
#define __ESP_MESH_INTERNAL_H__
Expand Down Expand Up @@ -107,6 +99,9 @@ typedef struct {
mesh_chain_layer_t chain;
} __attribute__((packed)) mesh_chain_assoc_t;

/* mesh max connections */
#define MESH_MAX_CONNECTIONS (10)

/**
* @brief Mesh PS duties
*/
Expand All @@ -117,7 +112,7 @@ typedef struct {
bool used;
uint8_t duty;
uint8_t mac[6];
} child[ESP_WIFI_MAX_CONN_NUM];
} child[MESH_MAX_CONNECTIONS];
} esp_mesh_ps_duties_t;

/*******************************************************
Expand Down
2 changes: 2 additions & 0 deletions components/esp_wifi/include/esp_wifi.h
Expand Up @@ -107,6 +107,7 @@ typedef struct {
int mgmt_sbuf_num; /**< WiFi management short buffer number, the minimum value is 6, the maximum value is 32 */
uint64_t feature_caps; /**< Enables additional WiFi features and capabilities */
bool sta_disconnected_pm; /**< WiFi Power Management for station at disconnected status */
int espnow_max_encrypt_num; /**< Maximum encrypt number of peers supported by espnow */
int magic; /**< WiFi init magic number, it should be the last field */
} wifi_init_config_t;

Expand Down Expand Up @@ -225,6 +226,7 @@ extern uint64_t g_wifi_feature_caps;
.mgmt_sbuf_num = WIFI_MGMT_SBUF_NUM, \
.feature_caps = g_wifi_feature_caps, \
.sta_disconnected_pm = WIFI_STA_DISCONNECTED_PM_ENABLED, \
.espnow_max_encrypt_num = CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM, \
.magic = WIFI_INIT_CONFIG_MAGIC\
}

Expand Down
2 changes: 1 addition & 1 deletion components/esp_wifi/include/esp_wifi_types.h
Expand Up @@ -315,7 +315,7 @@ typedef struct {
#if CONFIG_IDF_TARGET_ESP32C2
#define ESP_WIFI_MAX_CONN_NUM (4) /**< max number of stations which can connect to ESP32C2 soft-AP */
#else
#define ESP_WIFI_MAX_CONN_NUM (10) /**< max number of stations which can connect to ESP32 soft-AP */
#define ESP_WIFI_MAX_CONN_NUM (16) /**< max number of stations which can connect to ESP32/ESP32S3/ESP32S2/ESP32C3 soft-AP */
#endif

/** @brief List of stations associated with the ESP32 Soft-AP */
Expand Down
10 changes: 3 additions & 7 deletions docs/en/api-reference/network/esp_now.rst
Expand Up @@ -68,15 +68,11 @@ Call :cpp:func:`esp_now_add_peer()` to add the device to the paired device list

.. only:: esp32c2

The maximum number of paired devices is 20, and the paired encryption devices are no more than 4, the default is 2.
The maximum number of paired devices is 20, and the paired encryption devices are no more than 4, the default is 2. If you want to change the number of paired encryption devices, set :ref:`CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM` in WiFi component configuration menu.

.. only:: esp32c3
.. only:: esp32 or esp32s2 or esp32s3 or esp32c3

The maximum number of paired devices is 20, and the paired encryption devices are no more than 10, the default is 6.

.. only:: esp32 or esp32s2 or esp32s3

The maximum number of paired devices is 20, and the paired encryption devices are no more than 16, the default is 6.
The maximum number of paired devices is 20, and the paired encryption devices are no more than 16, the default is 6. If you want to change the number of paired encryption devices, set :ref:`CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM` in WiFi component configuration menu.

A device with a broadcast MAC address must be added before sending broadcast data. The range of the channel of paired devices is from 0 to 14. If the channel is set to 0, data will be sent on the current channel. Otherwise, the channel must be set as the channel that the local device is on.

Expand Down
10 changes: 3 additions & 7 deletions docs/zh_CN/api-reference/network/esp_now.rst
Expand Up @@ -68,15 +68,11 @@ ESP-NOW 采用 CCMP 方法保护供应商特定动作帧的安全,具体可参

.. only:: esp32c2

配对设备的最大数量是 20,其中加密设备的数量不超过 4,默认值是 2。
配对设备的最大数量是 20,其中加密设备的数量不超过 4,默认值是 2。如果想要修改加密设备的数量,在 WiFi menuconfig 设置 :ref:`CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM`。

.. only:: esp32c3
.. only:: esp32 or esp32s2 or esp32s3 or esp32c3

配对设备的最大数量是 20,其中加密设备的数量不超过 10,默认值是 6。

.. only:: esp32 or esp32s2 or esp32s3

配对设备的最大数量是 20,其中加密设备的数量不超过 16,默认值是 6。
配对设备的最大数量是 20,其中加密设备的数量不超过 16,默认值是 6。如果想要修改加密设备的数量,在 WiFi menuconfig 设置 :ref:`CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM`。

在发送广播数据之前必须添加具有广播 MAC 地址的设备。配对设备的信道范围是从 0 ~14。如果信道设置为 0,数据将在当前信道上发送。否则,必须使用本地设备所在的通道。

Expand Down
1 change: 0 additions & 1 deletion tools/ci/check_copyright_ignore.txt
Expand Up @@ -601,7 +601,6 @@ components/esp_system/test_eh_frame_parser/eh_frame_parser_impl.h
components/esp_system/test_eh_frame_parser/esp_private/panic_internal.h
components/esp_system/test_eh_frame_parser/linker.ld
components/esp_system/ubsan.c
components/esp_wifi/include/esp_mesh_internal.h
components/esp_wifi/include/esp_private/esp_wifi_types_private.h
components/esp_wifi/include/esp_private/wifi_types.h
components/esp_wifi/include/esp_smartconfig.h
Expand Down

0 comments on commit d89a512

Please sign in to comment.