Skip to content

Commit ee74f27

Browse files
jack0cjack0c
committed
Merge branch 'feat/support_longer_data_len_in_espnow' into 'master'
feat(wifi/espnow): Support longer data length in espnow Closes IDFGH-7935 See merge request espressif/esp-idf!31097
2 parents dde0b46 + b4d1027 commit ee74f27

File tree

4 files changed

+66
-24
lines changed

4 files changed

+66
-24
lines changed

‎components/esp_wifi/include/esp_now.h‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2019-2023 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -49,7 +49,9 @@ extern "C" {
4949
#define ESP_NOW_MAX_TOTAL_PEER_NUM 20 /*!< Maximum number of ESPNOW total peers */
5050
#define ESP_NOW_MAX_ENCRYPT_PEER_NUM 6 /*!< Maximum number of ESPNOW encrypted peers */
5151

52-
#define ESP_NOW_MAX_DATA_LEN 250 /*!< Maximum length of ESPNOW data which is sent very time */
52+
#define ESP_NOW_MAX_IE_DATA_LEN 250 /**< Maximum data length in a vendor-specific element */
53+
#define ESP_NOW_MAX_DATA_LEN ESP_NOW_MAX_IE_DATA_LEN /**< Maximum length of data sent in each ESPNOW transmission for v1.0 */
54+
#define ESP_NOW_MAX_DATA_LEN_V2 1490 /**< Maximum length of data sent in each ESPNOW transmission for v2.0 */
5355

5456
/**
5557
* @brief Status of sending ESPNOW data .
@@ -135,7 +137,12 @@ esp_err_t esp_now_init(void);
135137
esp_err_t esp_now_deinit(void);
136138

137139
/**
138-
* @brief Get the version of ESPNOW
140+
* @brief Get the version of ESPNOW. Currently, ESPNOW supports two versions: v1.0 and v2.0.
141+
*
142+
* The v2.0 devices are capable of receiving packets from both v2.0 and v1.0 devices. In contrast, v1.0 devices can only receive packets from other v1.0 devices.
143+
* However, v1.0 devices can receive v2.0 packets if the packet length is less than or equal to ESP_NOW_MAX_IE_DATA_LEN.
144+
* For packets exceeding this length, the v1.0 devices will either truncate the data to the first ESP_NOW_MAX_IE_DATA_LEN bytes or discard the packet entirely.
145+
* For detailed behavior, please refer to the documentation corresponding to the specific IDF version.
139146
*
140147
* @param version ESPNOW version
141148
*

‎components/esp_wifi/lib‎

Submodule lib updated 62 files

‎docs/en/api-reference/network/esp_now.rst‎

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,15 @@ CTR with CBC-MAC Protocol (CCMP) is used to protect the action frame for securit
1313
Frame Format
1414
------------
1515

16-
ESP-NOW uses a vendor-specific action frame to transmit ESP-NOW data. The default ESP-NOW bit rate is 1 Mbps. The format of the vendor-specific action frame is as follows:
16+
ESP-NOW uses a vendor-specific action frame to transmit ESP-NOW data. The default ESP-NOW bit rate is 1 Mbps.
17+
18+
Currently, ESP-NOW supports two versions: v1.0 and v2.0. The maximum packet length supported by v2.0 devices is ESP_NOW_MAX_DATA_LEN_V2 bytes, while the maximum packet length supported by v1.0 devices is ESP_NOW_MAX_DATA_LEN bytes.
19+
The v2.0 devices are capable of receiving packets from both v2.0 and v1.0 devices. In contrast, v1.0 devices can only receive packets from other v1.0 devices.
20+
However, v1.0 devices can receive v2.0 packets if the packet length is less than or equal to ESP_NOW_MAX_IE_DATA_LEN.
21+
For packets exceeding this length, the v1.0 devices will either truncate the data to the first ESP_NOW_MAX_IE_DATA_LEN bytes or discard the packet entirely.
22+
For detailed behavior, please refer to the documentation corresponding to the specific IDF version.
23+
24+
The format of the vendor-specific action frame is as follows:
1725

1826
.. highlight:: none
1927

@@ -22,28 +30,39 @@ ESP-NOW uses a vendor-specific action frame to transmit ESP-NOW data. The defaul
2230
------------------------------------------------------------------------------------------------------------
2331
| MAC Header | Category Code | Organization Identifier | Random Values | Vendor Specific Content | FCS |
2432
------------------------------------------------------------------------------------------------------------
25-
24 bytes 1 byte 3 bytes 4 bytes 7-257 bytes 4 bytes
33+
24 bytes 1 byte 3 bytes 4 bytes 7-x bytes 4 bytes
2634

2735
- Category Code: The Category Code field is set to the value (127) indicating the vendor-specific category.
2836
- Organization Identifier: The Organization Identifier contains a unique identifier (0x18fe34), which is the first three bytes of MAC address applied by Espressif.
2937
- Random Value: The Random Value filed is used to prevents relay attacks.
30-
- Vendor Specific Content: The Vendor Specific Content contains vendor-specific fields as follows:
38+
- Vendor Specific Content: The Vendor Specific Content contains several (at least one) vendor-specific element fields. For version v2.0, x = 1532(1490 + 6*7), for version v1.0, x = 257(250 + 7).
39+
40+
The format of the vendor-specific element frame is as follows:
3141

3242
.. highlight:: none
3343

3444
::
3545

36-
-------------------------------------------------------------------------------
37-
| Element ID | Length | Organization Identifier | Type | Version | Body |
38-
-------------------------------------------------------------------------------
39-
1 byte 1 byte 3 bytes 1 byte 1 byte 0-250 bytes
46+
ESP-NOW v1.0:
47+
------------------------------------------------------------------------------------------
48+
| Element ID | Length | Organization Identifier | Type | Reserved | Version | Body |
49+
------------------------------------------------------------------------------------------
50+
7~4 bits | 3~0 bits
51+
1 byte 1 byte 3 bytes 1 byte 1 byte 0-250 bytes
52+
53+
ESP-NOW v2.0:
54+
-----------------------------------------------------------------------------------------------------
55+
| Element ID | Length | Organization Identifier | Type | Reserved | More data |Version | Body |
56+
-----------------------------------------------------------------------------------------------------
57+
7~5 bits | 1 bit |3~0 bits
58+
1 byte 1 byte 3 bytes 1 byte 1 byte 0-250 bytes
4059

4160
- Element ID: The Element ID field is set to the value (221), indicating the vendor-specific element.
42-
- Length: The length is the total length of Organization Identifier, Type, Version and Body.
61+
- Length: The length is the total length of Organization Identifier, Type, Version and Body, the maximum value is 255.
4362
- Organization Identifier: The Organization Identifier contains a unique identifier (0x18fe34), which is the first three bytes of MAC address applied by Espressif.
4463
- Type: The Type field is set to the value (4) indicating ESP-NOW.
4564
- Version: The Version field is set to the version of ESP-NOW.
46-
- Body: The Body contains the ESP-NOW data.
65+
- Body: The Body contains the actual ESP-NOW data to be transmitted.
4766

4867
As ESP-NOW is connectionless, the MAC header is a little different from that of standard frames. The FromDS and ToDS bits of FrameControl field are both 0. The first address field is set to the destination address. The second address field is set to the source address. The third address field is set to broadcast address (0xff:0xff:0xff:0xff:0xff:0xff).
4968

‎docs/zh_CN/api-reference/network/esp_now.rst‎

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,53 @@ CTR 与 CBC-MAC 协议 (CCMP) 可用来保护动作帧的安全。ESP-NOW 广泛
1313
帧格式
1414
------------
1515

16-
ESP-NOW 使用各个供应商的动作帧传输数据，默认比特率为 1 Mbps。各个供应商的动作帧格式为：
16+
ESP-NOW 使用供应商的动作帧传输数据，默认比特率为 1 Mbps。目前 ESP-NOW 支持两个版本： v1.0 和 v2.0。
17+
18+
v2.0 的设备支持的最大数据包长度为 ESP_NOW_MAX_DATA_LEN_V2 bytes； v1.0 的设备支持的最大数据包长度为 ESP_NOW_MAX_DATA_LEN bytes。
19+
v2.0 设备可以接收来自 v2.0 和 v1.0 设备的数据包。v1.0 设备能接收来自 v1.0 的数据包。v1.0 设备可以接收长度不超过 ESP_NOW_MAX_IE_DATA_LEN 的 v2.0 数据包，而对于长度超过 ESP_NOW_MAX_IE_DATA_LEN 的数据包，它要么只接收前 ESP_NOW_MAX_IE_DATA_LEN 字节，要么丢弃数据包。具体行为请参考对应 IDF 版本中的文档。
20+
21+
供应商的动作帧格式为：
1722

1823
.. highlight:: none
1924

2025
::
2126

22-
-----------------------------------------------------------------------------------------
27+
-----------------------------------------------------------------------------
2328
| MAC 报头 | 分类代码 | 组织标识符 | 随机值 | 供应商特定内容 | FCS |
24-
-----------------------------------------------------------------------------------------
25-
24 字节 1 字节 3 字节 4 字节 7-257 字节 4 字节
29+
-----------------------------------------------------------------------------
30+
24 字节 1 字节 3 字节 4 字节 7-x 字节 4 字节
2631

2732
- 分类代码：分类代码字段可用于指示各个供应商的类别（比如 127）。
2833
- 组织标识符：组织标识符包含一个唯一标识符（比如 0x18fe34），为乐鑫指定的 MAC 地址的前三个字节。
2934
- 随机值：防止重放攻击。
30-
- 供应商特定内容：供应商特定内容包含供应商特定字段，如下所示：
35+
- 供应商特定内容：供应商特定内容包含若干个（大于等于1）特定供应商元素字段，对于 v2.0 版本，x = 1532(1490+6*7)；对于 v1.0 版本，x = 257(250+7)。
36+
37+
特定供应商元素的帧格式为：
3138

3239
.. highlight:: none
3340

3441
::
3542

36-
----------------------------------------------------------------------------------------
37-
| 元素 ID | 长度 | 组织标识符 | 类型 | 版本 | 正文 |
38-
----------------------------------------------------------------------------------------
39-
1 字节 1 字节 3 字节 1 字节 1 字节 0-250 字节
43+
ESP-NOW v1.0：
44+
---------------------------------------------------------------------------
45+
| 元素 ID | 长度 | 组织标识符 | 类型 | 保留 | 版本 | 正文 |
46+
---------------------------------------------------------------------------
47+
7~4 比特| 3~0 比特
48+
1 字节 1 字节 3 字节 1 字节 1 字节 0-250 字节
49+
50+
ESP-NOW v2.0：
51+
-------------------------------------------------------------------------------------
52+
| 元素 ID | 长度 | 组织标识符 | 类型 | 保留 |更多数据 | 版本 | 正文 |
53+
-------------------------------------------------------------------------------------
54+
7~5 比特 | 1 比特 | 3~0 比特
55+
1 字节 1 字节 3 字节 1 字节 1 字节 0-250 字节
4056

4157
- 元素 ID：元素 ID 字段可用于指示特定于供应商的元素。
42-
- 长度：长度是组织标识符、类型、版本和正文的总长度。
58+
- 长度：长度是组织标识符、类型、版本和正文的总长度，最大值为 255。
4359
- 组织标识符：组织标识符包含一个唯一标识符（比如 0x18fe34），为乐鑫指定的 MAC 地址的前三个字节。
4460
- 类型：类型字段设置为 4，代表 ESP-NOW。
4561
- 版本：版本字段设置为 ESP-NOW 的版本。
46-
- 正文：正文包含 ESP-NOW 数据。
62+
- 正文：正文包含实际要发送的 ESP-NOW 数据。
4763

4864
由于 ESP-NOW 是无连接的，因此 MAC 报头与标准帧略有不同。FrameControl 字段的 FromDS 和 ToDS 位均为 0。第一个地址字段用于配置目标地址。第二个地址字段用于配置源地址。第三个地址字段用于配置广播地址 (0xff:0xff:0xff:0xff:0xff:0xff)。
4965

0 commit comments

Comments
 (0)