Example Code for [Platform]-[keywords]
Last revision 2025/11/30
用一两句话概括本教程/示例的功能,内容简明扼要。字数有所控制,建议AI设置长度控制在500(字符数)以内。
具体参考格式见《WIKI撰写规范(2025年版)》的“Example Code”
1. Hardware Preparation
- 名称 | 型号/SKU | 数量 | 购买链接
- 采用无序列表形式,列出所需的硬件清单,并简要描述产品
- 项目所需配件,需标明产品SKU和商城购买链接,非商城产品可不附超链接
- 国内Wiki使用中文商城超链接,英文wiki接使用英文商城超链接
2. Software Preparation
- 列出所需的开发工具、平台说明,并附下载链接及安装教程
- 如软件版本差别较大,需提供不同版本的软件库
- 中文Wiki使用Gitee链接,英文Wiki使用GitHub链接
3. Wiring Diagram
- 提供清晰的接线图(推荐使用 Inkscape 绘制),必要时可附实物接线照片
(连线图教程:如何画一个DFRobot资料库风格的电路图? DF创客社区) - 以表格形式说明各端口与对应引脚的关系
- 每条接线说明应简洁清晰,避免线序重叠呈现
示例:

| 传感器侧/显示器侧 | 引脚名称 | 主控侧 | 引脚名称 |
|---|---|---|---|
| Gravity I2C BMM150模块 | VCC | ESP32-E主控 | 3V3 |
| Gravity I2C BMM150模块 | SCL | ESP32-E主控 | SCL |
| XX | XX | XX | XX |
| XX | XX | XX | XX |
4. Sample Code
- 格式必须选择"代码块",需统一使用Arduino格式,不同语言高亮代码不同
- 分模块注释每段代码的功能,产品功能相关代码需做详细注释说明
- 英文wiki的示例代码,不能出现中文注释
示例:
// the setup function runs once when you press reset or power the board
void setup() {
// initialize digital pin LED_BUILTIN as an output.
pinMode(LED_BUILTIN, OUTPUT);
}
// the loop function runs over and over again forever
void loop() {
digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level)
delay(1000); // wait for a second
digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW
delay(1000); // wait for a second
}
5. Result
- 提供项目结果的图片,并配以文字说明结果
(比如示波器输出、串口输出、项目实物照片等) - 若有动态效果,可附加 MP4 视频文件,避免使用 GIF
- 如含有物理量的专业传感器,需将不同区间的数值加以说明
(例如甲醛传感器,通风条件下数值为多少,密闭盒中有甲醛环境数值为多少)
Was this article helpful?
