功能名称开发指南
本文件是开发指南结构模板。复制后删除本说明,并将占位内容替换为经过代码和开发板验证的信息。
功能简介
说明能力、典型使用场景、限制条件,以及本文最终能帮助开发者完成什么。
对应代码
| 项目 | 位置 |
|---|---|
| Demo 工程 | 链接到 samples/ 下真实存在的项目 README |
| SDK 接口 | 链接到 src/ 下真实存在的头文件或实现 |
| 构建配置 | 链接到实际目标配置和组件 CMakeLists |
路径、配置宏、组件名和命令以仓库当前代码为准。Linux、WSL、Docker 和 GitCode 上的路径大小写敏感。
准备硬件
列出开发板、外设、连接方式、供电、串口和测试服务。没有某项依赖时应说明功能会受到什么影响。
选择开发环境
| 开发环境 | 适用场景 | 使用指南 |
|---|---|---|
| 一站式 CLI(推荐) | 快速完成目标选择、构建、烧录和串口监视 | 一站式 CLI 开发环境使用指南 |
| HiSpark Studio for VS Code | 图形化编辑、编译、烧录和调试 | HiSpark Studio for VS Code 开发环境使用指南 |
| WSL 与 Docker | 在 Windows 上使用一致的 Linux 容器构建环境 | WSL 与 Docker 环境使用指南 |
后续命令默认使用一站式 CLI;使用其他环境时执行等价的目标选择、构建、烧录和串口操作。
快速运行
- 启用目标配置和 Demo 组件。
- 构建
diting-community,写出可直接复制执行的命令。 - 烧录完整镜像或明确列出的分区。
- 连接正确串口,给出波特率。
- 写出触发功能的按钮、AT 命令或任务入口。
预期结果
给出成功日志、返回值或可观察现象;同时说明失败时首先检查什么。
核心流程
用流程图和短代码片段解释初始化、配置、调用、释放和异常处理。代码片段应来自当前 Demo 或 SDK,并注明来源文件。
基于 Demo 开发
说明如何复制组件、修改组件名和配置宏、加入目标、替换业务逻辑,以及产品化时需要补充的错误处理、并发保护、权限和安全措施。
常见问题
按“现象—原因—解决方法”给出可执行的排查步骤。
相关资料
只链接仓库中实际存在的文档、代码、图片或稳定的官方外部页面;提交前校验相对链接和锚点。