diff --git a/docs/Advanced_development/en/HeliosSDK/Helios_SDK_01.md b/docs/Advanced_development/en/HeliosSDK/Helios_SDK_01.md index 7c72361222b5d9ecd283b8ef0f3ea68dfb607c68..96ec892f03657dea97ac9038b2b8f6523a423faa 100644 --- a/docs/Advanced_development/en/HeliosSDK/Helios_SDK_01.md +++ b/docs/Advanced_development/en/HeliosSDK/Helios_SDK_01.md @@ -17,13 +17,13 @@ Meanwhile, whether enabling the function of all components, you can configure vi **Step 1: Download tool-chain** -Download **[toolchain.exe](https://github.com/quecpython/toolchain/releases)** under the circumstance of Windows 10 from GitHub website. + * Download **[toolchain.exe](https://github.com/quecpython/toolchain/releases)** under the circumstance of Windows 10 from GitHub website. ![Helios_SDK_01_01](media\Helios_SDK_01_01.png) - **Step 2 : Install tool-chain ** + **Step 2 : Install tool-chain** -Run the **helios-toolchain.exe** by Administrator as described below. just click the " **Install** " button. + * Run the **helios-toolchain.exe** by Administrator as described below. just click the "**Install**" button. ![Helios_SDK_01_02](media\Helios_SDK_01_02.png) @@ -33,19 +33,19 @@ Run the **helios-toolchain.exe** by Administrator as described below. just click **Step 1: download tool-chain** -Download **[toolchain.exe](https://github.com/quecpython/toolchain/releases)** under the circumstance of Ubuntu16.04 from GitHub website. + * Download **[toolchain.exe](https://github.com/quecpython/toolchain/releases)** under the circumstance of Ubuntu16.04 from GitHub website. ![Helios_SDK_01_03](media\Helios_SDK_01_03.png) **Step 2: Install tool-chain** -Place the package to the same location with the target folder as predicted. you can install the **tool-chain** via executing following command. + * Place the package to the same location with the target folder as predicted. you can install the **tool-chain** via executing following command. `sudo ./helios-toolchain` - **Step 3: Install other tooIs ** + **Step 3: Install other tooIs** -Install `p7zip-full`, `git`, `make` and `python3` by clicking into following commands on terminal. + * Install `p7zip-full`, `git`, `make` and `python3` by clicking into following commands on terminal. 1. sudo apt install p7zip-full git make python3 @@ -91,11 +91,11 @@ Take the`sample` under the root directory of SDK as an example: **Step 1: Build a new application code folder** -Build a new `sample` folder under the root directory of SDK. + * Build a new `sample` folder under the root directory of SDK. **Step 2: Build the source file of application code** -Enter`sample` folder and build a new `sample.c`. + * Enter `sample` folder and build a new `sample.c`. **Step 3: Compile application code** @@ -136,15 +136,15 @@ Define the log output interface that customizing label in `sample.c`, then modif * The logs are printed every second in `sample.c`. Here shows codes - 1. static void AppSample(void *argv) + 1. static void AppSample(void *argv) 2. { 3. UNUSED(argv); // Define in helios.h - 4. 5. while (1) - 6. { - 7. app_debug("app sample running ...\r\n"); // Output the customized log with label. - 8. Helios_sleep(1); // Define in helios_os.h. - 9. } - 10. } + 4. while (1) + 5. { + 6. app_debug("app sample running ...\r\n"); // Output the customized log with label. + 7. Helios_sleep(1); // Define in helios_os.h. + 8. } + 9. } ​ @@ -154,9 +154,10 @@ Define the log output interface that customizing label in `sample.c`, then modif * After compiling application function codes, call the following interfaces to automatically start application functions after the system is started: - 1. application_init(AppSample, "AppSample", 2, 0); // Define in helios.h + 1. application_init(AppSample, "AppSample", 2, 0); // Define in helios.h > Illustration of `application_init` Interface +> > Definition: ：`application_init(entry, name, stack_size_kib, startup_prio)` > > Parameter：`entry` \- Entrance address of application code @@ -177,10 +178,10 @@ Build a new `.mk` file that shares the same name with root directory of applicat > As for the details on compiling mk script file, please refer to the `README.MD` under the root directory of SDK. - 1. NAME := SAMPLE # Component name, it is suggested to keep in line with the name in the root directory of componnet with capitals. - 2. 3. $(NAME)_SRCS := sample.c # Add the relative path of source which is going to be compiled, (Compared with root directory of component code. However, it is sample directory) - 4. 5. $(NAME)_INCS := . # The relative path that can be quoted by internal component limitedly,(Compared with root directory of component code. However, it is sample directory. In actual, there is no header file in sample directory, which can be deleted hereby ) - 6. 7. $(NAME)_COMPONENTS := # Relative path of other components on which the current component depends (Relative to SDK root, this line can be deleted when empty) + 1. NAME := SAMPLE # Component name, it is suggested to keep in line with the name in the root directory of componnet with capitals. + 2. $(NAME)_SRCS := sample.c # Add the relative path of source which is going to be compiled, (Compared with root directory of component code. However, it is sample directory) + 3. $(NAME)_INCS := . # The relative path that can be quoted by internal component limitedly,(Compared with root directory of component code. However, it is sample directory. In actual, there is no header file in sample directory, which can be deleted hereby ) + 4. $(NAME)_COMPONENTS := # Relative path of other components on which the current component depends (Relative to SDK root, this line can be deleted when empty) ​ @@ -191,18 +192,18 @@ Till now, the application code compilation is done. **Step 1： Check the method to compile command** -Click the `helios` in the booted command lines under SDK directory, then press "Enter" to check the method to use helios commands + * Click the `helios` in the booted command lines under SDK directory, then press "Enter" to check the method to use helios commands The following figure shows the outputted result. - 1. Usage: helios [] [] [] - 2. 3. These are common commands used in various situations: - 4. menuconfig - Do the project configuration - 5. make [[] []] - Do the compilation work - 6. private_clean - Clean the app private target - 7. clean - Clean the output directory - 8. help - Show this help page + 1. Usage: helios [] [] [] + 2. These are common commands used in various situations: + 3. menuconfig - Do the project configuration + 4. make [[] []] - Do the compilation work + 5. private_clean - Clean the app private target + 6. clean - Clean the output directory + 7. help - Show this help page ​ @@ -211,7 +212,7 @@ The following figure shows the outputted result. **Step 2: Compile FW** -Take **EC600SCN_LB** module as an example, click into following commands in line and press " **Enter** " + * Take **EC600SCN_LB** module as an example, click into following commands in line and press "**Enter**" 1. helios make sample @EC600SCN_LB EC600SCNLBR01A01M08 @@ -225,7 +226,7 @@ Take **EC600SCN_LB** module as an example, click into following commands in line * `@EC600SCN_LB`：Assign target module type, which is by default with a value of `@EC200UCN_AA`. * `EC600SCNLBR01A01M08`：Name of FW version by default. Take the assigned root directory of application code as the default value. -If there is a need to delete the target to be compiled, click following commands in line and press " **Enter** " +If there is a need to delete the target to be compiled, click following commands in line and press "**Enter**" 1. helios clean @@ -235,43 +236,43 @@ If there is a need to delete the target to be compiled, click following commands **Step 3: Check the target after compiling** -The generated FW package is saved in the `output/release` folder under the root directory of SDK, which is shown as next figure. + * The generated FW package is saved in the `output/release` folder under the root directory of SDK, which is shown as next figure. ![Helios_SDK_01_05](media\Helios_SDK_01_05.png) **Step 4 : Flash FW** -For flashing FW, please refer to + * For flashing FW, please refer to ## Function Test - **Step 1: Connect PC and module** +**Step 1: Connect PC and module** -Connect the debug and PC via serial port wire. + * Connect the debug and PC via serial port wire. - **Step 2: Check the serial port number of Debug on PC** +**Step 2: Check the serial port number of Debug on PC** -Open the device manager on PC, which is shown as next figure. In this document, it is the COM20 that is deployed. + * Open the device manager on PC, which is shown as next figure. In this document, it is the COM20 that is deployed. ![Helios_SDK_01_06](media\Helios_SDK_01_06.png) - **Step 3: Open the serial port debug tool on PC** +**Step 3: Open the serial port debug tool on PC** -Take the SecureCRT as an example. Click the "Quick connect" as described below, then the `Quick Connect`window will appear + * Take the SecureCRT as an example. Click the "Quick connect" as described below, then the `Quick Connect` window will appear -After that, click the drop-down of `Port` selection and select COM20 correspondingly. As for parameters of the rest, please adhere to the configurations as told below. + * After that, click the drop-down of `Port` selection and select COM20 correspondingly. As for parameters of the rest, please adhere to the configurations as told below. -It is available to open the serial port via clicking the `Connect`button on the bottom right corner. +It is available to open the serial port via clicking the `Connect` button on the bottom right corner. ![Helios_SDK_01_07](media\Helios_SDK_01_07.png) - **Step 4: Start module program ** +**Step 4: Start module program** - Reset the module to start the program + * Reset the module to start the program - **Step 5: Check the running log of module** +**Step 5: Check the running log of module** - Check the running log in the receiving area of serial port of SecureSRT. + * Check the running log in the receiving area of serial port of SecureSRT. ![Helios_SDK_01_08](media\Helios_SDK_01_08.png) diff --git a/docs/Advanced_development/en/HeliosSDK/Helios_SDK_02.md b/docs/Advanced_development/en/HeliosSDK/Helios_SDK_02.md index f3974eed371e991c3d45b05652dfd077964f0d81..9235951e055478ecb80f50fbfef0e98408577a04 100644 --- a/docs/Advanced_development/en/HeliosSDK/Helios_SDK_02.md +++ b/docs/Advanced_development/en/HeliosSDK/Helios_SDK_02.md @@ -67,7 +67,7 @@ The compiled file will be saved in the config file under the root directory of S * The `config.mk` is called by compiled script. * In SDK, the mbedtls has been enabled by default. -Here shows the content that corresponding to `autoconf.h` . +Here shows the content that corresponding to `autoconf.h`. ```c @@ -126,7 +126,7 @@ These 4 categories of menus are used to configure the QuecPython FW and check wh The user can configure the functions supported by QuecPython via menuconfig according to actual needs. -In this case, we just deploy the default configuration of menuconfig and take **EC600SCN_LB** as an example. Then input following commands in command line and click " **Enter** ". +In this case, we just deploy the default configuration of menuconfig and take **EC600SCN_LB** as an example. Then input following commands in command line and click "**Enter**". ```makefile @@ -173,7 +173,7 @@ For opening COM5, please refer to the Step 3 of Chapter 7 in >>` that specialized for Python will appear. +Click "**Enter**" in the data receiving area of SecureCRT, there will be command interaction reminder `>>>` that specialized for Python will appear. At this time, we will carry out the printing operation with the assistance of `print` function of Python. Before that, we should input following codes into SecureCRT. diff --git a/docs/Advanced_development/en/HeliosSDK/Helios_SDK_03.md b/docs/Advanced_development/en/HeliosSDK/Helios_SDK_03.md index ce595ba5b428bc75d3a53743a7d5de973a320612..58b9c24bddba0aee51986cdc7c893c536b0140e0 100644 --- a/docs/Advanced_development/en/HeliosSDK/Helios_SDK_03.md +++ b/docs/Advanced_development/en/HeliosSDK/Helios_SDK_03.md @@ -44,7 +44,7 @@ Compile the script file with the name of `QuecPython_demo.py` in PC. ### Import the Python script file into QuecPython file system -**Step 1: Open QPYcom ** +**Step 1: Open QPYcom** Double click the `QPYcom.exe` in root directory of tool. @@ -119,7 +119,7 @@ Compile a script file named `main.py` in PC. Here shows the contents: -**Step 2: Import main.py file into file system of module ** +**Step 2: Import main.py file into file system of module** Import the `main.py` file into the file system of module via Chapter 1.3. @@ -133,7 +133,7 @@ The USB serial device port that opened by QPYcom will disconnect with PC owing t Reconnect the port according to the Step 2 of Chapter 1.3. -**Step 5: Observe the result after executing ** +**Step 5: Observe the result after executing** After reconnecting the USB serial device port, if there exists `Hello, QuecPython!` with an interval of every other 1s periodically in command interaction surface, which means the *mian.py* script has been auto-booted successfully. @@ -167,7 +167,7 @@ Open `services\microPython\ports\quectel\core\Makefile`, then add `$(BUILD)/hell ![image_1f5cmta1hj4fo2515p41ovj1l3b9.png-109kB](media\Helios_SDK_03_08.png) -> Pay attention to the `\` at the end of `$(BUILD)/hello.mpy \` . +> Pay attention to the `\` at the end of `$(BUILD)/hello.mpy \`. > >In Makefile, if you separate one command into several lines, the `\` should be suffixed. In addition, no character shall exist behind the `\` , including in empty space. diff --git a/docs/Advanced_development/en/README.md b/docs/Advanced_development/en/README.md index 3326a98352d5391f017852c6d7917d14b38d54df..5d355a6b21a8bd3d7796f904c4a83d2646f792ae 100644 --- a/docs/Advanced_development/en/README.md +++ b/docs/Advanced_development/en/README.md @@ -1,12 +1,12 @@ ## Advanced development Advanced development mainly includes the following parts -- a cloud platform +- Cloud platform - Basic peripherals -- component -- Third-party Components +- Component +- Third party component - Advanced components - HeliosService -- Mass production related +- Mass production - HeliosSDK -- Tool related \ No newline at end of file +- Tool \ No newline at end of file diff --git a/docs/Quick_start/en/GPIO.md b/docs/Quick_start/en/GPIO.md index 911ed445ee81c61589ed131a6b94149178937f3b..8986c94102c29bf63a29b77d452c0b97acbb44c7 100644 --- a/docs/Quick_start/en/GPIO.md +++ b/docs/Quick_start/en/GPIO.md @@ -30,7 +30,7 @@ Also, it can be used to read the external level status. When the high level is r **gpio = Pin(GPIOn, direction, pullMode, level)** -**参数Parameters：** +**Parameters：** ​ GPIOn： diff --git a/docs/Quick_start/en/QuecPythonStart/app_dev.md b/docs/Quick_start/en/QuecPythonStart/app_dev.md index 82b2359f304615de1d3a18e85b3db02fbde10492..15d41e5300f40c01c09da57c0a9a4eaab24d7032 100644 --- a/docs/Quick_start/en/QuecPythonStart/app_dev.md +++ b/docs/Quick_start/en/QuecPythonStart/app_dev.md @@ -1,8 +1,8 @@ -## QuecPython APP开发流程 +## QuecPython app development process -本文档主要介绍如何使用QuecPython开发出一个完整的APP。 +This document mainly introduces how to use quecpthon to develop a complete app. -适用模块： +Applicable modules: - EC100Y-CNAA - EC600S-CNAA @@ -17,97 +17,97 @@ - EC200U-CNLB - EC200U-EUAB -### 开发流程 +### Development process -通过上一节的学习，已经掌握了电脑和模组的通信工作，那么我们平时是如何开发产品的呢，如何写代码、管理文件呢，这个时候就要安装工具了。 +Through the study of the previous section, we have mastered the communication between computers and modules. How do we usually develop products, write codes and manage files? At this time, we need to install tools. -- 安装代码编辑Vscode； +-Installation code editing vscode; -- 通过QPYcom工具下载.py脚本文件到模块中运行、调试。 +-Download through qpycom tool Py script file into the module to run and debug. -- 调试功能代码参考API说明：https://python.quectel.com/wiki/#/zh-cn/api/?id=pin +-Refer to API description for debugging function code: https://python.quectel.com/wiki/#/en-us/api/?id=pin -- 快速体验功能效果可下载参考demo：https://python.quectel.com/download +-To quickly experience the function effect, you can download the reference Demo: https://python.quectel.com/download -### 安装编辑工具 VsCode或PyCharm +### Install the editing tool vscode or pycharm -### 安装Python3.9 +### Install Python 3 nine -Python安装包下载地址：https://www.python.org/downloads/ +Python installation package download address: https://www.python.org/downloads/ -一路下一步直到安装完成，默认路径在：C:\Users\Chic.ye\AppData\Local\Programs\Python\ +Go to the next step until the installation is completed. The default path is: C: \ users \ chic ye\AppData\Local\Programs\Python\ -安装完成后，使用cmd命令窗口输入：python --version +After installation, use the CMD command window to enter: Python -- version -看到返回 Python 3.9.1，说明已经正确安装Python的开发环境 +When you see Python 3.9.1 returned, it indicates that the python development environment has been correctly installed ### Vscode -推荐参考 -[VSCode搭建Python开发环境(含Python环境搭建)](https://zhuanlan.zhihu.com/p/165379391) +Recommended reference +[vscode builds Python development environment (including Python environment construction)](https://zhuanlan.zhihu.com/p/165379391) -### 编写代码 +### Write code -以PyCharm为例： +Take pycharm as an example: ![](../media/PyCharm_1.png) -### 在模组中运行代码文件 +### Run code files in modules -把上一步编辑好的代码，点击加号选择文件（或者直接从左边拖到右边），文件就下载到模组里面了。 +Click the plus sign to select the file (or drag it directly from the left to the right), and the file will be downloaded to the module. ![](../media/C59.png) -如下图：在QPYcom工具的【文件】选项卡中选中脚本文件，点击“运行” +As shown in the following figure: select the script file in the [file] tab of qpycom tool and click "run" ![](../media/C60.png) -自动跳转至【交互】界面，即可看到模组的执行结果。 +Automatically jump to the [interaction] interface to see the execution results of the module. ![](../media/C61.png) -读者会发现在QPYcom的执行结果和模组是一样的，通常我们编写代码是，同样可以在电脑验证业务逻辑或语法，然后再放到模组中执行，这样开发效率就大大提高了。 +Readers will find that the execution result of qpycom is the same as that of the module. Usually, when we write code, we can also verify the business logic or syntax on the computer, and then put it into the module for execution. In this way, the development efficiency is greatly improved. -| 小提示 | +|Tips| | ------------------------------------------------------------ | -| 若要作为控制器可从点灯开始，参考链接：https://mp.weixin.qq.com/s/wrE2LXuE35UtKqaCV74zAg | -| 开发板上有LED灯可供点亮哦，详情请查看开发板原理图 | +|To be a controller, you can start with lighting, refer to the link: https://mp.weixin.qq.com/s/wrE2LXuE35UtKqaCV74zAg | +|There are led lights on the development board for lighting. Please check the schematic diagram of the development board for details| -### 巧用wiki助力开发 +### Skillfully using Wiki to help development -遇到不懂的功能开发或者想看看有没有想要的功能，可以参考wiki上的API详细介绍，里面有所有功能的接口说明、参数说明，**只需要在左上角搜索关键字就可以找到你想要的API**。 +When you encounter a function development you don't understand or want to see if there is a desired function, you can refer to the detailed introduction of API on Wiki, which contains the interface description and parameter description of all functions. ** you can find the API you want by searching keywords in the upper left corner. -wiki中文API介绍链接：https://python.quectel.com/wiki/#/zh-cn/api/ +Wiki Chinese api introduction link: https://python.quectel.com/wiki/#/zh-cn/api/ -wiki英文API介绍链接：https://python.quectel.com/wiki/#/en-us/api/ +Wiki English API introduction link: https://python.quectel.com/wiki/#/en-us/api/ -![](../media/C62.png) +![](../media/readme_17.jpg) -点击相应的栏目，可以看到API的详细介绍 +Click the corresponding column to see the detailed introduction of API -![](../media/C63.png) +![](../media/readme_18.jpg) -**特别注意：如果要控制GPIO一定查询上图中的硬件相关功能里的Pin，里面介绍了API中的GPIO对应的各个模组物理引脚号，所有支持GPIO操作的引脚已经列出。** 可以在左上角搜索Pin或者GPIO快速找到。 +**Special note: if you want to control GPIO, you must query the pin in the hardware related functions in the figure above, which introduces the physical pin numbers of each module corresponding to GPIO in API, and all pins supporting GPIO operation have been listed** You can search pin or GPIO in the upper left corner to find it quickly. -### 巧用demo快速开发 +### Quick development with demo -demo下载地址：https://python.quectel.com/download +Demo download address: https://python.quectel.com/download -更多实用demo可在QQ群：445121768，群文件搜索关键词进行下载。 +More practical demos can be downloaded in QQ group: 445121768, group file search keywords. ![](../media/C65.png) -下载后，解压出来的文件夹，添加到pycarm项目里面，可以很方便的查看和编辑demo里面的代码了 +After downloading, unzip the folder and add it to the pycarm project. You can easily view and edit the code in the demo ![](../media/C64.png) -每一个代码都有注释说明 +Each code has comments ![](../media/C66.png) -官网提供的demo非常丰富和完善，帮助客户快速开发产品。 +The demo provided by the official website is very rich and perfect to help customers develop products quickly. diff --git a/docs/Quick_start/en/README.md b/docs/Quick_start/en/README.md index 56aac3ada4bc7bcce7473f2ed3d7566b620ad0ac..5ba28484bc587e394d7516e2527d9707eb024044 100644 --- a/docs/Quick_start/en/README.md +++ b/docs/Quick_start/en/README.md @@ -4,19 +4,15 @@ | ------- | ---------- | ---------- | ---------------------------------------------- | | 1.0 | 2021-09-02 | Kayden | Initial compilation& User Guide on Quick-Start | | 1.1 | 2021-09-10 | David.Tang | Added the notices on environment building | -| 1.2 | 2022-02-12 | David.Tang | Translate Chinese operation pictures | - -## Preface - -This document is a little monotonous probably. However, if you scan over, you can take charge of QuecPython EVB comprehensively. +| 1.2 | 2022-02-12 | David.Tang | Translate Chinese operation pictures | ## Introduction on Official Website **Official Website address**: **[https://python.quectel.com/](https://python.quectel.com/)** -**Wiki address of official website**: **[https://python.quectel.com/wiki/#/](https://python.quectel.com/wiki/#/)** . You can check all APIs that supported by module. +**Wiki address of official website**: **[https://python.quectel.com/wiki/#/](https://python.quectel.com/wiki/#/)**. You can check all APIs that supported by module. -**Document address**: **[https://python.quectel.com/doc/](https://python.quectel.com/doc/)** , which includes Quick-start, Common interfaces development, Development improvement and Simple tests. +**Document address**: **[https://python.quectel.com/doc/](https://python.quectel.com/doc/)**, which includes Quick-start, Common interfaces development, Development improvement and Simple tests. **Address for downloading development resources**: **[https://python.quectel.com/download](https://python.quectel.com/download)**, which includes development tool, driver, FW and Referential HW design. @@ -32,7 +28,7 @@ Or you can use the magnifier in the top right-hand corner to find what you want. If you have no idea about how to handle with this EVB, please take this document as a reference. -For detailed operation, you can refer to the EC600X EVB. Furthermore, please take the link as a reference: [Application Note on EC600X EVB](https://python.quectel.com/doc/doc/Quecpython_intro/en/Qp_Product_intro/Hardware_Support.html) . +For detailed operation, you can refer to the EC600X EVB. Furthermore, please take the link as a reference: [Application Note on EC600X EVB](https://python.quectel.com/doc/doc/Quecpython_intro/en/Qp_Product_intro/Hardware_Support.html). In this document, we just take EC600S_QuecPython_EVB_V1.1 as an example. As for the differences compared with V1.2 or V1.3, you can check the above link on EC600X EVB. @@ -53,7 +49,7 @@ After acquiring the EVB, plug in the USB interface on the EVB and carry out pow ### Download and Install Driver -As the name implies, " device driver ", with its full name of " device driver program ", is a special program that used to communicate between PC and device. To some extent, it is similar with the HW interface. The operation system can control the running of HW device via this interface only; and if the driver program of certain device is failed to install, it won't run normally. +As the name implies, "device driver", with its full name of "device driver program", is a special program that used to communicate between PC and device. To some extent, it is similar with the HW interface. The operation system can control the running of HW device via this interface only; and if the driver program of certain device is failed to install, it won't run normally. Open the [Link of downloading driver](https://python.quectel.com/download), then select the driver that matched with your own PC as the figure shows. If you drag the arrow to the right, a button for downloading will appear, just click it. @@ -61,9 +57,9 @@ Notices on driver installation 1. **The driver is divided into two categories mainly:** - **No. 1** Based on the platform: ASR platform (EC600SCNAA、EC600SCNLA、EC600SCNLB、EC600N、EC100Y）and RDA platform（EC600U). For more info about platform, please refer to the link :[HW Support.](https://python.quectel.com/doc/doc/Quecpython_intro/en/Qp_Product_intro/Hardware_Support.html) + **No. 1** Based on the platform: ASR platform (EC600SCNAA、EC600SCNLA、EC600SCNLB、EC600N、EC100Y）and RDA platform（EC600U). For more info about platform, please refer to the link: [HW Support.](https://python.quectel.com/doc/doc/Quecpython_intro/en/Qp_Product_intro/Hardware_Support.html) - Many may ask what the platform of EC600X is. Generally, the ” **X** “ in EC600X is an unknown, which can indicate EC600S or EC600U instead of the actual platform. + Many may ask what the platform of EC600X is. Generally, the "**X**" in EC600X is an unknown, which can indicate EC600S or EC600U instead of the actual platform. **No. 2** Based on the PC system: Whether in Windows 7 or Windows 10, please download corresponding driver separately. @@ -73,7 +69,7 @@ Notices on driver installation -Please do as following sequence: open " **My Computer** "--" **Management** "--" **Device manager** " +Please do as following sequence: open "**My Computer**"--"**Management**"--"**Device manager**" Before installing driver: @@ -83,7 +79,7 @@ After installing driver ![](media/readme_5.jpg) -Open unzipped package, then double click to run " **setup.exe** "; after that, keep on clicking the " **Next Step** " till the installation is done. If the port marked with " **exclamation** " in " **device manager** " is invisible, which means the installation is a success and normal communication can be executed. **As the above figure implies, there still exists an" exclamation ", please just ignore for it is useless.** +Open unzipped package, then double click to run "**setup.exe**"; after that, keep on clicking the "**Next Step**" till the installation is done. If the port marked with "**exclamation**" in "**device manager**" is invisible, which means the installation is a success and normal communication can be executed. **As the above figure implies, there still exists an "exclamation", please just ignore for it is useless.** ![](media/readme_6.jpg) @@ -133,23 +129,23 @@ The print (), a function, is used to output some info from the inner device. Thu The print () can also be used to print string and variate. -In QuecPython, the string is indicated by a pair of single quotation marks, such as ‘Hello world! QuecPython’. +In QuecPython, the string is indicated by a pair of single quotation marks, such as 'Hello world! QuecPython'. ### In Real Scenario ****![](media/readme_11.jpg) -After opening up QPYcom, we can see three ports in “select interface” are module-related, among which: +After opening up QPYcom, we can see three ports in "select interface" are module-related, among which: -The “Quectel USB AT Port” is used to send AT command. +The "Quectel USB AT Port" is used to send AT command. -As for “Quectel USB DIAG Port” , it is used to check the debugging info of module. +As for "Quectel USB DIAG Port", it is used to check the debugging info of module. -It is hardly for user to deploy above two ports. As a result, we should pay attention to " ***Quectel USB MI05 COM port*** " particularly. we can debug the code via this port only. +It is hardly for user to deploy above two ports. As a result, we should pay attention to "***Quectel USB MI05 COM port***" particularly. we can debug the code via this port only. -Click dropdown with selecting " ***Quectel USB MI05 COM port*** " following, after that, click " **Enable serial interface** ". +Click dropdown with selecting "***Quectel USB MI05 COM port***" following, after that, click "**Enable serial interface**". -Input **print(‘Hello world! QuecPython’)** in interaction surface and click " **Enter** ". +Input **print('Hello world! QuecPython')** in interaction surface and click "**Enter**". What we can see is shown as following @@ -163,7 +159,7 @@ Hello World! QuecPython ![image-20210910111634969](media/readme_12.jpg) -The returned value of module is visible and "Hello world! QuecPython " is outputted successfully. +The returned value of module is visible and "Hello world! QuecPython" is outputted successfully. ### Other API Interfaces @@ -215,7 +211,7 @@ We have already acquired the communication between PC and module via above chapt Download address for Python installation package: https://www.python.org/downloads/ -Click " Next step " one by one till the installation is done, the default path is located in C:\Users\Chic.ye\AppData\Local\Programs\Python\ +Click "Next step" one by one till the installation is done, the default path is located in C:\Users\Chic.ye\AppData\Local\Programs\Python\ Once the installation is achieved, input **python --version** command in window @@ -239,11 +235,11 @@ Select the compiled code above via clicking"**+**" (Or drag from left to right), ![](media/readme_14.jpg) -Select script file in " **file** " selection under QPYcom, click " **Run** " as following figure shows: +Select script file in "**file**" selection under QPYcom, click "**Run**" as following figure shows: ![](media/readme_15.jpg) -Skip to " **Interaction** " surface automatically, then you can see the executed result of module. +Skip to "**Interaction**" surface automatically, then you can see the executed result of module. ![](media/readme_16.jpg) diff --git a/docs/Quick_start/en/Start_to_abandon.md b/docs/Quick_start/en/Start_to_abandon.md index 511fb59ba04fe562bd0b9c3741ea10b16e7ae8e8..ae814262c7b74cc2a208dc7d7d2aed9ac4dbf918 100644 --- a/docs/Quick_start/en/Start_to_abandon.md +++ b/docs/Quick_start/en/Start_to_abandon.md @@ -2,14 +2,13 @@ In this document, it mainly tells the quick start of QuecPython with three aspects: printing hello World， lighting LED and obtaining source codes of web pages via HTTP. -## Print “Hello World” +## Print "Hello World" 1. Connecting the EVB to PC, there is a need to install driver and flash module FW. For details, please refer to . -2. Print “hello world” +2. Print "hello world" - -（1）Print in interactive surface + (1) Print in interactive surface As next figure shows, the port is connected to the "**Interactive port of QuecPython**" via QPYcom, then click "Interaction" surface; after that, following printing will be carried out. @@ -20,7 +19,7 @@ hello world hello world ``` -（2） Compile *test_helloworld.py* file and print + (2) Compile *test_helloworld.py* file and print Create *test_helloworld.py* file, the next figure tells the compiled script. @@ -77,15 +76,17 @@ while account: utime.sleep(2) # delay 2s ``` -### Running result +### Running result1 + +  1. Run *led_net.py* in QPYcom. + + ![start_to_abandon_02](media\start_to_abandon_02.jpg) -1. Run *led_net.py* in QPYcom. -![start_to_abandon_02](media\start_to_abandon_02.jpg) +  2. When it is a success to get request in running, you should plug out the SIM card (Try stimulate the situation of failure to register network). Please check the log as described below: -2. When it is a success to get request in running, you should plug out the SIM card (Try stimulate the situation of failure to register network). Please check the log as described below: -![Operation_effect](media/Start_to_abandon_03.jpg) + ![Operation_effect](media/Start_to_abandon_03.jpg) Illustration