Skip to content

Commit 886fc2d

Browse files
committed
Merge branch 'docs/fix_parentheses_usage' into 'master'
docs: fix parentheses usage in Chinese documentation See merge request application/esp-at!1957
2 parents 690713c + b17f6fb commit 886fc2d

8 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/zh_CN/AT_Command_Examples/MQTT_AT_Examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ MQTT AT 示例
236236
237237
说明:
238238

239-
- ``AT`` 输出 ``>`` 字符后,数据中的特殊字符不需要转义字符进行转义,也不需要以新行结尾CR-LF
239+
- ``AT`` 输出 ``>`` 字符后,数据中的特殊字符不需要转义字符进行转义,也不需要以新行结尾 (CR-LF)
240240
- 如果 {IDF_TARGET_NAME} MQTT 发布者成功发布消息,以下信息将会在 {IDF_TARGET_NAME} MQTT 订阅者端提示。
241241

242242
.. code-block:: none

docs/zh_CN/AT_Command_Examples/classic_bluetooth_at_examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@
139139
说明:
140140

141141
- 若输入的字节数目超过 ``AT+BTSPPSEND`` 命令设定的长度 (n),则系统会响应 ``busy p...``,并发送数据的前 n 个字节,发送完成后响应 ``OK``。
142-
- ``AT`` 输出 ``>`` 字符后,数据中的特殊字符不需要转义字符进行转义,也不需要以新行结尾CR-LF
142+
- ``AT`` 输出 ``>`` 字符后,数据中的特殊字符不需要转义字符进行转义,也不需要以新行结尾 (CR-LF)
143143

144144
#. 接收 4 字节数据。
145145

docs/zh_CN/AT_Command_Examples/http_at_examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ HTTP 客户端 POST 请求方法(推荐方式)
388388
389389
说明:
390390

391-
- ``AT`` 输出 ``>`` 字符后,HTTP body 中的特殊字符不需要转义字符进行转义,也不需要以新行结尾CR-LF
391+
- ``AT`` 输出 ``>`` 字符后,HTTP body 中的特殊字符不需要转义字符进行转义,也不需要以新行结尾 (CR-LF)
392392

393393
HTTP 客户端 PUT 请求方法(适用于无数据情况)
394394
---------------------------------------------------
@@ -600,7 +600,7 @@ HTTP 客户端 PUT 请求方法(推荐方式)
600600
601601
说明:
602602

603-
- ``AT`` 输出 ``>`` 字符后,HTTP body 中的特殊字符不需要转义字符进行转义,也不需要以新行结尾CR-LF
603+
- ``AT`` 输出 ``>`` 字符后,HTTP body 中的特殊字符不需要转义字符进行转义,也不需要以新行结尾 (CR-LF)
604604

605605
HTTP 客户端 DELETE 请求方法
606606
---------------------------------------------------

docs/zh_CN/AT_Command_Set/Basic_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1234,7 +1234,7 @@
12341234
""""""
12351235

12361236
- 请先使用本命令配置有效的过滤器,再通过 :ref:`AT+SYSMSGFILTER <cmd-SYSMSGFILTER>` 命令启用或禁用系统消息过滤,实现更加精细的系统消息管理。
1237-
- 头部和尾部正则表达式格式参考 `POSIX 基本正则语法BRE <https://en.wikipedia.org/wiki/Regular_expression#POSIX_basic_and_extended>`_。
1237+
- 头部和尾部正则表达式格式参考 `POSIX 基本正则语法 (BRE) <https://en.wikipedia.org/wiki/Regular_expression#POSIX_basic_and_extended>`_。
12381238
- 为了避免 :term:`系统消息` (AT 命令口的 TX 数据) 被错误过滤,**强烈建议** 头部正则表达式以 ``^`` 开头,尾部正则表达式以 ``$`` 结束。
12391239
- 只有系统消息 **同时匹配** 上头部正则表达式和尾部正则表达式时,系统消息才会被过滤。过滤后,系统消息被正则表达式匹配上的数据会被 AT 过滤掉,MCU 不会收到;而未被正则表达式匹配上的数据,会原样发往 MCU。
12401240
- 当系统消息匹配到一个过滤器后,不会再继续匹配其它的过滤器。

docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ MQTT AT 命令集
1111
- :ref:`AT+MQTTLONGUSERNAME <cmd-MQTTLONGUSERNAME>`:设置 MQTT 登陆用户名
1212
- :ref:`AT+MQTTLONGPASSWORD <cmd-MQTTLONGPASSWORD>`:设置 MQTT 登陆密码
1313
- :ref:`AT+MQTTCONNCFG <cmd-MQTTCONNCFG>`:设置 MQTT 连接属性
14-
- :ref:`AT+MQTTALPN <cmd-MQTTALPN>`:设置 MQTT 应用层协议协商ALPN
15-
- :ref:`AT+MQTTSNI <cmd-MQTTSNI>`:设置 MQTT 服务器名称指示SNI
14+
- :ref:`AT+MQTTALPN <cmd-MQTTALPN>`:设置 MQTT 应用层协议协商 (ALPN)
15+
- :ref:`AT+MQTTSNI <cmd-MQTTSNI>`:设置 MQTT 服务器名称指示 (SNI)
1616
- :ref:`AT+MQTTCONN <cmd-MQTTCONN>`:连接 MQTT Broker
1717
- :ref:`AT+MQTTPUB <cmd-MQTTPUB>`:发布 MQTT 消息(字符串)
1818
- :ref:`AT+MQTTPUBRAW <cmd-MQTTPUBRAW>`:发布长 MQTT 消息
@@ -274,15 +274,15 @@ MQTT AT 命令集
274274

275275
.. _cmd-MQTTALPN:
276276

277-
:ref:`AT+MQTTALPN <MQTT-AT>`:设置 MQTT 应用层协议协商ALPN
277+
:ref:`AT+MQTTALPN <MQTT-AT>`:设置 MQTT 应用层协议协商 (ALPN)
278278
-------------------------------------------------------------------------
279279

280280
设置命令
281281
^^^^^^^^
282282

283283
**功能:**
284284

285-
设置 MQTT 应用层协议协商ALPN
285+
设置 MQTT 应用层协议协商 (ALPN)
286286

287287
**命令:**
288288

@@ -328,15 +328,15 @@ MQTT AT 命令集
328328

329329
.. _cmd-MQTTSNI:
330330

331-
:ref:`AT+MQTTSNI <MQTT-AT>`:设置 MQTT 服务器名称指示SNI
331+
:ref:`AT+MQTTSNI <MQTT-AT>`:设置 MQTT 服务器名称指示 (SNI)
332332
-------------------------------------------------------------------------
333333

334334
设置命令
335335
^^^^^^^^
336336

337337
**功能:**
338338

339-
设置 MQTT 服务器名称指示SNI
339+
设置 MQTT 服务器名称指示 (SNI)
340340

341341
**命令:**
342342

docs/zh_CN/AT_Command_Set/TCP-IP_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2151,7 +2151,7 @@ ESP-AT 在运行时,通过 Wi-Fi 从指定的服务器上下载新固件到某
21512151

21522152
说明
21532153
^^^^
2154-
- 类似于 :ref:`AT+CIPSSLCPSK <cmd-SSLCPSK>` 命令,该命令也用于设置或查询 SSL 客户端的预共享密钥PSK,但其 ``<"psk">`` 参数使用十六进制格式而不是字符串格式。因此, ``<"psk">`` 参数中的 ``\0`` 表示为 ``00``。
2154+
- 类似于 :ref:`AT+CIPSSLCPSK <cmd-SSLCPSK>` 命令,该命令也用于设置或查询 SSL 客户端的预共享密钥 (PSK),但其 ``<"psk">`` 参数使用十六进制格式而不是字符串格式。因此, ``<"psk">`` 参数中的 ``\0`` 表示为 ``00``。
21552155

21562156
示例
21572157
^^^^

docs/zh_CN/AT_Command_Set/user_at_commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ AT 输出上述信息之后,升级过程开始。如果升级完成,返回
179179
- 不建议升级到旧版本。降到旧版本会存在一定的兼容性问题,甚至无法运行,如果您坚持要升级到旧版本,请根据自己的产品自行测试验证功能。
180180
- 建议升级 AT 固件后,调用 :ref:`AT+RESTORE <cmd-RESTORE>` 恢复出厂设置。
181181
- ``AT+USEROTA`` 支持 ``HTTP`` 和 ``HTTPS``。
182-
- AT 输出 ``>`` 字符后,数据中的特殊字符不需要转义字符进行转义,也不需要以新行结尾CR-LF
182+
- AT 输出 ``>`` 字符后,数据中的特殊字符不需要转义字符进行转义,也不需要以新行结尾 (CR-LF)
183183
- 当 URL 为 ``HTTPS`` 时,不建议 SSL 认证。如果要求 SSL 认证,您必须自行生成 PKI 文件然后将它们下载到对应的分区中,之后在 ``AT+USEROTA`` 命令的实现代码中加载证书。对于 PKI 文件请参考 :doc:`../Compile_and_Develop/How_to_update_pki_config`。对于 ``AT+USEROTA`` 命令,可参考 ESP-AT 工程提供的示例 `USEROTA <https://github.com/espressif/esp-at/blob/master/components/at/src/at_user_cmd.c>`_。
184184
- 请参考 :doc:`../Compile_and_Develop/How_to_implement_OTA_update` 获取更多 OTA 命令。
185185

docs/zh_CN/Compile_and_Develop/How_to_update_IDF.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:link_to_translation:`en:[English]`
77

8-
ESP-AT 固件基于乐鑫物联网开发框架ESP-IDF,每个版本的 ESP-AT 固件对应某个特定的 ESP-IDF 版本。强烈建议使用 ESP-AT 工程默认的 ESP-IDF 版本,**不建议** 更新 ESP-IDF 版本,因为 lib{IDF_TARGET_PATH_NAME}_at_core.a 底层的 ESP-IDF 版本与 ESP-AT 工程的 IDF 版本不一致可能会导致固件的错误操作。
8+
ESP-AT 固件基于乐鑫物联网开发框架 (ESP-IDF),每个版本的 ESP-AT 固件对应某个特定的 ESP-IDF 版本。强烈建议使用 ESP-AT 工程默认的 ESP-IDF 版本,**不建议** 更新 ESP-IDF 版本,因为 lib{IDF_TARGET_PATH_NAME}_at_core.a 底层的 ESP-IDF 版本与 ESP-AT 工程的 IDF 版本不一致可能会导致固件的错误操作。
99

1010
但是,在某些特殊情况下,ESP-IDF 的小版本更新也可能适用于 ESP-AT 工程。如果您需要更新,本文档可作为参考。
1111

0 commit comments

Comments
 (0)