SDK 问题反馈指南_Rev1.1

English

1 修订记录

版本

日期

作者

修订内容

Rev1.1

26-06-05

MBB

完善问题反馈模板与联系方式说明

Rev1.0

26-04-22

MBB

创建文档

2 简介

本文档介绍 SDK 使用过程中问题反馈的建议方式和必要信息,帮助更快定位问题。

3 项目概述

Lierda LTE-EC71X OpenCPU SDK 是利尔达物联网推出的 EC71X 系列模组的 OpenCPU 开发套件。该 SDK 允许开发者直接在模组上运行自定义应用程序,无需外挂 MCU。

主要特性:

特性

说明

模组平台

EC71X 系列

支持底包

F6B_A、F6D_A、F7B_A、K2B_A、K2F_A 等系列

操作系统

FreeRTOS 实时操作系统

API 接口

底层基于 CMSIS-OS2,用户侧主要使用 Lierda OpenCPU API / OSAL

中间件

MQTT、HTTP、LwIP、mbedTLS、LittleFS 等

编译工具

GCC、Keil

系统接口

文件系统、GPIO、UART、低功耗管理等

4 问题反馈

4.1 反馈类型

类型

说明

示例

Bug 报告

功能异常、崩溃、错误等

编译失败、烧录或启动异常、运行崩溃、外设或网络异常

功能建议

新功能需求、现有功能改进

希望增加 XX 协议支持、优化 XX 接口性能

文档问题

文档错误、缺失、不清晰

某 API 说明有误、缺少使用示例

使用疑问

使用过程中的问题咨询

如何实现 XX 功能、某参数的含义

如果是 Bug 报告,建议在标题中标明问题分类,例如:编译问题、烧录/启动问题、运行崩溃、外设驱动、网络协议、低功耗、FOTA。

4.2 反馈模板

请尽量按以下模板提交问题,方便快速定位:

### 问题类型
Bug 报告 / 功能建议 / 文档问题 / 使用疑问

### 问题分类(Bug 报告建议填写)
编译问题 / 烧录或启动问题 / 运行崩溃 / 外设驱动 / 网络协议 / 低功耗 / FOTA / 其他

### 问题描述
清晰描述问题现象、报错信息和影响范围。

### 环境信息
- SDK 版本:版本号 / tag / commit
- PROJECT:
- 模组型号(MODEM):
- 底包型号(MODEMPKG):
- 芯片平台:EC71X
- 编译工具链版本:
- 编译命令:
- 操作系统:

### 硬件信息(硬件相关问题建议填写)
- 开发板类型:EVB / 客户板
- 供电方式:
- 关键连线与外设:UART / GPIO / SPI / I2C / USB 等
- 外设型号:

### 复现步骤
1. ...
2. ...
3. ...

### 复现情况
- 是否必现:
- 复现概率:
- 触发条件:
- 从上电到问题出现的大致时长:

### 日志与附件
- 日志类型:编译日志 / 运行日志 / dump / 抓包 / 波形截图
- 日志来源:Debug UART / USB / 其他
- 请尽量提供从上电到问题发生的完整日志
- 如可以,请附最小复现工程或关键代码片段

### 期望行为
说明期望的正确行为。

4.3 功能建议补充说明

提交功能建议时,请额外说明:

  • 功能需求场景

  • 期望的实现方式

  • 与其他功能的兼容性考虑

4.4 提交说明

  • 涉及编译失败、运行崩溃或外设异常时,建议优先提供最小复现工程或关键代码片段。

  • 日志请尽量覆盖从上电到问题发生的完整过程,并说明日志口来源。

  • 涉及 IMEI、SIM 卡号、服务器地址、密钥、账号等敏感信息时,请先脱敏后再提交。

5 联系方式

渠道

适用场景

说明

GitHub 仓库

公开问题反馈、文档问题、功能建议

https://github.com/orgs/lierda-iot/repositories

技术讨论

一般技术交流

扫描下方二维码加入技术讨论群

邮箱联系

私密问题或不便公开的问题

yumx@lierda.com, liangj@lierda.com

6 致谢

感谢所有为本项目做出贡献的开发者。