diff --git a/docs/Application_guide/en/dev-tools/QMulti-DL/README.md b/docs/Application_guide/en/dev-tools/QMulti-DL/README.md new file mode 100644 index 0000000000000000000000000000000000000000..2cb4a0688fc654ea2f167bcd1714d33cb35216fa --- /dev/null +++ b/docs/Application_guide/en/dev-tools/QMulti-DL/README.md @@ -0,0 +1,18 @@ +# QMulti_DL Usage Tutorial + +## Overview +[QMulti_DL](https://images.quectel.com/python/sites/2/2023/05/QMulti_DL_V3.0_EN.zip) is a batch burning tool for mass production. + +## Obtain the Tool + +[Download](https://python.quectel.com/en/download) + +![](../../media/dev-tools/QMulti-DL/1.png) + +## User Guide + +[QMulti_DL User Guide Download](https://images.quectel.com/python/sites/2/2024/07/Quectel_QMulti_DL_User_Guide_V2.3.pdf) + +Note: If the firmware suffix format does not conform to the tool, you need to use QPYcom to `Extract MP Firmware` function to extract the MP Firmware. + +![](../../media/dev-tools/QMulti-DL/3.png) \ No newline at end of file diff --git a/docs/Application_guide/en/dev-tools/QPYcom/README.md b/docs/Application_guide/en/dev-tools/QPYcom/README.md index 2947258844d78a9d1591411b349c99d4fc0b806a..94d8c8e51f847928daf13001fcff46567d2e5940 100644 --- a/docs/Application_guide/en/dev-tools/QPYcom/README.md +++ b/docs/Application_guide/en/dev-tools/QPYcom/README.md @@ -5,7 +5,7 @@ This series of documents will introduce the use of *QPYcom* from the following aspects: - [GUI](./qpycom-gui.md) -- [REPL](./qpycom-repl.md) -- [Combination of Firmware and Script](./qpycom-merge.md) - [Firmware&Script Download](./qpycom-dw.md) +- [REPL](./qpycom-repl.md) +- [Script Combination, Backup, Encryption](./qpycom-merge.md) - [Extended Functions](./qpycom-ext.md) \ No newline at end of file diff --git a/docs/Application_guide/en/dev-tools/QPYcom/qpycom-ext.md b/docs/Application_guide/en/dev-tools/QPYcom/qpycom-ext.md index c745eeae4cf43825ef25829bd04c7e270081a860..fd7d6671d954bee4a6123e1d237c643f5b0d790d 100644 --- a/docs/Application_guide/en/dev-tools/QPYcom/qpycom-ext.md +++ b/docs/Application_guide/en/dev-tools/QPYcom/qpycom-ext.md @@ -16,7 +16,7 @@ Step 2: Click "**OK**" to generate the delta package. The generated delta packag Step 1: Select the new and old firmware packages for delta package making. -Step 2: Click "**OK**" to generate the delta package. +Step 2: Click "**OK**" to generate the delta package. ` The implementation principle refers to [FOTA](../../firmware-upgrade/firmware-ota.md). ` @@ -46,9 +46,14 @@ As shown in the figure: ## Toolkit -Click "**The toolkit**" and select an option in the sub-menu to quickly execute the configured codes. +Click "**The toolkit**" and select an option in the sub-menu to quickly execute the configured codes. ## Add quickCMD You can configure the common code and add it to the toolkit, where it can be executed by one click. +## Extract MP Firmware + +When you need to use other tools (such as Qflash tool, QMulti_DL tool, etc.) to burn the firmware, if the firmware suffix does not match the burning tool, you need to use this function to extract the mass production firmware. + +![](../../media/dev-tools/qpycom/3.png) \ No newline at end of file diff --git a/docs/Application_guide/en/dev-tools/QPYcom/qpycom-merge.md b/docs/Application_guide/en/dev-tools/QPYcom/qpycom-merge.md index d9d33a3eef4e4cd630d7cd9c22e8ce1312a95b5a..8f76963fb2af6cecce706f63bb0df3355dabf866 100644 --- a/docs/Application_guide/en/dev-tools/QPYcom/qpycom-merge.md +++ b/docs/Application_guide/en/dev-tools/QPYcom/qpycom-merge.md @@ -1,4 +1,4 @@ -# Combination of Firmware and Script +# Combination of Firmware and Script ## Combine Firmware and Script @@ -27,6 +27,22 @@ On the ''**Download**" page, you can combine local Python script files with firm 1. If "**Backup**" is not selected, both the *usr* partition and the non-usr part of *bak* partition will be combined with the firmware and neither will be backed up. 2. Files will only be backed up if they exist in both *usr* and *bak/usr* and the "**Backup**" option is selected. +## Backup File + +### Overview of Backup File + +The tool can back up the files to be merged during the firmware merging process + +If the backed-up files are accidentally deleted, they can be restored by restarting the virtual machine + +### Backup Steps + +1. Follow the firmware and script merging process above, after selecting the firmware and script to be merged, enable the backup function by checking the backup checkbox + +2. After checking the backup, click the merge button, and the selected script will be backed up before merging + +![](../../media/dev-tools/qpycom/image48.png) + ## Encrypt Code ### Overview of Python Script Encryption @@ -45,6 +61,8 @@ For example, after being encrypted, *user.py* will become *user.mpy*. We can dir 2. After selecting "**Encryption**", click "**Combine**". The selected scripts will be encrypted before being combined to ensure all combined scripts in the firmware are in *.mpy* format. After the combination is completed, you can find the generated *.mpy* file in the *mpy* folder in the directory. +![](../../media/dev-tools/qpycom/image47.png) + ## Adjust Image Partition ### Adjust User and Backup Partition Sizes diff --git a/docs/Application_guide/en/dev-tools/README.md b/docs/Application_guide/en/dev-tools/README.md index 97923b57b1be36d85426a01deb7f29cea8e1e9ff..f0ea4604fc7870e375febc039a1c4bdc47f627b3 100644 --- a/docs/Application_guide/en/dev-tools/README.md +++ b/docs/Application_guide/en/dev-tools/README.md @@ -10,3 +10,4 @@ This series of documents will introduce the use of QuecPython tools, including t - [Factory Tool User Guide](./FactoryTool/README.md) - [Log Tool User Guide](./LogTool/README.md) - [VSCode Plugin User Guide](./VSCode-Plugin-quecpython/README.md) +- [Multi-port User Guide](./QMulti-DL/README.md) diff --git a/docs/Application_guide/en/media/dev-tools/QMulti-DL/1.png b/docs/Application_guide/en/media/dev-tools/QMulti-DL/1.png new file mode 100644 index 0000000000000000000000000000000000000000..388f5085088bccdc23aab55a96f58aa81aba4c92 Binary files /dev/null and b/docs/Application_guide/en/media/dev-tools/QMulti-DL/1.png differ diff --git a/docs/Application_guide/en/media/dev-tools/QMulti-DL/3.png b/docs/Application_guide/en/media/dev-tools/QMulti-DL/3.png new file mode 100644 index 0000000000000000000000000000000000000000..5d36b2b230a2deb4f81505fd9ef3188fef87ce96 Binary files /dev/null and b/docs/Application_guide/en/media/dev-tools/QMulti-DL/3.png differ diff --git a/docs/Application_guide/en/media/dev-tools/qpycom/3.png b/docs/Application_guide/en/media/dev-tools/qpycom/3.png new file mode 100644 index 0000000000000000000000000000000000000000..5d36b2b230a2deb4f81505fd9ef3188fef87ce96 Binary files /dev/null and b/docs/Application_guide/en/media/dev-tools/qpycom/3.png differ diff --git a/docs/Application_guide/en/media/dev-tools/qpycom/image21.png b/docs/Application_guide/en/media/dev-tools/qpycom/image21.png index 533d1dc53e0e6e6e809b0cc6a955984e85f4c8c5..d8027557f6c0c85f6f2d22da8dce0a0c3625fd6b 100644 Binary files a/docs/Application_guide/en/media/dev-tools/qpycom/image21.png and b/docs/Application_guide/en/media/dev-tools/qpycom/image21.png differ diff --git a/docs/Application_guide/en/media/dev-tools/qpycom/image47.png b/docs/Application_guide/en/media/dev-tools/qpycom/image47.png new file mode 100644 index 0000000000000000000000000000000000000000..5b2ed240a5b5da9085eb456e81b7921256b0dda8 Binary files /dev/null and b/docs/Application_guide/en/media/dev-tools/qpycom/image47.png differ diff --git a/docs/Application_guide/en/media/dev-tools/qpycom/image48.png b/docs/Application_guide/en/media/dev-tools/qpycom/image48.png new file mode 100644 index 0000000000000000000000000000000000000000..8404216fb7dfd325ca4136874af5f92eadea0a69 Binary files /dev/null and b/docs/Application_guide/en/media/dev-tools/qpycom/image48.png differ diff --git a/docs/Application_guide/en/media/solutions/tracker/solution-tracker-007.png b/docs/Application_guide/en/media/solutions/tracker/solution-tracker-007.png index b0a55f14c5c9ce53b3b3826344ca1e51069623ad..4c6516ab0dddb47b9d1b44f34e3f3b2ab310678f 100644 Binary files a/docs/Application_guide/en/media/solutions/tracker/solution-tracker-007.png and b/docs/Application_guide/en/media/solutions/tracker/solution-tracker-007.png differ diff --git a/docs/Application_guide/en/media/solutions/tracker/solution-tracker-008.png b/docs/Application_guide/en/media/solutions/tracker/solution-tracker-008.png index f93609d2104192a6a71fdc091c01d51877f18ec9..0e64161c1a93a45b3dc5094d45b5922475c7894f 100644 Binary files a/docs/Application_guide/en/media/solutions/tracker/solution-tracker-008.png and b/docs/Application_guide/en/media/solutions/tracker/solution-tracker-008.png differ diff --git a/docs/Application_guide/en/media/solutions/tracker/solution-tracker-013.png b/docs/Application_guide/en/media/solutions/tracker/solution-tracker-013.png index 98b0a5b47928483df51ae0f70b7e23d8b5d029b4..09978ded1918bc990272c4eacb78a0b66f02df67 100644 Binary files a/docs/Application_guide/en/media/solutions/tracker/solution-tracker-013.png and b/docs/Application_guide/en/media/solutions/tracker/solution-tracker-013.png differ diff --git a/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST1.png b/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST1.png index d4fc736b8f535027ba214f3ae0eda69c0d28f01a..5983dfeedf340afdba41d81af281bed3b6be31c3 100644 Binary files a/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST1.png and b/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST1.png differ diff --git a/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST2.png b/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST2.png index 6b960bd9489d2490975a6899388f8c2a8f3f1fc1..8fe68185da877296652906b225be29f31b22bf9d 100644 Binary files a/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST2.png and b/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST2.png differ diff --git a/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST3.png b/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST3.png index 85872c5825ee807f55431e22f0ac36c12ead256d..9bd6f21be8d501ee226ced66f065744caf3a5cde 100644 Binary files a/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST3.png and b/docs/Application_guide/en/media/system/memory-device/REGIN_ADJUST3.png differ diff --git a/docs/Application_guide/en/sidebar.yaml b/docs/Application_guide/en/sidebar.yaml index b46722c8a4ee14514f0183a8f96633271c1365ef..8708a1d19746b0e064b08223aa75905beddf68c3 100644 --- a/docs/Application_guide/en/sidebar.yaml +++ b/docs/Application_guide/en/sidebar.yaml @@ -79,7 +79,7 @@ items: file: hardware/display/touch_screen.md - label: Nixie Tube file: hardware/display/nixie_tube.md - + - label: Sensor file: hardware/sensors/README.md items: @@ -238,7 +238,7 @@ items: file: dev-tools/QPYcom/qpycom-dw.md - label: REPL Debuggig file: dev-tools/QPYcom/qpycom-repl.md - - label: Combination of Firmware and Script + - label: Script Combination, Backup, Encryption file: dev-tools/QPYcom/qpycom-merge.md - label: Extension Function file: dev-tools/QPYcom/qpycom-ext.md @@ -259,6 +259,8 @@ items: file: dev-tools/LogTool/UNISOC8910.md - label: VSCode Plugin User Guide file: dev-tools/VSCode-Plugin-quecpython/README.md + - label: QMulti-DL User Guide + file: dev-tools/QMulti-DL/README.md - label: Product Solution file: solutions/README.md items: diff --git a/docs/Application_guide/en/solutions/tracker/README.md b/docs/Application_guide/en/solutions/tracker/README.md index 981f8496a5f9cefc44c6b770ffff2dd87e55f985..92371430ec421cfa421fe5bbc6108cd920615d65 100644 --- a/docs/Application_guide/en/solutions/tracker/README.md +++ b/docs/Application_guide/en/solutions/tracker/README.md @@ -153,7 +153,7 @@ Business Process Description: Tracker solution resources can be downloaded from [https://github.com/QuecPython/solution-tracker](https://github.com/QuecPython/solution-tracker) > The solution project has a sub-project named `modules`. Do not forget to download the sub-project together. -> +> > The command for downloading the sub-project synchronously: `git clone --recursive https://github.com/QuecPython/solution-tracker.git` Resource package directory: @@ -196,7 +196,7 @@ This is a public version of the tracker solution, which does not include all fun #### Install USB Driver -Please download and install the driver according to the platform of the module to be debugged. [Click here to download USB Drivers](https://python.quectel.com/download) +Please download and install the driver according to the platform of the module to be debugged. [Click here to download USB Drivers](https://python.quectel.com/en/download) ![solution-tracker-004](../../media/solutions/tracker/solution-tracker-004.png) @@ -204,7 +204,7 @@ Please download and install the driver according to the platform of the module t It is recommended to use QPYcom for development and debugging. The processes described in this document are under the premise that QPYcom is used and USB driver installation is successful. -[Click here to download QPYcom](https://python.quectel.com/download) +[Click here to download QPYcom](https://python.quectel.com/en/download) ![solution-tracker-005](../../media/solutions/tracker/solution-tracker-005.png) @@ -327,7 +327,7 @@ ota_status = { Download the corresponding QuecPython firmware according to the current debugging module model from the QuecPython official website, and download the firmware into the module with QPYcom. -[Click here to download firmware](https://python.quectel.com/download) +[Click here to download firmware](https://python.quectel.com/en/download) ![solution-tracker-006](../../media/solutions/tracker/solution-tracker-006.png) diff --git a/docs/Application_guide/en/system/memory-device.md b/docs/Application_guide/en/system/memory-device.md index 40b75b505a5a8b020e67f428b28853c84556ce02..d21ed66b762863a7d397eb403d6c455f51095b7f 100644 --- a/docs/Application_guide/en/system/memory-device.md +++ b/docs/Application_guide/en/system/memory-device.md @@ -147,31 +147,17 @@ Currently, only the EG912N and EG915N series modules support partition adjustmen Taking the EG915U series module as an example: -1. Select the "Download" interface. - -2. Click the "**Create**" button to create a project. - -3. Name it "EG915U". +1. Click "Function Box" -> "Partition Management" -> "UNISOC" ![](../media/system/memory-device/REGIN_ADJUST1.png) -1. Select the firmware file, such as QPY_OCPU_V0003_EG915U_EUAB_FW\QPY_OCPU_V0003_EG915U_EUAB_FW.pac. - -2. Check "size self-provisioning(pac fw)" button. - -3. Click the "**Combine**" button. - -4. A dialog box will appear, showing the sizes of the "usr" and "bak" partitions, as well as the total size of both partitions. +2. Select the firmware file, such as QPY_OCPU_V0003_EG915U_EUAB_FW\QPY_OCPU_V0003_EG915U_EUAB_FW.pac, showing the sizes of the "usr" and "bak" partitions, as well as the total size of both partitions. ![](../media/system/memory-device/REGIN_ADJUST2.png) -1. Modify the size of the usr partition. - -2. Click the "**Update**" button. +3. Drag the progress bar or enter in the text box to change the size of the usr partition, The size of the bak partition will be automatically updated to the new value. -3. The size of the bak partition will be automatically updated to the new value. - -4. Click the "**OK**" button to start combining the firmware and wait for the combination to complete. +4. Click the "**Confirm**" button to start generating firmware and wait for the new firmware to be generated.. ![](../media/system/memory-device/REGIN_ADJUST3.png) @@ -179,8 +165,6 @@ Flash the combined firmware and check the new partition size distribution: ![](../media/system/memory-device/REGIN_ADJUST4.png) -(Note: The QPYcom tool does not currently support this feature on EG9xxN series modules. It is under development.) - #### Adding a Partition ##### Scenario: @@ -223,7 +207,7 @@ When the firmware is flashing, different partition processing methods are used f The reason for generating mass production firmware is that the official firmware released by QuecPython only includes the programs of the platform layer and the QuecPython adaptation layer. Users need to use the QuecPython Modules API and write programs in Python to implement the complete functionality of the application. These Python programs need to be stored in the user file system partition and user file backup system partition in the form of files. During the debugging phase, flash the user files to the device's user file system partition through QPYcom download script function. However, during mass production, to improve efficiency, the debugged files need to be packaged into the QuecPython official firmware in advance, so that the QuecPython official firmware and user files can be flashed into the device together. The general steps are as follows. When the device leaves the factory, it has the default firmware that does not include QuecPython related features. Users need to flash the firmware officially released by QuecPython, and after developing and debugging the user application functions based on the QuecPython module, package the user's script files and QuecPython firmware into one firmware. This firmware is then flashed into all devices as the final mass production firmware. For details on generating the mass production firmware, see [Combination of Firmware and Script](https://my.qpy.wiki/doc/Application_guide/en/dev-tools/QPYcom/qpycom-merge.html#Combine-Firmware-and-Script). -### Common Applications of Internal Storage +### Common Applications of Internal Storage #### Program Image @@ -235,7 +219,7 @@ Mounting a specified partition as a file system to store data allows data to be #### GUI Fonts -A specified partition is used to store the font content required for GUI display. This font content contains different font information and has a fixed structure. Therefore, the font file needs to be flashed into the specified partition of the device together when you flash the firmware. In this way, the GUI display program can directly access the font content through the flash related interface, which is faster than accessing through the file system and can improve the real-time performance of GUI display. +A specified partition is used to store the font content required for GUI display. This font content contains different font information and has a fixed structure. Therefore, the font file needs to be flashed into the specified partition of the device together when you flash the firmware. In this way, the GUI display program can directly access the font content through the flash related interface, which is faster than accessing through the file system and can improve the real-time performance of GUI display. #### Raw Partition Operations @@ -297,7 +281,7 @@ Currently only the EC200U and EG915U series modules support the 6-wire SPI NOR f | | SPI_FLASH_SIO2 | 121 | 108 | | | SPI_FLASH_SIO3 | 119 | 92 | -As shown in the table, for EC200U and EG915U series modules, if the MIPI LCD function is not used and only the 6-wire SPI NOR flash is connected externally, any of the two SPI channels can be selected as the flash SPI communication interface. If both the external 6-wire SPI NOR flash and the MIPI LCD function need to be supported, the flash SPI communication interface must be selected as SPI2. +As shown in the table, for EC200U and EG915U series modules, if the MIPI LCD function is not used and only the 6-wire SPI NOR flash is connected externally, any of the two SPI channels can be selected as the flash SPI communication interface. If both the external 6-wire SPI NOR flash and the MIPI LCD function need to be supported, the flash SPI communication interface must be selected as SPI2. ##### Adding Models diff --git a/docs/Application_guide/zh/dev-tools/QMulti-DL/README.md b/docs/Application_guide/zh/dev-tools/QMulti-DL/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e09c362a7537cd60ca9a0c6e7e7af776667333aa --- /dev/null +++ b/docs/Application_guide/zh/dev-tools/QMulti-DL/README.md @@ -0,0 +1,18 @@ +# QMulti_DL 使用教程 + +## 简介 +[QMulti_DL](https://images.quectel.com/python/2022/12/QMulti_DL_V3.0_CN.zip) 是用于量产的批量烧录工具 + +## 工具获取 + +[官网下载](https://python.quectel.com/download) + +![](../../media/dev-tools/QMulti-DL/1.png) + +## 用户指导 + +[QMulti_DL用户指导下载](https://images.quectel.com/python/2024/07/Quectel_QMulti_DL_用户指导_V2.3.pdf) + +注: 若固件后缀格式不符合该工具,则需要使用QPYcom `提取量产包` 功能提取量产包 + +![](../../media/dev-tools/QMulti-DL/3.png) \ No newline at end of file diff --git a/docs/Application_guide/zh/dev-tools/QPYcom/README.md b/docs/Application_guide/zh/dev-tools/QPYcom/README.md index 99c9d92eaae6e50bf8867f9fcf3a24ecce161afc..3280ae802b24eb776f391cbc1da02ec1bfb91c9c 100644 --- a/docs/Application_guide/zh/dev-tools/QPYcom/README.md +++ b/docs/Application_guide/zh/dev-tools/QPYcom/README.md @@ -7,5 +7,5 @@ - [QPYcom 图形化界面介绍](./qpycom-gui.md) - [QPYcom 固件&脚本下载](./qpycom-dw.md) - [QPYcom REPL 命令交互](./qpycom-repl.md) -- [QPYcom 固件脚本合并](./qpycom-merge.md) +- [QPYcom 脚本合并、备份、加密](./qpycom-merge.md) - [QPYcom 扩展功能](./qpycom-ext.md) diff --git a/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-ext.md b/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-ext.md index e78e7b999505e99efb5343dcffab198da2d01903..a1aea81b348626aaf4b9082110c62d47630cf8e8 100644 --- a/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-ext.md +++ b/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-ext.md @@ -65,4 +65,10 @@ uos.uname() 如果需要额外增加指令,可以通过手动配置的方式增加指令,在工具目录下的**config.ini**文件中按照预配置命令格式在后面追加后重启工具即可,或者点击配置工具箱按钮后在弹窗中添加。 -> 指令配置完毕后,重启后生效。 \ No newline at end of file +> 指令配置完毕后,重启后生效。 + +## 提取量产包 + +当需要使用其他工具(例如: Qflash工具, QMulti_DL批量烧录工具等)烧录固件时,若固件后缀与烧录工具不匹配,需要用该功能提取出量产包。 + +![](../../media/dev-tools/qpycom/3.png) \ No newline at end of file diff --git a/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-merge.md b/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-merge.md index 94f370cbe25f9df5c6475dca14ce53889565881b..19abaeb8f40e83c0422a01fa01904a1820a1cba5 100644 --- a/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-merge.md +++ b/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-merge.md @@ -16,6 +16,21 @@ ![](../../media/dev-tools/qpycom/suffix.png) +## 代码备份 + +### Python脚本备份概述 + +工具可以在合并的固件的过程中将待合入的文件进行备份 + +备份后的文件如果意外删除,可以通过重启虚拟机的方式进行还原 + +### 备份操作步骤 + +1. 按照上文固件脚本合并的过程,在选择好要合并的固件和脚本之后,通过勾选备份复选框开启备份功能 + +2. 勾选备份之后点击合并按钮,在合并前会对已选择的脚本进行备份操作 + +![](../../media/dev-tools/qpycom/image48.png) ## 代码加密 @@ -23,7 +38,7 @@ 工具可以在合并的固件的过程中将待合入的py脚本加密成mpy文件以达到代码安全的要求 -加密后的mpy文件不可读但是仍然可以通过导入库的形式来使用,但是无法通过工具的执行按钮和来运行 +加密后的mpy文件不可读但是仍然可以通过导入库的形式来使用,但是无法通过工具的执行按钮来运行 工具在加密脚本文件的过程中会避开main.py, 应用程序的编写规范一般是将main.py作为入口文件来调用其他代码 diff --git a/docs/Application_guide/zh/dev-tools/README.md b/docs/Application_guide/zh/dev-tools/README.md index 0b82c118746b714a5e78d14fe77dc3a873c03843..37a588772b7aca2ce2d3e71057c2f221d267aadb 100644 --- a/docs/Application_guide/zh/dev-tools/README.md +++ b/docs/Application_guide/zh/dev-tools/README.md @@ -10,3 +10,4 @@ - [产测工具使用教程](./FactoryTool/README.md) - [各平台Log工具使用教程](./LogTool/README.md) - [VSCode 插件使用教程](./VSCode-Plugin-quecpython/README.md) +- [QMulti_DL 批量烧录工具使用教程](./QMulti-DL/README.md) diff --git a/docs/Application_guide/zh/media/dev-tools/QMulti-DL/1.png b/docs/Application_guide/zh/media/dev-tools/QMulti-DL/1.png new file mode 100644 index 0000000000000000000000000000000000000000..21e32a7d581c148913449725ece1f402df854f7a Binary files /dev/null and b/docs/Application_guide/zh/media/dev-tools/QMulti-DL/1.png differ diff --git a/docs/Application_guide/zh/media/dev-tools/QMulti-DL/3.png b/docs/Application_guide/zh/media/dev-tools/QMulti-DL/3.png new file mode 100644 index 0000000000000000000000000000000000000000..a02c8d270454b11d7309ad243e691987f96af4d4 Binary files /dev/null and b/docs/Application_guide/zh/media/dev-tools/QMulti-DL/3.png differ diff --git a/docs/Application_guide/zh/media/dev-tools/qpycom/3.png b/docs/Application_guide/zh/media/dev-tools/qpycom/3.png new file mode 100644 index 0000000000000000000000000000000000000000..a02c8d270454b11d7309ad243e691987f96af4d4 Binary files /dev/null and b/docs/Application_guide/zh/media/dev-tools/qpycom/3.png differ diff --git a/docs/Application_guide/zh/media/dev-tools/qpycom/image48.png b/docs/Application_guide/zh/media/dev-tools/qpycom/image48.png new file mode 100644 index 0000000000000000000000000000000000000000..ec77e924d9272f13fa05eca7309ebefd27dcf7ba Binary files /dev/null and b/docs/Application_guide/zh/media/dev-tools/qpycom/image48.png differ diff --git a/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST1.png b/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST1.png index d4fc736b8f535027ba214f3ae0eda69c0d28f01a..5983dfeedf340afdba41d81af281bed3b6be31c3 100644 Binary files a/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST1.png and b/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST1.png differ diff --git a/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST2.png b/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST2.png index 6b960bd9489d2490975a6899388f8c2a8f3f1fc1..ce2c5306606ee70986870e74c1c54906012de251 100644 Binary files a/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST2.png and b/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST2.png differ diff --git a/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST3.png b/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST3.png index 85872c5825ee807f55431e22f0ac36c12ead256d..0c0d6a5d327f146776bc600be180d0dbd7d86ab1 100644 Binary files a/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST3.png and b/docs/Application_guide/zh/media/system/memory-device/REGIN_ADJUST3.png differ diff --git a/docs/Application_guide/zh/multi-media/lvgl/lvgl_fontlib.md b/docs/Application_guide/zh/multi-media/lvgl/lvgl_fontlib.md index d1a24af9a803f9cc36382e5e91c5ccd2d2c98b5c..82ca0d5365fcde8d503575487064ff91ba76fbd4 100644 --- a/docs/Application_guide/zh/multi-media/lvgl/lvgl_fontlib.md +++ b/docs/Application_guide/zh/multi-media/lvgl/lvgl_fontlib.md @@ -152,6 +152,52 @@ bin文件生成工具: [LvglFontTool工具V0.4](http://www.armbbs.cn/forum.php?m bin文件合成工具: font_bin_merge.py +```python +# font_bin_merge.py +from struct import * + +def bin_create(*args): + if len(args) < 1: + print("wrong params number!") + return -1 + + with open("ext_font.bin","wb") as dest_file: + # start + start = "s" + end = "e" + + font_num = len(args) + bin_data = [] + bin_size = [] + font_name = "" + + for i in range(font_num): + with open(args[i], "rb") as bin_file: + data = bin_file.read() + padding = "\0" * (128 - len(args[i])) + string_padded = args[i] + padding + font_name += string_padded + bin_size.append(len(data)) + bin_data.append(data) + + write_data = pack(" 注意:此工具目前只有中文版本,海外客户可照下面图示及文字描述的步骤操作。 > > 最终使用的二进制bin文件可能包含多个字体,所以需要先使用bin文件生成工具生成单个bin文件,再使用bin文件合成工具合成最终使用的二进制bin文件:ext_font.bin。 diff --git a/docs/Application_guide/zh/sidebar.yaml b/docs/Application_guide/zh/sidebar.yaml index 9a94e2599f0c728c801fdcacb1d71946b44a2da9..cc36d5eaedf44024443ad929ef24668df896dd1a 100644 --- a/docs/Application_guide/zh/sidebar.yaml +++ b/docs/Application_guide/zh/sidebar.yaml @@ -79,7 +79,7 @@ items: file: hardware/display/touch_screen.md - label: 数码管 file: hardware/display/nixie_tube.md - + - label: 传感器 file: hardware/sensors/README.md items: @@ -237,7 +237,7 @@ items: file: dev-tools/QPYcom/qpycom-dw.md - label: REPL 命令交互 file: dev-tools/QPYcom/qpycom-repl.md - - label: 固件脚本合并 + - label: 脚本合并、备份、加密 file: dev-tools/QPYcom/qpycom-merge.md - label: 扩展功能 file: dev-tools/QPYcom/qpycom-ext.md @@ -262,6 +262,8 @@ items: file: dev-tools/LogTool/UNISOC8910.md - label: VSCode 插件使用教程 file: dev-tools/VSCode-Plugin-quecpython/README.md + - label: QMulti_DL 批量烧录工具使用教程 + file: dev-tools/QMulti-DL/README.md - label: 产品方案 file: solutions/README.md items: diff --git a/docs/Application_guide/zh/system/memory-device.md b/docs/Application_guide/zh/system/memory-device.md index ac29b5ba3be12b6bf794870bcb38166c9099e21e..913240a46184c31b422a1bb6dbe9107f9e7a8300 100644 --- a/docs/Application_guide/zh/system/memory-device.md +++ b/docs/Application_guide/zh/system/memory-device.md @@ -164,45 +164,31 @@ c)文件系统分区:用于存放用户应用脚本和用户参数。 ##### 支持的模组: -目前只有ECx00N & EGx00N & ECx00M & EGx00M系列和ECx00U & EGx00U & ECx00G系列支持调整分区。且只支持用户文件系统usr和用户文件系统bak之间调整大小。 +目前只有ECx00N & EGx00N & ECx00M & EGx00M系列和ECx00U & EGx00U & ECx00G & ECx00Z系列支持调整分区。且只支持用户文件系统usr和用户文件系统bak之间调整大小。 ##### 操作: 以EC600U型号为例 -1、选择下载界面。 - -2、点击创建按钮创建项目。 - -3、命名为EC600U。 +1、点击 "Function Box" -> "Partition Management" -> "UNISOC" ![](../media/system/memory-device/REGIN_ADJUST1.png) -1、选择固件文件如QPY_OCPU_V0002_EC600U_CNLB_FW\QPY_OCPU_V0002_EC600U_CNLB_FW.pac。 - -2、勾选自动调整大小按钮。 - -3、点击合并固件按钮。 - -4、弹出对话框,其中显示usr和bak分区各自的大小及两者之和的大小。 +2、选择固件文件如QPY_OCPU_V0002_EC600U_CNLB_FW\QPY_OCPU_V0002_EC600U_CNLB_FW.pac,显示usr和bak分区各自的大小及两者之和的大小。 ![](../media/system/memory-device/REGIN_ADJUST2.png) -1、修改usr分区的大小。 - -2、点击更新按钮。 +3、拖拽进度条或者文本框输入修改usr分区的大小,bak分区大小自动更新为新的值。 -3、bak分区大小自动更新为新的值。 - -4、点击OK按钮后开始合并固件,等待合并完成。 +4、点击"Confirm"按钮后开始生成新固件,等待生成新固件完成。 ![](../media/system/memory-device/REGIN_ADJUST3.png) -烧录合并完成的固件,并查询新的分区大小分布: + +烧录新生成的固件,并查询新的分区大小分布: ![](../media/system/memory-device/REGIN_ADJUST4.png) -(ECx00N & EGx00N & ECx00M & EGx00M系列QPYcom工具该功能暂不支持,待开发。) #### 新增分区 diff --git a/docs/FAQ/en/guide/contribute.md b/docs/FAQ/en/guide/contribute.md index 4c99423e0035f80d630082a9c0f351d78d6ef41f..f14ffbb800a77b1585f6d4bd5707aa8136be7049 100644 --- a/docs/FAQ/en/guide/contribute.md +++ b/docs/FAQ/en/guide/contribute.md @@ -10,28 +10,28 @@ There is no specific introduction to gi-related operations, please query [Git re ### Add questions -1. Create a [Create new branch](#Create new branch) locally and adhere to the [Branch Name Standard](#Branch Name Standard); +1. Create a [Create new branch](#Create-new-branch) locally and adhere to the [Branch Name Standard](#Branch-Name-Standard); 2. Find the `*.md` file corresponding to the question type locally or in the web IDE, and add a new question according to the template format; -3. After editing, open the preview interface to check whether the display result meets expectations. You can use [Local Compilation Environment](#Local Compilation Environment) to compile the document and check whether the generated web page is satisfactory; +3. After editing, open the preview interface to check whether the display result meets expectations. You can use [Local Compilation Environment](#Local-Compilation-Environment) to compile the document and check whether the generated web page is satisfactory; -4. Adhere to [Submission information specifications](#Submission information specifications), push to github and hand in Pull Requests; +4. Adhere to [Submission information specifications](#Submission-information-specifications), push to github and hand in Pull Requests; -5. If above expectations are met, then [Submit merge request](#Submit merge request); +5. If above expectations are met, then [Submit merge request](#Submit-merge-request); 6. When all discussions on the document are resolved and the PR is successfully submitted, the process of adding new issues is completed. ### Modify questions -1. Create a [Create new branch](#Create new branch) locally and adhere to the [Branch Name Standard](#Branch Name Standard); +1. Create a [Create new branch](#Create-new-branch) locally and adhere to the [Branch Name Standard](#Branch-Name-Standard); 2. Find the `*.md` file corresponding to the question type locally or in the web IDE, and add a new question according to the template format; -3. After editing, open the preview interface to check whether the display result meets expectations. You can use [Local Compilation Environment](#Local Compilation Environment) to compile the document and check whether the generated web page is satisfactory; +3. After editing, open the preview interface to check whether the display result meets expectations. You can use [Local Compilation Environment](#Local-Compilation-Environment) to compile the document and check whether the generated web page is satisfactory; -4. Adhere to [Submission information specifications](#Submission information specifications), push to github and hand in Pull Requests; +4. Adhere to [Submission information specifications](#Submission-information-specifications), push to github and hand in Pull Requests; -5. If above expectations are met, then [Submit merge request](#Submit merge request); +5. If above expectations are met, then [Submit merge request](#Submit-merge-request); 6. When all discussions on the document are resolved and the PR is successfully submitted, the process of adding new issues is completed. @@ -162,7 +162,7 @@ We will merge the branch into the main branch via github merge request,see follo * Title Requirement: - `add: ``A brief description`` + `add: A brief description` * Description Requirement: diff --git a/docs/Getting_started/en/driver_prepare.md b/docs/Getting_started/en/driver_prepare.md index 41a844c9ba491cd07641b6d596eeb1e32c924707..de87c00fa05af9057d3c82515821a9b431a308aa 100644 --- a/docs/Getting_started/en/driver_prepare.md +++ b/docs/Getting_started/en/driver_prepare.md @@ -12,7 +12,7 @@ The "device driver" is a special program that allows the PC to communicate with -- In the search box, type "EG912U" to find the appropriate driver for EG912U, and then click the download button to download the driver: [QuecPython_USB Driver Win10_U_G](https://images.quectel.com/python/2023/04/QuecPython_USB_Driver_Win10_U_G.zip). +- In the search box, type "EG912U" to find the appropriate driver for EG912U, and then click the download button to download the driver: [QuecPython_USB Driver Win10_U_G](https://images.quectel.com/python/sites/2/2023/05/Quectel_Windows_USB_DriverU_V1.0.19.zip). diff --git a/docs/Getting_started/en/tools_prepare.md b/docs/Getting_started/en/tools_prepare.md index 2fee3d4a836633fa473cbb218311f75275415bbb..33321504c0ee77afe7f7b990d2f8c3c34385a373 100644 --- a/docs/Getting_started/en/tools_prepare.md +++ b/docs/Getting_started/en/tools_prepare.md @@ -4,7 +4,7 @@ To develop with QuecPython, you need a specialized development and debugging tool — **QPYcom**. This tool is used for debugging code, analyzing logs, transferring files, downloading firmware, merging firmware, and more. -[QPYcom](https://images.quectel.com/python/2022/12/QPYcom_V3.1.2.zip) is a one-stop debugging tool for QuecPython development. +[QPYcom](https://images.quectel.com/python/sites/2/2023/05/QPYcom_V3.5.zip) is a one-stop debugging tool for QuecPython development. *Note: This tool does not need to be installed. Just unzip and use it.* diff --git a/docs/Getting_started/zh/flash_firmware.md b/docs/Getting_started/zh/flash_firmware.md index e164e4bc52c98486eb0e71ab9391fffadb644dee..0e51bb275270957b22a6ddd03874140e1375c627 100644 --- a/docs/Getting_started/zh/flash_firmware.md +++ b/docs/Getting_started/zh/flash_firmware.md @@ -4,7 +4,7 @@ 模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件,如需基于 QuecPython 对模块进行开发,需要手动为其重新烧录专门的 QuecPython 固件。 -官网固件下载地址:**** +官网固件下载地址:**** ![](media/readme/Firmware.png) @@ -20,7 +20,7 @@ 从官网下载的固件包为压缩包格式,固件压缩包下载到本地后,需进行解压。解压后可获得两个文件,其中 .bin 、.lod或 .pac 格式的是 QuecPython 固件本体,.md 格式的是更新日志。 -固件解压后的本体文件有以下后缀区分 +固件解压后的本体文件有以下后缀区分(**官网发布日期于2024.05.20之后的固件,所有模组型号固件已统一为.bin后缀**) | 固件下载文件名称后缀 | 固件文件对应模组型号 | 备注 | | -------------------- | -------------------------------------- | -------------------------- | @@ -28,6 +28,7 @@ | pac | EC600U、EC200U、EG912U、EC800G、EC600G | 固件压缩包解压后可得 | | lod | BC25 | 固件压缩包解压后可得 | | binpkg | EC600E、EC800E | 解压后固件名称同名文件夹内 | +| hbinpkg | EC800Z | 解压后固件名称同名文件夹内 | | blf | EC200A | 解压后固件名称同名文件夹内 | | mbn | BG95 | 解压后固件名称同名文件夹内 | | bin | FCM360W | 解压后固件名称同名文件夹内 | @@ -42,7 +43,7 @@ - **Step2:选择固件** -选择要下载到模组的固件(根据要下载的模组型号选择对应的固件) +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件,若为新格式固件则所有模组型号都选择.bin文件即可) 其中BG95系列选择官网下载固件包解压后mbn结尾的文件,M/N系列选择官网下载固件包解压后的bin文件,U/G系列模组选择解压后的PAC文件,BC25选择lod文件,A系列选择blf文件,E系列选择binpkg文件 @@ -54,8 +55,13 @@ 点击**"Download FW"**后,开始下载固件,下载过程会有进度条和进度百分比显示,等待下载完毕会有弹窗提示下载成功 -部分固件如**BC25**需要打开固件下载串口后再点击**"Download FW"**,直接点击会提示打开串口 - -**FCM360W**需要打开串口后点击**"Download FW"**后等待进度条出现后再按下开发板**“RESET”**按钮开始下载固件 +| 模组型号 | 注意事项 | +| -------------------------------------- | -------------------------- | +| BC25 | 需要打开固件下载串口后再点击**"Download FW"**,直接点击会提示打开串口 | +| BG95 | 需要打开DM串口后再点击**"Download FW"**,直接点击会提示打开串口 | +| FCM360W | 需要打开串口后点击**"Download FW"**后等待进度条出现后再按下开发板**“RESET”**按钮开始下载固件 | +| EC600E | 需要短接开发板 BOOT 和 GND 并按下开发板**“RESET”**按钮出现下载口后,立即点击**"Download FW"**开始下载固件 | +| EC800E | 需要短接开发板 EXT 和 GND 并按下开发板**“RESET”**按钮出现下载口后,立即点击**"Download FW"**开始下载固件 | +| EC800Z | 需要短接开发板 BOOT 和 EXT 并按下开发板**“RESET”**按钮出现下载口后,立即点击**"Download FW"**开始下载固件 | ![](media/readme/firmware.gif) \ No newline at end of file diff --git a/docs/Getting_started/zh/tools_prepare.md b/docs/Getting_started/zh/tools_prepare.md index 8d31caab98bcee47d4a1091536555b6022874997..6c62dd83d1bae8b4a17d491c8321fa5169d4806c 100644 --- a/docs/Getting_started/zh/tools_prepare.md +++ b/docs/Getting_started/zh/tools_prepare.md @@ -4,7 +4,7 @@ 使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**,包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 -[QPYcom](https://images.quectel.com/python/2022/12/QPYcom_V3.1.2.zip) : 适用于QuecPython开发的一站式调试工具 +[QPYcom](https://images.quectel.com/python/2022/12/QPYcom_V3.5.zip) : 适用于QuecPython开发的一站式调试工具 *注意:该工具无需安装,解压即用。*