diff --git a/zh/README.md b/zh/README.md index 400ece74d07e4c324f2ccc60fcd2a47c92672e8a..221c9a84437dec949e1bfe5d5636e1cf4abf1319 100644 --- a/zh/README.md +++ b/zh/README.md @@ -1,4 +1,4 @@ -# QuecPython 应用指导 +# 开发板操作指南 QuecPython 开发板是由移远通信（Quectel）推出的嵌入式物联网开发平台，基于 QuecPython 嵌入式操作系统（专为物联网优化的 Python 轻量级解释器）。该开发板集成了蜂窝通信模组（如 4G Cat.1/NB-IoT/5G）、Wi-Fi/蓝牙等无线连接能力，支持通过 Python 语言快速开发物联网终端设备，大幅降低开发门槛。 diff --git a/zh/bg95-evb.md b/zh/bg95-evb.md index 334c63627bc893a92782a33df441f4db24e4bbb0..ba840e46e7beff38b9ef685bfd4c6d77c6ae0b42 100644 --- a/zh/bg95-evb.md +++ b/zh/bg95-evb.md @@ -127,7 +127,7 @@ QuecPython_BG95_EVB 开发板是一款专门针对QuecPython设计的、小巧 - **Step3：开发板连接** -使用 USB Type-C 数据线连接开发板的 Type-C/Micro USB 接口和电脑 USB 口即可完成供电。 +使用 USB Type-C 数据线连接开发板的 Type-C 接口和电脑 USB 口即可完成供电。 - **Step4：开发板开机** @@ -372,3 +372,97 @@ example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 （1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块 + + +## 低功耗测试指导 + +BG95模组支持多种工作模式，每种模式的功耗各不相同，常见的工作模式有以下几种： + +**ACTIVE**：模组进行LTE数传、GSM通话或RTOS在运行逻辑时的状态，功耗受到具体业务和网络通信制式的影响，CPU本身功耗和网络射频功率都有所不同，故实际功耗在不同工况下会有较大差异。 + +**IDLE**：此时模组处于空闲状态，硬件正常在电，RTOS保持运行，但没有任何线程需要被执行。有业务启动或网络业务呼入时，会立即恢复运行。ECX00U系列模组会在IDLE模式下降低时钟频率，进入轻睡眠状态（关闭高速时钟，但CPU不休眠的状态）。 + +**休眠**：休眠模式的前提是模组处于空闲状态且使能autosleep，进入休眠模式后，RTOS暂停运行，模组的时钟频率会变慢，部分外设控制器（UART、SPI等）下电，同时只保留部分中断控制器，达到减小功耗的目的。 + +**PSM**：PSM模式是3GPP协议所规定的一种低功耗模式，这种模式下，模组只会周期性的唤醒并执行业务，其余时间都处于PSM休眠中。PSM休眠时，模组行为和功耗都近似于关机。 + +**关机**：模组完全下电的状态，此时BB芯片和外设控制器完全关闭，但PMIC仍是在电的。一般可由Powerkey或者RTC闹钟唤醒。 + +| 模组型号 | BG95 | +| :------------------- | :------------------ | +| IDLE（LTE FDD@64ms） | 18.9 mA(catm@128ms) | +| SLEEP(LTE FDD@64ms) | 1.89 mA(catm@128ms) | +| SLEEP(CFUN0) | 0.575mA | +| PSM | 5.10 μA | +| 关机 | 14.87 μA | + +### 测试准备 + +- **Step1：硬件准备** + + 开始之前需要准备以下配件 + + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G 天线** + 6. **Power Monitor Mini**（功耗仪） + +- **Step2：天线&SIM卡安装** + +安装开发板配套的天线,安装位置为 MAIN 天线座位置,并将 SIM 卡插入开发板上的 SIM 卡座。 + +- **Step3：开发板连接** + +使用 USB Type-C 数据线连接开发板的 Type-C 接口和电脑 USB 口，功耗仪正极连接MODULE_EN的Vbat，具体位置可以参考[BG95用户指导](https://developer.quectel.com/wp-content/uploads/2024/09/BG95-Pi-Zero%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf)，功耗仪负极连接模组GND即可。具体连接如图： + + + +> 注意！！！ +> +> 测量功耗时需要拔出所有跳线帽，以免测量结果受其他外界因素影响 + +### 测量功耗 + +#### 关机耗流 + +使用 USB Type-C 数据线连接开发板的 Type-C 接口和电脑 USB 口，待测设备硬件连接完毕后，不进行开机，断开USB_VBus（位于开发板背面，USB开关拨至off即可），即可直接测量关机电流。此时，模组不工作，对外的输出引脚也全部拉低或悬空，整体平均耗流保持相对稳定，基本都在uA级。 + +image-20250709190947650 + +#### 空闲耗流 + +完成关机电流测量后，长按powerkey开机，模组开机默认的功耗模式是IDLE（即空闲模式）。此时模组处于空闲状态，硬件正常在电，RTOS保持运行，但没有任何线程需要被执行。有业务启动或网络业务呼入时，会立即恢复运行。 + +image-20250709193332755 + +#### 休眠耗流 + +模组处于空闲状态时，若autosleep被使能，则模组会进入休眠状态。此时，模组会关闭部分IP核（如外设控制器和中断控制器等）并且降低时钟频率，从而实现功耗的降低。 + +完成空闲耗流测量后，打开USB_VBus，电脑端打开[QPYcom工具](https://developer.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.8.0.zip)，导入`pm`模块，调用`autosleep`方法打开模组的自动休眠，在没有任务执行时，模组会自动进入休眠状态，调用方法后记得断开USB_VBus(USB开关拨至off)，否则模组不会进入休眠状态。[API参考](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/pm.html#%3Ccode%3Epm.autosleep%3C/code%3E)。关于休眠耗流的详细介绍[参考](https://developer.quectel.com/doc/quecpython/Application_guide/zh/system/power-consumption.html)。 + +image-20250709194047484 + +进入休眠模式后，模组应有的耗流波形会有周期稳定的凸起，如下图： + +image-20250709194047484 + +#### PSM耗流 + +启用PSM时，需要先向基站发送请求（通过ATTACH或TA_UPDATER携带定时器信息）。基站若支持进入PSM，则会在对应的REQUEST中下发定时器信息，需要注意的是，实际PSM的参数会使用基站下发的值，并不一定和我们请求的值相同。模组会以基站下发的值来配置定时器时间，当模组进入IDLE且ACT定时器超时，模组会关闭CPU和一切射频，此时相当于部分关机，只是保留了比关机更多的唤醒源，一般包括ACT、TAU定时器和PSM_INT。功耗一般下降到微安级别。 + +打开USB_VBus，电脑端打开[QPYcom工具](https://developer.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.8.0.zip)，启用PSM，开启后记得断开USB_VBus(USB开关拨至off)。关于PSM详细介绍[参考](https://developer.quectel.com/doc/quecpython/Application_guide/zh/system/power-consumption.html#PSM-%E6%A8%A1%E5%BC%8F)。启用PSM模式的[API参考](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/pm.html#%3Ccode%3Epm.set_psm_time%3C/code%3E)。 + +image-20250709194047484 + +等待ACT定时器超时后，我们可查看PSM休眠下的底电流。如图可见，PSM的底电流远低于普通的autosleep模式，和关机耗流的大小、特征较为相似。 + +image-20250709194047484 + +> 注意： +> +> 进入PSM模式需要确认运营商是否支持，还需配置支持的网络制式 ! ! ! +> +> 更多耗流测试指导请[参考这里](https://developer.quectel.com/doc/quecpython/Application_guide/zh/system/power-consumption.html)。 diff --git a/zh/ec600x-ec800x-core-evb.md b/zh/ec600x-ec800x-core-evb.md index 0e54e983709159ad83b2cc4cf16ab7efc52d53a4..fc6ca68b020f9ff4b81ad241c4272619b42195d5 100644 --- a/zh/ec600x-ec800x-core-evb.md +++ b/zh/ec600x-ec800x-core-evb.md @@ -44,14 +44,266 @@ QuecPython_EC600X/EC800X 核心板是专门针对 QuecPython 制造的、最小 ![](./media/ec600x-ec800x-core-evb/核心板-宇.png) -## 上手准备 +## 快速入门 -**Step1：天线安装** +### 硬件准备 + +以下是开发板上手之后的硬件准备步骤 + +- **Step1：硬件准备** + + 开始之前需要准备以下配件 + + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC)/(USB-A TO Micro USB)(由具体开发板而定) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G 天线** + +- **Step2：天线&SIM卡安装** + +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 + +- **Step3：开发板连接** + +使用 USB Type-C 数据线连接开发板的 Type-C 和电脑 USB 口即可完成供电。 + +- **Step4: 开发板开机** + +模组上电自动开机 + +> POW灯常亮即开机成功。 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC600N和EC800M等，以EC600N为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_ASR](https://developer.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](./media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座，如需使用GNSS功能，则需在对应的天线座安装天线 -**Step2：开发板连接** -使用USB Type-C数据线连接开发板的Type-C/Micro USB接口和电脑USB口即可完成供电开机 -> POW灯常亮即开机成功。 \ No newline at end of file diff --git a/zh/ec600x-evb.md b/zh/ec600x-evb.md index 28924a3afaf57a8454161910518ce432a251fd17..d7a536f6dffeacf91ab6485797844fb334fb0ff9 100644 --- a/zh/ec600x-evb.md +++ b/zh/ec600x-evb.md @@ -99,22 +99,266 @@ QuecPython_EC600X_EVB 开发板是专门针对 QuecPython 制造的、小巧便 | 4 | 功放芯片 | NS4160 | 是 | SPK | 21,22 | | 5 | LCD 显示屏（需选择含屏套餐） | ST7789 | 是 | SPI | 63~67 | -## 上手准备 +## 快速入门 -首先需要有一台运行有 Windows 10 以上 操作系统的电脑 +### 硬件准备 -- **Step1：天线安装** +以下是开发板上手之后的硬件准备步骤 -安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座，如需使用GNSS或者BTWIFI功能，则需在对应的天线座安装天线 +- **Step1：硬件准备** -- **Step2：开发板连接** + 开始之前需要准备以下配件 -使用USB Type-C数据线连接开发板的Type-C接口和电脑USB口即可完成供电 + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G 天线** + +- **Step2：天线&SIM卡安装** + +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 + +- **Step3：开发板连接** + +使用 USB Type-C 数据线连接开发板的 Type-C 和电脑 USB 口即可完成供电。 + +- **Step4: 开发板开机** + +开发板上USB和DC的电源选择开关拨到USB处 + +长按PWRKEY开机，在按下PWRKEY按键之前，需保证供电电压稳定。建议从上电到按下PWRKEY按键之间的时间间隔不少于30 ms。开机后开发板NET灯闪烁，开发板已正常开机。 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC600U、EC600M和EC600N，以EC600U为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_U_G](https://images.quectel.com/python/2023/04/Quectel_Windows_USB_DriverU_V1.0.19.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](./media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-- **Step3：开发板电源设置** -开发板上USB和DC的电源选择开关拨到USB处,开发板上的PWK_ON跳帽短接AUTO(上电自动开机) -- **Step4：开发板开机** -按住PWK直至主板上电源指示灯亮（主板上丝印为POW的灯）,如果上一步短接PWK_ON则无需长按PWK自动开机 diff --git a/zh/ec800g_hua_dtu.md b/zh/ec800g_hua_dtu.md index 5a37add977673e5c882664cbc597fadcaa9615b7..e1cf0394aa096f62fe3d7fb60338c471909d9287 100644 --- a/zh/ec800g_hua_dtu.md +++ b/zh/ec800g_hua_dtu.md @@ -54,28 +54,143 @@ [EC800G_华-DTU系列开发板产品规格及用户指导](https://python.quectel.com/wp-content/uploads/2024/09/EC800G_华-DTU系列开发板产品规格及用户指导.pdf) -## 上手准备 +## 快速入门 -> 首先需要有一台运行有Windows 10以上操作系统的电脑。 +### 硬件准备 -- **Step1：开发板连接** +以下是开发板上手之后的硬件准备步骤 -使用 9~36V 外部供电。 +- **Step1：硬件准备** -使用 USB 数据线连接开发板和电脑 USB 口。 + 开始之前需要准备以下配件 -- **Step2：开发板开机** + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **Nano SIM 卡** + 5. **胶棒天线** + 6. **USB转TTL模块** -开发板上电即开机。电源指示灯常亮亮（POWER指示灯）。 +- **Step2：天线&SIM卡安装** -**执行以上操作后 POWER 灯常亮即开机成功** +安装配套的胶棒天线,并将Nano SIM卡插入开发板上的SIM卡座。 -- **Step3: 编写脚本** +- **Step3：开发板连接** -脚本实现 WORK 指示灯 每隔 0.2 秒周期性高低电平变化，示例脚本如下： +使用 mini USB 数据线连接开发板和电脑 USB 口即可完成供电。使用 USB 转 TTL 模块连接至电脑。TX（DTU开发板） 接 RX（USB 转 TTL 模块）；RX（DTU开发板） 接 TX（USB 转 TTL 模块）；GND（DTU开发板） 接 GND（USB 转 TTL 模块）共地； + +- **Step4: 开发板开机** + +开发板上电即开机。 + +> 电源指示灯常亮亮（POWER指示灯）。 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC800G，以EC800G为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB_Driver_Win10_U_G](https://developer.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*work.py*文件，实现 WORK 指示灯 每隔 0.2 秒周期性高低电平变化，编写脚本如下所示： ```python -import time +import utime from machine import Pin print('Start') LED_Work = Pin(Pin.GPIO12, Pin.OUT, Pin.PULL_DISABLE, 1) @@ -84,11 +199,129 @@ while True: LED_Work.write(0) else: LED_Work.write(1) - time.sleep(0.2) + utime.sleep(0.2) +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/work.py") # filePath为要执行的脚本文件路径 ``` -- **Step4: 导入并执行脚本** +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图,观察 WORK 指示灯变化 + +![](./media/ec800g_hua_dtu/work.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-使用 QPYcom 工具将我们编写的 Python 脚本导入模组中，并执行该脚本，观察 WORK 指示灯变化。 -> :heavy_exclamation_mark: 关于如何使用 QPYcom 导入并执行脚本，请参阅 QPYcom 工具使用章节。 \ No newline at end of file diff --git a/zh/ec800x-dp-dtu-q600r.md b/zh/ec800x-dp-dtu-q600r.md index 31e87d9a1dd62f71554b0bd40b3e5b4b9512fc97..860655a90955078f9f51b973a814925a45bc403a 100644 --- a/zh/ec800x-dp-dtu-q600r.md +++ b/zh/ec800x-dp-dtu-q600r.md @@ -57,20 +57,262 @@ EC800X_DP-DTU-Q600R 系列开发板是一款使用 LTE CAT1 网络的 DTU 开发 - USB 口。 - 天线接口。 -## 上手准备 +## 快速入门 -**Step1：天线安装** +### 硬件准备 -安装开发板配套的天线，安装位置为 LTE 天线接口位置，并将 SIM 卡插入开发板上的 SIM 卡槽。 +以下是开发板上手之后的硬件准备步骤 -**Step2：开发板连接** +- **Step1：硬件准备** -使用 Micro USB 数据线连接开发板的 USB 接口和电脑 USB 口即可完成供电开机。 + 开始之前需要准备以下配件 + + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **天线** + +- **Step2：天线&SIM卡安装** + +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 + +- **Step3：开发板连接** + +使用 micro USB 数据线连接开发板的USB接口和电脑 USB 口即可完成供电。 + +- **Step4: 开发板开机** + +上电自动开机 > POW灯常亮即开机成功。 -**Step3: 使用 repl 交互命令行进行代码调试** +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC800M和EC800K，以EC800K为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_ASR](https://developer.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](D:/teedoc/dev_board_guide/zh/media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](D:/teedoc/dev_board_guide/zh/media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](D:/teedoc/dev_board_guide/zh/media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](D:/teedoc/dev_board_guide/zh/media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](D:/teedoc/dev_board_guide/zh/media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](D:/teedoc/dev_board_guide/zh/media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](D:/teedoc/dev_board_guide/zh/media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 -> 选择带有 **REPL** 字样的端口并打开，然后即可看到 **>>>** 命令提示符，在该符号后面可以键入 python 代码并进行调试。 +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: -![](./media/ec800x-dp-dtu-q600r/hello_world.png) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
diff --git a/zh/ec800x-duino-evb.md b/zh/ec800x-duino-evb.md index d809df51e91eddd063064ca2d992e771f071270f..53b041de8c6528b50697f943d5019452c8aeaa70 100644 --- a/zh/ec800x-duino-evb.md +++ b/zh/ec800x-duino-evb.md @@ -83,28 +83,262 @@ EC800M 系列、EC800K 系列、EG800K 系列、EC800E 系列等。 | 2 | LED灯 | - | 是 | GPIO | - | | 3 | 麦克风 | B4013AM423-092 | 是 | SPK | - | +## 快速入门 -`具体外设资源使用指导参考规格书` +### 硬件准备 -## 上手准备 +以下是开发板上手之后的硬件准备步骤 -* 注意事项 +- **Step1：硬件准备** -EVB 的供电电压为 5V，可通过 TypeC 或者 DC 座输入电源，也可以通过排母 5V 引脚输入 5V（V1.1 版本悬空不可用）。为了确保开发板任何情况下工作正常，请确保输入电流至少 2A。请勿同时接 TypeC 或者 DC 座和引脚 5V，防止电流灌入 USB，导致 USB 设备损坏 + 开始之前需要准备以下配件 -首先需要有一台运行有 Windows 10 以上 操作系统的电脑 + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G天线** -- **Step1：天线安装** +- **Step2：天线&SIM卡安装** -安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座，如需使用GNSS功能，则需在对应的天线座安装天线 +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 -- **Step2：开发板连接** +- **Step3：开发板连接** 使用USB Type-C数据线连接开发板的Type-C接口和电脑USB口即可完成供电, 上电前需要跳帽短接 VUBS EN、VDD_EXT EN、VBAT EN 排针 -- **Step3：开发板开机** +- **Step4: 开发板开机** 按住S1直至主板上电源指示灯亮（主板上丝印为D1的灯）,如果上一步短接PWK_ON则无需长按PWK自动开机 +> 注意：EVB 的供电电压为 5V，可通过 TypeC 或者 DC 座输入电源，也可以通过排母 5V 引脚输入 5V（V1.1 版本悬空不可用）。为了确保开发板任何情况下工作正常，请确保输入电流至少 2A。请勿同时接 TypeC 或者 DC 座和引脚 5V，防止电流灌入 USB，导致 USB 设备损坏 -`关于开发板灯光和电源详细设置参见规格书` +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC800M、EC800K等，以EC800K为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_ASR](https://developer.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](D:/teedoc/dev_board_guide/zh/media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](D:/teedoc/dev_board_guide/zh/media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](D:/teedoc/dev_board_guide/zh/media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](D:/teedoc/dev_board_guide/zh/media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](D:/teedoc/dev_board_guide/zh/media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](D:/teedoc/dev_board_guide/zh/media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](D:/teedoc/dev_board_guide/zh/media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
diff --git a/zh/ec800x-evb.md b/zh/ec800x-evb.md index 392d357afe2728dc5698791415ba3f707b41f11c..66ecb2b68010e3757a2e08707ce0c8c2d68f26db 100644 --- a/zh/ec800x-evb.md +++ b/zh/ec800x-evb.md @@ -106,22 +106,266 @@ EC800X_QuecPython_EVB 开发板是专门针对 QuecPython 制造的、小巧便 | 4 | 功放芯片 | NS4160 | 是 | SPK | 5,6 | | 5 | LCD 显示屏（需选择含屏套餐） | ST7789 | 是 | SPI | 49~53 | -## 上手准备 +## 快速入门 -首先需要有一台运行有 Windows 10 以上 操作系统的电脑 +### 硬件准备 -- **Step1：天线安装** +以下是开发板上手之后的硬件准备步骤 -安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座，如需使用GNSS或者BTWIFI功能，则需在对应的天线座安装天线 +- **Step1：硬件准备** -- **Step2：开发板连接** + 开始之前需要准备以下配件 -使用USB Type-C数据线连接开发板的Type-C接口和电脑USB口即可完成供电 + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G 天线** + +- **Step2：天线&SIM卡安装** + +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 + +- **Step3：开发板连接** + +使用 USB Type-C 数据线连接开发板的 Type-C 和电脑 USB 口即可完成供电。 + +- **Step4: 开发板开机** + +开发板上USB和DC的电源选择开关拨到USB处 + +长按PWRKEY开机，在按下PWRKEY按键之前，需保证供电电压稳定。建议从上电到按下PWRKEY按键之间的时间间隔不少于30 ms。开机后开发板NET灯闪烁，开发板已正常开机。 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC800M、EC800N和EC800G，以EC800M为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_ASR](https://developer.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](./media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-- **Step3：开发板电源设置** -开发板上USB和DC的电源选择开关拨到USB处,开发板上的PWK_ON跳帽短接AUTO(上电自动开机) -- **Step4：开发板开机** -按住PWK直至主板上电源指示灯亮（主板上丝印为POW的灯）,如果上一步短接PWK_ON则无需长按PWK自动开机 diff --git a/zh/ec800x-pico-evb.md b/zh/ec800x-pico-evb.md index 47de12c03fde8c5116ae2c2e7707311a051f03a7..15fed9209e19c2540ac36075e3c4e261b9c6e2b2 100644 --- a/zh/ec800x-pico-evb.md +++ b/zh/ec800x-pico-evb.md @@ -14,6 +14,7 @@ ### 基本概述 EC800X_pico 系列开发板是一款使用 LTE CAT1 网络，基于移远 EC800 系列模组的低成本但灵活的开发板。 + - 开发板上 40 个拓展引脚具备 28.6mm× 65.5mm 'DIP'风格，封装上 PCB 厚度为 1.6mm； - 拓展引脚中多达 30 个 3.3V 通用 GPIO； - 具备 2 路 ADC 接口； @@ -79,20 +80,264 @@ EC800X_pico 系列开发板是一款使用 LTE CAT1 网络，基于移远 EC800 | 39 | TXD0 | debug 串口发送引脚 | 3.3V 电平 | | 40 | RXD0 | debug 串口接收引脚 | 3.3V 电平 | -## 上手准备 +## 快速入门 + +### 硬件准备 + +以下是开发板上手之后的硬件准备步骤 + +- **Step1：硬件准备** + + 开始之前需要准备以下配件 + + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G 天线** + +- **Step2：天线&SIM卡安装** + +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 + +- **Step3：开发板连接** + +使用 USB Type-C 数据线连接开发板的 Type-C 和电脑 USB 口即可完成供电。 + +- **Step4: 开发板开机** + +上电自动开机 + +> POW灯常亮即开机成功 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EC800M、EC800E等，以EC800M为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_ASR](https://developer.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 -**Step1：天线安装** +![](./media/readme/QPYcom_repl_hello.png) -安装开发板配套的天线，安装位置为 LTE 天线接口位置，并将 SIM 卡插入开发板上的 SIM 卡槽。 +### 停止程序运行 -**Step2：开发板连接** +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: -使用 USB Type-C 数据线连接开发板的 USB 接口和电脑 USB 口即可完成供电开机。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-> POW灯常亮即开机成功。 -**Step3: 使用 repl 交互命令行进行代码调试** -> 选择带有 **REPL** 字样的端口并打开，然后即可看到 **>>>** 命令提示符，在该符号后面可以键入 python 代码并进行调试。 -![](./media/ec800x-pico-evb/hello.png) \ No newline at end of file diff --git a/zh/eg91x-evb.md b/zh/eg91x-evb.md index 24116ac78b652a02f584c69e3db9d4ff471fffb8..13af6975812641ca892ff603d1abd57377fff52d 100644 --- a/zh/eg91x-evb.md +++ b/zh/eg91x-evb.md @@ -122,27 +122,262 @@ QuecPython_EG91X系列C1-P02开发板是一款专门针对QuecPython设计的、 | 37 | P108 | GPIO37 | 通用输入输出 | 38 | P06 | GPIO3
SPI1_MOSI | 通用输入输出
SPI1主输出从输入 | | 39 | GND | - | 接地 | 40 | P04 | GPIO1
SPI1_CLK | 通用输入输出
SPI1时钟 | +## 快速入门 -## 上手准备 +### 硬件准备 -> 首先需要有一台运行有Windows 10以上操作系统的电脑。 +以下是开发板上手之后的硬件准备步骤 -- **Step1：开发板连接** +- **Step1：硬件准备** -使用USB Type-C数据线连接开发板的Type-C接口和电脑USB口即可完成供电。 + 开始之前需要准备以下配件 -- **Step2：开发板开机** + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + 4. **SIM 卡** + 5. **4G 天线** -长按PWRKEY开机，在按下PWRKEY按键之前，需保证供电电压稳定。建议从上电到按下PWRKEY按键之间的时间间隔不少于30 ms。如果需上电自动开机且不需要关机功能，则可以把10-Pin排针中PWK_AUTO丝印对应的两个引脚短接。 +- **Step2：天线&SIM卡安装** -进行以上操作后等待主板上电源指示灯亮（主板上丝印为PWR灯，参考上文指示灯）。 +安装开发板配套的天线,安装位置为LTE天线座位置,并将SIM卡插入开发板上的SIM卡座。 -**执行以上操作后PWR灯常亮即开机成功** +- **Step3：开发板连接** -## 资料下载 +使用 USB Type-C 数据线连接开发板的 Type-C 和电脑 USB 口即可完成供电。 +- **Step4: 开发板开机** -- [QuecPython_EG915_C1_P02_EVB_SCH](https://python.quectel.com/wp-content/uploads/2024/09/QuecPython_EG915_C1_P02_EVB_SCH_V1.2.pdf) +长按PWRKEY开机，在按下PWRKEY按键之前，需保证供电电压稳定。建议从上电到按下PWRKEY按键之间的时间间隔不少于30 ms。开机后开发板NET灯闪烁，开发板已正常开机。 如果PWK_AUTO已使用跳线帽短接则模组上电会自动开机。 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有EG915U，以EG915U为例，在下载页面右侧选择该型号的USB驱动[QuecPython_USB Driver Win10_U_G](https://images.quectel.com/python/2023/04/Quectel_Windows_USB_DriverU_V1.0.19.zip)点击下载，如果开发板搭载的是其他型号同样按照以上操作即可。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出**Quectel USB** 名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，端口选择连接**Quectel USB REPL Port**，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/readme/hello_world.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](./media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-- [QuecPython_EG915_C1_P02_EVB_丝印](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02系列开发板丝印.pdf) diff --git a/zh/fcm360w-evb.md b/zh/fcm360w-evb.md index 81c3cea557318b089ff94011a9c3baa324050e9d..ada208b807aa5745a9fd9be1bdaa2dbfa8cfd223 100644 --- a/zh/fcm360w-evb.md +++ b/zh/fcm360w-evb.md @@ -76,17 +76,260 @@ QuecPython_FCM360W_EVB 开发板是一款专门针对QuecPython设计的、小 | 1 | USB转串口 | CH340N | 是 | USB | 26,27 | | 2 | 按键 | - | 是 | GPIO | 15,16 | +## 快速入门 -## 上手准备 +### 硬件准备 -> 首先需要有一台运行有 Windows 10 以上 操作系统的电脑 +以下是开发板上手之后的硬件准备步骤 -- **Step1：开发板连接** +- **Step1：硬件准备** + + 开始之前需要准备以下配件 + + 1. **开发板** + 2. **USB 数据线** (USB-A TO USB-TypeC) + 3. **PC** (Windows10) + +- **Step2：开发板连接** + +使用 USB Type-C 数据线连接开发板的 Type-C 和电脑 USB 口即可完成供电。 + +- **Step3: 开发板开机** + +上电即自动开机 + +> 执行以上操作后POW灯常亮即开机成功 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有FCM360W，以FCM360W为例，在下载页面右侧选择该型号的USB驱动[CH343SER](https://developer.quectel.com/wp-content/uploads/2024/09/CH343SER_V1.8.zip)点击下载。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出USB-**Enhanced-SERIAL**名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，选择端口，选择“交互”界面。 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息。 + +```python +>>> print('hello world') +hello world +``` + +![](./media/fcm360W-evb/hello.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](./media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
-使用USB Type-C数据线连接开发板的Type-C接口和电脑USB口即可完成供电 -- **Step2：开发板开机** -上电后会自动开机，等待主板上电源指示灯亮（主板上丝印为POWER LED的灯） -**执行以上操作后POW灯常亮即开机成功** \ No newline at end of file diff --git a/zh/fcm360w-teb.md b/zh/fcm360w-teb.md index d76eb6de3779b0c70b6544a049eec21fcf6ac425..10bff36a5c276c81aab07d5ceb4a0cecea6792a5 100644 --- a/zh/fcm360w-teb.md +++ b/zh/fcm360w-teb.md @@ -70,21 +70,260 @@ QuecPython_FCM360W_TE-B 开发板是一款Quectel推出的Wi-Fi 和蓝牙开发 | 2 | 按键 | - | 是 | GPIO | | 2 | ANT | - | 是 | - | +## 快速入门 -## 上手准备 +### 硬件准备 -> 首先需要有一台运行有 Windows 10 以上 操作系统的电脑 +以下是开发板上手之后的硬件准备步骤 -- **Step1：开发板烧录固件** +- **Step1：硬件准备** -首先使用micro usb数据线将开发板上的UART0接口和电脑USB口连接即可完成供电，开发板的POWER开关切换到ON状态，然后使用QPYcom工具进行[固件烧录](https://python.quectel.com/doc/Getting_started/zh/flash_firmware.html) + 开始之前需要准备以下配件 + + 1. **开发板** + 2. **USB 数据线** (USB-A TO micro USB) + 3. **PC** (Windows10) - **Step2：开发板连接** -完成上面烧录固件步骤后，将数据线连接从UART0口切换到UART2口，使用串口工具连接该串口， +开发板的POWER开关切换到ON状态，使用 micro USB 数据线连接开发板的 UART0 和电脑 USB 口即可完成供电用于下载固件。连接USRT2用于调试输出。 + +即UART2为QuecPython的repl口。 + +- **Step3: 开发板开机** + +上电即自动开机 + +### 驱动安装 + +- 打开[QuecPython官网驱动下载链接](https://python.quectel.com/resource-download?cid=5) + +- 选择与模组型号匹配的驱动，该开发板搭载的模组有FCM360W，以FCM360W为例，在下载页面右侧选择该型号的USB驱动[CH343SER](https://developer.quectel.com/wp-content/uploads/2024/09/CH343SER_V1.8.zip)点击下载。 + +- 下载后解压驱动压缩包，找到**"setup.exe"** 或者是**"setup.bat"**，双击运行即可，安装完之后打开设备管理器就可以看到设备管理器中端口的黄色感叹号消失了，说明安装成功，能够正常通信。 + +> 出现 Mobile ECM Network Adapter 或 CDC Ethernet Control Modle (ECM) 等设备未被识别属于正常现象，不影响固件烧录和后续开发，无需理会。 + +- 右键打开【**我的电脑**】——选择【**管理**】——选择【**设备管理器**】,然后在设备管理器中选择 【**端口**】，按照步骤打开页面后如图所示能刷新出USB-**Enhanced-SERIAL**名称开头的串口则USB驱动安装成功。 + + +### 工具安装 + +- QPYcom获取 + +使用QuecPython进行开发需要用到专用的开发调试工具——**QPYcom**，包括但不限于调试代码、分析日志、文件传输、烧录固件、合并固件等。 + +打开[QuecPython工具下载页面](https://python.quectel.com/resource-download?cid=8)，根据操作系统选择对应的工具进行下载。 + +*注意:该工具无需安装，解压即用。* + +- VSCode插件 + +编辑Python代码一般会用到专用于Python或者兼容多种语言的IDE，可以有效提升开发效率，这里推荐VSCode + +针对VScode，QuecPython推出专用插件实现代码提示、代码补全和串口调试等功能，安装方法见下图 + +在VSCode中点击侧边栏插件市场，在插件市场中搜索 “QuecPython”，根据搜索结果下载该插件即可 + +![](./media/readme/VScode_1.png) + +### 固件烧录 + +**固件获取** + +模组在出厂时通常烧录有标准 AT 固件或 QuecOpen 固件，如需基于 QuecPython 对模块进行开发，需要手动为其重新烧录专门的 QuecPython 固件。 + +[官网固件下载地址](https://python.quectel.com/resource-download?cid=15) + +![](./media/readme/Firmware.png) + +面对官网种类众多的固件，如何选择合适的固件包，首先需要知道使用的模组的型号，模组型号可以通过模组的镭雕或者发送AT指令来获得。 + +在获取到模组型号之后根据模组的型号去官网下载该模组对应的固件即可,固件的名称一般为`QPY_OCPU_版本号_模组型号_FW`，没有特殊需求默认下载最新版本即可。 + +点击下载列的下载按钮即可下载，下载成功后会得到一个固件名称命名的压缩包文件(zip包) + +从官网下载的固件包为压缩包格式，固件压缩包下载到本地后，需进行解压。解压后可获得两个文件，其中 .bin 格式的是 QuecPython 固件本体，.md 格式的是更新日志。 + +![](./media/readme/firmware_zip.png) + +> 请务必将压缩包内容解压至一个**不包含中文、空格和其他特殊字符**的路径下，否则下载工具可能无法正常识别到固件，同时下载工具路径也**不可包含中文、空格和其他特殊字符**。 + +**固件烧录** + +- **Step1：创建项目** + +首先确保模组连接正常并已开机，打开QPYcom工具进入下载页面，点击**"创建"**项目，新建要下载的固件项目，项目名称自定义，配置完成后持久化保存 + +- **Step2：选择固件** + +选择要下载到模组的固件(根据要下载的模组型号选择对应的固件，若为新格式固件则所有模组型号都选择.bin文件即可） + +- **Step3：设置下载模式** + +单击**“Download script”**右侧的下拉选择箭头，选择**"Download FW"** + +- **Step4：开始烧录固件** + +点击**"Download FW"**后，开始下载固件,下载过程会有进度条和进度百分比显示，等待下载完毕会有弹窗提示下载成功 + +![](./media/readme/firmware.gif) + +### REPL调试 + +REPL全称为**Read-Eval-Print-Loop (交互式解释器)**，可以在REPL中进行QuecPython程序的调试 + +运行 **QPYcom** 工具后，选择正确的串口（波特率无需指定）并打开，即可开始 Python 命令行交互。 + +- **Step1：进入交互页面** + +打开QPYcom工具，选择端口，选择“交互”界面 + +- **Step2：打开串口** + +点击“打开串口”按钮，在交互界面输入**print(‘hello world’)**，按回车后可以看到执行的结果信息 + +```python +>>> print('hello world') +hello world +``` + +![](./media/fcm360W-evb/hello.png) + +*注意：工具交互页面输入时需要输入英文字符，中文字符将会被屏蔽* + +## 开发第一个脚本 + +### 编写第一个脚本文件 + +创建*helloworld.py*文件输出“hello world”，打印“hello world”，编写脚本如下所示： + +```python +print("hello world") +``` + +通过QPYcom将上面编辑好的文件下载到模组中去并运行 + +![](./media/readme/QPYcom_hello.jpg) + +### PC与模组间的文件传输 + +**下载方法一:** + +image-2021081301 + +- **Step1：打开串口** + +首先选择模组的交互口,点击"打开串口"按钮 + +- **Step2：通过工具按钮下载** + +可以通过文件页面右侧上面的 "**+**","**-**" 按钮来上传和删除文件 + +- **Step3：通过拖拽形式下载** + +也可以通过拖拽的方式将文件页面左侧显示的本地文件直接拖拽到右侧模组中去（也可以拖拽文件夹） + +- **Step4：下载进度和结果** + +下载过程中会在状态栏显示下载文件名和下载进度 + +**下载方法二:** + +image-2021081301 + +- **Step1：创建项目** + +根据需求，创建用户项目（点击"创建"按钮）,步骤同上文烧录固件 + +- **Step2：配置要下载的文件** + +选择需要下载到模块的用户脚本(在"用户脚本"区域通过右键菜单添加) + +- **Step3：设置下载模式** + +左击下拉选择箭头，选择"下载脚本"，即"Download Script" + +- **Step4：开始下载脚本** + +点击"下载脚本"开始下载脚本，下载过程中有进度条提示 + +### 运行脚本文件 + +- **Step1：下载脚本** + +将要执行的脚本文件下载到模组中去,具体步骤参考上文 + +- **Step2：通过repl执行脚本** + +打开串口之后，在QPYcom交互页面输入以下代码执行脚本文件 + +```python +import example +example.exec("/usr/helloworld.py") # filePath为要执行的脚本文件路径 +``` + +- **Step3：通过GUI工具执行脚本** + +或者通过QPYcom文件页面 **执行** 按钮执行脚本文件,在工具的文件页面选择要执行的脚本文件然后点击 "**▷**"按钮 + +执行结果如图 + +![](./media/readme/QPYcom_repl_hello.png) + +### 停止程序运行 + +如何停止正在运行的程序,根据运行的脚本文件类型有以下方法: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
程序名是否
为main.py		程序中是否
包含了死循环		程序中是否
使用了多线程		停止步骤
✓✓✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请重新烧录固件
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓（1）按 Ctrl + A 键进入 RAW 模式
（2）按 Ctrl + D 键重启 QuecPython 虚拟机
（3）按 Ctrl + B 键回到普通交互模式
（4）若以上方法无效，请耐心等待程序运行结束
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件
✗✓✓（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗（1）按 Ctrl + D 键重启 QuecPython 虚拟机
（2）若以上方法无效，请直接重启模块
✗✓（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
✗（1）按 Ctrl + C 键打断程序运行
（2）若以上方法无效，请重新烧录固件或直接重启模块
+ -串口工具使用[QCOM](https://python.quectel.com/wp-content/uploads/2024/09/QCOM_V1.6.zip) ，需要先将工具的RTS勾选框勾选上，然后打开串口 -- **Step3：开发板交互** -完成上述连接步骤后，按下板载的RESET按钮，即可看到模组开机信息，该串口即为QuecPython的REPL口,可以通过串口工具正常进行repl交互 \ No newline at end of file diff --git a/zh/media/bg95/PowerMonitor_connect.png b/zh/media/bg95/PowerMonitor_connect.png new file mode 100644 index 0000000000000000000000000000000000000000..801b825f80559c3cad916bfd2a67d73e95b25382 Binary files /dev/null and b/zh/media/bg95/PowerMonitor_connect.png differ diff --git a/zh/media/bg95/close_power.png b/zh/media/bg95/close_power.png new file mode 100644 index 0000000000000000000000000000000000000000..e5d40f3023ec18391ccc2e2c1ef3186755a6c0ad Binary files /dev/null and b/zh/media/bg95/close_power.png differ diff --git a/zh/media/bg95/free_power.png b/zh/media/bg95/free_power.png new file mode 100644 index 0000000000000000000000000000000000000000..c8bd75b51ff004c0c5ee9186c2018c604551d14a Binary files /dev/null and b/zh/media/bg95/free_power.png differ diff --git a/zh/media/bg95/open_auto_sleep.png b/zh/media/bg95/open_auto_sleep.png new file mode 100644 index 0000000000000000000000000000000000000000..dbdbb95878679ef136aa2a91d4c3727adafd5c3b Binary files /dev/null and b/zh/media/bg95/open_auto_sleep.png differ diff --git a/zh/media/bg95/psm_power1.png b/zh/media/bg95/psm_power1.png new file mode 100644 index 0000000000000000000000000000000000000000..bca71ae7c9a149dd85b334ac090bbee8fd2005a6 Binary files /dev/null and b/zh/media/bg95/psm_power1.png differ diff --git a/zh/media/bg95/psm_power2.png b/zh/media/bg95/psm_power2.png new file mode 100644 index 0000000000000000000000000000000000000000..8a63cc9414584ff66c7c63c3ac12eb67d157b2c2 Binary files /dev/null and b/zh/media/bg95/psm_power2.png differ diff --git a/zh/media/bg95/set_psmmode.png b/zh/media/bg95/set_psmmode.png new file mode 100644 index 0000000000000000000000000000000000000000..cea9e0afbf9600094a51ba00e55fa596e884816a Binary files /dev/null and b/zh/media/bg95/set_psmmode.png differ diff --git a/zh/media/bg95/sleep_power.png b/zh/media/bg95/sleep_power.png new file mode 100644 index 0000000000000000000000000000000000000000..13d4a3b578865a472484f5d4fcce54b317fcc96a Binary files /dev/null and b/zh/media/bg95/sleep_power.png differ diff --git a/zh/media/ec800g_hua_dtu/work.png b/zh/media/ec800g_hua_dtu/work.png new file mode 100644 index 0000000000000000000000000000000000000000..91210af335628503d36c23e632c5eb86a3c13c1f Binary files /dev/null and b/zh/media/ec800g_hua_dtu/work.png differ diff --git a/zh/media/fcm360w-evb/hello.png b/zh/media/fcm360w-evb/hello.png new file mode 100644 index 0000000000000000000000000000000000000000..a15a3e13a3556519e908bec15822aa7d987afd0e Binary files /dev/null and b/zh/media/fcm360w-evb/hello.png differ diff --git a/zh/sidebar.yaml b/zh/sidebar.yaml index 1ec8c437ac0d2890ebd9680cb226df1d22f474f1..8ad953a01961b6d63274203d0c124d4883888f55 100644 --- a/zh/sidebar.yaml +++ b/zh/sidebar.yaml @@ -1,5 +1,5 @@ items: -- label: QuecPython开发板介绍 +- label: QuecPython开发板操作指南 file: ./README.md - label: EC2X 开发板介绍 file: ./ec2x-evb.md