BW21-CBV-Kit 二次开发的正确打开方式

[复制链接]
查看1061 | 回复5 | 2024-12-16 16:11:58 | 显示全部楼层 |阅读模式

本帖最后由 起个名字好难啊 于 2025-1-2 11:12 编辑

简介

上周做好了 BW21-CBV-Kit 的全中文开发教程,可能刚拿到开发板的小伙伴不知道怎么下手玩,所以今天专门写一篇帖子教大家怎么开始玩 BW21-CBV-Kit。

打开教程文档

先给大家几个链接:

我们当然是看中文教程链接了,打开链接之后,就是开发教程的首页: image.png

在首页里的左边的导航栏上有所有教程的文档,导航栏往外的一栏,是页面的目录:

image.png

导航栏: 教程的所有页面导航,你可以在导航栏找到想要的例程或者API说明。

教程使用

导航栏的使用

导航栏一共只有 5 个大目录:

  • 首页
  • 快速入门
  • 项目案例
  • 其他指南
  • SDK 源码

首页

在首页里面,你可以看到 BW21-CBV-Kit 的参数介绍,包括:尺寸、接口、GPIO 映射以及性能参数。而我们常用的,可能就是 GPIO 映射图

快速入门

快速入门栏目,是我们比较重要的页面,因为里面包含了:

  • Arduino 环境搭建
  • 例程指南
  • API 指南

Arduino 环境搭建

这里的内容会教大家从头开始在 Arduino IDE 上搭建 BW21-CBV-Kit 的开发环境。所有人都需要根据这个教程搭建好开发环境,才能进行接下来的所有开发。

例程指南

顾名思义,里面包含了 BW21-CBV-Kit 的所有 demo,点击 例程指南就能看到所有的 demo,把展示方式改成宫格,会更加明了。

image.png

里面的每个文档,都有与其相关的例程。

API 指南

API 指南,指的是函数指南,因为 Arduino 采用的是 C++ 编程语言,因此对未使用过 C++ 的做一个名词科普:

  • Class: 称为 类。粗略的认为它是一种结构体类型(但是不等于)。
  • 构造函数:由类创建出来的变量,类似结构体变量。
  • 方法:C语言的函数,一段可以执行的代码。
  • 成员:类里面的可执行函数。
  • 属性:类里面的变量。

API 指南里,会把每个类以及成员的功能、调用方式、参数说明、返回值和调用例程进行说明。里面已经包含了所有 Arduino 可用的接口。

image.png

目录的使用

例程文档目录

目录指的是具体教程文档中的标题点,例如 GPIO demo:

image.png

例程目录里面一般会有:用料、示例、代码参考。三个标题,你可以根据标题查看对应的内容。

API 文档目录

点击 API 指南进入到页面,你可以看到所有 API 分类:

image.png

以 GPIO API 说明为例:

image.png

开头介绍的是 对应的说明,接着就是详细的成员接口说明:

  • 说明:功能说明
  • 语法:调用方法
  • 参数说明:形参说明
  • 返回值:返回值说明
  • 示例代码:示例参考

你可以根据需求查看对应的 API 说明

参考代码查看

因为源代码主要在 Github 为了正常查看代码,API 接口复制粘贴了 Github 的源码到教程当中,方便用户查看。 参考代码主要在 API 指南当中,一般有两种展现方式:

  • 整个文档只参考了一个示例:参考代码会放在文档的最后,并在说明里面进行链接跳转
  • 文档有两个及以上的参考示例:每个参考代码只展现一次,在说明里面进行链接跳转

例如:

image.png

无论那种方式,使用点击查看都能转到相应的参考代码,

搜索内容

因为整个教程非常大,你也可以使用搜索功能,但是飞书的搜索功能只有登录后才能使用。因此需要先登录。 登录之后,点击页面右上角的搜索图标即可使用搜索功能。

image.png

回复

使用道具 举报

爱笑 | 2024-12-16 16:29:42 | 显示全部楼层
等后续这块板子大量推广后,资料就可以很好的利用起来了。
用心做好保姆工作
回复 支持 反对

使用道具 举报

WT_0213 | 2024-12-16 22:01:13 | 显示全部楼层
非常帅
回复

使用道具 举报

bzhou830 | 2024-12-17 08:37:58 | 显示全部楼层
cool
选择去发光,而不是被照亮
回复

使用道具 举报

小小鸟 | 2024-12-17 14:22:46 | 显示全部楼层
好帅
回复

使用道具 举报

1055173307 | 2024-12-19 15:36:04 | 显示全部楼层
学习
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则