diff --git a/docs/Quick_start/en/README.md b/docs/Quick_start/en/README.md index fc398dc21d167db1e087cfc717a8840c8f7e5057..56aac3ada4bc7bcce7473f2ed3d7566b620ad0ac 100644 --- a/docs/Quick_start/en/README.md +++ b/docs/Quick_start/en/README.md @@ -1,9 +1,10 @@ ## Revision History -| Version | Date | Author | Description | -| ------- | ---------- | ------ | ---------------------------------------------- | -| 1.0 | 2021-09-02 | Kayden | Initial compilation& User Guide on Quick-Start | -| 1.1 | 2021-09-10 | David | Added the notices on environment building | +| Version | Date | Author | Description | +| ------- | ---------- | ---------- | ---------------------------------------------- | +| 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 @@ -17,13 +18,11 @@ This document is a little monotonous probably. However, if you scan over, you ca **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. +**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. -**QuecPython Community link** ：[https://forumschinese.quectel.com/c/function-subjects/quectpython/43] +**QuecPython Community link** ：**[https://forums.quectel.com/c/quecpython/66](https://forums.quectel.com/c/quecpython/66)** -**[](https://forumschinese.quectel.com/c/function-subjects/quectpython/43)** - - + Or you can use the magnifier in the top right-hand corner to find what you want. If there is none, you can apply for us when it is convenient to you. @@ -33,7 +32,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/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.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. @@ -45,8 +44,6 @@ After acquiring the EVB, plug in the USB interface on the EVB and carry out pow ### How to Boot - - | EVB | Boot operation | | -------------------------- | ------------------------------------------------------------ | | EC600S_QuecPython_EVB_V1.0 | Plug in to boot | @@ -64,7 +61,7 @@ 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/zh/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. @@ -74,24 +71,21 @@ Notices on driver installation 3. **In RDA platform, after downloading USB driver zip, it contains drivers of both Windows 7 and Windows 10.** - - + Please do as following sequence: open " **My Computer** "--" **Management** "--" **Device manager** " Before installing driver: - + After installing driver -![](media/readme_5.png) +![](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.** -![](media/readme_6.png) - -![](media/readme_7.png) +![](media/readme_6.jpg) ![](media/readme_8.png) @@ -111,7 +105,7 @@ Open unzipped package, then double click to run " **setup.exe** "; after that, k 6. **The QPYcom supports flashing Python FW instead of the FW of C or AT Standard.** -7. **When downloading FW, please do not exit tool or plug out the serial interface, which may result in the inaccessibility of module. Once above situation happens, you can refer to the chapter “[How to rescue QuecPython from inaccessibility](https://python.quectel.com/doc/doc/FAQ/zh/QP_recovery/QP_recovery.html)”** +7. **When downloading FW, please do not exit tool or plug out the serial interface, which may result in the inaccessibility of module. Once above situation happens, you can refer to the chapter “[How to rescue QuecPython from inaccessibility](https://python.quectel.com/doc/doc/FAQ/en/QP_recovery/QP_recovery.html)”** ### How to Use QPYcom.exe @@ -143,7 +137,7 @@ In QuecPython, the string is indicated by a pair of single quotation marks, such ### In Real Scenario -****![](media/readme_11.png) +****![](media/readme_11.jpg) After opening up QPYcom, we can see three ports in “select interface” are module-related, among which: @@ -167,13 +161,13 @@ Hello World! QuecPython >>> ``` -![image-20210910111634969](media/readme_12.png) +![image-20210910111634969](media/readme_12.jpg) The returned value of module is visible and "Hello world! QuecPython " is outputted successfully. ### Other API Interfaces -For other functions, please refer to the official website: https://python.quectel.com/wiki/#/zh-cn/api/?id=pin +For other functions, please refer to the official website: https://python.quectel.com/wiki/#/en-us/api/?id=pin It is also available to download relevant tools, routines, drivers and documents in official website: https://python.quectel.com/download @@ -208,7 +202,7 @@ We have already acquired the communication between PC and module via above chapt - Download **.py** script file into module to run and debug via QPYcom. -- About debugging functional code, please refer to API illustration: https://python.quectel.com/wiki/#/zh-cn/api/?id=pin +- About debugging functional code, please refer to API illustration: https://python.quectel.com/wiki/#/en-us/api/?id=pin - About getting better experience, please refer to demo: https://python.quectel.com/download @@ -237,21 +231,21 @@ Referential document Take *PyCharm* as an example -![](media/PyCharm_1.png) +![](media/readme_13.jpg) ### Run Code on Module Select the compiled code above via clicking"**+**" (Or drag from left to right), the file will be downloaded to module. -![](media/C59.png) +![](media/readme_14.jpg) Select script file in " **file** " selection under QPYcom, click " **Run** " as following figure shows: -![](media/C60.png) +![](media/readme_15.jpg) Skip to " **Interaction** " surface automatically, then you can see the executed result of module. -![](media/C61.png) +![](media/readme_16.jpg) What we can find is that the result in QPYcom is as same as that in module. Normally, when compiling codes, we can verify service logic and sentence in PC but execute in module, as a result, the development efficiency will be improved prominently. @@ -267,11 +261,11 @@ API Introduction on WIKI (In Chinese): https://python.quectel.com/wiki/#/zh-cn/a API Introduction on WIKI (In English): https://python.quectel.com/wiki/#/en-us/api/ -![](media/C62.png) +![](media/readme_17.jpg) Click the corresponding item, detailed introduction on API will be displayed. -![](media/C63.png) +![](media/readme_18.jpg) @@ -283,16 +277,12 @@ Address to download demo：https://python.quectel.com/download For more practical demos, you can search for key words for downloading in QQ Group: 445121768. -![](media/C65.png)Unzip the folder and add it into the **pycarm** after downloading, then you can check and compile the code in demo conveniently. +![](media/C65.jpg)Unzip the folder and add it into the **pycharm** after downloading, then you can check and compile the code in demo conveniently. -![](media/C64.png) +![](media/readme_19.png) There exists illustration on every code. -![](media/C66.png) - - - from machine import Pin import utime @@ -301,21 +291,19 @@ import checkNet -，，， +''' It is a must to have following two variates. Users can modify the value of these two variates according to the actual need. And before executing user codes, the value of these two variates will be printed beforehand. -**PROJECT_NAME = "QuecPython_Pin_example"** +''' - **PROJECT_VERSION = "1. 0. 0"** +**PROJECT_NAME = "QuecPython_Pin_example"** - + **PROJECT_VERSION = "1. 0. 0"** checkNet = checkNet. CheckNetwork(PROJECT_NAME, PROJECT_VERSION) - - - ，，， +\''' * Parameter 1： Pin No. @@ -335,4 +323,6 @@ It is a must to have following two variates. Users can modify the value of these +''' + Abundant and complete demos are displayed on official website, which can do a great favor in developing user product. \ No newline at end of file diff --git a/docs/Quick_start/en/media/C65.jpg b/docs/Quick_start/en/media/C65.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1a6bf431305b64fb3630810b30870dee1cd87a18 Binary files /dev/null and b/docs/Quick_start/en/media/C65.jpg differ diff --git a/docs/Quick_start/en/media/image-20211009095453632.png b/docs/Quick_start/en/media/image-20211009095453632.png new file mode 100644 index 0000000000000000000000000000000000000000..d6d9a6fa369e8d1d8e666120ba64045090abc284 Binary files /dev/null and b/docs/Quick_start/en/media/image-20211009095453632.png differ diff --git a/docs/Quick_start/en/media/readme_1.jpg b/docs/Quick_start/en/media/readme_1.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5c5fec23bc8816fb64b18f70e17025cda05ce88c Binary files /dev/null and b/docs/Quick_start/en/media/readme_1.jpg differ diff --git a/docs/Quick_start/en/media/readme_10.png b/docs/Quick_start/en/media/readme_10.png new file mode 100644 index 0000000000000000000000000000000000000000..68f76ccb4239962c24d7e6739046a63811d3151a Binary files /dev/null and b/docs/Quick_start/en/media/readme_10.png differ diff --git a/docs/Quick_start/en/media/readme_11.jpg b/docs/Quick_start/en/media/readme_11.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7ca94b917ce2d588af46e92a2862f55f3f197c6 Binary files /dev/null and b/docs/Quick_start/en/media/readme_11.jpg differ diff --git a/docs/Quick_start/en/media/readme_12.jpg b/docs/Quick_start/en/media/readme_12.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ebbb19a639346eefc687e106ca18aad2e9f480bb Binary files /dev/null and b/docs/Quick_start/en/media/readme_12.jpg differ diff --git a/docs/Quick_start/en/media/readme_13.jpg b/docs/Quick_start/en/media/readme_13.jpg new file mode 100644 index 0000000000000000000000000000000000000000..893414099d75d0a945bbe46cd319251f18c7d216 Binary files /dev/null and b/docs/Quick_start/en/media/readme_13.jpg differ diff --git a/docs/Quick_start/en/media/readme_14.jpg b/docs/Quick_start/en/media/readme_14.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9bbaa51d15bcb4728cf85aabed6c34820530ae9e Binary files /dev/null and b/docs/Quick_start/en/media/readme_14.jpg differ diff --git a/docs/Quick_start/en/media/readme_15.jpg b/docs/Quick_start/en/media/readme_15.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59f266599398dfe90b839323af6a9b7424cc5ab0 Binary files /dev/null and b/docs/Quick_start/en/media/readme_15.jpg differ diff --git a/docs/Quick_start/en/media/readme_16.jpg b/docs/Quick_start/en/media/readme_16.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e634a17ae8db0e16306f66ac75f726919a18226 Binary files /dev/null and b/docs/Quick_start/en/media/readme_16.jpg differ diff --git a/docs/Quick_start/en/media/readme_17.jpg b/docs/Quick_start/en/media/readme_17.jpg new file mode 100644 index 0000000000000000000000000000000000000000..153d7499957b7b564406ae55d03f97091687ee04 Binary files /dev/null and b/docs/Quick_start/en/media/readme_17.jpg differ diff --git a/docs/Quick_start/en/media/readme_18.jpg b/docs/Quick_start/en/media/readme_18.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3381812e8d1da583a6b89b312e6ab6785537a332 Binary files /dev/null and b/docs/Quick_start/en/media/readme_18.jpg differ diff --git a/docs/Quick_start/en/media/readme_19.png b/docs/Quick_start/en/media/readme_19.png new file mode 100644 index 0000000000000000000000000000000000000000..30a51d2aab5c545540a13f938227e70459143db7 Binary files /dev/null and b/docs/Quick_start/en/media/readme_19.png differ diff --git a/docs/Quick_start/en/media/readme_2.png b/docs/Quick_start/en/media/readme_2.png new file mode 100644 index 0000000000000000000000000000000000000000..668a64649fc0861aab506b2ebb18c2f7e9a2af67 Binary files /dev/null and b/docs/Quick_start/en/media/readme_2.png differ diff --git a/docs/Quick_start/en/media/readme_3.jpg b/docs/Quick_start/en/media/readme_3.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07c15f102325f067099895e1d964d20f1b5b748e Binary files /dev/null and b/docs/Quick_start/en/media/readme_3.jpg differ diff --git a/docs/Quick_start/en/media/readme_4.jpg b/docs/Quick_start/en/media/readme_4.jpg new file mode 100644 index 0000000000000000000000000000000000000000..180aea7d90ae694a5276810703c22f65421f33c3 Binary files /dev/null and b/docs/Quick_start/en/media/readme_4.jpg differ diff --git a/docs/Quick_start/en/media/readme_5.jpg b/docs/Quick_start/en/media/readme_5.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb27216350ac189938ba84b3352e3ac44211272e Binary files /dev/null and b/docs/Quick_start/en/media/readme_5.jpg differ diff --git a/docs/Quick_start/en/media/readme_6.jpg b/docs/Quick_start/en/media/readme_6.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b68e75dd6af2f1f61e97f682dccdb667d89c8c8 Binary files /dev/null and b/docs/Quick_start/en/media/readme_6.jpg differ diff --git a/docs/Quick_start/en/media/readme_8.png b/docs/Quick_start/en/media/readme_8.png new file mode 100644 index 0000000000000000000000000000000000000000..95bbe9b3d5d099e5cef199d0d40b800cc23265fe Binary files /dev/null and b/docs/Quick_start/en/media/readme_8.png differ diff --git a/docs/Quick_start/en/media/readme_9.png b/docs/Quick_start/en/media/readme_9.png new file mode 100644 index 0000000000000000000000000000000000000000..8fbf4c08741337eeec98ec82f4a06017fb41a602 Binary files /dev/null and b/docs/Quick_start/en/media/readme_9.png differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_01.jpg b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_01.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cd032438c868c707ee2337efee92116f8af2ae3a Binary files /dev/null and b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_01.jpg differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_01.png b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_01.png deleted file mode 100644 index d3ff00fe6989a40b433d3c2a88feb41cdd47908f..0000000000000000000000000000000000000000 Binary files a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_01.png and /dev/null differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_02.jpg b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_02.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6118beda05b86b5b5af89e7a7cb6f8fa64280dcc Binary files /dev/null and b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_02.jpg differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_02.png b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_02.png deleted file mode 100644 index cf01c852045c1a2b91b96c5498b7143e31ef16bc..0000000000000000000000000000000000000000 Binary files a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_02.png and /dev/null differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_03.jpg b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_03.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d09ccb3733ef9c451116a5b5d79112cd4c1b7a6 Binary files /dev/null and b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_03.jpg differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_03.png b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_03.png deleted file mode 100644 index 01a07df983814ad728c799bfb93d48d33662da4a..0000000000000000000000000000000000000000 Binary files a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_03.png and /dev/null differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_04.jpg b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_04.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58d8d473481728f95c90776ee6a3743796940f94 Binary files /dev/null and b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_04.jpg differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_04.png b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_04.png deleted file mode 100644 index ced3c491f839bb0aaf03315e37ba1433a7ba430d..0000000000000000000000000000000000000000 Binary files a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_04.png and /dev/null differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_05.png b/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_05.png deleted file mode 100644 index 489fc4e8e019475afad73bbde61b4f09212d1f3f..0000000000000000000000000000000000000000 Binary files a/docs/sbs/en/QuecPythonWirelessNetwork/media/ntp_05.png and /dev/null differ diff --git a/docs/sbs/en/QuecPythonWirelessNetwork/ntp.md b/docs/sbs/en/QuecPythonWirelessNetwork/ntp.md index 222e4d8355b21eeed848c58de24a229bbd51da1d..36b8c49f667f5f843501f560fea8363ec66a63c8 100644 --- a/docs/sbs/en/QuecPythonWirelessNetwork/ntp.md +++ b/docs/sbs/en/QuecPythonWirelessNetwork/ntp.md @@ -3,6 +3,7 @@ |------|------|------|------| | 1.0 | 2021-4-1 | gary.zhou | Initial version | | 1.1 | 2021-9-15 | David.Tang | Checked and modified | +| 1.2 | 2022-02-15 | David.Tang | Translate Chinese operation pictures | ## Foreword @@ -18,50 +19,46 @@ In order to prevent the malicious damage to time server, the Authentication mech ## About API -For detailed API, please refer to [QuecPython-ntptime-NTP Time Service](https://python.quectel.com/wiki/#/zh-cn/api/QuecPythonThirdlib?id=ntptime-ntp对时) +For detailed API, please refer to [QuecPython-ntptime-NTP Time Service](https://python.quectel.com/wiki/#/en-us/api/QuecPythonThirdlib?id=ntptime-ntp-time-synchronization) ## Function realization For NTP time service, you should get time from NTP server. Therefore, there is a need to connect network beforehand. In this document, we just take the access to network via SIM card as an example. ### Step 1 -Prepare one usable SIM card, plug in, power on and wait for the automatic dial up. Take **EC600S-CN** as an example. The NANO SIM socket, with a feature of push - push, downward touching point and inward notch, is implemented on *the EC600S_QuecPython_EVB_V1.1*. +Prepare one usable SIM card, plug in, power on and wait for the automatic dial up. Take **EC200U-EU** as an example. After automatic dial up, verify whether it is a success via following method: - ![ntp-01（E）](media\ntp-01（E）.png) Figure 1 Insert SIM card +![](media/ntp_01.jpg) -After automatic dial up, verify whether it is a success via following method: - -![](media/ntp_02.png) - -​ Figure 2: The verification of data call is a success +​ Figure 1: The verification of data call is a success ### Step 2 Import *ntptime* module and return to the current NTP server, which is *ntp.aliyun.com* by default. -![](media/ntp_03.png) +![](media/ntp_02.jpg) - ​ Figure 3 Current NTP Server + ​ Figure 2: Current NTP Server ### Step 3 Set NTP server. If it is a success, which will return 0, while it is a failure, which will return -1. -![](media/ntp_04.png) +![](media/ntp_03.jpg) - ​ Figure 4: Set NTP Server + ​ Figure 3: Set NTP Server ### Step 4 Synchronize NTP time via *ntptime.settime.* If it is a success, which will return 0, while it is a failure, which will return -1. -As for the time service result, it is available to verify via *utime.localtime()*. The current time with a tuple- (year, month, mday, hour, minute, second, weekday, yearday) will be returned once execute *utime.localtime()*. For detailed API, please refer to [QuecPython-utime-Time related functions](https://python.quectel.com/wiki/#/zh-cn/api/pythonStdlib?id=utime-与时间相关功能). +As for the time service result, it is available to verify via *utime.localtime()*. The current time with a tuple- (year, month, mday, hour, minute, second, weekday, yearday) will be returned once execute *utime.localtime()*. For detailed API, please refer to [https://python.quectel.com/wiki/#/en-us/api/pythonStdlib?id=utime-time-related-functions). The returned time is UTC via *ntptime.settime()*, however, the Beijing time is ahead of UTC for 8 eight, therefore, compared with current time, the time goes back 8 hours. -![](media/ntp_05.png) +![](media/ntp_04.jpg) - ​ Figure 5: Success in Time Service + ​ Figure 4: Success in Time Service ## Appendix: Term abbreviation