mirror of
https://github.com/espressif/esp-idf.git
synced 2026-08-18 06:35:35 +03:00
docs: Update CN translation
This commit is contained in:
Zhang Shuxian
committed by
Euripedes Rocha
Euripedes Rocha
parent
448714b056
commit
41c3c2d539
@@ -53,7 +53,6 @@ These third party libraries can be included into the application (firmware) prod
|
||||
|
||||
* :component_file:`SD/MMC driver <sdmmc/sdmmc_cmd.c>` is derived from `OpenBSD SD/MMC driver`_, Copyright (C) 2006 Uwe Stuehler, and is licensed under BSD License.
|
||||
|
||||
|
||||
* :component:`BLE Mesh <bt/esp_ble_mesh>` is adapted from Zephyr Project, Copyright (C) 2017-2018 Intel Corporation and licensed under Apache License 2.0.
|
||||
|
||||
* `mynewt-nimble`_, Copyright (C) 2015-2018 The Apache Software Foundation, is licensed under Apache License 2.0 as described in :component_file:`LICENSE file <bt/host/nimble/nimble/LICENSE>`.
|
||||
@@ -160,7 +159,6 @@ Copyright (C) 2011 ChaN, all right reserved.
|
||||
.. _protobuf-c: https://github.com/protobuf-c/protobuf-c
|
||||
.. _Unity: https://github.com/ThrowTheSwitch/Unity
|
||||
.. _asio: https://github.com/chriskohlhoff/asio
|
||||
.. _mqtt: https://github.com/espressif/esp-mqtt
|
||||
.. _zephyr: https://github.com/zephyrproject-rtos/zephyr
|
||||
.. _mynewt-nimble: https://github.com/apache/mynewt-nimble
|
||||
.. _ESP-IDF Programming Guide: https://docs.espressif.com/projects/esp-idf/en/latest/
|
||||
|
||||
@@ -27,11 +27,13 @@ Application Examples
|
||||
Two reference examples are available in ESP-IDF:
|
||||
|
||||
- MQTT over TLS (certificate bundle): ``examples/protocols/mqtt``
|
||||
|
||||
- Validates the broker with ESP-IDF's certificate bundle (default).
|
||||
- Default broker URI targets ``mqtts://test.mosquitto.org:8886`` (Let's Encrypt chain).
|
||||
- Alternative configuration pins Mosquitto CA and uses ``mqtts://test.mosquitto.org:8883``.
|
||||
|
||||
- MQTT 5.0 over TLS (certificate bundle): ``examples/protocols/mqtt5``
|
||||
|
||||
- Uses MQTT v5.0 with TLS and validation via the certificate bundle.
|
||||
- Default broker URI targets ``mqtts://test.mosquitto.org:8886``.
|
||||
|
||||
|
||||
@@ -112,10 +112,12 @@ ESP-MQTT
|
||||
Breaking change: ESP-MQTT moved to a managed component and example set updated.
|
||||
|
||||
- The ESP-MQTT component has been removed from ESP-IDF and is now a managed component: ``espressif/mqtt``.
|
||||
|
||||
- To add the component to an application, run ``idf.py add-dependency espressif/mqtt``.
|
||||
- Include headers and APIs remain the same (``mqtt_client.h``), but the component is fetched via the Component Manager.
|
||||
|
||||
- Example changes in ESP-IDF:
|
||||
|
||||
- Legacy MQTT TLS examples under ``examples/protocols/mqtt/ssl*`` were removed.
|
||||
- New reference examples are available:
|
||||
|
||||
|
||||
@@ -53,8 +53,6 @@
|
||||
|
||||
* :component_file:`SD/MMC 驱动程序 <sdmmc/sdmmc_cmd.c>` 派生自 `OpenBSD SD/MMC 驱动程序`_，版权归 2006 Uwe Stuehler 所有，并根据 BSD 许可证进行许可。
|
||||
|
||||
|
||||
|
||||
* :component:`BLE Mesh <bt/esp_ble_mesh>` 改编自 Zephyr 项目，版权归 2017-2018 英特尔公司所有，并根据 Apache License 2.0 进行许可。
|
||||
|
||||
* `mynewt-nimble`_，版权归 2015-2018 Apache 软件基金会所有，根据 :component_file:`LICENSE 文件 <bt/host/nimble/nimble/LICENSE>` 中描述的 Apache License 2.0 进行许可。
|
||||
@@ -161,7 +159,6 @@ TJpgDec - Tiny JPEG 解压器 R0.01 (C) 2011 ChaN，是一个用于小型嵌入
|
||||
.. _protobuf-c: https://github.com/protobuf-c/protobuf-c
|
||||
.. _Unity: https://github.com/ThrowTheSwitch/Unity
|
||||
.. _asio: https://github.com/chriskohlhoff/asio
|
||||
|
||||
.. _zephyr: https://github.com/zephyrproject-rtos/zephyr
|
||||
.. _mynewt-nimble: https://github.com/apache/mynewt-nimble
|
||||
.. _ESP-IDF 编程指南: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
||||
|
||||
@@ -66,7 +66,7 @@ TLS 连接所需的 DS 外设配置
|
||||
使用 DS 外设进行 SSL 双向认证
|
||||
-----------------------------
|
||||
|
||||
此前位于 ``examples/protocols/mqtt/ssl_ds`` 的 SSL 双向认证示例现已随独立的 `espressif/mqtt <https://components.espressif.com/components/espressif/mqtt>`__ 组件一同提供。请按照该组件文档说明获取 SSL DS 示例并与 ESP-MQTT 一起构建。示例继续使用通过 `ESP-MQTT` 实现的 `mqtt_client` 连接到 ``test.mosquitto.org``，并使用 `ESP-TLS` 完成 TLS 双向认证。
|
||||
此前位于 ``examples/protocols/mqtt/ssl_ds`` 目录下的 SSL 双向认证示例现已随独立的 `espressif/mqtt <https://components.espressif.com/components/espressif/mqtt>`__ 组件一同提供。请参照该组件文档获取 SSL DS 示例，并与 ESP-MQTT 一起构建。该示例仍使用 `mqtt_client`（由 ESP-MQTT 实现），通过双向认证 TLS 连接至 ``test.mosquitto.org``，其中 TLS 通信层仍由 `ESP-TLS` 实现。
|
||||
|
||||
API 参考
|
||||
--------
|
||||
|
||||
@@ -229,7 +229,7 @@ ESP-TLS 支持在 ESP32 系列芯片上使用 ATECC608A 加密芯片，但必须
|
||||
|
||||
当使用数字签名进行 TLS 连接时，除其他必要参数外，仅需提供客户端证书 (``clientcert_buf``) 和数字签名参数 (``ds_data``) ，此时可将客户端密钥 (``clientkey_buf``) 设置为 NULL。
|
||||
|
||||
* 使用数字签名外设进行双向认证的示例现随独立的 `espressif/mqtt <https://components.espressif.com/components/espressif/mqtt>`__ 组件一同提供，并在内部通过 ESP-TLS 建立 TLS 连接。请按照该组件文档说明获取并构建该示例。
|
||||
* 现有一个基于 DS 外设的双向认证示例，已随独立的 `espressif/mqtt <https://components.espressif.com/components/espressif/mqtt>`__ 组件一同提供，其内部依赖 ESP-TLS 建立 TLS 连接。请参照组件文档获取并构建该示例。
|
||||
|
||||
.. only:: SOC_ECDSA_SUPPORTED
|
||||
|
||||
|
||||
@@ -6,13 +6,13 @@ ESP-MQTT
|
||||
概述
|
||||
--------
|
||||
|
||||
ESP‑MQTT 是 `MQTT <https://mqtt.org/>`__ 协议客户端的实现，属于轻量级发布/订阅消息协议。ESP‑MQTT 现已支持 `MQTT v5.0 <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html>`__。
|
||||
ESP-MQTT 是 `MQTT <https://mqtt.org/>`__ 协议客户端的实现，属于轻量级发布/订阅消息协议。ESP-MQTT 现已支持 `MQTT v5.0 <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html>`__。
|
||||
|
||||
自 ESP‑IDF v6.0 起，``ESP‑MQTT`` 组件已从 ESP‑IDF 中移至独立仓库：
|
||||
自 ESP-IDF v6.0 起，``ESP-MQTT`` 组件已从 ESP-IDF 中移至独立仓库：
|
||||
|
||||
* `esp-mqtt 组件仓库 <https://github.com/espressif/esp-mqtt>`__
|
||||
|
||||
如需在项目中添加 ESP‑MQTT 组件，请运行 ``idf.py add-dependency espressif/mqtt``。
|
||||
如需在项目中添加 ESP-MQTT 组件，请运行 ``idf.py add-dependency espressif/mqtt``。
|
||||
|
||||
托管文档
|
||||
---------------------
|
||||
@@ -24,16 +24,18 @@ ESP‑MQTT 是 `MQTT <https://mqtt.org/>`__ 协议客户端的实现，属于轻
|
||||
应用示例
|
||||
--------------------
|
||||
|
||||
ESP‑IDF 中提供了两个参考示例：
|
||||
ESP-IDF 中提供了两个参考示例：
|
||||
|
||||
- 基于 TLS（证书包）的 MQTT 示例：``examples/protocols/mqtt``
|
||||
- 默认使用 ESP‑IDF 证书包进行服务器验证。
|
||||
- 默认 Broker URI 为 ``mqtts://test.mosquitto.org:8886`` （Let's Encrypt 链）。
|
||||
- 也可固定 Mosquitto CA，并使用 ``mqtts://test.mosquitto.org:8883``。
|
||||
- 基于 TLS 的 MQTT 通信（证书包模式）：``examples/protocols/mqtt``
|
||||
|
||||
- 基于 TLS（证书包）的 MQTT 5.0 示例：``examples/protocols/mqtt5``
|
||||
- 使用 MQTT v5.0 与 TLS，并通过证书包进行验证。
|
||||
- 默认 Broker URI 为 ``mqtts://test.mosquitto.org:8886``。
|
||||
- 默认使用 ESP-IDF 证书包验证代理服务器。
|
||||
- 默认代理地址指向 ``mqtts://test.mosquitto.org:8886`` （采用 Let's Encrypt 证书链）。
|
||||
- 替代方案可配置 Mosquitto CA 证书并改用 ``mqtts://test.mosquitto.org:8883`` 地址。
|
||||
|
||||
- 基于 TLS 的 MQTT 5.0 通信（证书包模式）：``examples/protocols/mqtt5``
|
||||
|
||||
- 使用 MQTT v5.0 协议，通过 TLS 传输并借助证书包完成验证。
|
||||
- 默认代理地址指向 ``mqtts://test.mosquitto.org:8886``。
|
||||
|
||||
如需更多传输模式（TCP、WS/WSS、双向认证等）的示例，请参考 `espressif/mqtt 组件仓库 <https://components.espressif.com/components/espressif/mqtt>`__。
|
||||
|
||||
|
||||
@@ -111,12 +111,14 @@ ESP-MQTT
|
||||
|
||||
重大变更：ESP-MQTT 迁移为托管组件，并更新了示例集。
|
||||
|
||||
- ESP-MQTT 组件已从 ESP-IDF 中移除，现在作为托管组件 ``espressif/mqtt`` 提供。
|
||||
- 在应用中添加该组件，请运行 ``idf.py add-dependency espressif/mqtt``。
|
||||
- 头文件与 API（``mqtt_client.h``）保持一致，但组件通过 Component Manager 获取。
|
||||
- ESP-MQTT 组件已从 ESP-IDF 中移除，现作为托管组件 ``espressif/mqtt`` 提供。
|
||||
|
||||
- ESP-IDF 中的示例变更：
|
||||
- 移除了 ``examples/protocols/mqtt/ssl*`` 下的旧版 MQTT TLS 示例。
|
||||
- 要将该组件添加至应用，运行 ``idf.py add-dependency espressif/mqtt``。
|
||||
- 头文件与 API 保持兼容（使用 ``mqtt_client.h``），但需通过组件管理器获取该组件。
|
||||
|
||||
- ESP-IDF 示例变更：
|
||||
|
||||
- 移除了 ``examples/protocols/mqtt/ssl*`` 路径下的旧版 MQTT TLS 示例。
|
||||
- 新增参考示例：
|
||||
|
||||
- ``examples/protocols/mqtt``：基于 TLS 的 MQTT。
|
||||
|
||||
Reference in New Issue
Block a user