SDK 开发指南：快速上手与目录结构详解

本文将带您全面了解 SDK 包的目录结构，并梳理从环境准备到固件烧录的完整开发流程，帮助您高效启动项目开发。

一、SDK 包目录结构

SDK 采用模块化设计，各目录职责清晰，主要内容如下：

二、开发流程：五步上手

步骤 1：复制工程模板

将 custom/custom_main 目录复制一份，并重命名为您的项目名称（例如 my_project）。这一步确保原始模板不被污染，同时为您提供了一个干净的开发环境。

步骤 2：编写业务逻辑

在复制后的工程目录中，根据产品需求编写您的业务代码。您可以：

• 参考 examples 目录下的 UART、MQTT、HTTP 等示例，了解 API 调用方式；

• 查阅 include 目录中的头文件，掌握各接口的参数定义与返回值说明。

步骤 3：配置编译规则

打开工程目录下的 custom.mk 文件，将您新增的源文件（.c）和头文件路径添加到编译列表中。确保构建系统能够正确识别并编译您编写的代码。

步骤 4：编译工程

执行编译命令（通常为 make 或 SDK 提供的专属构建指令）。编译成功后，生成的固件文件将自动输出到 out 目录。

步骤 5：烧录固件

将 out 目录中生成的固件文件通过烧录工具写入目标硬件，完成部署。随后即可进行功能验证与调试。

三、总结

SDK 以 custom_main 为起点、examples 为参考、include 为手册、out 为终点，形成了一套闭环的开发体系。按照"复制模板 → 编写代码 → 修改配置 → 编译 → 烧录"的流程，您可以快速完成从环境搭建到产品落地的全过程。

建议首次开发时，先编译并运行 examples 中的示例，确认硬件与工具链环境正常后，再基于 custom_main 开展正式的业务开发。