Skip to content

Commit d61b2a1

Browse files
committed
Merge branch 'doc/change_url_to_v1.0' into 'release/v1.0'
doc: Change the URLs in the documents to release/v1.0 See merge request ae_group/esp-mesh-lite!198
2 parents 4c8119e + c143fdf commit d61b2a1

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
ESP-MESH-LITE is a Wi-Fi networking application of [IoT-Bridge](https://github.com/espressif/esp-iot-bridge), based on the **SoftAP + Station** mode, a set of Mesh solutions built on top of the Wi-Fi protocol. ESP-MESH-LITE allows numerous devices (henceforth referred to as nodes) spread over a large physical area (both indoors and outdoors) to be interconnected under a single WLAN (Wireless Local-Area Network). The biggest difference between ESP-MESH-LITE and [ESP-MESH](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/esp-wifi-mesh.html) (also known as ESP-WIFI-MESH) is that ESP-MESH-LITE allows sub-devices in the network to independently access the external network, and the transmission information is insensitive to the parent node, which greatly reduces the difficulty to develop the application layer. ESP-MESH-LITE is self-organizing and self-healing, which means the network can be built and maintained autonomously.
88

9-
For more information about ESP-MESH-LITE, please refer to [ESP-MESH-LITE Guide](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/User_Guide.md).
9+
For more information about ESP-MESH-LITE, please refer to [ESP-MESH-LITE Guide](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/User_Guide.md).
1010

11-
In the [examples](https://github.com/espressif/esp-mesh-lite/blob/master/examples) directory, demos of some common application scenarios are implemented for users to quickly integrate into their own application projects.
11+
In the [examples](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/examples) directory, demos of some common application scenarios are implemented for users to quickly integrate into their own application projects.
1212

1313
- [examples/mesh_local_control](examples/mesh_local_control): This example only simply demonstrates device networking and TCP communication, and does not include complex network applications. Users can carry out secondary development based on this example.
1414
- [examples/rainmaker/led_light](examples/rainmaker/led_light): This example integrates the Mesh functionality into the Rainmaker application. Users can configure the device through the `Nova Home` APP and successfully connect to the Rainmaker cloud. The device is connected to the cloud based on Rainmaker. It can also provide other devices with the ability to surf the Internet wirelessly, and form a network with the Mesh-Lite function, which greatly reduces the load on the router and expands the wireless communication range.

README_CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
ESP-MESH-LITE 是以 [IoT-Bridge](https://github.com/espressif/esp-iot-bridge) 为模型,基于 **SoftAP + Station** 模式,建立在 Wi-Fi 协议之上的一套 Mesh 方案。ESP-MESH-LITE 允许分布在大范围区域内(室内和室外)的大量设备(下文称节点)在同一个 WLAN(无线局域网)中相互连接。ESP-MESH-LITE 与 [ESP-MESH](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/esp-wifi-mesh.html)(又称 ESP-WIFI-MESH)最大的不同是 ESP-MESH-LITE 允许组网内的子设备独立访问外部网络,传输信息对于父节点无感,大大降低了应用层开发难度,ESP-MESH-LITE 具有自组网和自修复的特性,也就是说 Mesh 网络可以自主地构建和维护。
88

9-
更多有关 ESP-MESH-LITE 的信息请参考 [ESP-MESH-LITE Guide](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/User_Guide_CN.md)
9+
更多有关 ESP-MESH-LITE 的信息请参考 [ESP-MESH-LITE Guide](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/User_Guide_CN.md)
1010

11-
[examples](https://github.com/espressif/esp-mesh-lite/blob/master/examples) 目录下,实现了一些常见应用场景的 demo,可供用户快速集成到自己的应用项目中。
11+
[examples](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/examples) 目录下,实现了一些常见应用场景的 demo,可供用户快速集成到自己的应用项目中。
1212

1313
- [examples/mesh_local_control](examples/mesh_local_control):本示例仅简单演示设备组网,以及 TCP 通信,不包含复杂的网络应用,用户可基于此示例进行二次开发。
1414
- [examples/rainmaker/led_light](examples/rainmaker/led_light):本示例将 Mesh 功能集成到 Rainmaker 应用中,用户可通过 `Nova Home` APP 来为设备配网并使设备成功连接至 Rainmaker 云端,设备本身基于 Rainmaker 实现自身连接云端的同时,还可以为其他无线设备提供无线上网的能力,搭配 Mesh-Lite 功能形成组网,极大程度上减轻路由器承载压力,同时扩大了无线通信范围。

components/mesh_lite/User_Guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- [中文版本](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/User_Guide_CN.md)
1+
- [中文版本](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/User_Guide_CN.md)
22

33
# ESP Wi-Fi Mesh Lite
44

@@ -138,7 +138,7 @@ If more than one candidate parent node exists on the same layer, the one with th
138138

139139
**Notes**
140140

141-
> Users can also define which layers are fixed or disabled for the selected nodes through `esp_mesh_lite_set_allowed_level` and `esp_mesh_lite_set_disallowed_level` (see [Mesh-Lite API Reference](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/include/esp_mesh_lite_core.h)).
141+
> Users can also define which layers are fixed or disabled for the selected nodes through `esp_mesh_lite_set_allowed_level` and `esp_mesh_lite_set_disallowed_level` (see [Mesh-Lite API Reference](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/include/esp_mesh_lite_core.h)).
142142
143143

144144
## Establish Network
@@ -147,7 +147,7 @@ If more than one candidate parent node exists on the same layer, the one with th
147147

148148
Warning
149149

150-
Before ESP-MESH-LITE officially starts building the network, please ensure that all nodes in the network share the same configuration (see [`esp_mesh_lite_config_t`](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/include/esp_mesh_lite_core.h)). Each node must be configured with **the same MESH_LITE network ID, maximum number of layers, and SoftAP**.
150+
Before ESP-MESH-LITE officially starts building the network, please ensure that all nodes in the network share the same configuration (see [`esp_mesh_lite_config_t`](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/include/esp_mesh_lite_core.h)). Each node must be configured with **the same MESH_LITE network ID, maximum number of layers, and SoftAP**.
151151

152152
The ESP-MESH-LITE network will first select the root node and then establish downstream connections layer by layer until all nodes have joined the network. The layout of the network may depend on factors such as root node selection, parent node selection, and asynchronous power-up reset. But in short, the process of building an ESP-MESH-LITE network can be summarized in the following steps:
153153

@@ -479,7 +479,7 @@ static void event_handler(void* arg, esp_event_base_t event_base,
479479
480480
**Notes**
481481
482-
> For specific provisioning code modification, please refer to [Wi-Fi Provisioning](https://github.com/espressif/esp-mesh-lite/blob/master/examples/rainmaker/led_light/components/app_wifi/app_wifi.c).
482+
> For specific provisioning code modification, please refer to [Wi-Fi Provisioning](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/examples/rainmaker/led_light/components/app_wifi/app_wifi.c).
483483
>
484484
> Except for the provisioning connection part, the rest of the network applications (Socket, MQTT, HTTP, etc.) do not need to be modified.
485485
@@ -488,6 +488,6 @@ static void event_handler(void* arg, esp_event_base_t event_base,
488488
## Further Notes
489489
490490
- Data transmission is encrypted using Wi-Fi WPA2-PSK (password required for SoftAP)
491-
- Communication between nodes within a Mesh network can be encrypted with AES128 using `esp_mesh_lite_aes_set_key` (see [Mesh-Lite API Reference](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/include/esp_mesh_lite_core.h))
491+
- Communication between nodes within a Mesh network can be encrypted with AES128 using `esp_mesh_lite_aes_set_key` (see [Mesh-Lite API Reference](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/include/esp_mesh_lite_core.h))
492492
493493
The router and Internet icons used in the images in this document are from [Smashicons](https://smashicons.com/) of [www.flaticon.com](https://smashicons.com/).

components/mesh_lite/User_Guide_CN.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- [English Version](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/User_Guide.md)
1+
- [English Version](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/User_Guide.md)
22

33
# ESP-MESH-LITE
44

@@ -138,7 +138,7 @@ ESP-MESH-LITE 中能够形成下行连接的每个节点(即具有 SoftAP 接
138138

139139
**备注**
140140

141-
> 用户还可以通过 `esp_mesh_lite_set_allowed_level``esp_mesh_lite_set_disallowed_level` 自行定义选择节点固定哪个层级或者禁用哪个层级(见 [Mesh-Lite API 详解](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/include/esp_mesh_lite_core.h))。
141+
> 用户还可以通过 `esp_mesh_lite_set_allowed_level``esp_mesh_lite_set_disallowed_level` 自行定义选择节点固定哪个层级或者禁用哪个层级(见 [Mesh-Lite API 详解](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/include/esp_mesh_lite_core.h))。
142142
143143

144144
## 建立网络
@@ -147,7 +147,7 @@ ESP-MESH-LITE 中能够形成下行连接的每个节点(即具有 SoftAP 接
147147

148148
警告
149149

150-
ESP-MESH-LITE 正式开始构建网络前,必须确保网络中所有节点具有相同的配置(见 [`esp_mesh_lite_config_t`](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/include/esp_mesh_lite_core.h))。每个节点必须配置 **相同 MESH_LITE 网络 ID、最大层级数量和 SoftAP 配置**
150+
ESP-MESH-LITE 正式开始构建网络前,必须确保网络中所有节点具有相同的配置(见 [`esp_mesh_lite_config_t`](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/include/esp_mesh_lite_core.h))。每个节点必须配置 **相同 MESH_LITE 网络 ID、最大层级数量和 SoftAP 配置**
151151

152152
ESP-MESH-LITE 网络将首先选择根节点,然后逐层形成下行连接,直到所有节点均加入网络。网络的布局可能取决于诸如根节点选择、父节点选择和异步上电复位等因素。但简单来说,一个 ESP-MESH-LITE 网络的构建过程可以概括为以下步骤:
153153

@@ -482,7 +482,7 @@ static void event_handler(void* arg, esp_event_base_t event_base,
482482
483483
**备注**
484484
485-
> 具体配网代码修改请参考 [Wi-Fi Provisioning](https://github.com/espressif/esp-mesh-lite/blob/master/examples/rainmaker/led_light/components/app_wifi/app_wifi.c)
485+
> 具体配网代码修改请参考 [Wi-Fi Provisioning](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/examples/rainmaker/led_light/components/app_wifi/app_wifi.c)
486486
>
487487
> 除了配网连接部分的修改,其余的网络应用(Socket、MQTT、HTTP 等)均不需要修改
488488
@@ -491,6 +491,6 @@ static void event_handler(void* arg, esp_event_base_t event_base,
491491
## 更多注意事项
492492
493493
- 数据传输使用 Wi-Fi WPA2-PSK 加密(SoftAP 需设置密码)
494-
- Mesh 网络内部节点间通信可以通过 `esp_mesh_lite_aes_set_key` 选择使用 AES128 加密(见 [Mesh-Lite API 详解](https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/include/esp_mesh_lite_core.h))
494+
- Mesh 网络内部节点间通信可以通过 `esp_mesh_lite_aes_set_key` 选择使用 AES128 加密(见 [Mesh-Lite API 详解](https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/include/esp_mesh_lite_core.h))
495495
496496
本文图片中使用的路由器与互联网图标来自 [www.flaticon.com](https://smashicons.com/) 的 [Smashicons](https://smashicons.com/)。

components/mesh_lite/idf_component.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "1.0.2"
22
description: A lite version Wi-Fi Mesh, each node can access the network over the IP layer.
33
url: https://github.com/espressif/esp-mesh-lite/tree/master/components/mesh_lite
44
repository: https://github.com/espressif/esp-mesh-lite.git
5-
documentation: https://github.com/espressif/esp-mesh-lite/blob/master/components/mesh_lite/User_Guide.md
5+
documentation: https://github.com/espressif/esp-mesh-lite/blob/release/v1.0/components/mesh_lite/User_Guide.md
66
issues: https://github.com/espressif/esp-mesh-lite/issues
77
dependencies:
88
idf: ">=5.0"

0 commit comments

Comments
 (0)