From e6de764ca19d03025022a73adf83be3862f94446 Mon Sep 17 00:00:00 2001 From: Shang Zhou Date: Mon, 8 May 2023 17:46:58 +0800 Subject: [PATCH] docs: update links in mdns.rst_backport_v5.1 --- docs/en/api-reference/protocols/mdns.rst | 2 +- docs/zh_CN/api-reference/protocols/mdns.rst | 2 + .../libs-frameworks.rst | 108 +++++++++++++++++- 3 files changed, 110 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/protocols/mdns.rst b/docs/en/api-reference/protocols/mdns.rst index 9010bbe642..c4630069fc 100644 --- a/docs/en/api-reference/protocols/mdns.rst +++ b/docs/en/api-reference/protocols/mdns.rst @@ -8,7 +8,7 @@ The ESP-IDF component `mDNS` has been moved from ESP-IDF since version v5.0 to a * `mDNS component on GitHub `__ -To add mDNS component in your project, please run `idf.py add-dependency espressif/mdns` +To add mDNS component in your project, please run `idf.py add-dependency espressif/mdns`. Hosted Documentation -------------------- diff --git a/docs/zh_CN/api-reference/protocols/mdns.rst b/docs/zh_CN/api-reference/protocols/mdns.rst index dc54178aee..c3027b7f99 100644 --- a/docs/zh_CN/api-reference/protocols/mdns.rst +++ b/docs/zh_CN/api-reference/protocols/mdns.rst @@ -8,6 +8,8 @@ mDNS 是一种组播 UDP 服务，用来提供本地网络服务和主机发现 * GitHub 上 `mDNS 组件 `__ +运行 `idf.py add-dependency espressif/mdns`，在项目中添加 mDNS 组件。 + 托管的文档 -------------------- diff --git a/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst b/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst index aed78f596e..9d8d918ab0 100644 --- a/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst +++ b/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst @@ -1 +1,107 @@ -.. include:: ../../en/libraries-and-frameworks/libs-frameworks.rst +其他库和开发框架 +============================= +:link_to_translation:`en:[English]` + +本文展示了一系列乐鑫官方发布的库和框架。 + +ESP-ADF +------------------------------------- + +ESP-ADF 是一个全方位的音频应用程序框架，该框架支持： + +* CODEC 的 HAL +* 音乐播放器和录音机 +* 音频处理 +* 蓝牙扬声器 +* 互联网收音机 +* 免提设备 +* 语音识别 + +该框架对应的 GitHub 仓库为 `ESP-ADF `_。 + +ESP-CSI +------------------------------------ + +ESP-CSI 是一个具有实验性的框架，它利用 Wi-Fi 信道状态信息来检测人体存在。 + +该框架对应的 GitHub 仓库为 `ESP-CSI `_。 + +ESP-DSP +------------------------------------ + +ESP-DSP 提供了针对数字信号处理应用优化的算法，该库支持： + +* 矩阵乘法 +* 点积 +* 快速傅立叶变换 (FFT) +* 无线脉冲响应 (IIR) +* 有限脉冲响应 (FIR) +* 向量数学运算 + +该库对应的 GitHub 仓库为 `ESP-DSP 库 `_。 + +ESP-WIFI-MESH +------------------------------------------------------ + +ESP-WIFI-MESH 基于 ESP-WIFI-MESH 协议搭建，该框架支持： + +* 快速网络配置 +* 稳定升级 +* 高效调试 +* LAN 控制 +* 多种应用示例 + +该框架对应的 GitHub 仓库为 `ESP-MDF `_。 + +ESP-WHO +------------------------------ + +ESP-WHO 框架利用 ESP32 及摄像头实现人脸检测及识别。 + +该框架对应的 GitHub 仓库为 `ESP-WHO `_。 + +ESP RainMaker +--------------------------------------------- + +`ESP RainMaker `_ 提供了一个快速 AIoT 开发的完整解决方案。使用 ESP RainMaker，用户可以创建多种 AIoT 设备，包括固件 AIoT 以及集成了语音助手、手机应用程序和云后端的 AIoT 等。 + +该解决方案对应的 GitHub 仓库为 `GitHub 上的 ESP RainMaker `_。 + +ESP-IoT-Solution +-------------------------------------------------- + +`ESP-IoT-Solution `_ 涵盖了开发 IoT 系统时常用的设备驱动程序及代码框架。在 ESP-IoT-Solution 中，设备驱动程序和代码框架以独立组件存在，可以轻松地集成到 ESP-IDF 项目中。 + +ESP-IoT-Solution 支持： + +* 传感器、显示器、音频、GUI、输入、执行器等设备驱动程序 +* 低功耗、安全、存储等框架和文档 +* 从实际应用角度指导乐鑫开源解决方案 + +该解决方案对应的 GitHub 仓库为 `GitHub 上的 ESP-IoT-Solution `_。 + + +ESP-Protocols +----------------------------------------- + +`ESP-Protocols `_ 库包含 ESP-IDF 的协议组件集。ESP-Protocols 中的代码以独立组件存在，可以轻松地集成到 ESP-IDF 项目中。此外，每个组件都可以在 `ESP-IDF 组件注册表 `_ 中找到。 + +ESP-Protocols 组件： + +* `esp_modem `_ 使用 AT 命令或 PPP 协议与 GSM/LTE 调制解调器连接，详情请参阅 `esp_modem 文档 `_。 + +* `mdns `_ (mDNS) 是一种组播 UDP 服务，用于提供本地网络服务与主机发现，详情请参阅 `mdns 文档 `_。 + +* `esp_websocket_client `_ 是 ESP-IDF 的托管组件，可在 ESP32 上实现 WebSocket 协议客户端，详情请参阅 `esp_websocket_client 文档 `_。有关 WebSocket 协议客户端，请参阅 `WebSocket_protocol_client `_。 + +* `asio `_ 是一个跨平台的 C++ 库，请参阅 ``_。该库基于现代 C++ 提供一致的异步模型，请参阅 `asio 文档 `_。 + +ESP-BSP +---------------------------------------- + +`ESP-BSP `_ 库包含了各种乐鑫和第三方开发板的板级支持包 (BSP)，可以帮助快速上手特定的开发板。它们通常包含管脚定义和辅助函数，这些函数可用于初始化特定开发板的外设。此外，BSP 还提供了一些驱动程序，可用于开发版上的外部芯片，如传感器、显示屏、音频编解码器等。 + +ESP-IDF-CXX +---------------------------------------------------------- + +`ESP-IDF-CXX `_ 包含了 ESP-IDF 的部分 C++ 封装，重点在实现易用性、安全性、自动资源管理，以及将错误检查转移到编译过程中，以避免运行时失败。它还提供了 ESP 定时器、I2C、SPI、GPIO 等外设或 ESP-IDF 其他功能的 C++ 类。ESP-IDF-CXX 作为组件可以从 `组件注册表 `_ 中获取。详情请参阅 `README.md `_。