From 1e87b746390b3af086a02835283ca5c2e4c31820 Mon Sep 17 00:00:00 2001 From: Chen Wu Date: Fri, 2 Jun 2023 17:54:22 +0800 Subject: [PATCH] docs: Added the command set support note --- docs/en/AT_Command_Set/BLE_AT_Commands.rst | 72 +++++++--- docs/en/AT_Command_Set/BT_AT_Commands.rst | 17 ++- docs/en/AT_Command_Set/Basic_AT_Commands.rst | 118 ++-------------- docs/en/AT_Command_Set/Driver_AT_Commands.rst | 11 ++ .../AT_Command_Set/Ethernet_AT_Commands.rst | 9 ++ docs/en/AT_Command_Set/FS_AT_Commands.rst | 129 ++++++++++++++++++ docs/en/AT_Command_Set/HTTP_AT_Commands.rst | 20 +++ docs/en/AT_Command_Set/MQTT_AT_Commands.rst | 11 ++ .../Signaling_Test_AT_Commands.rst | 11 ++ docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst | 13 ++ .../AT_Command_Set/Web_server_AT_Commands.rst | 11 ++ docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst | 15 ++ docs/en/AT_Command_Set/index.rst | 1 + docs/en/AT_Command_Set/user_at_commands.rst | 11 ++ .../AT_Command_Set/websocket_at_commands.rst | 11 ++ .../RainMaker_AT/RainMaker_AT_Command_Set.rst | 6 + docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst | 72 +++++++--- docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst | 17 ++- .../AT_Command_Set/Basic_AT_Commands.rst | 120 ++-------------- .../AT_Command_Set/Driver_AT_Commands.rst | 11 ++ .../AT_Command_Set/Ethernet_AT_Commands.rst | 9 ++ docs/zh_CN/AT_Command_Set/FS_AT_Commands.rst | 129 ++++++++++++++++++ .../zh_CN/AT_Command_Set/HTTP_AT_Commands.rst | 20 +++ .../zh_CN/AT_Command_Set/MQTT_AT_Commands.rst | 11 ++ .../Signaling_Test_AT_Commands.rst | 11 ++ .../AT_Command_Set/TCP-IP_AT_Commands.rst | 13 ++ .../AT_Command_Set/Web_server_AT_Commands.rst | 11 ++ .../AT_Command_Set/Wi-Fi_AT_Commands.rst | 15 ++ docs/zh_CN/AT_Command_Set/index.rst | 1 + .../zh_CN/AT_Command_Set/user_at_commands.rst | 11 ++ .../AT_Command_Set/websocket_at_commands.rst | 11 ++ .../RainMaker_AT/RainMaker_AT_Command_Set.rst | 6 + 32 files changed, 675 insertions(+), 259 deletions(-) create mode 100644 docs/en/AT_Command_Set/FS_AT_Commands.rst create mode 100644 docs/zh_CN/AT_Command_Set/FS_AT_Commands.rst diff --git a/docs/en/AT_Command_Set/BLE_AT_Commands.rst b/docs/en/AT_Command_Set/BLE_AT_Commands.rst index f2d24d5f..9fdc5142 100644 --- a/docs/en/AT_Command_Set/BLE_AT_Commands.rst +++ b/docs/en/AT_Command_Set/BLE_AT_Commands.rst @@ -5,26 +5,9 @@ Bluetooth® Low Energy AT Commands :link_to_translation:`zh_CN:[中文]` - .. only:: esp32 - - Currently, AT firmware for {IDF_TARGET_NAME} series supports `Bluetooth® Core Specification Version 4.2 `_. - - .. only:: esp32c3 - - Currently, AT firmware for {IDF_TARGET_NAME} supports `Bluetooth® Core Specification Version 5.0 `_. - -.. only:: esp32c2 - - Currently, AT firmware for {IDF_TARGET_NAME} supports `Bluetooth® Core Specification Version 5.0 `_. - - .. attention:: - **{IDF_TARGET_CFG_PREFIX}-4MB AT firmware supports BluFi, but {IDF_TARGET_CFG_PREFIX}-2MB AT firmware does not**. If you need the firmware with BluFi support on {IDF_TARGET_CFG_PREFIX}-2MB, please compile it 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`` -> ``Bluetooth`` -> ``Bluetooth`` -> ``Host`` -> ``NimBLE`` - ``BLE only`` - - ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable blufi functionality`` - .. list:: + :esp32 or esp32c3 or esp32c2: - :ref:`Introduction ` :esp32 or esp32c3 or esp32c2: - :ref:`AT+BLEINIT `: Bluetooth LE initialization. :esp32 or esp32c3 or esp32c2: - :ref:`AT+BLEADDR `: Query/Set Bluetooth LE device address. :esp32 or esp32c3 or esp32c2: - :ref:`AT+BLENAME `: Query/Set Bluetooth LE device name. @@ -80,6 +63,59 @@ Bluetooth® Low Energy AT Commands :esp32c3 or esp32c2: - :ref:`AT+BLEREADPHY `: Query the current transmitter PHY. :esp32c3 or esp32c2: - :ref:`AT+BLESETPHY `: Set the current transmitter PHY. +.. _cmd-ble-intro: + +Introduction +------------ + + .. only:: esp32 + + Currently, AT firmware for {IDF_TARGET_NAME} series supports `Bluetooth® Core Specification Version 4.2 `_. + + .. only:: esp32c2 or esp32c3 + + Currently, AT firmware for {IDF_TARGET_NAME} supports `Bluetooth® Core Specification Version 5.0 `_. + +.. only:: esp32 or esp32c3 + + .. important:: + 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: + + - Disable BluFi commands: ``Component config`` -> ``AT`` -> ``AT blufi command support`` + - Disable Bluetooth LE commands: ``Component config`` -> ``AT`` -> ``AT ble command support`` + - Disable Bluetooth LE HID commands: ``Component config`` -> ``AT`` -> ``AT ble hid command support`` + +.. only:: esp32c2 + + .. important:: + The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware supports BluFi functionality, while the {IDF_TARGET_CFG_PREFIX}-2MB AT firmware does not. If you need BluFi functionality for {IDF_TARGET_CFG_PREFIX}-2MB, please refer to the :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation and follow the steps below in the project configuration (Step 5): + + - Enable ``Component config`` -> ``Bluetooth`` + - Enable ``Component config`` -> ``Bluetooth`` -> ``Bluetooth`` -> ``Host`` -> ``NimBLE`` - ``BLE only`` + - Enable ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable blufi functionality`` + - Enable ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable BLE 5 feature`` -> ``Enable extended advertising`` + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Maximum number of concurrent connections`` -> 1 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_1_Block Count`` -> 10 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_1_Block Size`` -> 100 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_2_Block Count`` -> 4 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``ACL Buffer Count`` -> 5 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``High Priority HCI Event Buffer count`` -> 5 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``Low Priority HCI Event Buffer count`` -> 3 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``BLE white list size`` -> 1 + - Set ``Component config`` -> ``Bluetooth`` -> ``Controller Options`` -> ``BLE LL Resolving list size`` -> 1 + - Set ``Component config`` -> ``Bluetooth`` -> ``Controller Options`` -> ``BLE duplicate scan list count`` -> 1 + + .. important:: + The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware and {IDF_TARGET_CFG_PREFIX}-2MB AT firmware do not support Bluetooth LE functionality. If you need to enable Bluetooth LE functionality, please refer to the :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation and follow the steps of above BluFi functionality in the project configuration (Step 5), and then follow the steps below: + + - Enable Bluetooth LE commands: ``Component config`` -> ``AT`` -> ``AT ble command support`` + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Maximum length of BLE device name in octets`` -> 32 + - Set ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Preferred MTU size in octets`` -> 203 + + If you encounter an error similar to ``Part 'ota_0' 0/16 @ 0xd0000 size 0x130000 (overflow 0x59a0)``, you need to disable unnecessary features in ``Component config`` -> ``AT`` according to your application requirements to reduce the firmware size. + + Due to limited memory, it is recommended to disable the Wi-Fi protocol stack by sending the command :ref:`AT+CWINIT=0 ` before using Bluetooth LE functionality. This will free up memory for Bluetooth operations. + .. only:: esp32 or esp32c3 or esp32c2 .. _cmd-BINIT: diff --git a/docs/en/AT_Command_Set/BT_AT_Commands.rst b/docs/en/AT_Command_Set/BT_AT_Commands.rst index 610aed02..98882613 100644 --- a/docs/en/AT_Command_Set/BT_AT_Commands.rst +++ b/docs/en/AT_Command_Set/BT_AT_Commands.rst @@ -5,8 +5,7 @@ :link_to_translation:`zh_CN:[中文]` -{IDF_TARGET_NAME} AT firmware supports `Bluetooth® Core Specification Version 4.2 `_. - +- :ref:`Introduction ` - :ref:`AT+BTINIT `: Classic Bluetooth initialization. - :ref:`AT+BTNAME `: Query/Set Classic Bluetooth device name. - :ref:`AT+BTSCANMODE `: Set Classic Bluetooth scan mode. @@ -30,6 +29,20 @@ - :ref:`AT+BTCOD `: Set class of devices. - :ref:`AT+BTPOWER `: Query/Set power of Classic Bluetooth. +.. _cmd-bt-intro: + +Introduction +------------ + +{IDF_TARGET_NAME} AT firmware supports `Bluetooth® Core Specification Version 4.2 `_. + +.. important:: + 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: + + - Enable Generic Bluetooth commands: ``Component config`` -> ``AT`` -> ``AT bt command support`` + - Enable SPP commands: ``Component config`` -> ``AT`` -> ``AT bt command support`` -> ``AT bt spp command support`` + - Enable A2DP commands:``Component config`` -> ``AT`` -> ``AT bt command support`` -> ``AT bt a2dp command support`` + .. _cmd-BTINIT: :ref:`AT+BTINIT `: Classic Bluetooth Initialization diff --git a/docs/en/AT_Command_Set/Basic_AT_Commands.rst b/docs/en/AT_Command_Set/Basic_AT_Commands.rst index 708443be..014ca686 100644 --- a/docs/en/AT_Command_Set/Basic_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Basic_AT_Commands.rst @@ -7,6 +7,7 @@ Basic AT Commands .. list:: + - :ref:`Introduction ` - :ref:`AT `: Test AT startup. - :ref:`AT+RST `: Restart a module. - :ref:`AT+GMR `: Check version information. @@ -25,8 +26,6 @@ Basic AT Commands - :ref:`AT+SYSMSGFILTERCFG `: Query/Set the :term:`system message` filters. - :ref:`AT+SYSFLASH `: Query/Set User Partitions in Flash. - :ref:`AT+SYSMFG `: Query/Set :term:`manufacturing nvs` User Partitions. - - :ref:`AT+FS `: Filesystem Operations. - - :ref:`AT+FSMOUNT `: Mount/Unmount Filesystem. - :ref:`AT+RFPOWER `: Query/Set RF TX Power. - :ref:`AT+SYSROLLBACK `: Roll back to the previous firmware. - :ref:`AT+SYSTIMESTAMP `: Query/Set local time stamp. @@ -36,6 +35,14 @@ Basic AT Commands - :ref:`AT+SYSREG `: Read/write the register. :esp32c3: - :ref:`AT+SYSTEMP `: Read the internal chip Celsius temperature value. +.. _cmd-basic-intro: + +Introduction +------------ + +.. important:: + The default AT firmware supports all the AT commands mentioned on this page. + .. _cmd-AT: :ref:`AT `: Test AT Startup @@ -1521,113 +1528,6 @@ Example // Wait until AT command port returns ``>``, and then write 1164 bytes -.. _cmd-FS: - -:ref:`AT+FS `: Filesystem Operations ---------------------------------------------------------------- - -Set Command -^^^^^^^^^^^ - -**Command:** - -:: - - AT+FS=,,,, - -**Response:** - -:: - - OK - -Parameters -^^^^^^^^^^ - -- ****: only FATFS is currently supported. - - - 0: FATFS - -- ****: - - - 0: delete file. - - 1: write file. - - 2: read file. - - 3: query the size of the file. - - 4: list files in a specific directory. Only root directory is currently supported. - -- ****: apply to writing and reading operations only. -- ****: data length, applying to writing and reading operations only. - -Notes -^^^^^ - -- This command will automatically mount the filesystem. After the :ref:`AT+FS ` filesystem operation is all done, it is strongly recommended to use the :ref:`AT+FSMOUNT=0 ` command to unmount the filesystem to free a large amount of RAM space. -- Please make sure that you have downloaded at_customize.bin before using this command. For more details, refer to `ESP-IDF Partition Tables `_ and :doc:`../Compile_and_Develop/How_to_customize_partitions`. -- If the length of the read data is greater than the actual file length, only the actual data length of the file will be returned. -- If the operator is ``write``, wrap return ``>`` after the write command, then you can send the data that you want to write. The length should be parameter ````. - -Example -^^^^^^^^ - -:: - - // delete a file. - AT+FS=0,0,"filename" - - // write 10 bytes to offset 100 of a file. - AT+FS=0,1,"filename",100,10 - - // read 100 bytes from offset 0 of a file. - AT+FS=0,2,"filename",0,100 - - // list all files in the root directory. - AT+FS=0,4,"." - -.. _cmd-FSMOUNT: - -:ref:`AT+FSMOUNT `: Mount/Unmount Filesystem ------------------------------------------------------- - -Set Command -^^^^^^^^^^^ - -**Command:** - -:: - - AT+FSMOUNT= - -**Response:** - -:: - - OK - -Parameters -^^^^^^^^^^ - -- ****: - - - 0: Unmount filesystem - - 1: Mount filesystem - -Notes -^^^^^ - -- After the :ref:`AT+FS ` filesystem operation is all done, it is strongly recommended to use the :ref:`AT+FSMOUNT=0 ` command to unmount the filesystem to free a large amount of RAM space. - -Example -^^^^^^^^ - -:: - - // unmount the filesystem manually - AT+FSMOUNT=0 - - // mount the filesystem manually - AT+FSMOUNT=1 - .. _cmd-RFPOWER: :ref:`AT+RFPOWER `: Query/Set RF TX Power diff --git a/docs/en/AT_Command_Set/Driver_AT_Commands.rst b/docs/en/AT_Command_Set/Driver_AT_Commands.rst index 1ce421df..ff8fc217 100644 --- a/docs/en/AT_Command_Set/Driver_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Driver_AT_Commands.rst @@ -5,6 +5,7 @@ Driver AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+DRVADC `: Read ADC channel value. - :ref:`AT+DRVPWMINIT `: Initialize PWM driver. - :ref:`AT+DRVPWMDUTY `: Set PWM duty. @@ -18,6 +19,16 @@ Driver AT Commands - :ref:`AT+DRVSPIRD `: Read SPI data. - :ref:`AT+DRVSPIWR `: Write SPI data. +.. _cmd-driver-intro: + +Introduction +------------ + +.. important:: + 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: + + - Enable ``Component config`` -> ``AT`` -> ``AT driver command support`` + .. _cmd-DRVADC: :ref:`AT+DRVADC `: Read ADC Channel Value diff --git a/docs/en/AT_Command_Set/Ethernet_AT_Commands.rst b/docs/en/AT_Command_Set/Ethernet_AT_Commands.rst index c1e65a08..2e8b130c 100644 --- a/docs/en/AT_Command_Set/Ethernet_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Ethernet_AT_Commands.rst @@ -7,10 +7,19 @@ :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`Prerequisite ` - :ref:`AT+CIPETHMAC `: Query/Set the MAC address of the {IDF_TARGET_NAME} Ethernet. - :ref:`AT+CIPETH `: Query/Set the IP address of the {IDF_TARGET_NAME} Ethernet. +.. _cmd-eth-intro: + +Introduction +------------ + +.. important:: + The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support Ethernet commands, please refer to :doc:`../Compile_and_Develop/How_to_enable_ESP_AT_Ethernet` documentation and :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>`. + .. _cmd-ETHPRE: :ref:`Prerequisite ` diff --git a/docs/en/AT_Command_Set/FS_AT_Commands.rst b/docs/en/AT_Command_Set/FS_AT_Commands.rst new file mode 100644 index 00000000..7344df97 --- /dev/null +++ b/docs/en/AT_Command_Set/FS_AT_Commands.rst @@ -0,0 +1,129 @@ +.. _FS-AT: + +FileSystem AT Commands +====================== + +:link_to_translation:`zh_CN:[中文]` + +.. list:: + + - :ref:`Introduction ` + - :ref:`AT+FS `: Filesystem Operations. + - :ref:`AT+FSMOUNT `: Mount/Unmount Filesystem. + +.. _cmd-fs-intro: + +Introduction +------------ + +.. important:: + 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: + + - Enable ``Component config`` -> ``AT`` -> ``AT FS command support`` + +.. _cmd-FS: + +:ref:`AT+FS `: Filesystem Operations +--------------------------------------------------------------- + +Set Command +^^^^^^^^^^^ + +**Command:** + +:: + + AT+FS=,,,, + +**Response:** + +:: + + OK + +Parameters +^^^^^^^^^^ + +- ****: only FATFS is currently supported. + + - 0: FATFS + +- ****: + + - 0: delete file. + - 1: write file. + - 2: read file. + - 3: query the size of the file. + - 4: list files in a specific directory. Only root directory is currently supported. + +- ****: apply to writing and reading operations only. +- ****: data length, applying to writing and reading operations only. + +Notes +^^^^^ + +- This command will automatically mount the filesystem. After the :ref:`AT+FS ` filesystem operation is all done, it is strongly recommended to use the :ref:`AT+FSMOUNT=0 ` command to unmount the filesystem to free a large amount of RAM space. +- Please make sure that you have downloaded at_customize.bin before using this command. For more details, refer to `ESP-IDF Partition Tables `_ and :doc:`../Compile_and_Develop/How_to_customize_partitions`. +- If the length of the read data is greater than the actual file length, only the actual data length of the file will be returned. +- If the operator is ``write``, wrap return ``>`` after the write command, then you can send the data that you want to write. The length should be parameter ````. + +Example +^^^^^^^^ + +:: + + // delete a file. + AT+FS=0,0,"filename" + + // write 10 bytes to offset 100 of a file. + AT+FS=0,1,"filename",100,10 + + // read 100 bytes from offset 0 of a file. + AT+FS=0,2,"filename",0,100 + + // list all files in the root directory. + AT+FS=0,4,"." + +.. _cmd-FSMOUNT: + +:ref:`AT+FSMOUNT `: Mount/Unmount Filesystem +------------------------------------------------------ + +Set Command +^^^^^^^^^^^ + +**Command:** + +:: + + AT+FSMOUNT= + +**Response:** + +:: + + OK + +Parameters +^^^^^^^^^^ + +- ****: + + - 0: Unmount filesystem + - 1: Mount filesystem + +Notes +^^^^^ + +- After the :ref:`AT+FS ` filesystem operation is all done, it is strongly recommended to use the :ref:`AT+FSMOUNT=0 ` command to unmount the filesystem to free a large amount of RAM space. + +Example +^^^^^^^^ + +:: + + // unmount the filesystem manually + AT+FSMOUNT=0 + + // mount the filesystem manually + AT+FSMOUNT=1 diff --git a/docs/en/AT_Command_Set/HTTP_AT_Commands.rst b/docs/en/AT_Command_Set/HTTP_AT_Commands.rst index e1dd3916..74c59e68 100644 --- a/docs/en/AT_Command_Set/HTTP_AT_Commands.rst +++ b/docs/en/AT_Command_Set/HTTP_AT_Commands.rst @@ -5,6 +5,7 @@ HTTP AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+HTTPCLIENT `: Send HTTP Client Request - :ref:`AT+HTTPGETSIZE `: Get HTTP Resource Size - :ref:`AT+HTTPCGET `: Get HTTP Resource @@ -14,6 +15,25 @@ HTTP AT Commands - :ref:`AT+HTTPCHEAD `: Set/Query HTTP request headers - :ref:`HTTP AT Error Codes ` +.. _cmd-http-intro: + +Introduction +------------ + +.. only:: esp32 or esp32c3 + + .. important:: + 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: + + - Disable ``Component config`` -> ``AT`` -> ``AT http command support`` + +.. only:: esp32c2 + + .. important:: + **The default {IDF_TARGET_CFG_PREFIX}-4MB AT firmware supports HTTP functionality, while the {IDF_TARGET_CFG_PREFIX}-2MB AT firmware does not.**. If you need {IDF_TARGET_CFG_PREFIX}-2MB 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: + + - Enable ``Component config`` -> ``AT`` -> ``AT http command support`` + .. _cmd-HTTPCLIENT: :ref:`AT+HTTPCLIENT `: Send HTTP Client Request diff --git a/docs/en/AT_Command_Set/MQTT_AT_Commands.rst b/docs/en/AT_Command_Set/MQTT_AT_Commands.rst index 866f704e..65349049 100644 --- a/docs/en/AT_Command_Set/MQTT_AT_Commands.rst +++ b/docs/en/AT_Command_Set/MQTT_AT_Commands.rst @@ -5,6 +5,7 @@ MQTT AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+MQTTUSERCFG `: Set MQTT user configuration - :ref:`AT+MQTTLONGCLIENTID `: Set MQTT client ID - :ref:`AT+MQTTLONGUSERNAME `: Set MQTT username @@ -20,6 +21,16 @@ MQTT AT Commands - :ref:`MQTT AT Error Codes ` - :ref:`MQTT AT Notes ` +.. _cmd-mqtt-intro: + +Introduction +------------ + +.. important:: + 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: + + - Disable ``Component config`` -> ``AT`` -> ``AT MQTT command support`` + .. _cmd-MQTTUSERCFG: :ref:`AT+MQTTUSERCFG `: Set MQTT User Configuration diff --git a/docs/en/AT_Command_Set/Signaling_Test_AT_Commands.rst b/docs/en/AT_Command_Set/Signaling_Test_AT_Commands.rst index 51662541..76ff059b 100644 --- a/docs/en/AT_Command_Set/Signaling_Test_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Signaling_Test_AT_Commands.rst @@ -5,8 +5,19 @@ Signaling Test AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+FACTPLCP `: Send with long or short PLCP (Physical Layer Convergence Procedure) +.. _cmd-signal-test-intro: + +Introduction +------------ + +.. important:: + 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: + + - Disable ``Component config`` -> ``AT`` -> ``AT signaling test command support`` + .. _cmd-FACTPLCP: :ref:`AT+FACTPLCP `: Send with Long or Short PLCP diff --git a/docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst b/docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst index 25b9425c..ea5993f5 100644 --- a/docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst +++ b/docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst @@ -5,6 +5,7 @@ TCP/IP AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+CIPV6 `: Enable/disable the network of Internet Protocol Version 6 (IPv6). - :ref:`AT+CIPSTATE `: Obtain the TCP/UDP/SSL connection information. - :ref:`AT+CIPSTATUS (deprecated) `: Obtain the TCP/UDP/SSL connection status and information. @@ -43,6 +44,18 @@ TCP/IP AT Commands - :ref:`AT+CIPDNS `: Query/Set DNS server information. - :ref:`AT+CIPTCPOPT `: Query/Set the socket options. +.. _cmd-tcpip-intro: + +Introduction +------------ + +.. important:: + 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: + + - Disable OTA commands (:ref:`AT+CIUPDATE ` and :ref:`AT+CIPFWVER `): ``Component config`` -> ``AT`` -> ``AT OTA command support`` + - Disable PING commands (:ref:`AT+PING `): ``Component config`` -> ``AT`` -> ``AT ping command support`` + - 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`` + .. _cmd-IPV6: :ref:`AT+CIPV6 `: Enable/disable the network of Internet Protocol Version 6 (IPv6) diff --git a/docs/en/AT_Command_Set/Web_server_AT_Commands.rst b/docs/en/AT_Command_Set/Web_server_AT_Commands.rst index 93921d52..58812b19 100644 --- a/docs/en/AT_Command_Set/Web_server_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Web_server_AT_Commands.rst @@ -5,8 +5,19 @@ Web Server AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+WEBSERVER `: Enable/disable Wi-Fi connection configuration via Web server. +.. _cmd-web-server-intro: + +Introduction +------------ + +.. important:: + The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support web server 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: + + - Enable ``Component config`` -> ``AT`` -> ``AT Web Server command support`` + .. _cmd-WEBSERVER: :ref:`AT+WEBSERVER `: Enable/disable Wi-Fi connection configuration via Web server diff --git a/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst b/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst index 10c77e49..c4f8dcbc 100644 --- a/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst +++ b/docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst @@ -5,6 +5,7 @@ Wi-Fi AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+CWINIT `: Initialize/Deinitialize Wi-Fi driver. - :ref:`AT+CWMODE `: Set the Wi-Fi mode (Station/SoftAP/Station+SoftAP). - :ref:`AT+CWSTATE `: Query the Wi-Fi state and Wi-Fi information. @@ -33,6 +34,20 @@ Wi-Fi AT Commands - :ref:`AT+CWHOSTNAME `: Query/Set the host name of an {IDF_TARGET_NAME} station. - :ref:`AT+CWCOUNTRY `: Query/Set the Wi-Fi Country Code. +.. _cmd-wifi-intro: + +Introduction +------------ + +.. important:: + The default AT firmware supports all the AT commands except :ref:`AT+CWJEAP ` 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: + + - Enable EAP commands (:ref:`AT+CWJEAP `): ``Component config`` -> ``AT`` -> ``AT WPA2 Enterprise command support`` + - Disable WPS commands (:ref:`AT+WPS `): ``Component config`` -> ``AT`` -> ``AT WPS command support`` + - Disable mDNS commands (:ref:`AT+MDNS `): ``Component config`` -> ``AT`` -> ``AT MDNS command support`` + - Disable smartconfig commands (:ref:`AT+CWSTARTSMART ` and :ref:`AT+CWSTOPSMART `): ``Component config`` -> ``AT`` -> ``AT smartconfig command support`` + - Disable all Wi-Fi commands (Not recommended. Once disabled, all Wi-Fi and above functions will be unusable, and you will need to implement these AT commands yourself): ``Component config`` -> ``AT`` -> ``AT wifi command support`` + .. _cmd-INIT: :ref:`AT+CWINIT `: Initialize or Deinitialize Wi-Fi Driver diff --git a/docs/en/AT_Command_Set/index.rst b/docs/en/AT_Command_Set/index.rst index f9308225..f31a598e 100755 --- a/docs/en/AT_Command_Set/index.rst +++ b/docs/en/AT_Command_Set/index.rst @@ -18,6 +18,7 @@ Here is a list of AT commands. :esp32: Bluetooth® AT Commands MQTT AT Commands HTTP AT Commands + FileSystem AT Commands WebSocket AT Commands :esp32: Ethernet AT Commands Signaling Test AT Commands diff --git a/docs/en/AT_Command_Set/user_at_commands.rst b/docs/en/AT_Command_Set/user_at_commands.rst index efb2c50a..28b9c6ce 100644 --- a/docs/en/AT_Command_Set/user_at_commands.rst +++ b/docs/en/AT_Command_Set/user_at_commands.rst @@ -5,12 +5,23 @@ User AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+USERRAM `: Operate user's free RAM. - :ref:`AT+USEROTA `: Upgrade the firmware according to the specified URL. - :ref:`AT+USERWKMCUCFG `: Configure how AT wakes up MCU. - :ref:`AT+USERMCUSLEEP `: MCU indicates its sleep state. - :ref:`AT+USERDOCS `: Query the ESP-AT user guide for current firmware. +.. _cmd-user-intro: + +Introduction +------------ + +.. important:: + The default AT firmware supports all the AT commands mentioned on this page. If you don't need {IDF_TARGET_NAME} to support user 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: + + - Disable ``Component config`` -> ``AT`` -> ``AT user command support`` + .. _cmd-USERRAM: :ref:`AT+USERRAM `: Operate user's free RAM diff --git a/docs/en/AT_Command_Set/websocket_at_commands.rst b/docs/en/AT_Command_Set/websocket_at_commands.rst index 72091bc2..beee0ca7 100644 --- a/docs/en/AT_Command_Set/websocket_at_commands.rst +++ b/docs/en/AT_Command_Set/websocket_at_commands.rst @@ -5,11 +5,22 @@ WebSocket AT Commands :link_to_translation:`zh_CN:[中文]` +- :ref:`Introduction ` - :ref:`AT+WSCFG `: Set the WebSocket configuration. - :ref:`AT+WSOPEN `: Query/Open a WebSocket connection. - :ref:`AT+WSSEND `: Send data to a WebSocket connection. - :ref:`AT+WSCLOSE `: Close a WebSocket connection. +.. _cmd-ws-intro: + +Introduction +------------ + +.. important:: + The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support WebSocket 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: + + - Enable ``Component config`` -> ``AT`` -> ``AT WebSocket command support`` + .. _cmd-WSCFG: :ref:`AT+WSCFG `: Set the WebSocket Configuration diff --git a/docs/en/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst b/docs/en/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst index edf57fbd..84c4abee 100644 --- a/docs/en/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst +++ b/docs/en/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst @@ -5,6 +5,12 @@ RainMaker AT Command Set :link_to_translation:`zh_CN:[中文]` +.. important:: + The default AT firmware does not support the AT commands listed on this page. If you need {IDF_TARGET_NAME} to support RainMaker commands, you have two options: + + - Refer to the :doc:`How to Download the Latest Temporary Version of AT Firmware from GitHub <../../Compile_and_Develop/How_to_download_the_latest_temporary_version_of_AT_from_github>` documentation to download the esp32c3-rainmaker-at firmware. + - Compile the ESP-AT project yourself by following the steps in :doc:`Compiling the ESP-AT Project `. During the third step (Install Environment), choose "PLATFORM_ESP32C3" for the "Platform name" and choose "ESP32C3_RAINMAKER" for the "Module name". + - :ref:`AT+RMNODEINIT `: Initialize the node. - :ref:`AT+RMNODEATTR `: Attributes operations. - :ref:`AT+RMDEV `: Device operations. diff --git a/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst index 4190f2d4..a3f68998 100644 --- a/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/BLE_AT_Commands.rst @@ -5,26 +5,9 @@ Bluetooth® Low Energy AT 命令集 :link_to_translation:`en:[English]` -.. only:: esp32 - - 当前，{IDF_TARGET_NAME} 系列 AT 固件支持 `蓝牙核心规范 4.2 版本 `_。 - -.. only:: esp32c3 - - 当前， {IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 5.0 版本 `_。 - -.. only:: esp32c2 - - 当前， {IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 5.0 版本 `_。 - - .. attention:: - **{IDF_TARGET_CFG_PREFIX}-4MB AT 固件支持 BluFi，而 {IDF_TARGET_CFG_PREFIX}-2MB AT 固件不支持 BluFi**。如果您需要 {IDF_TARGET_CFG_PREFIX}-2MB 支持 BluFi 功能，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： - - - ``Component config`` -> ``Bluetooth`` -> ``Bluetooth`` -> ``Host`` -> ``NimBLE`` - ``BLE only`` - - ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable blufi functionality`` - .. list:: + :esp32 or esp32c3 or esp32c2: - :ref:`介绍 ` :esp32 or esp32c3 or esp32c2: - :ref:`AT+BLEINIT `：Bluetooth LE 初始化 :esp32 or esp32c3 or esp32c2: - :ref:`AT+BLEADDR `：设置 Bluetooth LE 设备地址 :esp32 or esp32c3 or esp32c2: - :ref:`AT+BLENAME `：查询/设置 Bluetooth LE 设备名称 @@ -80,6 +63,59 @@ Bluetooth® Low Energy AT 命令集 :esp32c3 or esp32c2: - :ref:`AT+BLEREADPHY `：查询当前连接使用的 PHY :esp32c3 or esp32c2: - :ref:`AT+BLESETPHY `：设置当前连接使用的 PHY +.. _cmd-ble-intro: + +介绍 +------ + +.. only:: esp32 + + 当前，{IDF_TARGET_NAME} 系列 AT 固件支持 `蓝牙核心规范 4.2 版本 `_。 + +.. only:: esp32c2 or esp32c3 + + 当前， {IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 5.0 版本 `_。 + +.. only:: esp32 or esp32c3 + + .. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。如果您需要修改 {IDF_TARGET_NAME} 默认支持的命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 BluFi 命令：``Component config`` -> ``AT`` -> ``AT blufi command support`` + - 禁用 Bluetooth LE 命令：``Component config`` -> ``AT`` -> ``AT ble command support`` + - 禁用 Bluetooth LE HID 命令： ``Component config`` -> ``AT`` -> ``AT ble hid command support`` + +.. only:: esp32c2 + + .. important:: + 默认的 {IDF_TARGET_CFG_PREFIX}-4MB AT 固件支持 BluFi 功能，而 {IDF_TARGET_CFG_PREFIX}-2MB AT 固件不支持 BluFi 功能。如果您需要 {IDF_TARGET_CFG_PREFIX}-2MB 支持 BluFi 功能，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 ``Component config`` -> ``Bluetooth`` + - 启用 ``Component config`` -> ``Bluetooth`` -> ``Bluetooth`` -> ``Host`` -> ``NimBLE`` - ``BLE only`` + - 启用 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable blufi functionality`` + - 启用 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Enable BLE 5 feature`` -> ``Enable extended advertising`` + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Maximum number of concurrent connections`` -> 1 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_1_Block Count`` -> 10 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_1_Block Size`` -> 100 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``MSYS_2_Block Count`` -> 4 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``ACL Buffer Count`` -> 5 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``High Priority HCI Event Buffer count`` -> 5 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Memory Settings`` -> ``Low Priority HCI Event Buffer count`` -> 3 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``BLE white list size`` -> 1 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``Controller Options`` -> ``BLE LL Resolving list size`` -> 1 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``Controller Options`` -> ``BLE duplicate scan list count`` -> 1 + + .. important:: + 默认的 {IDF_TARGET_CFG_PREFIX}-4MB AT 固件 和 {IDF_TARGET_CFG_PREFIX}-2MB AT 固件均不支持 Bluetooth LE 功能。如果您需要支持 Bluetooth LE 功能，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里除了需要开启上面的 BluFi 功能外，另外选择： + + - 启用 Bluetooth LE 命令：``Component config`` -> ``AT`` -> ``AT ble command support`` + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Maximum length of BLE device name in octets`` -> 32 + - 设置 ``Component config`` -> ``Bluetooth`` -> ``NimBLE Options`` -> ``Preferred MTU size in octets`` -> 203 + + 如果编译提示 ``Part 'ota_0' 0/16 @ 0xd0000 size 0x130000 (overflow 0x59a0)`` 类似错误，则您需要根据自己的应用场景，在 ``Component config`` -> ``AT`` 里关闭不需要的功能，以便减小固件大小。 + + 由于内存受限，请在使用 Bluetooth LE 功能之前，发送 :ref:`AT+CWINIT=0 ` 命令禁用 Wi-Fi 协议栈。 + .. only:: esp32 or esp32c3 or esp32c2 .. _cmd-BINIT: diff --git a/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst index afed2888..33224ef3 100644 --- a/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/BT_AT_Commands.rst @@ -5,8 +5,7 @@ :link_to_translation:`en:[English]` -{IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 4.2 版本 `_。 - +- :ref:`介绍 ` - :ref:`AT+BTINIT `：Classic Bluetooth 初始化 - :ref:`AT+BTNAME `：查询/设置 Classic Bluetooth 设备名称 - :ref:`AT+BTSCANMODE `：设置 Classic Bluetooth 扫描模式 @@ -30,6 +29,20 @@ - :ref:`AT+BTCOD `：设置设备类型 - :ref:`AT+BTPOWER `：查询/设置 Classic Bluetooth 的 TX 功率 +.. _cmd-bt-intro: + +介绍 +------ + +{IDF_TARGET_NAME} AT 固件支持 `蓝牙核心规范 4.2 版本 `_。 + +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持经典蓝牙命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用通用蓝牙命令：``Component config`` -> ``AT`` -> ``AT bt command support`` + - 启用 SPP 命令： ``Component config`` -> ``AT`` -> ``AT bt command support`` -> ``AT bt spp command support`` + - 启用 A2DP 命令：``Component config`` -> ``AT`` -> ``AT bt command support`` -> ``AT bt a2dp command support`` + .. _cmd-BTINIT: :ref:`AT+BTINIT `：Classic Bluetooth 初始化 diff --git a/docs/zh_CN/AT_Command_Set/Basic_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Basic_AT_Commands.rst index 3cf2b372..073e868c 100644 --- a/docs/zh_CN/AT_Command_Set/Basic_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Basic_AT_Commands.rst @@ -1,12 +1,13 @@ .. _Basic-AT: -基础 AT 命令 +基础 AT 命令集 ================= :link_to_translation:`en:[English]` .. list:: + - :ref:`介绍 ` - :ref:`AT `：测试 AT 启动 - :ref:`AT+RST `：重启模块 - :ref:`AT+GMR `：查看版本信息 @@ -25,8 +26,6 @@ - :ref:`AT+SYSMSGFILTERCFG `：查询/配置 :term:`系统消息` 的过滤器 - :ref:`AT+SYSFLASH `：查询或读写 flash 用户分区 - :ref:`AT+SYSMFG `：查询或读写 :term:`manufacturing nvs` 用户分区 - - :ref:`AT+FS `：文件系统操作 - - :ref:`AT+FSMOUNT `：挂载/卸载文件系统 - :ref:`AT+RFPOWER `：查询/设置 RF TX Power - :ref:`AT+SYSROLLBACK `：回滚到以前的固件 - :ref:`AT+SYSTIMESTAMP `：查询/设置本地时间戳 @@ -36,6 +35,14 @@ - :ref:`AT+SYSREG `：读写寄存器 :esp32c3: - :ref:`AT+SYSTEMP `：读取芯片内部摄氏温度值 +.. _cmd-basic-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。 + .. _cmd-AT: :ref:`AT `：测试 AT 启动 @@ -1521,113 +1528,6 @@ // 等待串口返回 > 后，写入 1164 字节的证书文件 -.. _cmd-FS: - -:ref:`AT+FS `：文件系统操作 ---------------------------------------------------------------- - -设置命令 -^^^^^^^^ - -**命令：** - -:: - - AT+FS=,,,, - -**响应：** - -:: - - OK - -参数 -^^^^ - -- ****：目前仅支持 FATFS - - - 0：FATFS - -- ****: - - - 0：删除文件 - - 1：写文件 - - 2：读文件 - - 3：查询文件大小 - - 4：查询路径下文件，目前仅支持根目录 - -- ****：偏移地址，仅针对读写操作设置 -- ****：长度，仅针对读写操作设置 - -说明 -^^^^ - -- 本命令会自动挂载文件系统。:ref:`AT+FS ` 文件系统操作完成后，强烈建议使用 :ref:`AT+FSMOUNT=0 ` 命令卸载文件系统，来释放大量 RAM 空间。 -- 使用本命令需烧录 at_customize.bin，详细信息可参考 `ESP-IDF 分区表 `_ 和 :doc:`../Compile_and_Develop/How_to_customize_partitions`。 -- 若读取数据的长度大于实际文件大小，仅返回实际长度的数据。 -- 当 ```` 为 ``write`` 时，系统收到此命令后先换行返回 ``>``，此时您可以输入要写的数据，数据长度应与 ```` 一致。 - -示例 -^^^^ - -:: - - // 删除某个文件 - AT+FS=0,0,"filename" - - // 在某个文件偏移地址 100 处写入 10 字节 - AT+FS=0,1,"filename",100,10 - - // 从某个文件偏移地址 0 处读取 100 字节 - AT+FS=0,2,"filename",0,100 - - // 列出根目录下所有文件 - AT+FS=0,4,"." - -.. _cmd-FSMOUNT: - -:ref:`AT+FSMOUNT `：挂载/卸载 FS 文件系统 ---------------------------------------------------------------- - -设置命令 -^^^^^^^^ - -**命令：** - -:: - - AT+FSMOUNT= - -**响应：** - -:: - - OK - -参数 -^^^^ - -- ****： - - - 0：卸载 FS 文件系统 - - 1：挂载 FS 文件系统 - -说明 -^^^^ - -- :ref:`AT+FS ` 文件系统操作完成后，强烈建议使用本命令 :ref:`AT+FSMOUNT=0 ` 命令卸载文件系统，来释放大量 RAM 空间。 - -示例 -^^^^ - -:: - - // 手动卸载文件系统 - AT+FSMOUNT=0 - - // 手动挂载文件系统 - AT+FSMOUNT=1 - .. _cmd-RFPOWER: :ref:`AT+RFPOWER `：查询/设置 RF TX Power diff --git a/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst index 97c61e32..738e7c21 100644 --- a/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Driver_AT_Commands.rst @@ -5,6 +5,7 @@ :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+DRVADC `：读取 ADC 通道值 - :ref:`AT+DRVPWMINIT `：初始化 PWM 驱动器 - :ref:`AT+DRVPWMDUTY `：设置 PWM 占空比 @@ -18,6 +19,16 @@ - :ref:`AT+DRVSPIRD `：读取 SPI 数据 - :ref:`AT+DRVSPIWR `：写入 SPI 数据 +.. _cmd-driver-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持驱动命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 ``Component config`` -> ``AT`` -> ``AT driver command support`` + .. _cmd-DRVADC: :ref:`AT+DRVADC `：读取 ADC 通道值 diff --git a/docs/zh_CN/AT_Command_Set/Ethernet_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Ethernet_AT_Commands.rst index 9d387a28..8e1ec53a 100644 --- a/docs/zh_CN/AT_Command_Set/Ethernet_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Ethernet_AT_Commands.rst @@ -7,10 +7,19 @@ :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`准备工作 ` - :ref:`AT+CIPETHMAC `：查询/设置 {IDF_TARGET_NAME} 以太网的 MAC 地址 - :ref:`AT+CIPETH `：查询/设置 {IDF_TARGET_NAME} 以太网的 IP 地址 +.. _cmd-eth-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持以太网命令，请参考 :doc:`../Compile_and_Develop/How_to_enable_ESP_AT_Ethernet` 文档自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`。 + .. _cmd-ETHPRE: :ref:`准备工作 ` diff --git a/docs/zh_CN/AT_Command_Set/FS_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/FS_AT_Commands.rst new file mode 100644 index 00000000..9f4320e5 --- /dev/null +++ b/docs/zh_CN/AT_Command_Set/FS_AT_Commands.rst @@ -0,0 +1,129 @@ +.. _FS-AT: + +文件系统 AT 命令集 +=================== + +:link_to_translation:`en:[English]` + +.. list:: + + - :ref:`介绍 ` + - :ref:`AT+FS `：文件系统操作 + - :ref:`AT+FSMOUNT `：挂载/卸载文件系统 + +.. _cmd-fs-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持文件系统命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 ``Component config`` -> ``AT`` -> ``AT FS command support`` + +.. _cmd-FS: + +:ref:`AT+FS `：文件系统操作 +--------------------------------------------------------------- + +设置命令 +^^^^^^^^ + +**命令：** + +:: + + AT+FS=,,,, + +**响应：** + +:: + + OK + +参数 +^^^^ + +- ****：目前仅支持 FATFS + + - 0：FATFS + +- ****: + + - 0：删除文件 + - 1：写文件 + - 2：读文件 + - 3：查询文件大小 + - 4：查询路径下文件，目前仅支持根目录 + +- ****：偏移地址，仅针对读写操作设置 +- ****：长度，仅针对读写操作设置 + +说明 +^^^^ + +- 本命令会自动挂载文件系统。:ref:`AT+FS ` 文件系统操作完成后，强烈建议使用 :ref:`AT+FSMOUNT=0 ` 命令卸载文件系统，来释放大量 RAM 空间。 +- 使用本命令需烧录 at_customize.bin，详细信息可参考 `ESP-IDF 分区表 `_ 和 :doc:`../Compile_and_Develop/How_to_customize_partitions`。 +- 若读取数据的长度大于实际文件大小，仅返回实际长度的数据。 +- 当 ```` 为 ``write`` 时，系统收到此命令后先换行返回 ``>``，此时您可以输入要写的数据，数据长度应与 ```` 一致。 + +示例 +^^^^ + +:: + + // 删除某个文件 + AT+FS=0,0,"filename" + + // 在某个文件偏移地址 100 处写入 10 字节 + AT+FS=0,1,"filename",100,10 + + // 从某个文件偏移地址 0 处读取 100 字节 + AT+FS=0,2,"filename",0,100 + + // 列出根目录下所有文件 + AT+FS=0,4,"." + +.. _cmd-FSMOUNT: + +:ref:`AT+FSMOUNT `：挂载/卸载 FS 文件系统 +--------------------------------------------------------------- + +设置命令 +^^^^^^^^ + +**命令：** + +:: + + AT+FSMOUNT= + +**响应：** + +:: + + OK + +参数 +^^^^ + +- ****： + + - 0：卸载 FS 文件系统 + - 1：挂载 FS 文件系统 + +说明 +^^^^ + +- :ref:`AT+FS ` 文件系统操作完成后，强烈建议使用本命令 :ref:`AT+FSMOUNT=0 ` 命令卸载文件系统，来释放大量 RAM 空间。 + +示例 +^^^^ + +:: + + // 手动卸载文件系统 + AT+FSMOUNT=0 + + // 手动挂载文件系统 + AT+FSMOUNT=1 diff --git a/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst index 75f74042..f002505b 100644 --- a/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/HTTP_AT_Commands.rst @@ -5,6 +5,7 @@ HTTP AT 命令集 :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+HTTPCLIENT `：发送 HTTP 客户端请求 - :ref:`AT+HTTPGETSIZE `：获取 HTTP 资源大小 - :ref:`AT+HTTPCGET `：获取 HTTP 资源 @@ -14,6 +15,25 @@ HTTP AT 命令集 - :ref:`AT+HTTPCHEAD `：设置/查询 HTTP 请求头 - :ref:`HTTP AT 错误码 ` +.. _cmd-http-intro: + +介绍 +------ + +.. only:: esp32 or esp32c3 + + .. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。如果您不需要 {IDF_TARGET_NAME} 支持 HTTP 命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 ``Component config`` -> ``AT`` -> ``AT http command support`` + +.. only:: esp32c2 + + .. important:: + **默认的 {IDF_TARGET_CFG_PREFIX}-4MB AT 固件支持 HTTP 命令，而 {IDF_TARGET_CFG_PREFIX}-2MB AT 固件不支持**。如果您需要 {IDF_TARGET_CFG_PREFIX}-2MB 支持 HTTP 功能，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 ``Component config`` -> ``AT`` -> ``AT http command support`` + .. _cmd-HTTPCLIENT: :ref:`AT+HTTPCLIENT `：发送 HTTP 客户端请求 diff --git a/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst index 67c5e81e..974430cc 100644 --- a/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/MQTT_AT_Commands.rst @@ -5,6 +5,7 @@ MQTT AT 命令集 :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+MQTTUSERCFG `：设置 MQTT 用户属性 - :ref:`AT+MQTTLONGCLIENTID `：设置 MQTT 客户端 ID - :ref:`AT+MQTTLONGUSERNAME `：设置 MQTT 登陆用户名 @@ -20,6 +21,16 @@ MQTT AT 命令集 - :ref:`MQTT AT 错误码 ` - :ref:`MQTT AT 说明 ` +.. _cmd-mqtt-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。如果您不需要 {IDF_TARGET_NAME} 支持 MQTT 命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 ``Component config`` -> ``AT`` -> ``AT MQTT command support`` + .. _cmd-MQTTUSERCFG: :ref:`AT+MQTTUSERCFG `：设置 MQTT 用户属性 diff --git a/docs/zh_CN/AT_Command_Set/Signaling_Test_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Signaling_Test_AT_Commands.rst index e6289a01..c752d4b5 100644 --- a/docs/zh_CN/AT_Command_Set/Signaling_Test_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Signaling_Test_AT_Commands.rst @@ -5,8 +5,19 @@ :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+FACTPLCP `：发送长 PLCP 或短 PLCP +.. _cmd-signal-test-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。如果您不需要 {IDF_TARGET_NAME} 支持信令测试命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 ``Component config`` -> ``AT`` -> ``AT signaling test command support`` + .. _cmd-FACTPLCP: :ref:`AT+FACTPLCP `：发送长 PLCP 或短 PLCP diff --git a/docs/zh_CN/AT_Command_Set/TCP-IP_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/TCP-IP_AT_Commands.rst index 85ae7f01..7d9a955c 100644 --- a/docs/zh_CN/AT_Command_Set/TCP-IP_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/TCP-IP_AT_Commands.rst @@ -5,6 +5,7 @@ TCP/IP AT 命令 :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+CIPV6 `: 启用/禁用 IPv6 网络 (IPv6) - :ref:`AT+CIPSTATE `：查询 TCP/UDP/SSL 连接信息 - :ref:`AT+CIPSTATUS (弃用) `：查询 TCP/UDP/SSL 连接状态和信息 @@ -43,6 +44,18 @@ TCP/IP AT 命令 - :ref:`AT+CIPDNS `：查询/设置 DNS 服务器信息 - :ref:`AT+CIPTCPOPT `：查询/设置套接字选项 +.. _cmd-tcpip-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。如果您需要修改 {IDF_TARGET_NAME} 默认支持的命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 OTA 命令（:ref:`AT+CIUPDATE `、:ref:`AT+CIPFWVER `）：``Component config`` -> ``AT`` -> ``AT OTA command support`` + - 禁用 PING 命令（:ref:`AT+PING `）：``Component config`` -> ``AT`` -> ``AT ping command support`` + - 禁用 TCP/IP 命令（不推荐。一旦禁用，所有 TCP/IP 功能将无法使用，您需要自行实现这些 AT 命令）： ``Component config`` -> ``AT`` -> ``AT net command support`` + .. _cmd-IPV6: :ref:`AT+CIPV6 `: 启用/禁用 IPv6 网络 (IPv6) diff --git a/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst index 3ce00409..e3f1c8cd 100644 --- a/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Web_server_AT_Commands.rst @@ -5,8 +5,19 @@ Web 服务器 AT 命令 :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+WEBSERVER `: 启用/禁用通过 Web 服务器配置 Wi-Fi 连接 +.. _cmd-web-server-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持 Web 服务器命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 ``Component config`` -> ``AT`` -> ``AT Web Server command support`` + .. _cmd-WEBSERVER: :ref:`AT+WEBSERVER `: 启用/禁用通过 Web 服务器配置 Wi-Fi 连接 diff --git a/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst b/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst index 978dec0f..10dac3e4 100644 --- a/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst +++ b/docs/zh_CN/AT_Command_Set/Wi-Fi_AT_Commands.rst @@ -5,6 +5,7 @@ Wi-Fi AT 命令集 :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+CWINIT `：初始化/清理 Wi-Fi 驱动程序 - :ref:`AT+CWMODE `：查询/设置 Wi-Fi 模式 (Station/SoftAP/Station+SoftAP) - :ref:`AT+CWSTATE `：查询 Wi-Fi 状态和 Wi-Fi 信息 @@ -33,6 +34,20 @@ Wi-Fi AT 命令集 - :ref:`AT+CWHOSTNAME `：查询/设置 {IDF_TARGET_NAME} Station 的主机名称 - :ref:`AT+CWCOUNTRY `：查询/设置 Wi-Fi 国家代码 +.. _cmd-wifi-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件支持此页面下除 :ref:`AT+CWJEAP ` 之外的所有 AT 命令。如果您需要修改 {IDF_TARGET_NAME} 默认支持的命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 EAP 命令（:ref:`AT+CWJEAP `）： ``Component config`` -> ``AT`` -> ``AT WPA2 Enterprise command support`` + - 禁用 WPS 命令（:ref:`AT+WPS `）：``Component config`` -> ``AT`` -> ``AT WPS command support`` + - 禁用 mDNS 命令（:ref:`AT+MDNS `）：``Component config`` -> ``AT`` -> ``AT MDNS command support`` + - 禁用 smartconfig 命令（:ref:`AT+CWSTARTSMART `、:ref:`AT+CWSTOPSMART `）：``Component config`` -> ``AT`` -> ``AT smartconfig command support`` + - 禁用所有 Wi-Fi 命令（不推荐。一旦禁用，所有 Wi-Fi 以及以上的功能将无法使用，您需要自行实现这些 AT 命令）： ``Component config`` -> ``AT`` -> ``AT wifi command support`` + .. _cmd-INIT: :ref:`AT+CWINIT `：初始化/清理 Wi-Fi 驱动程序 diff --git a/docs/zh_CN/AT_Command_Set/index.rst b/docs/zh_CN/AT_Command_Set/index.rst index b0c079a7..eb55399c 100755 --- a/docs/zh_CN/AT_Command_Set/index.rst +++ b/docs/zh_CN/AT_Command_Set/index.rst @@ -18,6 +18,7 @@ AT 命令集 :esp32: Bluetooth® AT 命令集 MQTT AT 命令集 HTTP AT 命令集 + 文件系统 AT 命令集 WebSocket AT 命令集 :esp32: 以太网 AT 命令集 信令测试 AT 命令集 diff --git a/docs/zh_CN/AT_Command_Set/user_at_commands.rst b/docs/zh_CN/AT_Command_Set/user_at_commands.rst index d5ab6fd5..66e1aab7 100644 --- a/docs/zh_CN/AT_Command_Set/user_at_commands.rst +++ b/docs/zh_CN/AT_Command_Set/user_at_commands.rst @@ -5,12 +5,23 @@ :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+USERRAM `：操作用户的空闲 RAM - :ref:`AT+USEROTA `：根据指定 URL 升级固件 - :ref:`AT+USERWKMCUCFG `：设置 AT 唤醒 MCU 的配置 - :ref:`AT+USERMCUSLEEP `：MCU 指示自己睡眠状态 - :ref:`AT+USERDOCS `：查询固件对应的用户文档链接 +.. _cmd-user-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件支持此页面下的所有 AT 命令。如果您不需要 {IDF_TARGET_NAME} 支持用户命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 禁用 ``Component config`` -> ``AT`` -> ``AT user command support`` + .. _cmd-USERRAM: :ref:`AT+USERRAM `: 操作用户的空闲 RAM diff --git a/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst b/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst index 46f997d1..d69bc6b7 100644 --- a/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst +++ b/docs/zh_CN/AT_Command_Set/websocket_at_commands.rst @@ -5,11 +5,22 @@ WebSocket AT 命令集 :link_to_translation:`en:[English]` +- :ref:`介绍 ` - :ref:`AT+WSCFG `：配置 WebSocket 参数 - :ref:`AT+WSOPEN `：查询/打开 WebSocket 连接 - :ref:`AT+WSSEND `：向 WebSocket 连接发送数据 - :ref:`AT+WSCLOSE `：关闭 WebSocket 连接 +.. _cmd-ws-intro: + +介绍 +------ + +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持 WebSocket 命令，请自行 :doc:`编译 ESP-AT 工程 <../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第五步配置工程里选择： + + - 启用 ``Component config`` -> ``AT`` -> ``AT WebSocket command support`` + .. _cmd-WSCFG: :ref:`AT+WSCFG `：配置 WebSocket 参数 diff --git a/docs/zh_CN/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst b/docs/zh_CN/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst index 66c910f0..af72233e 100644 --- a/docs/zh_CN/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst +++ b/docs/zh_CN/Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst @@ -5,6 +5,12 @@ RainMaker AT 命令集 :link_to_translation:`en:[English]` +.. important:: + 默认的 AT 固件不支持此页面下的 AT 命令。如果您需要 {IDF_TARGET_NAME} 支持 RainMaker 命令，请任选下面一种方式： + + - 参考 :doc:`如何从 GitHub 下载最新临时版本 AT 固件 <../../Compile_and_Develop/How_to_download_the_latest_temporary_version_of_AT_from_github>` 文档，下载 esp32c3-rainmaker-at 固件 + - 自行 :doc:`编译 ESP-AT 工程 <../../Compile_and_Develop/How_to_clone_project_and_compile_it>`，在第三步安装环境里 ``Platform name`` 选择 PLATFORM_ESP32C3，``Module name`` 选择 ESP32C3_RAINMAKER。 + - :ref:`AT+RMNODEINIT `：初始化节点 - :ref:`AT+RMNODEATTR `：属性信息操作 - :ref:`AT+RMDEV `：设备操作