在 Docker 中使用 OpenThread 模拟线程网络

1. 简介

26b7f4f6b3ea0700.png

Google 发布的 OpenThreadThread 网络协议的开源实现。Google Nest 发布了 OpenThread,供开发者广泛使用 Nest 产品中使用的技术,以加快智能家居产品开发速度。

线程规范为家庭应用定义了基于 IPv6 的可靠、安全、低功耗无线设备到设备通信协议。OpenThread 实现了所有 Thread 网络层,包括 IPv6、6LoWPAN、IEEE 802.15.4,以及 MAC 安全机制、网格链路建立服务和网格路由。

此 Codelab 会引导您使用 Docker 在模拟设备上模拟 Thread 网络。

学习内容

  • 如何设置 OpenThread 构建工具链
  • 如何模拟 Thread 网络
  • 如何对 Thread 节点进行身份验证
  • 如何使用 OpenThread 守护程序管理 Thread 网络

所需条件

  • Docker
  • 具备 Linux、网络路由方面的基础知识

2. 设置 Docker

此 Codelab 用于在 Linux、Mac OS X 或 Windows 计算机上使用 Docker。建议使用 Linux 环境。

安装 Docker

在您选择的操作系统上安装 Docker。

拉取 Docker 映像

安装 Docker 后,打开一个终端窗口并拉取 openthread/environment Docker 映像。此映像包含已预先构建并可供此 Codelab 使用的 OpenThread 和 OpenThread Daemon。

$ docker pull openthread/environment:latest

请注意,下载可能需要几分钟时间。

在终端窗口中,从映像启动 Docker 容器并连接到其 bash shell:

$ docker run --name codelab_otsim_ctnr -it --rm \
   --sysctl net.ipv6.conf.all.disable_ipv6=0 \
   --cap-add=net_admin openthread/environment bash

当您退出容器时,--rm 选项会删除容器。如果您不希望删除容器,请勿使用此选项。

请注意此 Codelab 所需的标志:

  • --sysctl net.ipv6.conf.all.disable_ipv6=0 - 此操作会在容器内启用 IPv6
  • --cap-add=net_admin - 启用 NET_ADMIN 功能,以便执行与网络相关的操作,例如添加 IP 路由

进入容器后,您应该会看到如下所示的提示:

root@c0f3912a74ff:/#

在上面的示例中,c0f3912a74ff 是容器 ID。Docker 容器实例的容器 ID 将不同于此 Codelab 的提示中显示的 ID。

使用 Docker

此 Codelab 假定您了解使用 Docker 的基础知识。在整个 Codelab 中,您应该在 Docker 容器中保留。

3. 模拟线程网络

您将在此 Codelab 中使用的示例应用演示一个最小的 OpenThread 应用,该应用通过基本命令行界面 (CLI) 公开 OpenThread 配置和管理界面。

本练习介绍了 ping 另一个模拟 Thread 设备以模拟另一个 Thread 设备所需的最少步骤。

下图介绍了基本的 Thread 网络拓扑。在本练习中,我们将模拟绿色圆圈内的两个节点:线程主管和线程路由器,它们彼此之间只有一个连接。

6e3aa07675f902dc.png

创建网络

1. 启动节点 1

如果您尚未在终端窗口中启动 Docker 容器并连接到其 bash shell,请执行此操作:

$ docker run --name codelab_otsim_ctnr -it --rm \
   --sysctl net.ipv6.conf.all.disable_ipv6=0 \
   --cap-add=net_admin openthread/environment bash

在 Docker 容器中,使用 ot-cli-ftd 二进制文件为模拟 Thread 设备生成 CLI 进程。

root@c0f3912a74ff:/# /openthread/build/examples/apps/cli/ot-cli-ftd 1

注意:运行此命令后,如果您没有看到 > 提示,请按 enter

此二进制文件实现了 OpenThread 设备。IEEE 802.15.4 无线装置驱动程序在 UDP 之上实现(IEEE 802.15.4 帧在 UDP 载荷内传递)。

1 的参数是一个文件描述符,表示对于模拟设备的“工厂分配”IEEE EUI-64 的最低位。在绑定到 UDP 端口以进行 IEEE 802.15.4 无线模拟(端口 = 9000 + 文件描述符)时,也会使用此值。此 Codelab 中的模拟 Thread 设备的每个实例将使用不同的文件描述符。

注意:在为模拟设备生成进程时,请仅使用本 Codelab 中所述的 1 或更高版本的文件描述符。0 的文件描述符专供其他用途使用。

创建一个新的操作数据集,并将其作为活跃数据集提交。Operationing Dataset 是您创建的 Thread 网络的配置。

> dataset init new
Done
> dataset
Active Timestamp: 1
Channel: 20
Channel Mask: 07fff800
Ext PAN ID: d6263b6d857647da
Mesh Local Prefix: fd61:2344:9a52:ede0/64
Network Key: e4344ca17d1dca2a33f064992f31f786
Network Name: OpenThread-c169
PAN ID: 0xc169
PSKc: ebb4f2f8a68026fc55bcf3d7be3e6fe4
Security Policy: 0, onrcb
Done

将此数据集提交为活跃数据集:

> dataset commit active
Done

启动 IPv6 接口:

> ifconfig up
Done

启动线程协议操作:

> thread start
Done

等待几秒钟,然后验证设备是否已成为线程领先变体。主要设备是负责管理路由器 ID 分配的设备。

> state
leader
Done

查看分配给节点 1 的线程接口的 IPv6 地址(输出会有所不同):

> ipaddr
fd61:2344:9a52:ede0:0:ff:fe00:fc00
fd61:2344:9a52:ede0:0:ff:fe00:5000
fd61:2344:9a52:ede0:d041:c5ba:a7bc:5ce6
fe80:0:0:0:94da:92ea:1353:4f3b
Done

请注意特定的 IPv6 地址类型:

  • fd 开头 = Mesh-local
  • fe80 开头 = link-local

网状网本地地址类型进一步分类:

  • 包含 ff:fe00 = 路由器定位器 (RLOC)
  • 不包含 ff:fe00 = 端点标识符 (EID)

确定控制台输出中的 EID,并记下该 ID 以供日后使用。在上面的示例输出中,EID 为:

fd61:2344:9a52:ede0:d041:c5ba:a7bc:5ce6

2. 启动节点 2

打开新终端,然后在当前运行的 Docker 容器中执行 bash shell 以用于节点 2。

$ docker exec -it codelab_otsim_ctnr bash

在这个新的 bash 提示符下,使用参数 2 生成 CLI 进程。这是您的第二个模拟 Thread 设备:

root@c0f3912a74ff:/# /openthread/build/examples/apps/cli/ot-cli-ftd 2

注意:运行此命令后,如果您没有看到 > 提示,请按 enter

使用与节点 1 的操作数据集相同的值配置线程网络键和 PAN ID:

> dataset networkkey e4344ca17d1dca2a33f064992f31f786
Done
> dataset panid 0xc169
Done

将此数据集提交为活跃数据集:

> dataset commit active
Done

启动 IPv6 接口:

> ifconfig up
Done

启动线程协议操作:

> thread start
Done

设备会将自身初始化为子级。Thread Child 相当于最终用户,它是仅通过父设备传输和接收单播流量的 Thread 设备。

> state
child
Done

在 2 分钟内,您应该会看到状态从 child 切换到 router。Thread 路由器能够在 Thread 设备之间路由流量。也称为“父级”。

> state
router
Done

验证网络

验证网状网络的一种简单方法是查看路由器表。

1. 检查连接情况

在节点 2 上,获取 RLOC16。RLOC16 是设备的 RLOC IPv6 地址的最后 16 位。

> rloc16
5800
Done

在节点 1 上,检查节点 2 的 RLOC16 的路由器表。请确保节点 2 已先切换到路由器状态。

> router table
| ID | RLOC16 | Next Hop | Path Cost | LQ In  | LQ Out  | Age | Extended MAC   |
+----+--------+----------+-----------+--------+-------+---+--------------------+
| 20 | 0x5000 |       63 |         0 |      0 |     0 |   0 | 96da92ea13534f3b |
| 22 | 0x5800 |       63 |         0 |      3 |     3 |  23 | 5a4eb647eb6bc66c |

可在表格中找到节点 2 的 0x5800 RLOC,确认它已连接到网格。

2. 从节点 2 ping 节点 1

验证两个模拟线程设备之间的连接。在节点 2 中,ping 分配给节点 1 的 EID:

> ping fd61:2344:9a52:ede0:d041:c5ba:a7bc:5ce6
> 16 bytes from fd61:2344:9a52:ede0:d041:c5ba:a7bc:5ce6: icmp_seq=1 hlim=64 time=12ms

enter 返回 > CLI 提示符。

测试网络

现在,您可以在两个模拟 Thread 设备之间成功执行 ping 操作,接下来,通过使一个节点离线来测试网状网络。

返回到节点 1 并停止线程:

> thread stop
Done

切换到节点 2 并检查状态。在两分钟内,节点 2 检测到领先变体(节点 1)处于离线状态,您应该会看到节点 2 过渡为网络的 leader

> state
router
Done
...
> state
leader
Done

确认后,停止节点并恢复出厂设置节点 2,然后再返回 Docker bash 提示符。恢复出厂设置会确保此练习中使用的 Thread 网络凭据不会转到下一个练习中。

> thread stop
Done
> factoryreset
>
> exit
root@c0f3912a74ff:/#

factoryreset 命令之后,您可能需要多次按 enter 才能使 > 提示符恢复显示。请勿退出 Docker 容器。

同时恢复出厂设置并退出节点 1:

> factoryreset
>
> exit
root@c0f3912a74ff:/#

请参阅 OpenThread CLI 参考文档,探索所有可用的 CLI 命令。

4. 使用调试功能对节点进行身份验证

在前面的练习中,您将设置一个具有两个模拟设备和已验证连接的 Thread 网络。不过,这只允许未经身份验证的 IPv6 链路本地流量在设备之间传输。如需在它们之间(并通过线程边界路由器在互联网之间)路由全球 IPv6 流量,节点必须通过身份验证。

要进行身份验证,必须将一个设备用作调试器。调试器是当前选定的新 Thread 设备的身份验证服务器,也是提供设备加入网络所需的网络凭据的授权者。

在本练习中,我们将使用与之前相同的双节点拓扑。对于身份验证,Thread Leader 将充当调试器,Thread Router 则是 Joiner。

d6a67e8a0d0b5dcb.png

Docker

对于剩余练习中的每个节点(终端窗口),请确保您运行的是 Docker 容器和 OpenThread 构建。如果继续之前的练习,您应该已经在同一个 Docker 容器中打开两个 bash 提示符。否则,请参阅 Docker 问题排查步骤,或者直接重新执行模拟线程网络练习。

1. 创建网络

在节点 1 中,生成 CLI 进程:

root@c0f3912a74ff:/# /openthread/build/examples/apps/cli/ot-cli-ftd 1

注意:运行此命令后,如果您没有看到 > 提示,请按 enter

创建一个新的操作数据集,将其作为活跃数据集提交,然后启动线程:

> dataset init new
Done
> dataset
Active Timestamp: 1
Channel: 12
Channel Mask: 07fff800
Ext PAN ID: e68d05794bf13052
Mesh Local Prefix: fd7d:ddf7:877b:8756/64
Network Key: a77fe1d03b0e8028a4e13213de38080e
Network Name: OpenThread-8f37
PAN ID: 0x8f37
PSKc: f9debbc1532487984b17f92cd55b21fc
Security Policy: 0, onrcb
Done

将此数据集提交为活跃数据集:

> dataset commit active
Done

启动 IPv6 接口:

> ifconfig up
Done

启动线程协议操作:

> thread start
Done

等待几秒钟,并验证设备是否已成为线程领导者:

> state
leader
Done

2. 启动“调试器”角色

继续在 Node 1 中,启动 Commissioner 角色:

> commissioner start
Done

允许任何具有 J01NME 加入者凭据的加入者(使用 * 通配符)调试网络。联接器是由真人管理员添加到委托 Thread 网络的设备。

> commissioner joiner add * J01NME
Done

3. 启动 Joiner 角色

在第二个终端窗口的 Docker 容器中,生成一个新的 CLI 进程。这是节点 2。

root@c0f3912a74ff:/# /openthread/build/examples/apps/cli/ot-cli-ftd 2

在节点 2 上,使用 J01NME Joiner 凭据启用 Joiner 角色。

> ifconfig up
Done
> joiner start J01NME
Done

... 等待几秒钟进行确认 ...

Join success

设备(节点 2)成功通过专员(节点 1)进行身份验证,并收到 Thread Network 凭据。

现在,节点 2 已通过身份验证,可以启动 Thread:

> thread start
Done

4. 验证网络身份验证

在节点 2 上检查 state,以验证它现在是否已加入网络。在两天内,节点 2 会从 child 转换到 router

> state
child
Done
...
> state
router
Done

5. 重置配置

为了重置下个练习,请重置配置。在每个节点上,停止线程,恢复出厂设置,然后退出模拟的线程设备:

> thread stop
Done
> factoryreset
>
> exit
root@c0f3912a74ff:/#

factoryreset 命令之后,您可能需要多次按 enter 才能使 > 提示符恢复显示。

5. 使用 OpenThread 守护程序管理网络

在本练习中,我们将模拟一个 CLI 实例(一个嵌入式 SoC 线程设备)和一个无线协处理器 (RCP) 实例。

ot-daemon 是 OpenThread Posix 应用的模式,它使用 UNIX 套接字作为输入和输出,以便 OpenThread 核心可以作为服务运行。客户端可通过使用 OpenThread CLI 作为协议连接到套接字来与此服务通信。

ot-ctl 是由 ot-daemon 提供的 CLI,用于管理和配置 RCP。通过这种方式,我们将 RCP 连接到 Thread 设备创建的网络。

Docker

在本练习中,对于每个节点(终端窗口),请确保您运行 Docker 容器并使用 OpenThread 构建。如果从上一个练习继续,您应该在同一个 Docker 容器中已经打开了两个 bash 提示。否则,请参阅 Docker 问题排查步骤。

使用 OT 守护程序

本练习将使用三个终端窗口,它们对应于:

  1. 模拟 Thread 设备的 CLI 实例(节点 1)
  2. ot-daemon流程
  3. ot-ctl 个 CLI 实例

1. 启动节点 1

在第一个终端窗口中,为模拟 Thread 设备生成 CLI 进程:

root@c0f3912a74ff:/# /openthread/build/examples/apps/cli/ot-cli-ftd 1

注意:运行此命令后,如果您没有看到 > 提示,请按 enter

创建一个新的操作数据集,将其作为活跃数据集提交,然后启动线程:

> dataset init new
Done
> dataset
Active Timestamp: 1
Channel: 13
Channel Mask: 07fff800
Ext PAN ID: 97d584bcd493b824
Mesh Local Prefix: fd55:cf34:dea5:7994/64
Network Key: ba6e886c7af50598df1115fa07658a83
Network Name: OpenThread-34e4
PAN ID: 0x34e4
PSKc: 38d6fd32c866927a4dfcc06d79ae1192
Security Policy: 0, onrcb
Done

将此数据集提交为活跃数据集:

> dataset commit active
Done

启动 IPv6 接口:

> ifconfig up
Done

启动线程协议操作:

> thread start
Done

查看分配给节点 1 的线程接口的 IPv6 地址:

> ipaddr
fd55:cf34:dea5:7994:0:ff:fe00:fc00
fd55:cf34:dea5:7994:0:ff:fe00:d000
fd55:cf34:dea5:7994:460:872c:e807:c4ab
fe80:0:0:0:9cd8:aab6:482f:4cdc
Done
>

模拟线程网络步骤中所述,一个地址是链路本地地址 (fe80),三个地址是网格本地地址 (fd)。EID 是地址中不包含 ff:fe00 的网格本地地址。在此示例输出中,EID 为 fd55:cf34:dea5:7994:460:872c:e807:c4ab

ipaddr 输出中确定特定的 EID,此 ID 将用于与节点进行通信。

2. 启动 OT 守护程序

在第二个终端窗口中,创建一个 tun 设备节点,并设置读写权限:

root@c0f3912a74ff:/# mkdir -p /dev/net && mknod /dev/net/tun c 10 200
root@c0f3912a74ff:/# chmod 600 /dev/net/tun

此设备用于在虚拟设备中传输数据包和接收数据包。如果设备已创建,您可能会收到错误消息。这是正常现象,可以忽略。

为 RCP 节点(我们将其称为“节点 2”)启动 ot-daemon。使用 -v 详细标志,以查看日志输出并确认其正在运行:

root@c0f3912a74ff:/# /openthread/build/posix/src/posix/ot-daemon -v \
'spinel+hdlc+forkpty:///openthread/build/examples/apps/ncp/ot-rcp?forkpty-arg=2'

成功后,详细模式下的 ot-daemon 会生成类似于以下内容的输出:

ot-daemon[31]: Running OPENTHREAD/297a880; POSIX; Feb  1 2022 04:43:39
ot-daemon[31]: Thread version: 3
ot-daemon[31]: Thread interface: wpan0
ot-daemon[31]: RCP version: OPENTHREAD/297a880; SIMULATION; Feb  1 2022 04:42:50

将此终端保持打开状态并在后台运行。您不必在其中输入任何其他命令。

3. 使用 ot-ctl 加入网络

我们尚未将 Node 2 (ot-daemon RCP) 委托给任何 Thread 网络。这正是 ot-ctl 的用武之地。ot-ctl 使用与 OpenThread CLI 应用相同的 CLI。因此,您可以使用与模拟其他 Thread 设备相同的方式控制 ot-daemon 节点。

打开第三个终端窗口并执行现有容器:

$ docker exec -it codelab_otsim_ctnr bash

进入容器后,启动 ot-ctl

root@c0f3912a74ff:/# /openthread/build/posix/src/posix/ot-ctl
>

在本第三个终端窗口中,您将使用 ot-ctl 来管理您在通过 ot-daemon 通过第二个终端窗口启动的节点 2(RCP 节点)。检查节点 2 的 state

> state
disabled
Done

获取节点 2 的 eui64 以限制联接到特定联接器:

> eui64
18b4300000000001
Done

在节点 1(第一个终端窗口)上启动调试器,并仅联接 eui64:

> commissioner start
Done
> commissioner joiner add 18b4300000000001 J01NME
Done

在第三个终端窗口中,打开节点 2 的网络接口并加入网络:

> ifconfig up
Done
> joiner start J01NME
Done

... 等待几秒钟进行确认 ...

Join success

作为一名联接人员,RCP(节点 2)已成功通过专员(节点 1)进行身份验证,并收到 Thread Network 凭据。

现在,将节点 2 连接到 Thread 网络(同样,在第三个终端窗口中):

> thread start
Done

4. 验证网络身份验证

在第三个终端中,检查节点 2 上的 state,验证它现在是否已加入网络。在两天内,节点 2 会从 child 转换到 router

> state
child
Done
...
> state
router
Done

5. 验证连接

在第三个终端窗口中,使用 Ctrl+Dexit 命令退出 ot-ctl,然后返回容器的 bash 控制台。在此控制台中,对节点 1 执行 ping 操作,通过 EID 使用 ping6 命令。如果 ot-daemon RCP 实例成功加入并连接 Thread 网络,ping 会成功:

root@c0f3912a74ff:/# ping6 -c 4 fd55:cf34:dea5:7994:460:872c:e807:c4ab
PING fd55:cf34:dea5:7994:460:872c:e807:c4ab (fd55:cf34:dea5:7994:460:872c:e807:c4ab): 56 data bytes
64 bytes from fd55:cf34:dea5:7994:460:872c:e807:c4ab: icmp_seq=0 ttl=64 time=4.568 ms
64 bytes from fd55:cf34:dea5:7994:460:872c:e807:c4ab: icmp_seq=1 ttl=64 time=6.396 ms
64 bytes from fd55:cf34:dea5:7994:460:872c:e807:c4ab: icmp_seq=2 ttl=64 time=7.594 ms
64 bytes from fd55:cf34:dea5:7994:460:872c:e807:c4ab: icmp_seq=3 ttl=64 time=5.461 ms
--- fd55:cf34:dea5:7994:460:872c:e807:c4ab ping statistics ---
4 packets transmitted, 4 packets received, 0% packet loss
round-trip min/avg/max/stddev = 4.568/6.005/7.594/1.122 ms

6. Docker 问题排查

如果您已退出 Docker 容器

bash 提示,您可能需要检查它是否正在运行,并根据需要重启 / 重新进入。如果您之前创建的所有 Docker 容器都未使用 --rm 选项,则该容器依然存在。

如需显示哪些 Docker 容器正在运行,请执行以下操作:

$ docker ps
CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES
505fc57ffc72        environment       "bash"              10 minutes ago      Up 10 minutes                           codelab_otsim_ctnr

如需显示所有 Docker 容器(包括正在运行和已停止),请执行以下操作:

$ docker ps -a
CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES
505fc57ffc72        environment       "bash"              10 minutes ago      Up 10 minutes                           codelab_otsim_ctnr

如果您在任一 docker ps 命令的输出中都没有看到容器 codelab_otsim_ctnr,请再次运行该命令:

$ docker run --name codelab_otsim_ctnr -it --rm \
   --sysctl net.ipv6.conf.all.disable_ipv6=0 \
   --cap-add=net_admin openthread/environment bash

仅当您希望在退出容器时删除容器时,才使用 --rm 选项。

如果容器已停止(在 docker ps -a 中列出,但未在 docker ps 中),请重启:

$ docker start -i codelab_otsim_ctnr

如果 Docker 容器已在运行(在 docker ps 中列出),请在每个终端中重新连接到容器:

$ docker exec -it codelab_otsim_ctnr bash

“不允许执行该操作”错误

如果您在创建新的 OpenThread 节点(使用 mknod 命令)时遇到 Operation not permitted 错误,请确保根据此 Codelab 中提供的命令以 root 用户身份运行 Docker。此 Codelab 不支持在无根模式下运行 Docker。

7. 恭喜!

您已成功使用 OpenThread 模拟了第一个 Thread 网络。也很棒!

在此 Codelab 中,你学习了如何:

  • 启动和管理 OpenThread 模拟模拟 Docker 容器
  • 模拟线程网络
  • 对 Thread 节点进行身份验证
  • 使用 OpenThread 守护程序管理 Thread 网络

如需详细了解 Thread 和 OpenThread,请查看以下参考资料:

或者,不妨尝试在 Docker 容器中使用 OpenThread 边界边界