这是最新(主)开发分支的文档。如果您正在查找以前版本的文档,使用左侧的下拉菜单选择所需的版本。

XXX

(下面是驱动比较通用模板,具体模块可以添加章节做进一步说明)

简介

功能列表

功能概述

(可以包含原理,通信流程等,基础的电路原) 图推荐用drawio画,生成图片的原始文件(比如 drawio文件)放到docs/original (SDK发布时,该目录会删除)

功能配置

(这里可以根据module情况命名)

XX1配置

( 比如pin脚)

XX2配置

主要功能/或者应用示例

XX功能1

(1 功能使用起始条件要做清晰描述,2 相互关联的其他模块或者本模块的其他API的时序,3 结果的清晰说明)

XX功能2

XX功能3

注意事项

(针对用户使用需要注意的事项)

应用实例

(把examples中的实例链接在下面,其他需要说明的示例放到”主要功能/XX功能”里面)

相关文档

(非必须,填写关联比较强的模块文档连接,比如eeprom和i2c关联比较强)

API参考

放链接