Skip to content

Commit 89187e6

Browse files
committed
Merge branch 'docs/unify-menu-path-separator' into 'master'
docs: unify menu path separator from -> to > See merge request application/esp-at!1942
2 parents b60b74f + 988788a commit 89187e6

40 files changed

+72
-72
lines changed

docs/en/AT_Binary_Lists/esp_at_binaries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It is recommended to use the latest version of firmware. Currently, Espressif re
1111

1212
- The released AT firmware only supports chip versions with a crystal oscillator frequency of 26 MHz. If your module uses a crystal oscillator frequency of 40 MHz, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
1313

14-
- ``Component config`` -> ``Hardware Settings`` -> ``Main XTAL Config`` -> ``Main XTAL frequency`` -> ``40 MHz``
14+
- ``Component config`` > ``Hardware Settings`` > ``Main XTAL Config`` > ``Main XTAL frequency`` > ``40 MHz``
1515

1616
.. only:: esp32 or esp32c2
1717

docs/en/AT_Command_Examples/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AT Command Examples
99

1010
AT Response Message Format Control Examples <at_msg_resp_fmt_ctrl_examples>
1111
TCP-IP AT Examples <TCP-IP_AT_Examples>
12-
:esp32 or esp32c2 or esp32c3 or esp32c5 or esp32c6 or esp32c61: Bluetooth® Low Engergy AT Examples <bluetooth_le_at_examples>
12+
:esp32 or esp32c2 or esp32c3 or esp32c5 or esp32c6 or esp32c61: Bluetooth® Low Energy AT Examples <bluetooth_le_at_examples>
1313
MQTT AT Examples <MQTT_AT_Examples>
1414
MQTT AT Examples for Cloud <mqtt-at-examples-for-cloud>
1515
:esp32: Ethernet AT Examples <Ethernet_AT_Examples>

docs/en/AT_Command_Set/BLE_AT_Commands.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ Introduction
8181
.. important::
8282
The default AT firmware supports all the AT commands mentioned on this page. If you need to modify the commands supported by {IDF_TARGET_NAME} by default, please compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections (Each item below is independent. Choose it according to your needs):
8383

84-
- Disable BluFi commands: ``Component config`` -> ``AT`` -> ``AT blufi command support``
85-
- Disable Bluetooth LE commands: ``Component config`` -> ``AT`` -> ``AT ble command support``
86-
- Disable Bluetooth LE HID commands: ``Component config`` -> ``AT`` -> ``AT ble hid command support``
84+
- Disable BluFi commands: ``Component config`` > ``AT`` > ``AT blufi command support``
85+
- Disable Bluetooth LE commands: ``Component config`` > ``AT`` > ``AT ble command support``
86+
- Disable Bluetooth LE HID commands: ``Component config`` > ``AT`` > ``AT ble hid command support``
8787

8888
.. only:: esp32c2
8989

docs/en/AT_Command_Set/BT_AT_Commands.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Introduction
3939
.. important::
4040
The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support Classic Bluetooth commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections (Each item below is independent. Choose it according to your needs):
4141

42-
- Enable Generic Bluetooth commands: ``Component config`` -> ``AT`` -> ``AT bt command support``
43-
- Enable SPP commands: ``Component config`` -> ``AT`` -> ``AT bt command support`` -> ``AT bt spp command support``
44-
- Enable A2DP commands:``Component config`` -> ``AT`` -> ``AT bt command support`` -> ``AT bt a2dp command support``
42+
- Enable Generic Bluetooth commands: ``Component config`` > ``AT`` > ``AT bt command support``
43+
- Enable SPP commands: ``Component config`` > ``AT`` > ``AT bt command support`` > ``AT bt spp command support``
44+
- Enable A2DP commands:``Component config`` > ``AT`` > ``AT bt command support`` > ``AT bt a2dp command support``
4545

4646
.. _cmd-BTINIT:
4747

docs/en/AT_Command_Set/Driver_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Introduction
2727
.. important::
2828
The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support driver commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
2929

30-
- Enable ``Component config`` -> ``AT`` -> ``AT driver command support``
30+
- Enable ``Component config`` > ``AT`` > ``AT driver command support``
3131

3232
.. _cmd-DRVADC:
3333

docs/en/AT_Command_Set/FS_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Introduction
1919
.. important::
2020
The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support FileSystem commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
2121

22-
- Enable ``Component config`` -> ``AT`` -> ``AT FS command support``
22+
- Enable ``Component config`` > ``AT`` > ``AT FS command support``
2323

2424
.. _cmd-FS:
2525

docs/en/AT_Command_Set/HTTP_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Introduction
2424
.. important::
2525
The default AT firmware supports all the AT commands mentioned on this page. If you don't need {IDF_TARGET_NAME} to support HTTP commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
2626

27-
- Disable ``Component config`` -> ``AT`` -> ``AT http command support``
27+
- Disable ``Component config`` > ``AT`` > ``AT http command support``
2828

2929
.. _cmd-HTTPCLIENT:
3030

docs/en/AT_Command_Set/MQTT_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Introduction
3030
.. important::
3131
- The default AT firmware supports all the AT commands mentioned on this page. If you don't need {IDF_TARGET_NAME} to support MQTT commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
3232

33-
- Disable ``Component config`` -> ``AT`` -> ``AT MQTT command support``
33+
- Disable ``Component config`` > ``AT`` > ``AT MQTT command support``
3434

3535
- For MQTT connection to local Broker examples, see :doc:`MQTT AT Examples <../AT_Command_Examples/MQTT_AT_Examples>`.
3636
- For MQTT connection to AWS IoT examples, see :doc:`MQTT Cloud Connection AT Examples <../AT_Command_Examples/mqtt-at-examples-for-cloud>`.

docs/en/AT_Command_Set/Signaling_Test_AT_Commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Introduction
1616
.. important::
1717
The default AT firmware supports all the AT commands mentioned on this page. If you don't need {IDF_TARGET_NAME} to support signaling test commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
1818

19-
- Disable ``Component config`` -> ``AT`` -> ``AT signaling test command support``
19+
- Disable ``Component config`` > ``AT`` > ``AT signaling test command support``
2020

2121
.. _cmd-FACTPLCP:
2222

docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Introduction
5555
.. important::
5656
The default AT firmware supports all the AT commands mentioned on this page. If you need to modify the commands supported by {IDF_TARGET_NAME} by default, please compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections (Each item below is independent. Choose it according to your needs):
5757

58-
- Disable OTA commands (:ref:`AT+CIUPDATE <cmd-UPDATE>` and :ref:`AT+CIPFWVER <cmd-FWVER>`): ``Component config`` -> ``AT`` -> ``AT OTA command support``
59-
- Disable PING commands (:ref:`AT+PING <cmd-CIPPING>`): ``Component config`` -> ``AT`` -> ``AT ping command support``
60-
- Disable mDNS commands (:ref:`AT+MDNS <cmd-MDNS>`): ``Component config`` -> ``AT`` -> ``AT MDNS command support``
61-
- Disable TCP/IP commands (Not recommended. Once disabled, all TCP/IP functions will be unavailable and you will need to implement these AT commands yourself): ``Component config`` -> ``AT`` -> ``AT net command support``
58+
- Disable OTA commands (:ref:`AT+CIUPDATE <cmd-UPDATE>` and :ref:`AT+CIPFWVER <cmd-FWVER>`): ``Component config`` > ``AT`` > ``AT OTA command support``
59+
- Disable PING commands (:ref:`AT+PING <cmd-CIPPING>`): ``Component config`` > ``AT`` > ``AT ping command support``
60+
- Disable mDNS commands (:ref:`AT+MDNS <cmd-MDNS>`): ``Component config`` > ``AT`` > ``AT MDNS command support``
61+
- Disable TCP/IP commands (Not recommended. Once disabled, all TCP/IP functions will be unavailable and you will need to implement these AT commands yourself): ``Component config`` > ``AT`` > ``AT net command support``
6262

6363
.. _cmd-IPV6:
6464

@@ -389,7 +389,7 @@ Notes
389389
- Obtain an IPv6 address through the :ref:`AT+CWJAP <cmd-JAP>` command
390390
- (Optional) Check whether {IDF_TARGET_NAME} has obtained an IPv6 address using the :ref:`AT+CIPSTA? <cmd-IPSTA>` command
391391

392-
- If you want to receive a UDP packet longer than 1460 bytes, please compile the firmware on your own by following :doc:`Compile ESP-AT Project <../Compile_and_Develop/How_to_clone_project_and_compile_it>` and choosing the following configurations in the Step 5. Configure: ``Component config`` -> ``LWIP`` -> ``Enable reassembly incoming fragmented IP4 packets``.
392+
- If you want to receive a UDP packet longer than 1460 bytes, please compile the firmware on your own by following :doc:`Compile ESP-AT Project <../Compile_and_Develop/How_to_clone_project_and_compile_it>` and choosing the following configurations in the Step 5. Configure: ``Component config`` > ``LWIP`` > ``Enable reassembly incoming fragmented IP4 packets``.
393393
- To view the reason for UDP transmission establishment failure, please first run :ref:`AT+SYSLOG=1 <cmd-SYSLOG>` to enable logging, then retry this command. Upon failure, AT will return a more detailed error code ``+ERRNO:<error_code>`` to help locate the problem.
394394

395395
Example

0 commit comments

Comments
 (0)