ML302 OpenCPU 开发指导手册_V100

ML302 OpenCPU 开发指导手册 4G LTE 系列 版本 V1 0 0 日期 2020 年 2 月 中移物联网有限公司 1 服务与支持 如果您有任何关于模组产品及产品手册的评论 疑问 想法 或者任何无法从本手册中找到答案的疑问 请通过以下方式联系我们 中移物联网有限公司 网址 邮箱 SmartModule 客户服务热线 400 110 0866 微信公众号 OneMO2019 中移物联网有限公司 2 文档声明 注意 本手册描述的产品及其附件特性和功能 取决于当地网络设计 因此 本手册中描述的全部或部分产品及 其附件特性和功能可能未包含在您的购买或使用范围之内 免责声明 除非合同另有约定 中移物联网有限公司对本文档内容不做任何明示或暗示的声明或保证 并且不对特定 目的适销性及适用性或者任何间接 特殊或连带的损失承担任何责任 由于产品版本升级或其他原因 本文档内容会不定期进行更新 除非另有约定 本文档仅作为使用指导 本文档中的所有陈述 信息和建议不构成任何明示或暗示的担保 公司保留随时修改本手册中任何信息的权利 无需进行提前通知且不承担任何责任 操作系统更新声明 操作系统仅支持官方升级 如用户自己刷非官方系统 导致安全风险和损失由用户负责 固件包完整性风险声明 固件仅支持官方升级 如用户自己刷非官方固件 导致安全风险和损失由用户负责 版权所有 中移物联网有限公司 保留一切权利 本手册中描述的产品 可能包含中移物联网有限公司及其存在的许可人享有版权的软件 除非获得相关权 利人的许可 否则 非经本公司书面同意 任何单位和个人不得擅自摘抄 复制本手册内容的部分或全部 并 以任何形式传播 中移物联网有限公司 3 关于文档 修订记录 版本 日期 作者 描述 V1 0 0 2020 2 25 谢刚亮 初版 中移物联网有限公司 4 目录 服务与支持 1 文档声明 2 关于文档 3 修订记录 3 目录 4 1 概述 5 2 ML302 OPENCPU SDK 开发包介绍 6 3 搭建编译环境 7 3 1 编译环境要求 7 3 2 安装及配置编译工具 7 4 烧录流程 9 5 DEMO 示例 11 6 SDK 开发指导 12 6 1 OpenCPU 入口函数 12 6 2 增加源文件方法 12 6 3 增加库文件方法 12 6 4 新增头文件方法 13 7 OPENCPU 调试 14 7 1 LOG 抓取 14 7 2 内存 dump 抓取 16 7 3 死机现场查看 17 8 SDK API 分类说明 18 8 1 模组操作系统 18 8 2 模组网络相关接口 18 8 3 模组基础功能接口 18 8 4 硬件外设接口 18 中移物联网有限公司 5 1 概述 本文档介绍在 Windows7 Windows10 环境下开发基于 ML302 OpenCPU SDK 的应用程序 ML302 OpenCPU SDK 提供交叉编译链 所需的库文件和头文件 API 和示例程序 这些 API 可以实现 客户相应的需求 所有的内容将以 SDK 压缩包的形式提供给客户 客户只需要解压 SDK 包 然后参照文档进 行应用程序编写 编译完成后烧入模组开发板中即可调试使用 SDK 的安装路径中不能包含中文和空格 中移物联网有限公司 6 2 ML302 OpenCPU SDK 开发包介绍 1 解压开发包 ZIP 包文件 版本请以实际为准 2 解压后得到如下文件 不同版本会有细微差别 3 进入 SDK 目录 目录详情见下表 其中 build bat 文件为编译脚本 目录名称 描述 firmware 目录是编译后固件生成的目录 inc 目录是用户头文件目录 lib 目录是 SDK 库文件目录 out 目录是编译中间文件目录 src 目录是用户源文件目录 utils 目录是编译环境相关文件 中移物联网有限公司 7 3 搭建编译环境 3 1 编译环境要求 本 SDK 仅支持在 Windows7 Windows10 下使用 3 2 安装及配置编译工具 1 首先确认要使用的硬件版本 以 DNLM 为例 编译命令为 build bat DNLM 在命令行中进入 SDK 主目录 输入 build bat DNLM 命令后回车 即可执行编译 2 编译成功会在 firmware DNLM 目录下生成 ML302 OpenCPU pac 固件 中移物联网有限公司 8 3 在命令行中输入 build bat CLEAN 命令后回车 即可删除编译结果 目前编译脚本支持两个参数 区分大小写 build bat DNLM 编译生成硬件版本为 DNLM 的固件 build bat CLEAN 清除编译结果 中移物联网有限公司 9 4 烧录流程 编译完版本 生成 pac 文件之后 将 pac 文件烧录至开发板 模组可以使用串口或 usb 来进行下载 如 果使用串口 对应模组 97 98 两个引脚 如果使用 usb 开发板连接电脑前 首先要安装模组 usb 驱动 可 联系技术支持提供 如下图 将开发板 usb 口通过 micro USB 线连接至 PC 如果使用串口 则使用开发板 HST TX HST RX 对应串口 将图示开发板中 1 2 两个排针用杜邦线短接 然后上电 也可以通过 AT 虚拟通道 发 送 AT FORCEDNLD 命令 使模组进入下载模式 中移物联网有限公司 10 打开 ResearchDownload exe 下载工具 如下图所示选择 pac 文件 然后点击配置 按下图所示配置 完成之后 点击启动下载 然后等待进度条完成即下载完成 中移物联网有限公司 11 5 DEMO 示例 在 onemo feature mk 中打开所有 demo 配置开关后 编译生成测试固件 将版本烧录至开发板后 使 用 USB 转串口工具连上 UART2 打开串口工具 选择对应串口 波特率设置为 115200 打开串口后 长按 PWKey 键 1 2 秒 系统启动后会通过串口打印初始化信息 串口助手接收界面会出现 如下图所示打印信息 输入 ONEMO XXX PARAM1 PARAM2 即可测试对应的功能 XXX 代表功能名称 PARAM 代表参 数 可在 onemo main c 中查找对应的测试功能编号 中移物联网有限公司 12 6 SDK 开发指导 6 1 OpenCPU 入口函数 以下代码在模组主程序的 main 函数中被调用 用户 APP 线程在这里建立 不能阻塞 void ML302 OpenCPU Entry 6 2 增加源文件方法 如在 src 目录下添加源文件 可自动被加入编译 如需再增加新目录 则需将该目录相对 SDK 根目录的相对路径填入 Makefile 中 添加方法如下 例如在 src 目录下新增 src 目录 则需将该目录的相对路径添加到 SRC DIRS 下 以空格分隔 新增的源文件目录也会被自动添加到头文件搜索目录 6 3 增加库文件方法 将 lib 放进 SDK 目录下 然后编辑 Makefile 按如下示例添加即可 中移物联网有限公司 13 6 4 新增头文件方法 将新增的头文件放到 SDK 目录下 按如下示例将包含目录添加到编译环境中 中移物联网有限公司 14 7 OpenCPU 调试 Log 抓取使用 Coolwatcher 工具 该工具可以抓取模组打印的 log 内存 dump 文件 使用 GDB 可以 查看死机现场信息 此处概略介绍 log 抓取 详细抓取方法请参见 ML302 文档 ML302 Log 抓取方法 7 1 LOG 抓取 双击 Coolwatcher exe 打开软件 左边芯片选择 8910 右边串口号填入实际的串口号 然后点击 OK 即出现第二界面 如下图所示 中移物联网有限公司 15 出现以上界面后 点击 Plugins Activate Tracer 然后点击绿色的三角按钮 开始接收 log 中移物联网有限公司 16 7 2 内存 dump 抓取 点击 Tools Blue Screen Dump 然后配置如下图 具体信息根据实际情况填写 点击 Start 按钮 软件即开始进行内存 dump 抓取 中移物联网有限公司 17 7 3 死机现场查看 看门狗打开时 出现死机模组将自动重启 死机现场无法查看 当软件处于调试阶段时 推荐关闭看门 狗 出现死机时 可使用工具查看死机现场 进行必要分析 看门狗开启或关闭通过 onemo wdt config cb 函数的返回值来设置 在 log 抓取界面 如出现死机 点击 Tools GDB Launcher 弹出界面按如下配置 以实际为准 然 后点击 Launch 则稍等片刻 即会显示死机的界面 图中是故意制造的死机现场 中移物联网有限公司 18 8 SDK API 分类说明 8 1 模组操作系统 ML302 OpenCPU SDK 使用 CMSIS 标准的 RTOS 接口 相关结构体 参数等可以参考 inc os 目录下 cmsis os h 头文件 8 2 模组网络相关接口 ML302 OpenCPU SDK 使用 LWIP V2 0 1 协议栈 socket 接口符合 POSIX 标准 用户可参照相关例程 进行应用程序编写 相关结构体 参数等可以参考 inc lwip 目录下头文件 8 3 模组基础功能接口 模组基础功能接口包含基本的模组信息获取 模组控制 模组状态设置等接口 OpenCPU 提供两类接口 一类是函数