1. 简介
Google 的 OpenThread (OT) 是 Thread 的开源实现。Google 发布了 OpenThread,以便让 Google Nest 产品中使用的网络技术可供开发者广泛使用,以便加速相关家居和商业建筑产品的开发。OpenThread 具有狭窄的平台抽象层且占用的内存很少,因此具备高度可移植性。它支持系统芯片 (SoC) 和网络协处理器 (NCP) 设计。
线程规范定义了适用于家庭和商业建筑应用的基于 IPv6 的可靠、低功耗的无线设备到设备通信协议。
Silicon Labs 增强了 OpenThread,可与 Silicon Labs 硬件配合使用。此源代码可在 GitHub 上找到,也可作为随 Simplicity Studio 5 (SSv5) 安装的软件开发套件 (SDK) 使用。SDK 包含经过全面测试的 GitHub 源代码快照。与 GitHub 版本相比,它支持的硬件种类更广泛,并且包含 GitHub 上未提供的文档和示例应用。
本指南将介绍如何开始使用 Silicon Labs OpenThread SDK 和 Simplicity Studio 5 开发 OpenThread 应用。下图显示了此 Codelab 中使用的板 (BRD) 和设置有 OT 边界路由器 (OTBR) 和两个线程设备的硬件。
学习内容
- 如何使用 Silicon Labs Simplicity Studio IDE 创建 OpenThread 项目。
- 如何构建 OpenThread CLI 二进制文件并将其刷写到 Silicon Labs 无线板。
- 如何使用 Docker 将 Raspberry Pi 3B 或更高版本设置为 OpenThread 边界路由器 (OTBR)。
- 如何在 OTBR 上创建线程网络。
- 将设备带外调试到线程网络。
- 如何使用 ping 命令验证节点之间的线程通信。
2. 前提条件
硬件:
- 3 台 EFR32MGxx 无线电板 - 可以使用以上任意设备组合。此 Codelab 使用 BRD4166A 作为 RCP,并使用两个 BRD4168A 作为全线程设备。
- EFR32MG12(BRD4161A、BRD4166A、BRD4170A、BRD4304A)
- EFR32MG13 (BRD4168A)
- EFR32MG21(BRD4180A、BRD4180B)
- BRD4001A:用于托管无线电板的无线入门主板 (WSTK)。除 BRD4166A 之外,所有无线电板都需要分别安装一个启动主板。用于连接 BRD4166A 主板或 Micro USB 线的迷你 USB 线。
- 已安装 Raspberry Pi 3B 或更高版本(带有 Raspbian Stretch Lite 操作系统映像)或Raspbian Stretch(含桌面设备)(通过以太网连接到互联网)。我们将其配置为 OT 边界路由器。
- 具有至少 2 个 USB 端口和互联网连接的 Windows/Linux/Mac 主机系统。查看 SSv5 的硬件和操作系统要求。
- 至少一根以太网网线,可将 Raspberry Pi 连接到互联网。WSTK 还支持通过 IP 地址进行调试和刷写,因此您还可以选择使用以太网网线,通过以太网交换器将 WSTK 连接到主机系统。
软件:
- 在 Windows/Linux/Mac Host system 使用
- GNU ARM 工具链
- Gecko SDK Suite 3.2.0 或更高版本以及 Silicon Labs OpenThread SDK。
3.硬件设置
此 Codelab 是使用
- EFR32MG12 BRD4166A Thunderboard Sense 2(如左侧所示)。
- 如右侧所示,是两个 FRD4168A EFR32MG13。
- 通过带有
- Gecko SDK 3.2.0
- GNU ARM v7.2.1
通过 USB 将每个无线入门套件主板连接到主机,如下图所示。这些连接将允许对 RCP 和最终用户的设备进行编程和分析。我们首先使用主机通过 ot-rcp 固件编写 BRD4166A 程序,并最终将其连接到 Raspberry Pi。(可选)您可以通过通用以太网交换机将终端设备连接到主机。入门套件还支持基于 IPv4 的编程和网络分析。
4.固件设置
您可以通过以下两种方式开始创建。这两个选项都可让您刷写此 Codelab 所需的固件。
- 项目:(推荐)创建、构建和刷写示例应用。通过此选项,您可以自定义项目中的应用。
- 演示:(可选)直接将预构建演示刷写到任何示例应用的无线电板上。我们鼓励用户试用设置为演示版练习的演示版固件。如需了解详情,请参阅此 Codelab 末尾的“可选的固件设置 - 演示”部分。
在本 Codelab 中,我们将使用项目方法。
使用示例创建项目
我们将创建两个项目。BRD4166A 的 ot-rcp
项目和两个 BRD4168A 的 ot-cli-ftd
项目。请按照下列步骤操作,为您的板选择适当的示例应用。
- 打开 Studio 的 File 菜单,然后依次选择 New > Silicon Labs Project Wizard。系统随即会打开“Target, SDK and Toolchain Selection”对话框。请勿更改 OpenThread 支持的默认 Simplicity IDE / GNU 工具链。点击“下一步”。
- 目标板:显示选定的无线电板 (BRD4168A) 和主板 (BRD4001A)
- 目标设备:此字段显示板载微控制器芯片 (MCU)。BRD4168A 内置 EFR32MG13 MCU。
- SDK:您可以在此处选择正在使用的 OT 的 SDK 版本。套件信息包括 SDK 标记和 OpenThread 的 Silicon Labs 版本,例如
Platform 4.0.1.0
和OpenThread 2.0.1.0 (GitHub-55af6ce2c)
。 - IDE/ 工具链:用于编译 OT 项目的工具链。我们使用 GNU ARM。
- 系统会打开示例项目选择对话框。您会看到示例项目列表。使用线程技术类型和关键字过滤器来搜索特定的示例。请务必记下 Gecko SDK Suite 版本号。将 Raspberry Pi 设置为边界路由器时,需要用到此版本标记。选择 ot-cli-ftd,然后点击下一步。
- 系统会打开“Project Configuration”对话框。您可以在此处重命名项目、更改默认项目文件位置,以及确定是链接到还是复制项目文件。关联的项目文件指向 SDK,因此您做出的所有修改最终都会在 SDK 中进行,并用于未来的项目。通过复制项目源代码,您可以修改项目本地副本,以使 SDK 文件保持不变。“关联 SDK 并复制项目源代码”是默认选项和建议执行的操作。 点击 FINISH。
- 系统随即会打开“SIDEyid IDE Perspective”并打开 OVERVIEW(概览)标签页。
您可以通过安装和卸载组件以及配置安装的组件,在软件组件标签页中配置项目。系统会检查已安装的组件。点击已安装的组件,查看由示例应用安装的组件的过滤列表。系统会自动保存您所做的任何更改,并且系统会自动生成项目文件。S 指示 简化版视图的右下角显示了进度。
在本演示中,我们将使用示例应用的默认配置。重复上述步骤,为您的其他开发板创建 ot-rcp
项目。
构建和刷写项目
构建并刷写 ot-rcp
和 ot-cli-ftd
项目。
- 配置完项目后,点击顶部工具栏中的 Build Control (hammer) 图标。或者,您可以右键点击该项目,然后点击构建项目。
- 进度显示在右下角,进度条也会在右下角显示。此输出窗口中也会出现与您的项目相关的所有错误或警告。
- 二进制文件映像是在项目构建成功后生成的。您可以从 Project Explorer 视图刷写二进制映像。在编译器子目录中找到 .bin、.hex 或 .s37 文件。右键点击该文件,然后选择刷写到设备。如果您连接了多部设备,然后选择要编排的设备,请点击确定。打开填充了文件路径的 Flash Programmer。点击程序。
5. 固件设置摘要
此时,您应该已经创建、编译并刷写到无线电板上的相应固件。将 ot-rcp
刷写到 BRD4166A 后,断开与主机系统的连接,并将此板连接到 Raspberry Pi。
完成本部分后,您的线程网络硬件设置将如下所示。
6.为 ot-cli-ft 设备设置串行控制台
如需启动 Console 界面,请在“IDE 简单”透视图的“设备视图 / 调试适配器”窗口中右键点击您的 J-Link 设备。选择启动控制台。如需在控制台中看到提示,请选择序列号 1 标签页,然后按 Enter。检查 FTD 节点的状态。
您会发现我们还没有 ot-rcp
的控制台。在下一步中,我们会将 Raspberry Pi 配置为 OT 边界路由器,并为 ot-rcp
设置控制台。
7. 将 Raspberry Pi 设置为边界路由器
Silicon Labs 建议使用 OTBR 部署公司的 Docker 容器。在容器中运行 OTBR 可创建易于部署的工件并加快开发原型设计和测试。
Silicon Labs OTBR 映像托管在 siliconlabsinc DockerHub 上,带有标记。每个标记都对应一个 GSDK 版本:
https://hub.docker.com/r/siliconlabsinc/openthread-border-router/tags
对于给定版本,Docker 容器必须与使用 Simplicity Studio 5 构建的 RCP 搭配使用。请确保将容器代码版本与您用于测试的 GSDK 版本相匹配。例如,如果您的 GDSK 版本为 Gecko SDK Suite v4.0.1 (140)
,那么当您从 Example Project Selection 窗口中选择 ot-rcp
时,请使用 siliconlabsinc/openthread-border-router:gsdk-4.0.1
映像。
Raspberry Pi 设置
- 在 SD 卡上,确保刷写 Raspbian Stretch Lite 操作系统映像或Raspbian Stretch 桌面设备版。
- 你可以通过 SSH 连接到 Raspberry Pi 或选择直接使用 Raspbian Desktop。打开终端。
- 请确保在安装 Docker 之前更新您的本地代码库和软件包管理器(apt-get update 和 apt-getupgrade)。
安装 Docker 映像
- 在 RPi 上使用以下命令安装 Docker。
curl -sSL https://get.docker.com | sh
- 完成后,您可以修改 Docker 用户设置,使其无需在每个命令之前运行 sudo。需要重新启动。
sudo usermod -aG docker $USER
- 发出以下命令来安装容器。请注意,使用 RCP 时,一次只能运行一个边界路由器容器。此外,请务必将 Simplicity Studio GSDK 版本与正确的 Docker 映像匹配。例如
gsdk-4.0.1
:docker pull siliconlabsinc/openthread-border-router:gsdk-4.0.1
配置并运行 Docker
- 您需要在启动时配置要用于 OTBR 的 TTY 端口,以便连接 RCP。查找 RCP 设备的 TTY 端口。最简单的方式是在连接 RCP 后查找
/tty/dev
... 条目。它通常应为/dev/ttyUSB0
或/dev/ttyACM0
。 - 使用以下命令运行 Docker 安装。请务必将 Docker 映像名称替换为匹配的 GSDK 版本。例如
gsdk-4.0.1
:docker run -d --name "otbr" \ --sysctl "net.ipv6.conf.all.disable_ipv6=0 net.ipv4.conf.all.forwarding=1 net.ipv6.conf.all.forwarding=1" \ -p 8080:80 --dns=127.0.0.1 -it \ --volume /dev/ttyACM0:/dev/ttyACM0 \ --privileged siliconlabsinc/openthread-border-router:gsdk-4.0.1 \ --radio-url spinel+hdlc+uart:///dev/ttyACM0?uart-baudrate=460800 \ --backbone-interface eth0
-d
可确保容器在分离模式下运行。- 您可以随时使用
docker logs
命令查看容器的运行日志。 --name
会保持粘滞状态,直到 Docker 容器正确关闭(或移除)为止。- 端口 8080 表示托管边界路由器管理网页的网络服务器的端口。
?uart-baudrate=460800
在无线网址选项中要求使用,以通过 UART 解决代价高昂的操作(例如使用长 IPv6 数据包的 DTLS)来解决碎片化 / 重组问题。
与 RCP 节点交互
Docker 运行后,您可以使用此命令通过交互式 shell 与 RCP 节点通信。检查 RCP 节点的状态。
$ docker exec -ti otbr sh -c "sudo ot-ctl" > state disabled Done
您可以获取正在运行的容器 ID 列表
$ docker ps -aq
您可以检查运行 OTBR Docker 容器的窗口以运行边界路由器的日志输出,也可以按如下所示关注容器日志:
$ docker logs [container-id] -f
(可选)如果正确加载 Docker 容器,您可以停止、移除或终止映像。
$ docker stop otbr
$ docker rm otbr
$ docker kill otbr
可选:要退出 shell,请使用 CNTL + C。
此时,您应该拥有 3 个控制台。
- S 隐式 y Studio 中的两个
ot-cli-ftd
控制台,设置为全线程设备。 - 在 Raspberry Pi 上设置一个可设为 OT 边界路由器的
ot-ctl
交互式 shell。
现在,我们已准备好构建线程网络。
8. 创建线程网络
设置 RCP
为了创建网络,我们在 OTBR 上使用 ot-ctl
shell 来与 RCP 节点通信。请按如下所示的顺序输入以下命令:
索引 | 命令 | 命令说明 | 预期响应 | ||
1 |
| 创建新的网络配置。 | 完成 | ||
2 |
| 将新数据集提交到活跃操作数据集。 | 完成 | ||
3 |
| 启用线程接口。 | 完成 | ||
4 |
| 启用并附加线程协议操作。 | 完成 | ||
等待 10 秒,让线程接口启动。 | |||||
5 |
| 检查设备状态。默认状态应为领先变体。 | 领先变体 | ||
6 |
| 查看网络配置。 | 有效时间戳:1 |
我们将使用 ot-cli-ftd
上的频道号和网络密钥将两个 FTD 加入此线程网络。
设置 FTD,并将其添加到我们的线程网络(带外方法)
使用带外方法时,我们了解所有安全信息,并手动添加节点。在 Simplicity Console 中,使用以下命令按如下所示的顺序将两个 FTD 添加到我们的网络中。
索引 | 命令 | 命令说明 | 预期响应 | ||
1 |
| 设置 OTBR 使用的通道。 | 完成 | ||
2 |
| 设备只需拥有网络密钥即可连接到线程网络。 | 完成 | ||
3 |
| 将新数据集提交到活跃操作数据集。 | 完成 | ||
4 |
| 启用线程接口。 | 完成 | ||
5 |
| 启用并附加线程协议操作。 | 完成 | ||
等待 20 秒,让设备自行加入和配置。 | |||||
6 |
| 查看网络配置。 | 孩子 |
线程设备间的通信
我们将使用 ping
命令检查设备能否相互通信。要使用 ping 命令,我们需要设备的 IPv6 地址。这些命令可通过 ipaddr
命令获取。
> ipaddr fd5c:c6b:3a17:40b9:0:ff:fe00:fc00 # Leader Anycast Locator (ALOC) fd5c:c6b:3a17:40b9:0:ff:fe00:1800 # Routing Locator (RLOC) fd5c:c6b:3a17:40b9:84e2:bae8:bd5b:fa03 # Mesh-Local EID (ML-EID) fe80:0:0:0:c449:ca4a:101f:5d16 # Link-Local Address (LLA)
从两个 FTD 中使用 OTBR 的 RLOC 地址对 OTBR 进行 ping 操作。
> ping fd5c:c6b:3a17:40b9:0:ff:fe00:1800 Done > > 16 bytes from fd5c:c6b:3a17:40b9:0:ff:fe00:1800: icmp_seq=3 hlim=64 time=30ms 16 bytes from fd5c:c6b:3a17:40b9:0:ff:fe00:1800: icmp_seq=3 hlim=64 time=52ms
响应表明已接收负载,且通信成功。重复上述过程,对 OTBR 中的 FTD 进行 ping 操作。
9. 恭喜
您已创建线程网络!
您现在已经了解:
- 如何使用 Silicon Labs Simplicity Studio IDE 创建 OpenThread 项目。
- 如何构建 OpenThread CLI 二进制文件并将其刷写到 Silicon Labs 无线板。
- 如何使用 Docker 将 Raspberry Pi 3B 或更高版本设置为 OpenThread 边界路由器 (OTBR)。
- 如何在 OTBR 上创建线程网络。
- 将设备带外调试到线程网络。
- 如何使用 ping 命令验证节点之间的线程通信。
更多详情
查看 openthread.io 和 GitHub,以获取各种 OpenThread 资源,包括:
- 支持的平台 - 查看所有支持 OpenThread 的平台
- 构建 OpenThread - 有关如何构建和配置 OpenThread 的更多详情
- Thread Primer - 介绍了此 Codelab 中介绍的所有线程概念
- Silicon Labs OpenThread 培训 - 介绍了 OpenThread,介绍了调试路由器和边界路由器,以及创建 OpenThread 网络的实操练习。
- QSG170:Silicon Labs OpenThread 快速入门指南 - 详细介绍了 Silicon Labs 线程开发的入门流程
- AN1256:搭配使用 Silicon Labs RCP 和 OpenThread 边界路由器 - 适用于 Raspberry Pi 边界路由器主机的构建和安装说明
10. 可选的固件设置 - 演示版
演示版是可以下载到兼容设备的预构建固件映像。在 Simplicity Studio 中查看您是否有可用的演示,最快速的方法是在“Debug Adapters”视图下点击您的部分,然后转到“Launcher Perspective”中的 EXAMPLE PROJECTS & DEMOS 标签页。停用“示例项目”过滤器并选中“技术类型”下的“线程”单选按钮。
随 OpenThread SDK 提供的预编译演示应用映像与以下开发板兼容:
- 4161 巴西雷亚尔
- BRD4166a
- 4168 巴西雷亚尔
- 4180 巴西雷亚尔
- 4304 巴西雷亚尔
在未来的 SDK 版本中,此列表可能会更新,以添加更多无线电板。有关受支持部分的完整列表,请参阅“文档”下的 Silicon Labs OpenThread SDK 版本说明。
在相应的开发板上刷写以下演示。如需进行刷写,请在左侧的“调试适配器”下选择您的开发板,然后点击相应示例应用的“运行”。系统会显示一个弹出式窗口,其中会显示闪烁进度。
- BRD4166A:ot-rcp - 此设备将用作 OT 边界路由器的无线电合作处理器。我们将使用此设备创建线程网络,并在线程网络上对其他两台设备建立初始配置。作为边界路由器,此设备还可以用作线程网络中的设备通过互联网进行通信的网关。
- 两个 BRD4168A:ot-cli-ftd - 这两台设备将作为全线程设备。他们将加入由 OTBR 创建的线程网络。