1 Star 2 Fork 1

chencwc / esp-gateway

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ESP-Gateway 智能网关方案

本文档将介绍 ESP-Gateway 智能网关方案的配置流程和使用方法

目录

1.概述

乐鑫 ESP-Gateway 智能网关方案已经适配乐鑫多种芯片:

Chip ESP-IDF Release/v4.3 ESP-IDF Release/v4.4
ESP32 alt text alt text
ESP32-C3 alt text
ESP32-S2 alt text
ESP32-S3 alt text
ESP32-H2 TODO
ESP32-C2 TODO

ESP-Gateway 方案提供多个网络接口,不同的网络接口可以分为两大类:

  • 用来连接互联网的接口

  • 为其他设备提供数据转发上网功能的接口

用户可以通过多种不同的网络接口组合来实现个性化的智能网关方案,最大程度地发挥乐鑫芯片的网络优势。

esp_gateway

根据接口的不同组合可以实现多种功能,如下表:

无线热点 以太网接口 USB 接口 SPI 接口 SDIO 接口 BLE 接口 Thread 接口
无线 Wi-Fi Wi-Fi 路由器 无线网卡 无线网卡 无线网卡 无线网卡 BLE 网关 Thread Border Router
以太网 Wi-Fi 路由器 不支持 有线网卡 有线网卡 有线网卡 BLE 网关 Thread Border Router
Cat.1 4G(UART) 4G 热点 4G 网卡 4G 网卡 4G 网卡 4G 网卡 BLE 网关 Thread Border Router
Cat.1 4G(USB) 4G 热点 4G 网卡 不支持 4G 网卡 4G 网卡 BLE 网关 Thread Border Router

备注:

  • 第一列的无线 Wi-Fi、以太网、Cat.1 4G(UART)、Cat.1 4G(USB) 为连接到互联网的接口
  • 第一行的无线热点、以太网接口、USB 接口、SPI 接口、SDIO 接口、BLE 接口、Thread 接口为为其它设备提供上网功能的接入接口

根据上表,我们将网络数据转发功能概括为了以下几种应用场景:Wi-Fi 路由器、4G 热点、4G 网卡、无线网卡、有线网卡、BLE 网关和 Thread Border Router,不同芯片对其的支持情况如下表所示:

ESP 设备 Wi-Fi 路由器 4G 热点 4G 网卡 无线网卡 有线网卡 BLE 网关 Thread Border Router
ESP32 alt text alt text alt text(ETH/SDIO/SPI) alt text(ETH/SDIO/SPI) alt text(SDIO/SPI) TODO TODO
ESP32-C3 alt text alt text alt text(ETH/SPI) alt text(ETH/SPI) alt text(SPI) TODO TODO
ESP32-S2 alt text alt text alt text(ETH/SPI) alt text(USB/ETH/SPI) alt text(USB/SPI) TODO
ESP32-S3 alt text alt text alt text(ETH/SPI) alt text(USB/ETH/SPI) alt text(USB/SPI) TODO TODO
ESP32-H2 TODO TODO TODO TODO TODO TODO TODO

备注:

  • ESP32、ESP32-C3 没有 USB 接口,使用 USB 网卡 或 Cat.1 4G(USB) 功能请选择 ESP32-S2 或 ESP32-S3
  • 只有 ESP32 支持以太网接口,其它芯片需要外接 SPI 转以太网芯片,ESP32 MAC&PHY 配置可以参考 Configure MAC and PHY
  • 使用 Thread Border Router 时,需要搭配 802.15.4 芯片,如 ESP32-H2
  • 对于 ESP32 SDIO 接口,硬件上有管脚上拉需求,具体可以参考 SD Pull-up Requirements

1.1 Wi-Fi 路由器

ESP-Gateway 可通过无线连接路由器或者以太网网线插入路由器 LAN 口连接网络,同时开启热点,智能设备可以连接至该热点访问网关 IP(默认 192.168.4.1)来进行网页配网,配网成功后用户设备即可通过该 SoftAP 热点上网。

  • Gateway 当前支持轻量化的 Mesh 组网功能 —— LiteMesh,用户可以通过自定义方式,灵活实现网络组网、层级分布

  • menuconfig(Gateway Configuration->SoftAP Config)中启用 ESP_GATEWAY_SOFTAP_SSID_END_WITH_THE_MAC,可以在 SoftAP SSID 末尾增加 MAC 信息

  • 单个 Gateway 设备支持最多 10 个 Station 同时连接,多个 Station 设备共享带宽

wifi_router

1.2 4G 热点

ESP-Gateway 设备可搭载插有 SIM 卡的移动网络模块,将蜂窝网络转换为 Wi-Fi 信号,周围的智能设备连接其开启的热点后即可联网。

  • 已适配 4G Cat.1 模块
UART USB
A7670C ML302-DNLM/CNLM
EC600N-CN Air724UG-NFM
SIM76000 EC600N-CNLA-N05
EC600N-CNLC-N06
SIMCom A7600C1
4G_hotpot

1.3 4G 网卡

ESP-Gateway 设备可搭载插有 SIM 卡的移动网络模块,网络模块联网后,可通过多个网络接口(ETH/SDIO/SPI)接入 PC 或 MCU,为设备提供上网能力。

4G_dongle

⚠️Note

使用 4G 网卡方案请联系 sales@espressif.com 来获取源码或固件

1.4 无线网卡

ESP-Gateway 设备可通过多个网络接口(USB/ETH/SDIO/SPI)接入 PC 或 MCU,PC 或 MCU 等设备在连接成功后会新增一个网卡,可以通过访问网关 IP 来进行网页配网,为设备提供上网能力。

  • USB 线一端连接至 ESP32-S2/S3 的 GPIO19/20,一端连接至 MCU

    USB_DP USB_DM
    ESP32-S2/S3 GPIO20 GPIO19
  • 使用 SPI/SDIO 接口需要对 MCU(Host) 侧进行配置,具体依赖项设置引导,请参考 Linux_based_readme

  • SDIO 硬件连线和 MCU(Host) 配置,详情请参考 SDIO_setup

  • SPI 硬件连线和 MCU(Host) 配置,详情请参考 SPI_setup

wireless_dongle

⚠️Note

使用无线网卡方案请联系 sales@espressif.com 来获取源码或固件

1.5 有线网卡

ESP-Gateway 设备将以太网网线插入路由器 LAN 口连接网络,同时通过多个网络接口(SoftAP/USB/SDIO/SPI)接入 PC 或 MCU,为设备提供上网能力。

  • USB 线一端连接至 ESP32-S2/S3 的 GPIO19/20,一端连接至 MCU

    USB_DP USB_DM
    ESP32-S2/S3 GPIO20 GPIO19
  • 使用 SPI/SDIO 接口需要对 MCU(Host) 侧进行配置,具体依赖项设置引导,请参考 Linux_based_readme

  • SDIO 硬件连线和 MCU(Host) 配置,详情请参考 SDIO_setup

  • SPI 硬件连线和 MCU(Host) 配置,详情请参考 SPI_setup

dongle

⚠️Note:

使用有线网卡方案请联系 sales@espressif.com 来获取源码或固件

2.硬件准备

  • Linux 环境

用来执行编译 & 烧写 & 运行等操作的必须环境。

windows 用户可安装虚拟机,在虚拟机中安装 Linux。

  • ESP 设备

ESP 设备包括 ESP 芯片,ESP 模组,ESP 开发板等。

  • 针对以太网路由器以太网无线网卡功能:
    • ESP32 需要额外增加一个以太网 PHY 芯片
    • 其它 ESP 芯片需要 SPI 转以太网芯片
  • 随身 Wi-Fi 功能需要额外增加一个插有 SIM 卡的移动网络模块
  • USB 线

连接 PC 和 ESP 设备,用来烧写/下载程序,查看 log 等。

3.环境搭建

如果您熟悉 ESP 开发环境,可以很顺利理解下面步骤; 如果您不熟悉某个部分,比如编译,烧录,需要您结合官方的相关文档来理解。如您需阅读 ESP-IDF 编程指南文档等。

3.1 编译器环境搭建

3.2 烧录工具/下载工具获取

  • 烧录工具位于 esp-idf./components/esptool_py/esptool/esptool.py
  • esptool 功能参考:
$ ./components/esptool_py/esptool/esptool.py --help

4.SDK 准备

  • 获取 Espressif SDK ESP-IDF
  • 为确保成功获取了完整的 ESP-IDF,请在终端中输入 idf.py --version,如果输出结果类似于 ESP-IDF v4.4-dev-3675-g35b20cadce,则代表安装成功。详细的安装和配置说明请参考快速入门文档
  • 成功获取到 ESP-IDF 之后,请将 ESP-IDF 版本切换到 release/v4.4 分支。
  • 给 ESP-IDF 打上 Patch,详情请参考 Patch for ESP-IDF

5.配置项

连接外部网络的接口选择

external

提供网络数据转发给其他设备的接口选择

data_forwarding

  • 用户可选择不同的接口组合来实现相应的功能
  • 暂时不支持同时选择多个网络数据转发接口(该功能将会在以后版本中进行支持)
  • 开启 Set Vendor IE info 选项后可以使能 LiteMesh 功能,详情请参考 LiteMesh

ETH 配置项

eth

Modem 配置项

modem

6.编译 && 烧写 && 运行

6.1 编译

在 esp-gateway 目录下执行:

$ idf.py menuconfig

根据 5.配置项 选择合适的配置选项,配置完成之后执行以下命令生成 bin

$ idf.py build

6.2 擦除 & 编译烧写 & 下载固件 & 查看 log

将 USB 线连接好 ESP 设备和 PC,确保烧写端口正确。

6.2.1 烧录程序

$ idf.py flash

6.2.3 运行

$ idf.py monitor

也可执行组合命令 idf.py build flash monitor 来执行编译、烧录、查看监视器

6.3 网页配网

对于 Wi-Fi 路由器方案以及无线网卡方案,PC 或 MCU 连接热点成功并获取到 IP 地址后,可以访问网关 IP 来进行网页配网

web_server

7.方案优势

功能模式 优势
Wi-Fi 路由器(Station) 可作为 Wi-Fi 中继或 Wi-Fi 信号放大器、有效减轻实际路由器的承载力,同时扩大无线覆盖范围
Wi-Fi 路由器(ETH) 可以减少实际使用的路由器数量、部署成本低
4G 热点 无需配网、移动性强、应用于共享场景中(共享按摩椅、共享充电宝),仅需一台共享设备搭载移动网络模块,其他设备连接其热点即可联网,大大节约成本
无线网卡(ETH) 免驱动、支持用户在任意位置部署需要通过网线联网的 MCU
无线网卡(USB) 免驱动、可热插拔、使用简便,开发成本低
无线网卡(SPI/SDIO) 传输速率高

部分功能演示视频请参考 ESP-Gateway 视频演示

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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.

简介

暂无描述 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/chencwc/esp-gateway.git
git@gitee.com:chencwc/esp-gateway.git
chencwc
esp-gateway
esp-gateway
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891