diff --git a/docs/Application_guide/en/README.md b/docs/Application_guide/en/README.md index cea0c60f2fc5d8d8489438962cad55f812b849f4..1df0015c33e6f6f5b83bc7b7ca0fb91d2eea5cc6 100644 --- a/docs/Application_guide/en/README.md +++ b/docs/Application_guide/en/README.md @@ -7,7 +7,7 @@ QuecPython Application Guide is a guide on how to use the commonly used function
Background Knowledge -- [Introduction to IoT and Low-code Development](background/iot-and-low-code.md) +- [Introduction to IoT and Low Code Development](background/iot-and-low-code.md) - [Introduction to Wireless Communication Modules](background/wireless-modules.md) @@ -104,7 +104,7 @@ QuecPython Application Guide is a guide on how to use the commonly used function
Helios SDK -- [Helios SDK Development Guide - Beginner](helios-sdk/quick-start.md) -- [Helios SDK Development Guide - Intermediate](helios-sdk/junior.md) -- [Helios SDK Development Guide - Advanced](helios-sdk/advanced.md) +- [Helios SDK Development Guide__Beginner](helios-sdk/quick-start.md) +- [Helios SDK Development Guide__Intermediate](helios-sdk/junior.md) +- [Helios SDK Development Guide__Advanced](helios-sdk/advanced.md)
diff --git a/docs/Application_guide/en/background/project-dev.md b/docs/Application_guide/en/background/project-dev.md index 1a3cbe02098f9da5b428bd0d91a272bc82eafaa9..c7de9a692d2e6aac7c5f16a7f204b14415a320e4 100644 --- a/docs/Application_guide/en/background/project-dev.md +++ b/docs/Application_guide/en/background/project-dev.md @@ -1 +1,3 @@ +# Project Development Process + ![](../media/background/project-dev/project.png) \ No newline at end of file diff --git a/docs/Application_guide/en/dev-tools/Thonny/README.md b/docs/Application_guide/en/dev-tools/Thonny/README.md index 8297f204070b46fc2cb467901a3a2f0b4e6baf04..f79f126d36f520286f2834bd27c6260b77404d95 100644 --- a/docs/Application_guide/en/dev-tools/Thonny/README.md +++ b/docs/Application_guide/en/dev-tools/Thonny/README.md @@ -141,7 +141,7 @@ Click "`select`" in the plugin bar to choose the firmware file you want to downl With Thonny, you can directly write and debug code through the REPL, or edit script files for execution and debugging. -### Select and Configure Interpreter +### Select & Configure Interpreter In the menu bar, select "**`Run`**" --> "**`Configure interpreter`**" --> "**`QuecPython(generic)`**" diff --git a/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md b/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md index a4030de4c3db6d9313b5ad5279e8d7730e0b1705..c82a3c66c4a529675909671483d9ffbb0e7c5ffe 100644 --- a/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md +++ b/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md @@ -39,12 +39,12 @@ The following steps are demonstrated based on the [U-235 development board](http - Use the shortcut `Ctrl+Shift+P` to open the command palette, type `> QuecPython` in it, and select `QuecPython: Focus on Firmware Manager View` from the options, as shown below: - ![cmd-palette.png](../../media/dev-tools/VSCode-Plugin-quecpython/cmd-palette.png) + ![cmd-palette.png](../../media/dev-tools/VSCode-Plugin-quecpython/cmd-palette.png) The firmware flashing interface on the primary sidebar is shown in the following image: -![fw-flash-ui.png](../../media/dev-tools/VSCode-Plugin-quecpython/fw-flash-ui.png) + ![fw-flash-ui.png](../../media/dev-tools/VSCode-Plugin-quecpython/fw-flash-ui.png) 2. **Select Firmware** @@ -52,7 +52,7 @@ The following steps are demonstrated based on the [U-235 development board](http The path to the firmware package will be displayed on the interface: -![selected-fw-path.png](../../media/dev-tools/VSCode-Plugin-quecpython/selected-fw-path.png) + ![selected-fw-path.png](../../media/dev-tools/VSCode-Plugin-quecpython/selected-fw-path.png) 3. **Flash Firmware** @@ -126,7 +126,7 @@ The following steps are demonstrated based on the [U-235 development board](http Press the up or down arrow keys to move the cursor to the desired interface, and press the `Tab` or `Enter` key to complete the code in the `test.py` file. -![code-auto-completed.gif](../../media/dev-tools/VSCode-Plugin-quecpython/code-auto-completed.gif) + ![code-auto-completed.gif](../../media/dev-tools/VSCode-Plugin-quecpython/code-auto-completed.gif) ### File Transfer @@ -149,7 +149,7 @@ During the file transfer process, a pop-up window appears in the bottom right co The imported file `test.py` is shown in the following image: - ![directory-list.png](../../media/dev-tools/VSCode-Plugin-quecpython/directory-list.png) +![directory-list.png](../../media/dev-tools/VSCode-Plugin-quecpython/directory-list.png) ### Run Script File diff --git a/docs/Application_guide/en/hardware/display/touch_screen.md b/docs/Application_guide/en/hardware/display/touch_screen.md index 6169b1cc38fd63b0e6d1455cdfed07b0c48efbe0..b31834f591e6a55908fa48b3c4f972fdc9d0857a 100644 --- a/docs/Application_guide/en/hardware/display/touch_screen.md +++ b/docs/Application_guide/en/hardware/display/touch_screen.md @@ -1,5 +1,5 @@ -## Touchscreen +## Touch Screen In embedded devices, a touchscreen is a common input device used to replace a mouse or other pointing devices for interacting with and controlling the device's interface. It is typically a flat surface on which users can touch and slide their fingers to perform corresponding actions. diff --git a/docs/Application_guide/en/media/network-comm/net-protocols/tcp-udp/osi-7-layers-en.png b/docs/Application_guide/en/media/network-comm/net-protocols/tcp-udp/osi-7-layers-en.png new file mode 100644 index 0000000000000000000000000000000000000000..0c81f9ce425d900f04c2967be753353058cb1b91 Binary files /dev/null and b/docs/Application_guide/en/media/network-comm/net-protocols/tcp-udp/osi-7-layers-en.png differ diff --git a/docs/Application_guide/en/media/network-comm/net-protocols/tcp-udp/tcpip-4-layers-en.png b/docs/Application_guide/en/media/network-comm/net-protocols/tcp-udp/tcpip-4-layers-en.png new file mode 100644 index 0000000000000000000000000000000000000000..013d3ee1806e5adff99038fcfdc5a84ddcb67dc9 Binary files /dev/null and b/docs/Application_guide/en/media/network-comm/net-protocols/tcp-udp/tcpip-4-layers-en.png differ diff --git a/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md b/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md index 9dd3befb21bf44d2ee62245869af702de90c3a1d..3933857465bdb6982396ad6092866f18970d36c6 100644 --- a/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md +++ b/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md @@ -20,11 +20,11 @@ The Open System Interconnection (OSI) model defined by the International Organiz The seven layers are "Application Layer", "Presentation Layer", "Session Layer", "Transport Layer", "Network Layer", "Data Link Layer", and "Physical Layer". -![](../../media/network-comm/net-protocols/tcp-udp/osi-7-layers.png) +![](../../media/network-comm/net-protocols/tcp-udp/osi-7-layers-en.png) To simplify protocol implementation or facilitate understanding, the models of five layers or four layers have emerged. The four-layer model is generally mentioned more frequently, including "Application Layer", "Transport Layer", "Network Layer" and "Network Interface Layer". -![](../../media/network-comm/net-protocols/tcp-udp/tcpip-4-layers.png) +![](../../media/network-comm/net-protocols/tcp-udp/tcpip-4-layers-en.png) The IP address mentioned earlier belongs to the network layer. diff --git a/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md b/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md index 061a992f8fe8100f0e0016e87513a69da2c0bf6d..a34e8956d8fb4fde7f017583e5eeae5ed1b8327a 100644 --- a/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md +++ b/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md @@ -120,9 +120,9 @@ The following examples demonstrate two methods of TCP communication using Ethern **TCP client binds Ethernet NIC for communication** -In this example, the module performs TCP communication by using the Ethernet NIC and calls *sock.bind()* in the socket module to specify the Ethernet NIC for data sending. +In this example, the module performs TCP communication by using the Ethernet NIC and calls `sock.bind()` in the socket module to specify the Ethernet NIC for data sending. ->In the example below, the parameter 192.168.1.100 in *sock.bind()* specifies the IP address of the Ethernet NIC. +>In the example below, the parameter 192.168.1.100 in `sock.bind()` specifies the IP address of the Ethernet NIC. ```python # Import the usocket module. diff --git a/docs/Application_guide/en/network-comm/nic/usbnet/README.md b/docs/Application_guide/en/network-comm/nic/usbnet/README.md index 59f0af8b03594d41ae1de1d7e58403cb0096e268..978321fb10bbd143ca2eea942cc33df9f32f36ec 100644 --- a/docs/Application_guide/en/network-comm/nic/usbnet/README.md +++ b/docs/Application_guide/en/network-comm/nic/usbnet/README.md @@ -164,7 +164,7 @@ USBNET.close() **2. When using the USB network adapter functionality on Unisoc 8910 modules, the computer cannot connect to the network after the first open in default ECM mode.** -> The USBnet of Unisoc 8910 modules requires NAT support. NAT is not enabled by default at boot and needs to be enabled before the USBnet can be used normally. Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki. For specific Unisoc 8910 modules, see [The Correspondence Between Platforms and Modules](https://python.quectel.com/doc/Application_guide/en/background/hardware-platform.html#Unisoc-Platform). +> The USBNET of Unisoc 8910 modules requires NAT support. NAT is not enabled by default at boot and needs to be enabled before the USBNET can be used normally. Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki. For specific Unisoc 8910 modules, see [The Correspondence Between Platforms and Modules](https://python.quectel.com/doc/Application_guide/en/background/hardware-platform.html#Unisoc-Platform). **3. For Unisoc 8850 modules, the module opens normally after the USB network adapter is set to RNDIS, but returns -1 when reopened.** diff --git a/docs/Application_guide/en/system/info.md b/docs/Application_guide/en/system/info.md index f81cb3ca463eec3d75ad29f25f40a31357a02341..4bbaf9286f844fdfeb16d9e441190b9fa195d57f 100644 --- a/docs/Application_guide/en/system/info.md +++ b/docs/Application_guide/en/system/info.md @@ -1,4 +1,4 @@ -# System Information +# Device Information This article introduces how to use the `uos`, `usys`, `modem`, and other features to query the firmware information and remaining memory size of the Quectel QuecPython modules, which are frequently concerned by users. This article will be continuously updated to facilitate users in understanding the basic information of the module. diff --git a/docs/Application_guide/en/system/log.md b/docs/Application_guide/en/system/log.md index fe0e2344c11798c6df6788c92ff1417fa5313f00..6d55afd4d08ec5634bbc010a27756ea550a07bc9 100644 --- a/docs/Application_guide/en/system/log.md +++ b/docs/Application_guide/en/system/log.md @@ -1,4 +1,4 @@ -# log - Output Log +# Log Output A log is a tool used to record the runtime state of an application in program development, as well as help developers diagnose and troubleshoot problems. Developers can quickly identify the root causes of problems and better understand the behaviors and performance of applications by viewing logs. `log` feature can output different log levels, including the DEBUG level, WARNING level, and ERROR level. diff --git a/docs/Application_guide/en/system/memory-device.md b/docs/Application_guide/en/system/memory-device.md index 40b75b505a5a8b020e67f428b28853c84556ce02..fd1eb8c4ba30f8cc4061ff6f38a4f111f8deffc5 100644 --- a/docs/Application_guide/en/system/memory-device.md +++ b/docs/Application_guide/en/system/memory-device.md @@ -1,4 +1,4 @@ -# Storage Device Application Note +# Memory Device This document aims to introduce the types, usage, and common issues of QuecPython storage devices, and provide guidance for using QuecPython storage devices.