diff --git a/docs/FAQ/zh/media/image-20210417094546127.png b/docs/FAQ/zh/media/image-20210417094546127.png new file mode 100644 index 0000000000000000000000000000000000000000..bab15af5508fce5acf2f9d8b639a3ba83d7fed2f Binary files /dev/null and b/docs/FAQ/zh/media/image-20210417094546127.png differ diff --git a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.md b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.md index 535d993ffdcebac42004f0f338c6955017566396..96116205e4b96c78eef5303784519991f048e47b 100644 --- a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.md +++ b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.md @@ -278,17 +278,37 @@ V1.2开发板集成了一个GNSS模组L76K，客户无需联网即可获取定 ## 准备工作 +### 开发板开机 + +对于模组来说，开机条件都是类似的，但是由于硬件设计的不同，不同开发板的开机操作略有区别， **如下表格强烈建议查看** + +| 开发板 | 开机操作 | +| -------------------------- | -------------------------------------------------------- | +| EC600S_QuecPython_EVB_V1.0 | 插电即开机 | +| EC600S_QuecPython_EVB_V1.1 | 长按开发板侧边的POWKY两秒松开，模组便会开机 | +| EC600S_QuecPython_EVB_V1.2 | 开发板上的PWK_ON跳帽短接，则无需长按PWK，反之需要长按PWK | + ### 安装USB驱动 使用开发板前，需要在电脑上安装USB驱动。正确安装后，电脑可以识别开发板。 驱动程序下载地址： -- 请选择对应的驱动 + **注意事项** + +**1.驱动的分类主要分为两大类：** + +**第一、基于模组支持的平台分类：ASR平台（EC600SCNAA、EC600SCNLA、EC600SCNLB、EC600N、EC100Y）和RDA平台（EC600U）更多模组的平台信息可见：[硬件支持](https://python.quectel.com/doc/doc/Quecpython_intro/zh/Qp_Product_intro/Hardware_Support.html)** - +**相信大家也有一个疑问EC600X是什么平台，实际上EC600X中“X”是一个未知数，可指EC600S、EC600U等，并不代表实际的平台。** -图13：驱动安装\_驱动位置 +**第二、基于PC的系统分类：Windows7系统请下载Windows7对应的驱动；Windows10系统请下载Windows10对应的驱动。** + +**2.对于EC600SCNLA和EC600SCNLB，必须下载最新版本的驱动，驱动版本至少在V1.0.8以上** + +驱动安装步骤如下： + +- 请选择对应的驱动，具体安装哪个驱动参考上述注意事项 - 开发者下载驱动程序的压缩包后，完整解压该压缩包到任意目录，双击运行setup.exe： @@ -310,11 +330,7 @@ V1.2开发板集成了一个GNSS模组L76K，客户无需联网即可获取定 ### 验证驱动安装 -驱动安装成功后，使用USB TypeA-TypeC数据线，将开发板连接到电脑上，并长按POWKY开机。 - -| 请注意 | -| ------------------------------------------------------------ | -| （1）V1.0开发板，上电自动开机，无需长按 POWKY
（2）V1.1开发板，需要长按POWKY开机
（3）V1.2开发板，是否需要长按POWKY开机，由跳帽决定。
（4）开发板的USB Type-U为母口，仅可当作从设备，接口类型为USB2.0 | +驱动安装成功后，使用USB TypeA-TypeC数据线，将开发板连接到电脑上，并开机（具体开机参考可参考上述“开发板开机”章节）。 在电脑上打开“设备管理器”，进入电脑的设备管理器，展开**“端口(COM 和LPT)”**，应出现三个串口设备： @@ -322,7 +338,7 @@ V1.2开发板集成了一个GNSS模组L76K，客户无需联网即可获取定 - **Quectel USB DIAG Port (COMx)** -- **USB 串行设备 (COMx)** +- **Quectel USB MI05 COM Port (COMx)** | 小提示 | | ---------------------------------------------------------------------------- | @@ -342,11 +358,11 @@ V1.2开发板集成了一个GNSS模组L76K，客户无需联网即可获取定 如果您的电脑只识别了两个串口设备（没有“USB串行设备”），那么可能是因为没有刷入QuecPython固件的缘故。别着急，请阅读下一章节，刷入QuecPython固件就可以啦。 -![](media/DM_not_Quecpython.png) +![image-20210417105022954](media/DM_not_Quecpython.png) 如果您的电脑正确识别了三个串口设备，那么恭喜您，一切准备就绪，可以开始QuecPython之旅啦\~！ -1604807389(1) +![image-20210417104910841](media/DM_Quecpython.png) ### 验证固件版本 @@ -390,9 +406,12 @@ QPYcom下载地址： 什么是QuecPython 固件（下简称“固件”）？为什么要下载它呢？ 固件是包含驱动、BL、FS、VM等资源的一个二进制程序，没有固件的模块，就像没有辣椒的火鸡面，寡淡无味。下载固件后，模块就可以“跑起来”啦。 通俗来讲，“固件相对于Quectel通信模组”，类似于“操作系统相对于电脑”；”用户脚本相对于QuecPython固件”，类似于”应用程序相对于操作系统”。 只有把操作系统安装到电脑上（下载固件），再把应用程序安装好（下载用户脚本），才能让电脑发挥相应的功能，执行相应的操作和指令。 -| 请注意 | -| ----------------------------------------------------------------------------------------------------- | -| 下载固件前，建议优先需要确认固件版本。以免降级或者下错版本。 下载固件后，所有用户区的内容都将被清空。 | + **注意事项** + +1. **哪里可以获取到QuecPython 固件？ 请到QuecPython官方网站下载：
** +2. **不同模组对应不同的固件，不支持交叉烧录，如果误烧，一定要纠正烧录成对应固件，否则无法正常使用。例如：EC600S分为EC600SCNAA、EC600SCNLA、EC600SCNLB等等，这些模组之间都不支持交叉烧录。**** +3. **关于固件包的说明，由于官网下载的固件压缩文件包含固件包与change log，所以官网下载的固件压缩文件需要解压一层，才可以得到可烧录的固件包，后面会评估更改固件包的后缀为.bin（计划中，如果后面更新完成，记得烧录时选择后缀为.bin的压缩文件）。** +4. **下载固件前，建议优先需要确认固件版本，以免降级或者下错版本。 下载固件后，所有用户区的内容都将被清空。** 使用QPYcom工具下载固件的步骤如下： @@ -406,13 +425,13 @@ QPYcom下载地址： 5. 左键点击页面右下角倒三角形，在弹出的菜单中选择“**下载固件**”菜单，点击“**下载固件**”按钮，工具自动开始固件下载 -| 小提示 | -| --------------------------------------------------------------------------------------------------------------------- | -| 下载固件时，无需选择串口，工具将自动选择并开始下载 请勿同时插入两个或两个以上的开发板，以免工具无法识别，导致下载出错 | +| 小提示 | +| ------------------------------------------------------------ | +| 下载固件时，无需选择串口，工具将自动选择并开始下载
请勿同时插入两个或两个以上的开发板，以免工具无法识别，导致下载出错 | -| 请注意 | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 下载固件过程中，请勿退出工具，或者拔掉串口，可能致使模块变砖。 如果模块确已变砖，则只有关机，拉高BOOT开机，强制进入下载模式（出现donwload下载口），并使用QPYcom重新下载固件成功，才能救砖。 | +| 请注意 | +| ------------------------------------------------------------ | +| 下载固件过程中，请勿退出工具，或者拔掉串口，可能致使模块变砖。 如果模块确已变砖，可见“[QuecPython救砖处理](https://python.quectel.com/doc/doc/FAQ/zh/QP_recovery/QP_recovery.html)”章节 | @@ -432,10 +451,6 @@ QPYcom下载地址： 下载完成后，可以使用上一章的方法，发送AT指令，或者使用“交互”页测试，固件是否正确下载。 -| 小提示 | -| ------------------------------------------------------------ | -| 哪里可以获取到QuecPython 固件？ 请到QuecPython官方网站下载：
下载失败如何处理？模块变砖怎么办？ 请加入我们的QQ 群 445121768，工程师在线为您答疑解惑 | - ### 下载helloworld.py程序到开发板 使用QPYcom工具，我们可以将自己的 Python 脚本文件下载到模块中。 diff --git a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_Quecpython.png b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_Quecpython.png index 44f24275daa1c55b664072c86ea14d54951d6347..5206d0512beab4dfb59b0eb522bd697a9cffe178 100755 Binary files a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_Quecpython.png and b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_Quecpython.png differ diff --git a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_not_Quecpython.png b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_not_Quecpython.png index 9eca0ad4c2c4d69699a62c24105ed5b12df3c587..ee6775860106c0d0b2aa52143f85c6041fb1ebf0 100755 Binary files a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_not_Quecpython.png and b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/DM_not_Quecpython.png differ diff --git a/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/image-20210417151615729.png b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/image-20210417151615729.png new file mode 100644 index 0000000000000000000000000000000000000000..dd94d41a3218a9d4053bb5408c54e272998bca1e Binary files /dev/null and b/docs/Quecpython_intro/zh/Qp_Hw_EC600X/media/image-20210417151615729.png differ diff --git a/docs/Quick_start/zh/Quick_start.md b/docs/Quick_start/zh/Quick_start.md new file mode 100644 index 0000000000000000000000000000000000000000..c2016059c5fcc6efd7e3f13ea42e268ee6a3cbae --- /dev/null +++ b/docs/Quick_start/zh/Quick_start.md @@ -0,0 +1,64 @@ +## 修订历史 + +| 版本 | 日期 | 作者 | 变更表述 | +| ---- | --------- | ----- | -------------------------- | +| 1.0 | 2021-4-17 | David | 首次编写，指导客户快速开发 | + +## 前言 + +本篇可能比较枯燥，但是仔细看完，相信你可以顺利玩转QuecPython开发板 + +## QuecPython 开发常用网址 + +**官网首页地址： [https://python.quectel.com/](https://python.quectel.com/)** + +**官网wiki地址：[https://python.quectel.com/wiki/#/](https://python.quectel.com/wiki/#/)**，对于模组支持的API都可以在此查找。 + +**文档中心地址：[https://python.quectel.com/doc/](https://python.quectel.com/doc/)**，主要包括快速入门，常用接口开发，开发进阶，小实验等。 + +**开发资源下载地址：[https://python.quectel.com/download](https://python.quectel.com/download)**，主要包括开发工具、驱动、固件、硬件参考设计等的下载。 + +## QuecPython 开发环境搭建 + +对于每一款开发板，都有对应的开发板使用说明，例如：[EC600X系列的开发板使用说明](https://python.quectel.com/doc/doc/Quecpython_intro/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.html)，详细的使用说明，这里不做赘述， **不过强烈建议大家看一下[EC600X系列的开发板使用说明](https://python.quectel.com/doc/doc/Quecpython_intro/zh/Qp_Hw_EC600X/Hardware_Support_EC600X.html)文档的第五章节“准备工作”（熟悉驱动安装、固件烧录、脚本下载等基本开发技能），尤其是此章节中的注意事项**。为了防止大家入坑，这里简单做个总结。 + +### 如何开机 + +| 开发板 | 开机操作 | +| -------------------------- | -------------------------------------------------------- | +| EC600S_QuecPython_EVB_V1.0 | 插电即开机 | +| EC600S_QuecPython_EVB_V1.1 | 长按开发板侧边的POWKY两秒松开，模组便会开机 | +| EC600S_QuecPython_EVB_V1.2 | 开发板上的PWK_ON跳帽短接，则无需长按PWK，反之需要长按PWK | + +### 驱动安装注意事项 + +1. **驱动的分类主要分为两大类：** + + **第一、基于模组支持的平台分类：ASR平台（EC600SCNAA、EC600SCNLA、EC600SCNLB、EC600N、EC100Y）和RDA平台（EC600U）更多模组的平台信息可见：[硬件支持](https://python.quectel.com/doc/doc/Quecpython_intro/zh/Qp_Product_intro/Hardware_Support.html),相信大家也有一个疑问EC600X是什么平台，实际上EC600X中“X”是一个未知数，可指EC600S、EC600U等，并不代表实际的平台。** + + **第二、基于PC的系统分类：Windows7系统请下载Windows7对应的驱动；Windows10系统请下载Windows10对应的驱动。** + +2. **对于EC600SCNLA和EC600SCNLB，必须下载最新版本的驱动，驱动版本至少在V1.0.8以上** + +### 固件烧录注意事项 + +1. **不同模组对应不同的固件，不支持交叉烧录，如果误烧，一定要纠正烧录成对应固件，否则无法正常使用。例如：EC600S分为EC600SCNAA、EC600SCNLA、EC600SCNLB等等，这些模组之间都不支持交叉烧录。** +2. **关于固件包的说明，由于官网下载的固件压缩文件包含固件包与change log，所以官网下载的固件压缩文件需要解压一层，才可以得到可烧录的固件包，后面会评估更改固件包的后缀为.bin（计划中，如果后面更新完成，记得烧录时选择后缀为.bin的压缩文件）。** +3. **下载固件前，建议优先需要确认固件版本，以免降级或者下错版本。 下载固件后，所有用户区的内容都将被清空。** +4. **下载固件时，无需选择串口，工具将自动选择并开始下载** +5. **请勿同时插入两个或两个以上的开发板，以免工具无法识别，导致下载出错** +6. **QPYcom工具支持烧录pythonn固件，不支持烧C固件或者AT标准固件** +7. **下载固件过程中，请勿退出工具，或者拔掉串口，可能致使模块变砖。 如果模块确已变砖，可见“[QuecPython救砖处理](https://python.quectel.com/doc/doc/FAQ/zh/QP_recovery/QP_recovery.html)”章节** + +## QuecPython代码编写资料地址 + +对于QuecPython代码编写资料主要分为三个部分 + +1. [demo例程](https://python.quectel.com/download)：在左侧超链接中，找到如下的文件，demo里面中的每个例子都可以单独运行。 + + ![image-20210417151635408](media/demo.png) + +2. [wiki_API库](https://python.quectel.com/wiki/#/)：此网站会详细介绍模组支持的API接口，以及API接口的使用说明，如果你开始不熟悉某个API接口的使用方法，可以在此连接找到对应的说明，例如：不熟悉UART的使用，可以点击[UART](https://python.quectel.com/wiki/#/zh-cn/api/QuecPythonClasslib?id=uart)。 + +3. [文档中心](https://python.quectel.com/doc/)：文档中心的内容比较丰富，主要分为：产品介绍、快速开始、手把手教学、小实验、开发进阶、产品案例、产品量产、常见问题。建议花点时间了解每个部分主要包括哪些，保证会有意想不到的效果。 + diff --git a/docs/Quick_start/zh/media/Document_Center.png b/docs/Quick_start/zh/media/Document_Center.png new file mode 100644 index 0000000000000000000000000000000000000000..9adb7443cbea1e2be4c7492b46126ef7b07bed63 Binary files /dev/null and b/docs/Quick_start/zh/media/Document_Center.png differ diff --git a/docs/Quick_start/zh/media/demo.png b/docs/Quick_start/zh/media/demo.png new file mode 100644 index 0000000000000000000000000000000000000000..dd94d41a3218a9d4053bb5408c54e272998bca1e Binary files /dev/null and b/docs/Quick_start/zh/media/demo.png differ diff --git a/docs/Quick_start/zh/media/image-20210417104838076.png b/docs/Quick_start/zh/media/image-20210417104838076.png new file mode 100644 index 0000000000000000000000000000000000000000..5206d0512beab4dfb59b0eb522bd697a9cffe178 Binary files /dev/null and b/docs/Quick_start/zh/media/image-20210417104838076.png differ diff --git a/docs/Quick_start/zh/sidebar.yaml b/docs/Quick_start/zh/sidebar.yaml index 678b00e34e14a104c72928c8c9d1985ff1af9107..bdfd18294e34d27a2bb9de8dc8eb8c5dd21e7eed 100755 --- a/docs/Quick_start/zh/sidebar.yaml +++ b/docs/Quick_start/zh/sidebar.yaml @@ -1,6 +1,8 @@ # Quecpython 快速开始 items: - - label: QuecPython 开发环境搭建 + - label: QuecPython开发环境搭建 file: README.md - - label: QuecPython快速入门 + - label: QuecPython快速开始 + file: Quick_start.md + - label: QuecPython快速入门（后面更改） file: QuecPythonHelloWord/README.md