alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Docs/add Chinese translation for api-reference/bluetooth/esp_gap_ble.rst, api-reference/protocols/modbus.rst, and libraries-and-frameworks/libs-frameworks.rst from scratch

Browse Source
This commit is contained in:
Cai Xin Ying 2023-05-04 17:25:41 +08:00
parent 88358282d0
commit 9c4dc67870
6 changed files with 199 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/api-reference/bluetooth/esp_gap_ble.rst
View File

@ -1,17 +1,18 @@
GAP API
=======
:link_to_translation:`zh_CN:[中文]`
Application Example
-------------------
Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials:
Check the :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials:
* This is a SMP security client demo and its tutorial. This demo initiates its security parameters and acts as a GATT client, which can send a security request to the peer device and then complete the encryption procedure.
* The following shows an SMP security client demo with its tutorial. This demo initiates its security parameters and acts as a GATT client, which can send a security request to the peer device and then complete the encryption procedure.
- :example:`bluetooth/bluedroid/ble/gatt_security_client`
- :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* This is a SMP security server demo and its tutorial. This demo initiates its security parameters and acts as a GATT server, which can send a pair request to the peer device and then complete the encryption procedure.
* The following shows an SMP security server demo with its tutorial. This demo initiates its security parameters and acts as a GATT server, which can send a pair request to the peer device and then complete the encryption procedure.
- :example:`bluetooth/bluedroid/ble/gatt_security_server`
- :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`

13
docs/en/api-reference/protocols/modbus.rst
View File

@ -1,33 +1,34 @@
ESP-Modbus
==========
:link_to_translation:`zh_CN:[中文]`
The Espressif ESP-Modbus Library (esp-modbus) supports Modbus communication in the networks based on RS485, Wi-Fi, Ethernet interfaces.
The ESP-IDF component `freemodbus` has been moved from ESP-IDF since version v5.0 to a separate repository:
The Espressif ESP-Modbus Library (esp-modbus) supports Modbus communication in the networks based on RS485, Wi-Fi, and Ethernet interfaces.
Since ESP-IDF version v5.0, the component ``freemodbus`` has been moved from ESP-IDF to a separate repository:
* `ESP-Modbus component on GitHub <https://github.com/espressif/esp-modbus>`__
Hosted Documentation
--------------------
The documentation can be found on the link below:
The documentation can be found through the link below:
* `ESP-Modbus documentation (English) <https://docs.espressif.com/projects/esp-modbus>`__
Application Example
-------------------
The examples below demonstrate the ESP-Modbus library of serial, TCP ports for slave and master implementations accordingly.
The examples below demonstrate the ESP-Modbus library of serial and TCP ports for both slave and master implementations respectively.
- :example:`protocols/modbus/serial/mb_slave`
- :example:`protocols/modbus/serial/mb_master`
- :example:`protocols/modbus/tcp/mb_tcp_slave`
- :example:`protocols/modbus/tcp/mb_tcp_master`
Please refer to the specific example README.md for details.
Please refer to the ``README.md`` documents of each specific example for details.
Protocol References
-------------------
- ``https://modbus.org/specs.php``: Modbus Organization with protocol specifications.
- - For the detailed protocol specifications, see `The Modbus Organization <https://modbus.org/specs.php>`_.

46
docs/en/libraries-and-frameworks/libs-frameworks.rst
View File

@ -1,5 +1,6 @@
Espressif's Frameworks
======================
:link_to_translation:`zh_CN:[中文]`
Here you will find a collection of the official Espressif libraries and frameworks.
@ -9,27 +10,26 @@ Espressif Audio Development Framework
The ESP-ADF is a comprehensive framework for audio applications including:
* CODEC's HAL
* Music Players and Recorders
* Audio Processing
* Bluetooth Speakers
* Internet Radios
* Music players and recorders
* Audio processing
* Bluetooth speakers
* Internet radios
* Hands-free devices
* Speech Recognition
* Speech decognition
This framework is available at GitHub: `ESP-ADF <https://github.com/espressif/esp-adf>`_.
This framework is available on GitHub: `ESP-ADF <https://github.com/espressif/esp-adf>`_.
ESP-CSI
-------
ESP-CSI is an experimental implementation that uses the Wi-Fi Channel State Information to detect the presence of a human body.
See `ESP-CSI <https://github.com/espressif/esp-csi>`_ project for more information about it.
See the `ESP-CSI <https://github.com/espressif/esp-csi>`_ project for more information.
Espressif DSP Library
---------------------
The library provides algorithms optimized specifically for digital signal processing applications.
This library supports:
The library provides algorithms optimized specifically for digital signal processing applications. This library supports:
* Matrix multiplication
* Dot product
@ -38,7 +38,7 @@ This library supports:
* FIR (Finite Impulse Response)
* Vector math operations
This library is available here: `ESP-DSP library <https://github.com/espressif/esp-dsp>`_.
This library is available on Github: `ESP-DSP library <https://github.com/espressif/esp-dsp>`_.
ESP-WIFI-MESH Development Framework
-----------------------------------
@ -51,21 +51,21 @@ This framework is based on the ESP-WIFI-MESH protocol with the following feature
* LAN control
* Various application demos
`ESP-MDF <https://github.com/espressif/esp-mdf>`_.
This framework is available on Github: `ESP-MDF <https://github.com/espressif/esp-mdf>`_.
ESP-WHO
-------
The ESP-WHO is a face detection and recognition framework using the ESP32 and camera.
To know more about the project, see `ESP-WHO <https://github.com/espressif/esp-who>`_ on GitHub.
This framework is available on Github: `ESP-WHO <https://github.com/espressif/esp-who>`_.
ESP RainMaker
-------------
`ESP RainMaker <https://rainmaker.espressif.com/>`_ is a complete solution for accelerated AIoT development.
Using ESP RainMaker, you can create AIoT devices from the firmware to the integration with voice-assistant, phone apps and cloud backend.
`ESP RainMaker <https://rainmaker.espressif.com/>`_ is a complete solution for accelerated AIoT development. Using ESP RainMaker, you can create AIoT devices from the firmware to the integration with voice-assistant, phone apps and cloud backend.
`ESP RainMaker on GitHub <https://github.com/espressif/esp-rainmaker>`_.
This project is available on Github: `ESP RainMaker on GitHub <https://github.com/espressif/esp-rainmaker>`_.
ESP-IoT-Solution
----------------
@ -78,30 +78,30 @@ ESP-IoT-Solution includes:
* Framework and documentation for low power, security, storage, etc.
* Guide for Espressif open source solutions from practical application point.
`ESP-IoT-Solution on GitHub <https://github.com/espressif/esp-iot-solution>`_.
This solution is available on Github: `ESP-IoT-Solution on GitHub <https://github.com/espressif/esp-iot-solution>`_.
ESP-Protocols
-------------
`ESP-Protocols <https://github.com/espressif/esp-protocols>`_ repository contains collection of protocol components for ESP-IDF. The code within the ESP-Protocols is organized into separate components, allowing them to be easily integrated into an ESP-IDF project. In addition to that, each component is available in `IDF Component Registry <https://components.espressif.com/>`_.
The `ESP-Protocols <https://github.com/espressif/esp-protocols>`_ repository contains a collection of protocol components for ESP-IDF. The code within ESP-Protocols is organized into separate components, allowing them to be easily integrated into an ESP-IDF project. Additionally, each component is available in `IDF Component Registry <https://components.espressif.com/>`_.
ESP-Protocols components:
* `esp_modem <https://components.espressif.com/component/espressif/esp_modem>`_ enables connectivity with GSM/LTE modems using AT commands or PPP protocol, see the `esp_modem documentation <https://docs.espressif.com/projects/esp-protocols/esp_modem/docs/latest/index.html>`_.
* `esp_modem <https://components.espressif.com/component/espressif/esp_modem>`_ enables connectivity with GSM/LTE modems using AT commands or PPP protocol. See the `esp_modem documentation <https://docs.espressif.com/projects/esp-protocols/esp_modem/docs/latest/index.html>`_.
* `mdns <https://components.espressif.com/component/espressif/mdns>`_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery, see the `mdns documentation <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html>`_.
* `mdns <https://components.espressif.com/component/espressif/mdns>`_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery. See the `mdns documentation <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html>`_.
* `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_ is a managed component for `esp-idf` that contains implementation of [WebSocket protocol client](https://datatracker.ietf.org/doc/html/rfc6455) for ESP32, see the `esp_websocket_client documentation <https://docs.espressif.com/projects/esp-protocols/esp_websocket_client/docs/latest/index.html>`_.
* `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_ is a managed component for ESP-IDF that contains implementation of WebSocket protocol client for ESP32. See the `esp_websocket_client documentation <https://docs.espressif.com/projects/esp-protocols/esp_websocket_client/docs/latest/index.html>`_. For detailes of WebSocket protocol client, see `WebSocket_protocol_client <https://datatracker.ietf.org/doc/html/rfc6455>`_.
* `asio <https://components.espressif.com/component/espressif/asio>`_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. , see the `asio documentation <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`_.
* `asio <https://components.espressif.com/component/espressif/asio>`_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. See the `asio documentation <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`_.
ESP-BSP
-------
`ESP-BSP <https://github.com/espressif/esp-bsp>`_ repository contains Board Support Packages (BSPs) for various Espressif's and 3rd party development boards. BSPs are useful for quick start on a supported board. Usually they contain pinout definition and helper functions, that will initialize peripherals for the specific board. Additionally, the BSP would contain drivers for external chips populated on the development board, such as sensors, displays, audio codecs etc.
The `ESP-BSP <https://github.com/espressif/esp-bsp>`_ repository contains Board Support Packages (BSPs) for various Espressif's and third-party development boards. BSPs help to quickly get started with a supported board. Usually they contain pinout definition and helper functions that will initialize peripherals for the specific board. Additionally, the BSPs contain drivers for external chips populated on the development board, such as sensors, displays, audio codecs, etc.
ESP-IDF-CXX
-----------
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ contains C++ wrappers for part of ESP-IDF. The focus is on ease of use, safety, automatic resource management and shifting checks to compile time instead of failing at run time. There are C++ classes for ESP-Timer, I2C, SPI, GPIO and other peripherals or features of ESP-IDF. ESP-IDF-CXX is `available as a component <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ from the component registry. Please check the project's `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_ for more information.
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ contains C++ wrappers for part of ESP-IDF. The focuses are on ease of use, safety, automatic resource management. They also move error checking from runtime to compile time to prevent running failure. There are C++ classes for ESP-Timer, I2C, SPI, GPIO and other peripherals or features of ESP-IDF. ESP-IDF-CXX is `available as a component <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ from the component registry. Please check the project's `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_ for more information.

25
docs/zh_CN/api-reference/bluetooth/esp_gap_ble.rst
View File

@ -1 +1,24 @@
.. include:: ../../../en/api-reference/bluetooth/esp_gap_ble.rst
GAP API
=======
:link_to_translation:`en:[English]`
应用实例
-------------------
以下示例及其教程存放在 ESP-IDF 项目示例的 :example:`bluetooth/bluedroid/ble` 目录下。
* 以下为 SMP（安全管理协议）安全客户端示例及教程。该示例程序会初始化其安全参数，并充当 GATT 客户端，可向对端设备发送安全请求，完成加密过程。
- :example:`bluetooth/bluedroid/ble/gatt_security_client`
- :example_file:`GATT 安全客户端示例演示 <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* 以下为 SMP 安全服务器示例及其教程。该示例程序会初始化其安全参数，并充当 GATT 客户端，可向对端设备发送配对请求，完成加密过程。
- :example:`bluetooth/bluedroid/ble/gatt_security_server`
- :example_file:`GATT 安全服务器示例演示 <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
API 参考
-------------
.. include-build-file:: inc/esp_gap_ble_api.inc

35
docs/zh_CN/api-reference/protocols/modbus.rst
View File

@ -1 +1,34 @@
.. include:: ../../../en/api-reference/protocols/modbus.rst
ESP-Modbus
==========
:link_to_translation:`en:[English]`
乐鑫的 ESP-Modbus 库 (esp-modbus) 支持基于 RS485、Wi-Fi 和以太网接口的 Modbus 通信。
自 ESP-IDF v5.0 版本以来， 组件 ``freemodbus`` 已被移动到单独的存储库中:
* `GitHub 上的 ESP-Modbus 组件 <https://github.com/espressif/esp-modbus>`__
托管文档
--------------------
相应文档请参阅：
* `ESP-Modbus 文档 <https://docs.espressif.com/projects/esp-modbus>`__
应用示例
-------------------
以下示例分别介绍了 ESP-Modbus 库的串行端口、TCP 端口的从机和主机实现。
- :example:`protocols/modbus/serial/mb_slave`
- :example:`protocols/modbus/serial/mb_master`
- :example:`protocols/modbus/tcp/mb_tcp_slave`
- :example:`protocols/modbus/tcp/mb_tcp_master`
详情请参阅具体示例的 ``README.md`` 。
协议参考
-------------------
- Modbus 组织与规范协议请参阅 `The Modbus Organization <https://modbus.org/specs.php>`_。

108
docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst
View File

@ -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 <https://github.com/espressif/esp-adf>`_。
ESP-CSI
------------------------------------
ESP-CSI 是一个具有实验性的框架，它利用 Wi-Fi 信道状态信息来检测人体存在。
该框架对应的 GitHub 仓库为 `ESP-CSI <https://github.com/espressif/esp-csi>`_。
ESP-DSP
------------------------------------
ESP-DSP 提供了针对数字信号处理应用优化的算法，该库支持：
* 矩阵乘法
* 点乘
* 快速傅立叶变换 (FFT)
* 无线脉冲响应 (IIR)
* 有限脉冲响应 (FIR)
* 向量数学运算
该库对应的 GitHub 仓库为 `ESP-DSP 库 <https://github.com/espressif/esp-dsp>`_。
ESP-WIFI-MESH
------------------------------------------------------
ESP-WIFI-MESH 基于 ESP-WIFI-MESH 协议搭建，该框架支持：
* 快速网络配置
* 稳定升级
* 高效调试
* LAN 控制
* 多种应用示例
该框架对应的 GitHub 仓库为 `ESP-MDF <https://github.com/espressif/esp-mdf>`_。
ESP-WHO
------------------------------
ESP-WHO 框架利用 ESP32 及摄像头实现人脸检测及识别。
该框架对应的 GitHub 仓库为 `ESP-WHO <https://github.com/espressif/esp-who>`_。
ESP RainMaker
---------------------------------------------
`ESP RainMaker <https://rainmaker.espressif.com/>`_ 提供了一个快速 AIoT 开发的完整解决方案。使用 ESP RainMaker，用户可以创建多种 AIoT 设备，包括固件 AIoT 以及集成了语音助手、手机应用程序和云后端的 AIoT 等。
该解决方案对应的 GitHub 仓库为 `GitHub 上的 ESP RainMaker <https://github.com/espressif/esp-rainmaker>`_。
ESP-IoT-Solution
--------------------------------------------------
`ESP-IoT-Solution <https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/>`_ 涵盖了开发 IoT 系统时常用的设备驱动程序及代码框架。在 ESP-IoT-Solution 中，设备驱动程序和代码框架以独立组件存在，可以轻松地集成到 ESP-IDF 项目中。
ESP-IoT-Solution 支持：
* 传感器、显示器、音频、GUI、输入、执行器等设备驱动程序
* 低功耗、安全、存储等框架和文档
* 从实际应用角度指导乐鑫开源解决方案
该解决方案对应的 GitHub 仓库为 `GitHub 上的 ESP-IoT-Solution <https://github.com/espressif/esp-iot-solution>`_。
ESP-Protocols
-----------------------------------------
`ESP-Protocols <https://github.com/espressif/esp-protocols>`_ 库包含 ESP-IDF 的协议组件集。ESP-Protocols 中的代码以独立组件存在，可以轻松地集成到 ESP-IDF 项目中。此外，每个组件都可以在 `ESP-IDF 组件注册表 <https://components.espressif.com/>`_ 中找到。
ESP-Protocols 组件：
* `esp_modem <https://components.espressif.com/component/espressif/esp_modem>`_ 使用 AT 命令或 PPP 协议与 GSM/LTE 调制解调器连接，详情请参阅 `esp_modem 文档 <https://espressif.github.io/esp-protocols/esp_modem/index.html>`_。
* `mdns <https://components.espressif.com/component/espressif/mdns>`_ (mDNS) 是一种组播 UDP 服务，用于提供本地网络服务与主机发现，详情请参阅 `mdns 文档 <https://espressif.github.io/esp-protocols/mdns/en/index.html>`_。
* `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_ 是 ESP-IDF 的托管组件，可在 ESP32 上实现 WebSocket 协议客户端，详情请参阅 `esp_websocket_client 文档 <https://docs.espressif.com/projects/esp-protocols/esp_websocket_client/docs/latest/index.html>`_。有关 WebSocket 协议客户端，请参阅 `WebSocket_protocol_client <https://datatracker.ietf.org/doc/html/rfc6455>`_。
* `asio <https://components.espressif.com/component/espressif/asio>`_ 是一个跨平台的 C++ 库，请参阅 `<https://think-async.com/Asio/>`_。该库基于现代 C++ 提供一致的异步模型，请参阅 `asio 文档 <https://espressif.github.io/esp-protocols/asio/index.html>`_。
ESP-BSP
----------------------------------------
`ESP-BSP <https://github.com/espressif/esp-bsp>`_ 库包含了各种乐鑫和第三方开发板的板级支持包 (BSP)，可以帮助快速上手特定的开发板。它们通常包含管脚定义和辅助函数，这些函数可用于初始化特定开发板的外设。此外，BSP 还提供了一些驱动程序，可用于开发版上的外部芯片，如传感器、显示屏、音频编解码器等。
ESP-IDF-CXX
----------------------------------------------------------
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ 包含了 ESP-IDF 的部分 C++ 封装，重点在实现易用性、安全性、自动资源管理，以及将错误检查转移到编译过程中，以避免运行时失败。它还提供了 ESP 定时器、I2C、SPI、GPIO 等外设或 ESP-IDF 其他功能的 C++ 类。ESP-IDF-CXX 作为组件可以从 `组件注册表 <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ 中获取。详情请参阅 `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_。