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

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

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.