OpenThread CLI 概览

<ph type="x-smartling-placeholder"></ph> 在 GitHub 上查看源代码

OpenThread CLI 通过 命令行界面。使用 OT CLI 创建 OpenThread 开发 或将其用作包含其他应用代码的工具。例如: OpenThread 测试脚本 使用 CLI 执行测试用例。

开始使用

使用 Docker 完成我们的模拟 Codelab,并查看 CLI 命令参考。

前往模拟 Codelab 前往 CLI 命令参考文档

使用 OT CLI

您可以将 OT CLI 与 OpenThread 边界路由器 (OTBR) 和 Thread 设备搭配使用。CLI 命令会有所不同,具体取决于您的设备类型和 build 标志。

OTBR

如需将 OT CLI 与 OTBR 搭配使用,请输入以下内容 前缀:

sudo ot-ctl

Thread 设备

如需在 Thread 设备上使用 CLI 命令,请参阅平台文档。 或指南在很多示例中,您无需输入字符即可开始输入命令 前缀:

state
router
Done

以下资源可帮助您顺利上手:

特殊字符

空格字符 (' ') 用于分隔命令名称和 不同的参数,同时使用制表符 ('\t') 和换行符 ('\r''\n')。

部分参数可能包含空格,例如 Thread 网络名称。接收者 在发送包含空格的参数时,使用反斜杠字符 ('\') 将 转义分隔符或反斜杠本身:

networkname Test\ Network
Done
networkname
Test Network
Done

参数映射

OT CLI 使用与 API 配置值对应的预定义参数。这些 映射可通过 CLI 命令传递,也可能返回 CLI 管理各种网络数据命令,例如 netdata show

otBorderRouterConfig

有些命令(例如 prefix add)需要使用 otBorderRouterConfig 值。如需通过命令行设置 otBorderRouterConfig 成员,请使用 OT CLI 为每个成员解析映射的字母参数。例如,参数 paros 组合将 mPreferredmSlaacmDefaultRoute, mOnMesh、 和 mStable 成员。

语法

在以下示例中,prefix 是必需的, otBorderRouterConfig 参数是可选的,映射为 padcrosnD:

prefix add prefix [padcrosnD]

用法

如需使用参数映射,请勿在字母之间输入空格:

prefix add 2001:dead:beef:cafe::/64 paros

otRoutePreference

要设置 otRoutePreference,请执行以下操作: 在 OT CLI 命令中使用 highmedlow

语法

prefix add prefix [padcrosnD] [high|med|low]

用法

以下是使用映射的 otBorderRouterConfigotRoutePreference 的示例 参数:

prefix add 2001:dead:beef:cafe::/64 paros med
Done

otExternalRouteConfig

对于 otExternalRouteConfig 值,s 映射到 mStablen 映射到 mNat64

语法

publish route prefix [sn]

用法

route add 2001:dead:beef:cafe::/64 s
Done

返回值

大多数命令会返回请求的值,后跟 Done

br onlinkprefix
fd41:2650:a6f5:0::/64
Done

其他包含网络数据的命令可能会返回参数映射 前缀、路由和服务记录。如需了解详情,请参阅 使用 OT CLI 显示和管理网络数据