CLI 命令参考文档

ba 临时密钥

指示临时密钥当前是否处于活跃状态。

需要 OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE。

参数

无参数。

示例

ba ephemeralkey
active
Done

CLI 和 API 参考文档

• otBorderAgentIsEphemeralKeyActive

ba 临时密钥回调（启用、停用）

设置 Border Agent 使用的回调函数，以通知与使用临时密钥相关的任何变化。

需要 OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE。

对此函数的后续调用将替换之前设置的所有回调。

参数

无参数。

示例

ba ephemeralkey callback enable
Done
ba ephemeralkey set W10X1 5000 49155
Done
BorderAgent callback: Ephemeral key active, port:49155
BorderAgent callback: Ephemeral key inactive

CLI 和 API 参考文档

• otBorderAgentSetEphemeralKeyCallback

ba 临时密钥清除

取消正在使用的临时密钥。

需要 OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE。

可用于在临时密钥超时之前取消之前设置的临时密钥。如果边界代理未运行或没有正在使用的临时密钥，则调用此函数不会产生任何效果。

如果使用临时密钥连接调试器，并且当前处于活跃状态，调用此函数不会更改其状态。在这种情况下， otBorderAgentIsEphemeralKeyActive() 将继续返回 TRUE，直到调试器断开连接。

参数

无参数。

示例

ba ephemeralkey clear
Done

CLI 和 API 参考文档

• otBorderAgentClearEphemeralKey

ba 临时密钥设置 [timeout-in-msec] [端口]

为指定的超时时长设置临时密钥。

需要 OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE。

如果 Border Agent 已在运行且当前未连接到任何外部调试器（即处于 OT_BORDER_AGENT_STATE_STARTED 状态），则可以设置临时密钥。否则，系统会返回 OT_ERROR_INVALID_STATE。

给定的 aKeyString 直接用作临时 PSK（不包括尾随的 null \0 字符）。aKeyString 的长度必须介于 OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH 和 OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH 之间（包括这两个数值）。

在之前设置的密钥超时之前再次设置临时密钥将替换之前设置的密钥并重置超时时间。

在超时间隔有效期间，临时密钥只能由外部调试机构使用一次。一旦调试器断开连接，临时密钥将被清除，边界代理将还原为使用 PSKc。

参数

无参数。

示例

ba ephemeralkey set Z10X20g3J15w1000P60m16 5000 1234
Done

CLI 和 API 参考文档

• otBorderAgentSetEphemeralKey

Ba id (get,set)

获取或设置 16 个字节的边界路由器 ID，该 ID 可在多个 BR 中唯一标识设备。

参数

ba id [border-agent-id]

使用可选的 border-agent-id 参数设置边界代理 ID。

示例

ba id
cb6da1e0c0448aaec39fa90f3d58f45c
Done

ba id 00112233445566778899aabbccddeeff
Done

CLI 和 API 参考文档

• otBorderAgentGetId
• otBorderAgentSetId

Ba 端口

获取 Thread Border Agent 服务的 UDP 端口。

参数

无参数。

示例

ba port
49153
Done

CLI 和 API 参考文档

• otBorderAgentGetUdpPort

巴州

获取 Thread Border Agent 角色的 otBorderAgentState。

参数

无参数。

示例

ba state
Started
Done

CLI 和 API 参考文档

• otBorderAgentGetState

BBR

返回 Thread 设备的当前主骨干路由器信息。

参数

无参数。

示例

bbr
BBR Primary:
server16: 0xE400
seqno:    10
delay:    120 secs
timeout:  300 secs
Done

bbr
BBR Primary: None
Done

CLI 和 API 参考文档

• 没有关联的 API

bbr 配置（已设置）

设置本地 Backbone Router 配置 otBackboneRouterConfig。

如果主骨干路由器的 BBR 数据集发生更改，系统会自动启动服务器数据请求消息 SRV_DATA.ntf。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

应明确发出 bbr register，以将骨干路由器服务注册给辅助骨干路由器的主要器。

参数

bbr config [seqno seqno] [delay delay] [timeout timeout]

示例

bbr config seqno 20 delay 30
Done

CLI 和 API 参考文档

• otBackboneRouterSetConfig

bbr 配置

获取本地 Backbone Router 配置。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

参数

无参数。

示例

bbr config
seqno:    10
delay:    120 secs
timeout:  300 secs
Done

CLI 和 API 参考文档

• otBackboneRouterGetConfig

bbr 停用

启用或停用 Backbone 功能。

启用后，如果 Thread 网络数据中没有 Backbone Router Service，则会为所连接的设备触发服务器数据请求消息 SRV_DATA.ntf。

如果停用，当骨干路由器处于主服务器状态时，会触发 SRV_DATA.ntf。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

参数

无参数。

示例

bbr disable
Done

CLI 和 API 参考文档

• otBackboneRouterSetEnabled

bbr 启用

启用或停用 Backbone 功能。

启用后，如果 Thread 网络数据中没有 Backbone Router Service，则会为所连接的设备触发服务器数据请求消息 SRV_DATA.ntf。

如果停用，当骨干路由器处于主服务器状态时，会触发 SRV_DATA.ntf。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

参数

无参数。

示例

bbr enable
Done

CLI 和 API 参考文档

• otBackboneRouterSetEnabled

bbr 抖动 (get,set)

获取或设置 Backbone Router 注册的抖动（以秒为单位）。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

参数

bbr jitter [jitter]

示例

bbr jitter
20
Done

bbr jitter 10
Done

CLI 和 API 参考文档

• otBackboneRouterGetRegistrationJitter
• otBackboneRouterSetRegistrationJitter

BB 管理

添加 meshLocalIid 后，此命令可配置下次 DUA 注册的响应状态。在不使用 meshLocalIid 的情况下，使用指定的 status 或 coap-code 响应下一个 DUA.req。

启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 后可用。

参数

bbr mgmt dua status|coap-code [meshLocalIid]

对于 status 或 coap-code，请使用：

• 0：ST_DUA_SUCCESS
• 1：ST_DUA_REREGISTER
• 2：ST_DUA_INVALID
• 3：ST_DUA_DUPLICATE
• 4：ST_DUA_NO_RESOURCES
• 5：ST_DUA_BBR_NOT_PRIMARY
• 6：ST_DUA_GENERAL_FAILURE
• 160：COAP 代码 5.00

示例

bbr mgmt dua 1 2f7c235e5025a2fd
Done

bbr mgmt dua 160
Done

CLI 和 API 参考文档

• otBackboneRouterConfigNextDuaRegistrationResponse

BBR mgmt MLr 监听器添加

添加具有超时值的多播监听器（以秒为单位）。

传递 0 即可使用默认 MLR 超时。

在启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE、OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE 和 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 后可用。

参数

bbr mgmt mlr listener add ipaddress [timeout-seconds]

示例

bbr mgmt mlr listener add ff04::1
Done

bbr mgmt mlr listener add ff04::2 300
Done

CLI 和 API 参考文档

• otBackboneRouterMulticastListenerAdd

BBR mgmt MLr 监听器

返回具有 otBackboneRouterMulticastListenerInfomTimeout（以秒为单位）的多播监听器。

在启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 和 OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE 后可用。

参数

无参数。

示例

bbr mgmt mlr listener
ff04:0:0:0:0:0:0:abcd 3534000
ff04:0:0:0:0:0:0:eeee 3537610
Done

CLI 和 API 参考文档

• otBackboneRouterMulticastListenerGetNext

BBR mgmt MLr 监听器清除

清除多播监听器。

在启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE、OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE 和 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 后可用。

参数

无参数。

示例

bbr mgmt mlr listener clear
Done

CLI 和 API 参考文档

• otBackboneRouterMulticastListenerClear

BBR mgmt MLR 响应

配置下一次多播监听器注册的响应状态。

在启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE、OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE 和 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 后可用。

参数

bbr mgmt mlr response status-code

对于 status-code，请使用：

• 0：ST_MLR_SUCCESS
• 2：ST_MLR_INVALID
• 3：ST_MLR_NO_PERSISTENT
• 4：ST_MLR_NO_RESOURCES
• 5：ST_MLR_BBR_NOT_PRIMARY
• 6：ST_MLR_GENERAL_FAILURE

示例

bbr mgmt mlr response 2
Done

CLI 和 API 参考文档

• otBackboneRouterConfigNextMulticastListenerRegistrationResponse

bbr 注册

显式注册本地 Backbone Router 配置。

针对连接的设备触发了服务器数据请求消息 SRV_DATA.ntf。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

参数

无参数。

示例

bbr register
Done

CLI 和 API 参考文档

• otBackboneRouterRegister

BBR 状态

获取 Backbone Router otBackboneRouterState。

启用 OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 后可用。

参数

无参数。

示例

bbr state
Disabled
Done

bbr state
Primary
Done

bbr state
Secondary
Done

CLI 和 API 参考文档

• otBackboneRouterGetState

br 停用

停用边界路由管理器。

参数

无参数。

示例

br disable
Done

CLI 和 API 参考文档

• otBorderRoutingSetEnabled

巴西启用

启用边界路由管理器。

参数

无参数。

示例

br enable
Done

CLI 和 API 参考文档

• otBorderRoutingSetEnabled

br init

初始化边界路由管理器。

参数

br init infrastructure-network-index is-running

示例

br init 2 1
Done

CLI 和 API 参考文档

• otBorderRoutingInit

br nat64 前缀

输出本地和首选 NAT64 前缀。

参数

无参数。

示例

br nat64prefix
Local: fd14:1078:b3d5:b0b0:0:0::/96
Favored: fd14:1078:b3d5:b0b0:0:0::/96 prf:low
Done

CLI 和 API 参考文档

• otBorderRoutingGetNat64Prefix
• otBorderRoutingGetFavoredNat64Prefix

br nat64prefix 青睐

获取当前首选的 NAT64 前缀。

首选的 NAT64 前缀可以从基础架构链路中找到，也可以是此设备的本地 NAT64 前缀。

参数

无参数。

示例

br nat64prefix favored
fd14:1078:b3d5:b0b0:0:0::/96 prf:low
Done

CLI 和 API 参考文档

• otBorderRoutingGetFavoredNat64Prefix

br nat64prefix 本地

获取边界路由器的本地 NAT64 前缀。

Thread 网络中可能不会通告 NAT64 前缀。

“OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE”必须启用。

参数

无参数。

示例

br nat64prefix local
fd14:1078:b3d5:b0b0:0:0::/96
Done

CLI 和 API 参考文档

• otBorderRoutingGetNat64Prefix

br omrprefix

输出本地和喜爱的 OMR 前缀。

参数

无参数。

示例

br omrprefix
Local: fdfc:1ff5:1512:5622::/64
Favored: fdfc:1ff5:1512:5622::/64 prf:low
Done

CLI 和 API 参考文档

• otBorderRoutingGetOmrPrefix
• otBorderRoutingGetFavoredOmrPrefix

br omrprefix（已收藏）

获取当前常用的 Off-Mesh-Routable (OMR) 前缀。

您可以从“网络数据”中发现首选的 OMR 前缀，也可以使用此设备的本地 OMR 前缀。

参数

无参数。

示例

br omrprefix favored
fdfc:1ff5:1512:5622::/64 prf:low
Done

CLI 和 API 参考文档

• otBorderRoutingGetFavoredOmrPrefix

br omrprefix 本地

获取本地 Off-Mesh-Routable (OMR) 前缀，例如 fdfc:1ff5:1512:5622::/64。

OMR 前缀是随机生成的 64 位前缀，如果还没有 OMR 前缀，则会在 Thread 网络中发布。可通过本地 Wi-Fi 或以太网网络访问此前缀。

注意 ：启用 DHCPv6 永久性磁盘后，边界路由器可能会从 DHCPv6 永久性磁盘发布前缀。

参数

无参数。

示例

br omrprefix local
fdfc:1ff5:1512:5622::/64
Done

CLI 和 API 参考文档

• otBorderRoutingGetOmrPrefix

br onlinkprefix

输出本地和偏好的链路前缀。

参数

无参数。

示例

br onlinkprefix
Local: fd41:2650:a6f5:0::/64
Favored: 2600::0:1234:da12::/64
Done

CLI 和 API 参考文档

• otBorderRoutingGetOnLinkPrefix
• otBorderRoutingGetFavoredOnLinkPrefix

br onlinkprefix 青睐

获取当前青睐的 On-Link 前缀。

首选前缀要么是在基础架构链路上发现的链路上前缀，要么是本地链路上前缀。

参数

无参数。

示例

br onlinkprefix favored
2600::0:1234:da12::/64
Done

CLI 和 API 参考文档

• otBorderRoutingGetFavoredOnLinkPrefix

br onlinkprefix 本地

获取相邻基础架构链路的本地链路前缀。

本地链路前缀是 64 位的前缀，如果链路上通告的链接上还没有可用的链路前缀，则会在基础架构链路上通告此前缀。

参数

无参数。

示例

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

CLI 和 API 参考文档

• otBorderRoutingGetOnLinkPrefix

br 前缀表

边界路由管理器在基础架构链接上获取发现的前缀。每个前缀条目的信息：

• 前缀
• 前缀是 on-link 还是路由
• 自上次收到包含此前缀的路由器通告以来经过的毫秒数
• 前缀生命周期（秒）
• 仅当前缀在链接上时，首选生命周期（以秒为单位）
• 路由偏好设置（低、中、高）仅当前缀为“路线”（而非链接时）时
• 通告此前缀的路由器 IPv6 地址
• 已接收的路由器通告标头中的标志：
  • M：托管地址配置标志
  • O：其他配置标志
  • 桩：桩路由器标志（表示路由器是否为桩路由器）

参数

无参数。

示例

br prefixtable
prefix:fd00:1234:5678:0::/64, on-link:no, ms-since-rx:29526, lifetime:1800, route-prf:med,
router:ff02:0:0:0:0:0:0:1 (M:0 O:0 Stub:1)
prefix:1200:abba:baba:0::/64, on-link:yes, ms-since-rx:29527, lifetime:1800, preferred:1800,
router:ff02:0:0:0:0:0:0:1 (M:0 O:0 Stub:1)
Done

CLI 和 API 参考文档

• otBorderRoutingGetNextPrefixTableEntry

巴西 raoptions (set,clear)

设置要在发出的路由器通告 (RA) 消息末尾附加的其他选项。

aOptions 的内容会在内部复制，因此可以是临时缓冲区（例如堆栈分配的数组）。

对此函数的后续调用会覆盖先前设置的值。

参数

br raoptions options|clear

br raoptions clear 将 nullptr 传递给 otBorderRoutingSetExtraRouterAdvertOptions。否则，您可以将 options 字节作为十六进制数据传递。

示例

br raoptions 0400ff00020001
Done

br raoptions clear
Done

CLI 和 API 参考文档

• otBorderRoutingSetExtraRouterAdvertOptions

br rioprf（高、中、低）

明确设置在通过基础架构链路发送的路由器通告消息中通告路由信息选项 (RIO) 时使用的偏好设置。

调用此函数后，BR 将为其通告的所有 RIO 使用给定的偏好设置。可通过调用 otBorderRoutingClearRouteInfoOptionPreference() 清除偏好设置。

参数

br rioprf [high|med|low]

示例

br rioprf low
Done

CLI 和 API 参考文档

• otBorderRoutingSetRouteInfoOptionPreference

巴西里奥普夫

获取在通过基础架构链路发送的路由器通告消息中通告路由信息选项 (RIO) 时使用的当前偏好设置。

RIO 首选项按如下方式确定：

• 如果用户通过调用 otBorderRoutingSetRouteInfoOptionPreference() 进行明确设置，系统将使用指定的偏好设置。
• 否则，则根据设备的当前角色来确定：处于路由器/主要角色时偏好设置为中等优先级，在子级角色中为低优先级。

参数

无参数。

示例

br rioprf
med
Done

CLI 和 API 参考文档

• otBorderRoutingGetRouteInfoOptionPreference

巴西境内晴朗

清除之前为通告路线信息选项设置的偏好设置值。

调用此函数后，BR 将使用设备的角色来确定 RIO 偏好设置：处于路由器/主要角色时偏好设置为中优先级，当处于子角色时优先级为低优先级。

参数

无参数。

示例

br rioprf clear
Done

CLI 和 API 参考文档

• otBorderRoutingClearRouteInfoOptionPreference

brrouteprf（高、中、低）

明确设置网络数据中已发布路由的偏好设置。

调用此函数后，BR 将使用给定的偏好设置。可通过调用 otBorderRoutingClearRoutePreference() 清除偏好设置。

参数

br routeprf [high|med|low]

示例

br routeprf low
Done

CLI 和 API 参考文档

• otBorderRoutingSetRoutePreference

brRouteprf

获取“网络数据”中已发布路由的当前偏好设置。

优先顺序确定如下：

• 如果用户通过调用 otBorderRoutingSetRoutePreference() 进行明确设置，系统将使用指定的偏好设置。
• 否则，是由 RoutingManager 根据设备的角色和链接质量自动确定的。

参数

无参数。

示例

br routeprf
med
Done

CLI 和 API 参考文档

• otBorderRoutingGetRoutePreference

brrouteprf 清除

清除之前在“网络数据”中为已发布路由设置的偏好设置值。

调用此函数后，BR 将根据设备的角色和链路质量（在充当最终设备时，确定与父项的关联）自动确定偏好设置。

参数

无参数。

示例

br routeprf clear
Done

CLI 和 API 参考文档

• otBorderRoutingClearRoutePreference

BR 路由器

通过边界路由管理器在基础架构链接上获取发现的路由器列表。每个路由器的信息：

• 路由器 IPv6 地址
• 已接收的路由器通告标头中的标志：
  • M：托管地址配置标志
  • O：其他配置标志
  • 桩：桩路由器标志（表示路由器是否为桩路由器）

参数

无参数。

示例

br routers
ff02:0:0:0:0:0:0:1 (M:0 O:0 Stub:1)
Done

CLI 和 API 参考文档

• otBorderRoutingGetNextRouterEntry

巴西州

获取边界路由管理器的当前状态。

参数

无参数。

示例

br state
running

CLI 和 API 参考文档

• otBorderRoutingGetState

缓冲区信息

获取当前消息缓冲区信息。

• total 用于显示对象池中的消息缓冲区总数。
• free 显示可用消息缓冲区的数量。
• max-used 显示自 OT 堆栈初始化或上次 bufferinfo reset 以来同时使用的缓冲区数上限。

接下来，CLI 会显示 OpenThread 堆栈使用的不同队列的相关信息，例如 6lo send。队列后面的每一行都表示有关队列的信息：

• 第一个数字表示队列中的消息数。
• 第二个数字表示队列中所有消息使用的缓冲区数。
• 第三个数字表示队列中所有消息的总字节数。

参数

无参数。

示例

bufferinfo
total: 40
free: 40
max-used: 5
6lo send: 0 0 0
6lo reas: 0 0 0
ip6: 0 0 0
mpl: 0 0 0
mle: 0 0 0
coap: 0 0 0
coap secure: 0 0 0
application coap: 0 0 0
Done

CLI 和 API 参考文档

• otMessageGetBufferInfo

重置缓冲区信息

重置消息缓冲区信息计数器，以跟踪同时使用的最大缓冲区数。

这会重置 otBufferInfo 中的 mMaxUsedBuffers。

参数

无参数。

示例

bufferinfo reset
Done

CLI 和 API 参考文档

• otMessageResetBufferInfo

ccathreshold（get、set）

根据 IEEE 802.15.4 - 2015 第 10.1.4 节所述，获取或设置在天线连接器测量的 CCA 阈值（以 dBm 为单位）。

参数

ccathreshold [CCA-threshold-dBm]

使用可选的 CCA-threshold-dBm 参数设置 CCA 阈值。

示例

ccathreshold
-75 dBm
Done

ccathreshold -62
Done

CLI 和 API 参考文档

• otPlatRadioGetCcaEnergyDetectThreshold
• otPlatRadioSetCcaEnergyDetectThreshold

渠道 (get,set)

获取或设置 IEEE 802.15.4 Channel 值。

参数

channel [channel-num]

使用 channel-num 设置渠道。

示例

channel
11
Done

channel 11
Done

CLI 和 API 参考文档

• 没有关联的 API

渠道管理器（自动）

启用或停用网络频道自动频道选择功能。

启用后，ChannelManager 会定期调用 RequestChannelSelect(false)。周期间隔可通过 otChannelManagerSetAutoChannelSelectionInterval() 设置。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE 以及 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 为必填项。

参数

channel manager auto enable

1 是 enable 的布尔值。

示例

channel manager auto 1
channel manager auto 1
Done

CLI 和 API 参考文档

• otChannelManagerSetAutoChannelSelectionEnabled

频道管理员变更

请求 Thread 网络信道更改。

网络在指定的延迟后切换到指定频道（请参阅 otChannelManagerSetDelay()）。通过更新待处理操作数据集执行频道变更。

如果是在后续的通话中，则将取消之前请求过的频道更改。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE为必填项。

参数

channel manager change channel-num

示例

channel manager change 11
channel manager change 11
Done

CLI 和 API 参考文档

• otChannelManagerRequestChannelChange

频道管理员

获取渠道管理员状态。必须提供 OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE。

参数

无参数。

示例

channel manager
channel: 11
auto: 1
delay: 120
interval: 10800
supported: { 11-26}
favored: { 11-26}
Done

CLI 和 API 参考文档

• otChannelManagerGetRequestedChannel

渠道管理员延迟

设置网络信道更改的延迟（以秒为单位）。

仅适用于 FTD。延迟时间最好超过 Thread 网络中所有休眠终端设备使用的最大数据轮询间隔。

必须提供 OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 和 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE。

参数

channel manager delay delay-seconds

示例

channel manager delay 120
channel manager delay 120
Done

CLI 和 API 参考文档

• otChannelManagerSetDelay

已收藏渠道管理员

设置好用的通道掩码。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE 以及 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 为必填项。

参数

channel manager favored mask

示例

channel manager favored 0x7fffc00
channel manager favored 0x7fffc00
Done

CLI 和 API 参考文档

• otChannelManagerSetFavoredChannels

渠道管理器间隔时间

设置自动频道选择功能使用的时间段间隔（以秒为单位）。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE 以及 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 为必填项。

参数

channel manager interval interval-seconds

示例

channel manager interval 10800
channel manager interval 10800
Done

CLI 和 API 参考文档

• otChannelManagerSetAutoChannelSelectionInterval

渠道管理员选择

请求 ChannelManager 检查并选择新频道并开始频道更改。

与必须以参数形式提供频道的 otChannelManagerRequestChannelChange() 不同，此函数会要求 ChannelManager 自行选择一个频道（根据收集到的频道质量信息）。

调用后，渠道管理员将执行以下 3 个步骤：

1) ChannelManager 决定变更渠道是否有用。如果 aSkipQualityCheck 设置为 true（强制进行频道选择并跳过质量检查），可以跳过此项检查。此步骤使用设备上收集的链路质量指标（例如 CCA 失败率、帧和每个相邻的消息错误率等）来确定当前信道质量是否处于信道变更合理水平。

2) 如果第一步通过，ChannelManager 会选择一个可能更好的频道。它会使用 ChannelMonitor 模块收集的频道质量数据。此步骤将用到支持的频道和喜爱的频道。（请参阅 otChannelManagerSetSupportedChannels() 和 otChannelManagerSetFavoredChannels() ）。

3) 如果新选择的频道与当前频道不同，ChannelManager 会请求/启动频道更改流程（在内部调用 RequestChannelChange()）。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE 以及 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 为必填项。

参数

channel manager select skip-quality-check

使用 1 或 0 作为布尔值 skip-quality-check。

示例

channel manager select 1
channel manager select 1
Done

CLI 和 API 参考文档

• otChannelManagerRequestChannelSelect

支持渠道管理员

设置支持的通道掩码。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE 以及 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 为必填项。

参数

channel manager supported mask

示例

channel manager supported 0x7fffc00
channel manager supported 0x7fffc00
Done

CLI 和 API 参考文档

• otChannelManagerSetSupportedChannels

渠道管理员阈值

设置 CCA 失败率阈值。

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE 或 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE 以及 OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE 为必填项。

参数

channel manager threshold threshold-percent

对于 threshold-percent，请使用十六进制值。0 映射到 0%，0xffff 映射到 100%。

示例

channel manager threshold 0xffff
channel manager threshold 0xffff
Done

CLI 和 API 参考文档

• otChannelManagerSetCcaFailureRateThreshold

频道监视器

获取当前信道监控状态和信道占用情况。OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE为必填项。

参数

无参数。

示例

channel monitor
enabled: 1
interval: 41000
threshold: -75
window: 960
count: 10552
occupancies:
ch 11 (0x0cb7)  4.96% busy
ch 12 (0x2e2b) 18.03% busy
ch 13 (0x2f54) 18.48% busy
ch 14 (0x0fef)  6.22% busy
ch 15 (0x1536)  8.28% busy
ch 16 (0x1746)  9.09% busy
ch 17 (0x0b8b)  4.50% busy
ch 18 (0x60a7) 37.75% busy
ch 19 (0x0810)  3.14% busy
ch 20 (0x0c2a)  4.75% busy
ch 21 (0x08dc)  3.46% busy
ch 22 (0x101d)  6.29% busy
ch 23 (0x0092)  0.22% busy
ch 24 (0x0028)  0.06% busy
ch 25 (0x0063)  0.15% busy
ch 26 (0x058c)  2.16% busy
Done

CLI 和 API 参考文档

• 没有关联的 API

频道监视器开始

启动频道监控器。OT CLI 会向 otChannelMonitorSetEnabled 发送布尔值 true。“OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE”为必填字段。

参数

无参数。

示例

channel monitor start
channel monitor start
Done

CLI 和 API 参考文档

• otChannelMonitorSetEnabled

频道监视器停止

停止频道监控器。OT CLI 会向 otChannelMonitorSetEnabled 发送布尔值 false。“OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE”为必填字段。

参数

无参数。

示例

channel monitor stop
channel monitor stop
Done

CLI 和 API 参考文档

• otChannelMonitorSetEnabled

首选频道

获取设备首选在其中形成的无线装置首选信道掩码。

参数

无参数。

示例

channel preferred
0x7fff800
Done

CLI 和 API 参考文档

• otPlatRadioGetPreferredChannelMask

支持渠道

获取允许设备开启的无线装置支持的信道掩码。

参数

无参数。

示例

channel supported
0x7fff800
Done

CLI 和 API 参考文档

• otPlatRadioGetSupportedChannelMask

子 (id)

根据关联的子节点 ID 或 RLOC16 获取其诊断信息。

参数

child child-id

示例

child 1
Child ID: 1
Rloc: 9c01
Ext Addr: e2b3540590b0fd87
Mode: rn
CSL Synchronized: 1
Net Data: 184
Timeout: 100
Age: 0
Link Quality In: 3
RSSI: -20
Done

CLI 和 API 参考文档

• otThreadGetChildInfoById

子列表

返回附加的子 ID 的列表。

参数

无参数。

示例

child list
1 2 3 6 7 8
Done

CLI 和 API 参考文档

• otThreadGetChildInfoByIndex

子表

输出附加子项的表格。

参数

无参数。

示例

child table
| ID  | RLOC16 | Timeout    | Age        | LQ In | C_VN |R|D|N|Ver|CSL|QMsgCnt| Extended MAC     |
+-----+--------+------------+------------+-------+------+-+-+-+---+---+-------+------------------+
|   1 | 0xc801 |        240 |         24 |     3 |  131 |1|0|0|  3| 0 |     0 | 4ecede68435358ac |
|   2 | 0xc802 |        240 |          2 |     3 |  131 |0|0|0|  3| 1 |     0 | a672a601d2ce37d8 |
Done

CLI 和 API 参考文档

• otThreadGetChildInfoByIndex

Childip

获取为 MTD 子级存储的 IP 地址列表。

参数

无参数。

示例

childip
3401: fdde:ad00:beef:0:3037:3e03:8c5f:bc0c
Done

CLI 和 API 参考文档

• otThreadGetChildNextIp6Address

childip max（设置）

设置或恢复每个 MTD 子级可在此设备上注册为父级的 IP 地址的数量上限。

传递 0 可清除设置并恢复默认设置。

启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 后可用。

注意 ：仅供 Thread 自动化测试框架使用，用于限制参考父项的地址注册，以便测试 MTD DUT 反应。

参数

childip max count

示例

childip max 2
Done

CLI 和 API 参考文档

• otThreadSetMaxChildIpAddresses

Childip Max

获取每个 MTD 子级可在此设备上注册为父级的 IP 地址的数量上限。

参数

无参数。

示例

childip max
4
Done

CLI 和 API 参考文档

• otThreadGetMaxChildIpAddresses

childmax（已设置）

设置当前允许的子项数量上限。

只有在停止 Thread 协议操作后才能设置此参数。

参数

childmax count

示例

childmax 2
Done

CLI 和 API 参考文档

• otThreadSetMaxAllowedChildren

Childmax

获取当前允许的子项数量上限。

参数

无参数。

示例

childmax
5
Done

CLI 和 API 参考文档

• otThreadGetMaxAllowedChildren

childrouterlinks（get、set）

获取或设置 MLE_CHILD_ROUTER_LINKS 值。

参数

childrouterlinks [links]

示例

childrouterlinks
16
Done

childrouterlinks 16
Done

CLI 和 API 参考文档

• otThreadGetChildRouterLinks
• otThreadSetChildRouterLinks

儿童监督检查超时（已设置）

为子级设置监督检查超时间隔（以秒为单位）。

参数

childsupervision checktimeout timeout-seconds

示例

childsupervision checktimeout 30
Done

CLI 和 API 参考文档

• otChildSupervisionSetCheckTimeout

儿童监督检查超时

获取子项的监督检查超时间隔（以秒为单位）。

如果设备处于休眠状态，并且未在指定的检查超时时间内收到父设备发来的消息，则会发起重新附加流程（与其父设备交换 MLE 子节点更新请求/响应）。

参数

无参数。

示例

childsupervision checktimeout
30
Done

CLI 和 API 参考文档

• otChildSupervisionGetCheckTimeout

儿童监督间隔（设置）

为子级设置子级监管间隔（以秒为单位）。

参数

childsupervision interval interval-seconds

示例

childsupervision interval 30
Done

CLI 和 API 参考文档

• otChildSupervisionSetInterval

儿童监督间隔

获取子项的子项监督间隔时间（以秒为单位）。

儿童监督功能为家长提供了一种机制，以确保他们可在监督间隔内将消息发送给每个睡着的孩子。如果在监督间隔内没有向子节点传输数据，则 OpenThread 会将子项监督消息加入队列并向子节点发送一条子监管消息。

参数

无参数。

示例

childsupervision interval
30
Done

CLI 和 API 参考文档

• otChildSupervisionGetInterval

childtimeout（已设置）

设置以子角色执行操作时使用的 Thread Child Timeout（以秒为单位）。

参数

childtimeout timeout-seconds

示例

childtimeout 300
Done

CLI 和 API 参考文档

• otThreadSetChildTimeout

儿童超时

获取以子角色执行操作时使用的线程子超时（以秒为单位）。

参数

无参数。

示例

childtimeout
300
Done

CLI 和 API 参考文档

• otThreadGetChildTimeout

协程取消

取消对 CoAP 服务器上远程资源的现有观察订阅。

注意 ：此命令仅在已设置 OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE 时可用。

参数

无参数。

示例

coap cancel
Done

CLI 和 API 参考文档

• coap observe

协程删除

删除指定的 CoAP 资源。

参数

coap delete address uri-path [type] [payload]

• address：CoAP 服务器的 IPv6 地址。
• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
• payload：CoAP 载荷字符串。例如 hellothere。

示例

coap delete fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done

CLI 和 API 参考文档

• 没有关联的 API

胶囊获得

获取 CoAP 服务器上指定 CoAP 资源的相关信息。

参数

coap get address uri-path [type]

• address：CoAP 服务器的 IPv6 地址。
• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
  • block-：如果应按块传输响应，请使用此选项，后跟分块值。有效值为：block-16、block-32、block-64、block-128、block-256、block-512 或 block-1024。

示例

coap get fdde:ad00:beef:0:2780:9423:166c:1aac test-resource
Done

coap get fdde:ad00:beef:0:2780:9423:166c:1aac test-resource block-1024
Done

CLI 和 API 参考文档

• 没有关联的 API

Coap 观察

触发订阅请求，允许 CoAP 客户端观察 CoAP 服务器上的指定资源，以了解其状态可能发生的变化。

注意 ：此命令仅在已设置 OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE 时可用。

参数

coap observe address uri-path [type]

• address：CoAP 服务器的 IPv6 地址。
• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）。

示例

coap observe fdde:ad00:beef:0:2780:9423:166c:1aac test-resource
Done

CLI 和 API 参考文档

• 没有关联的 API

coap 参数(get,set)

如果在没有可选参数的情况下运行命令，则获取当前的 CoAP 参数值。

将 CoAP 参数设置为其默认值或指定的值，具体取决于所选的语法。

参数

coap parameters type [default | ack_timeout ack_random_factor_numerator ack_random_factor_denominator max_retransmit]

• type：request（对于 CoAP 请求）或 response（对于 CoAP 响应）。如果没有给出更多参数，该命令会输出当前配置。
• default：将传输参数设置为以下默认值：
  • ack_timeout：2000 毫秒
  • ack_random_factor_numerator：3
  • ack_random_factor_denominator：2
  • max_retransmit：4
• ack_timeout：ACK_TIMEOUT (0-UINT32_MAX)，以毫秒为单位。请参阅 RFC7252。
• ack_random_factor_numerator：ACK_RANDOM_FACTOR 分子，可能的值为 0-255。请参阅 RFC7252。
• ack_random_factor_denominator：ACK_RANDOM_FACTOR 分母，可能的值为 0-255。请参阅 RFC7252。
• max_retransmit：MAX_RETRANSMIT (0-255)。请参阅 RFC7252。

示例

coap parameters request
Transmission parameters for request:
ACK_TIMEOUT=1000 ms, ACK_RANDOM_FACTOR=255/254, MAX_RETRANSMIT=2
Done

coap parameters request default
Transmission parameters for request:
default
Done

coap parameters request 1000 255 254 2
Transmission parameters for request:
ACK_TIMEOUT=1000 ms, ACK_RANDOM_FACTOR=255/254, MAX_RETRANSMIT=2
Done

CLI 和 API 参考文档

• 没有关联的 API

Coap Post

创建指定的 CoAP 资源。有关详情，请参阅使用 OT CLI 测试与受限应用协议 (CoAP) 资源的连接。

参数

coap post address uri-path [type] [payload]

• address：CoAP 服务器的 IPv6 地址。
• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
  • block-：使用此选项，后跟分块值，可发送包含随机生成的载荷字节数的块。有效值为：block-16、block-32、block-64、block-128、block-256、block-512 或 block-1024。
• payload：CoAP 载荷请求；如果使用此参数，则为字符串或整数，具体取决于 type。如果 type 为 con 或 non-con，则 payload 参数是可选的。如果您省略 payload 参数，系统会发送空载荷。不过，如果您使用 payload 形参，则它的值必须是一个字符串，例如 hellothere。如果 type 为 block-，则 payload 参数的值必须是整数，用于指定要发送的块数。block- 类型需要设置 OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE。

示例

coap post fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done

coap post fdde:ad00:beef:0:2780:9423:166c:1aac test-resource block-1024 10
Done

CLI 和 API 参考文档

• 没有关联的 API

CANNOT TRANSLATE

修改指定的 CoAP 资源。有关详情，请参阅使用 OT CLI 测试与受限应用协议 (CoAP) 资源的连接。

参数

coap put address uri-path [type] [payload]

• address：CoAP 服务器的 IPv6 地址。
• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
  • block-：使用此选项，后跟分块值，可发送包含随机生成的载荷字节数的块。有效值为：block-16、block-32、block-64、block-128、block-256、block-512 或 block-1024。
• payload：CoAP 载荷请求；如果使用此参数，则为字符串或整数，具体取决于 type。如果 type 为 con 或 non-con，则 payload 参数是可选的。如果您省略 payload 参数，系统会发送空载荷。不过，如果您使用 payload 形参，则它的值必须是一个字符串，例如 hellothere。如果 type 为 block-，则 payload 参数的值必须是整数，用于指定要发送的块数。block- 类型需要设置 OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE。

示例

coap put fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done

coap put fdde:ad00:beef:0:2780:9423:166c:1aac test-resource block-1024 10
Done

CLI 和 API 参考文档

• 没有关联的 API

Coap 资源（get、set）

获取或设置 CoAP 服务器资源的 URI 路径。

参数

coap resource [uri-path]

示例

coap resource test-resource
Done

coap resource
test-resource
Done

CLI 和 API 参考文档

• otCoapAddResource
• otCoapAddBlockWiseResource

Coap 设置

设置 CoAP 服务器上的资源发送的内容。如果 CoAP 客户端正在观察资源，系统会向该客户端发送通知。

参数

coap set new-content

示例

coap set Testing123
Done

CLI 和 API 参考文档

• coap observe
• otCoapMessageInit
• otCoapNewMessage

Coap 开始

启动 CoAP 服务器。有关详情，请参阅使用 OT CLI 测试与受限应用协议 (CoAP) 资源的连接。

参数

无参数。

示例

coap start
Done

CLI 和 API 参考文档

• otCoapStart

短叫停止

停止 CoAP 服务器。

参数

无参数。

示例

coap stop
Done

CLI 和 API 参考文档

• otCoapStop

Coaps Connect

初始化与对等方的数据报传输层安全协议 (DTLS) 会话。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

coaps connect address

address 参数是对等方的 IPv6 地址。

示例

coaps connect fdde:ad00:beef:0:9903:14b:27e0:5744
Done
coaps connected

CLI 和 API 参考文档

• otCoapSecureConnect

Coaps 删除

要删除的 CoAPS 负载字符串。

参数

coaps delete uri-path [type] [payload]

• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
• payload：CoAPS 载荷请求。

示例

coaps delete test-resource con hellothere
Done

CLI 和 API 参考文档

• 没有关联的 API

协程断开连接

停止 DTLS 会话。

参数

无参数。

示例

coaps disconnect
coaps disconnected
Done

CLI 和 API 参考文档

• otCoapSecureDisconnect

监狱获得

获取有关 CoAPS 服务器上指定 CoAPS 资源的信息。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

coaps get uri-path [type]

• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
  • block-：如果应按块传输响应，请使用此选项，后跟分块值。有效值为：block-16、block-32、block-64、block-128、block-256、block-512 或 block-1024。

示例

coaps get test-resource
Done

coaps get test-resource block-1024
Done

CLI 和 API 参考文档

• 没有关联的 API

Coaps 已关闭

指明 CoAP Secure 服务是否已关闭。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

无参数。

示例

coaps isclosed
no
Done

CLI 和 API 参考文档

• otCoapSecureIsClosed

监狱交接

指示 CoAP Secure 服务连接是否处于活动状态（已连接或正在建立连接）。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

无参数。

示例

coaps isconnactive
yes
Done

CLI 和 API 参考文档

• otCoapSecureIsConnectionActive

Coaps 已连接

指示 CoAP Secure 服务是否已连接。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

无参数。

示例

coaps isconnected
yes
Done

CLI 和 API 参考文档

• otCoapSecureIsConnected

Coaps Post

创建指定的 CoAPS 资源。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

uri-path [type] [payload]

• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
  • block-：使用此选项，后跟分块值，可发送包含随机生成的载荷字节数的块。有效值为：block-16、block-32、block-64、block-128、block-256、block-512 或 block-1024。
• payload：CoAPS 载荷请求；如果使用此参数，则为字符串或整数，具体取决于 type。如果 type 为 con 或 non-con，则载荷参数是可选的。如果您省略 payload 参数，则系统会发送空的载荷。但是，如果使用 payload 参数，则其值必须是字符串，例如 hellothere。如果 type 为 block-，则载荷参数的值必须是整数，用于指定要发送的块数。block- 类型需要设置 OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE。

示例

coaps post test-resource con hellothere
Done

coaps post test-resource block-1024 10
Done

CLI 和 API 参考文档

• 没有关联的 API

Coaps PSC

设置预共享密钥 (PSK) 和加密套件 DTLS_PSK_WITH_AES_128_CCM_8。

注意 ：此命令要求启用构建时功能 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED。

参数

coaps psk psk-value psk-id

• psk-value：预共享密钥
• psk-id：预共享密钥标识符。

示例

coaps psk 1234 key1
Done

CLI 和 API 参考文档

• otCoapSecureSetPsk

美国老板

修改指定的 CoAPS 资源。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

uri-path [type] [payload]

• uri-path：资源的 URI 路径。
• type：
  • con：可确认
  • non-con：不可确认（默认）
  • block-：使用此选项，后跟分块值，可发送包含随机生成的载荷字节数的块。有效值为：block-16、block-32、block-64、block-128、block-256、block-512 或 block-1024。
• payload：CoAPS 载荷请求；如果使用此参数，则为字符串或整数，具体取决于 type。如果 type 为 con 或 non-con，则载荷参数是可选的。如果您省略 payload 参数，则系统会发送空的载荷。但是，如果使用 payload 参数，则其值必须是字符串，例如 hellothere。如果 type 为 block-，则载荷参数的值必须是整数，用于指定要发送的块数。block- 类型需要设置 OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE。

示例

coaps put test-resource con hellothere
Done

coaps put test-resource block-1024 10
Done

CLI 和 API 参考文档

• 没有关联的 API

Coaps 资源（get、set）

获取或设置 CoAPS 服务器资源的 URI 路径。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

coaps resource [uri-path]

示例

coaps resource test-resource
Done

coaps resource
test-resource
Done

CLI 和 API 参考文档

• otCoapSecureAddBlockWiseResource

辅导员设置

设置 CoAPS 服务器上的资源发送的内容。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

coaps set new-content

示例

coaps set Testing123
Done

CLI 和 API 参考文档

• 没有关联的 API

监狱开始

启动 CoAP Secure 服务。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

coaps start [check-peer-cert | max-conn-attempts]

check-peer-cert 参数用于确定是启用（默认）还是停用对等证书检查。max-conn-attempts 参数用于设置允许尝试（成功或失败）连接到 CoAP Secure 服务器的尝试次数上限。此参数的默认值为 0，表示对尝试次数没有限制。虽然您只能指定一个实参，但 check-peer-cert 和 max-conn-attempts 形参可在以下组合中搭配使用：

• 未指定参数：使用默认值。
• 将 check-peer-cert 设置为 true：与省略实参相同，即 check-peer-cert 值为 true，max-conn-attempts 值为 0。
• 将 check-peer-cert 设置为 false：check-peer-cert 的值为 false，max-conn-attempts 的值为 0。
• 指定数字：check-peer-cert 为 true，max-conn-attempts 值为参数中指定的数字。

示例

coaps start
Done

coaps start false
Done

coaps start 8
Done

CLI 和 API 参考文档

• otCoapSecureStart
• otCoapSecureSetSslAuthMode
• otCoapSecureSetClientConnectedCallback

警察站

停止 CoAP Secure 服务。如需了解详情，请参阅使用 OT CLI 测试与受限应用协议安全 (CoAPS) 资源的连接。

参数

无参数。

示例

coaps stop
Done

CLI 和 API 参考文档

• otCoapSecureStop

Coaps x509

使用与 DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 的 DTLS 会话对应的私钥，设置本地设备的 X509 证书。

注意 ：此命令需要启用 MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED=1。X.509 证书存储在以下位置：src/cli/x509_cert_key.hpp。

参数

无参数。

示例

coaps x509
Done

CLI 和 API 参考文档

• otCoapSecureSetCertificate
• otCoapSecureSetCaCertificateChain

专员公告

发送“开始播报”消息。

注意 ：请仅在使用 commissioner start 命令成功启动调试器角色后使用此命令。

参数

commissioner announce mask count period destination

• mask：标识用于发送 MLE Announce 消息的通道的位掩码。
• count：每个通道的 MLE Announce 传输次数。
• period：连续 MLE Announce 传输之间的毫秒数。
• destination：消息的目标 IPv6 地址。该消息可以是多播的。

示例

commissioner announce 0x00050000 2 32 fdde:ad00:beef:0:0:ff:fe00:c00
Done

CLI 和 API 参考文档

• 委托人启动
• otCommissionerAnnounceBegin

专员能源

发送能耗扫描查询消息。系统会按原样输出收到的命令输出。

注意 ：请仅在使用 commissioner start 命令成功启动调试器角色后使用此命令。

参数

commissioner energy mask count period scanDuration destination

• mask：标识用于执行 IEEE 802.15.4 能量扫描的通道的位掩码。
• count：每个信道的 IEEE 802.15.4 能量扫描次数。
• period：连续 IEEE 802.15.4 能量扫描之间的毫秒数。
• scanDuration：执行 IEEE 802.15.4 能量扫描时使用的扫描时长（以毫秒为单位）。
• destination：消息的目标 IPv6 地址。该消息可以是多播的。

示例

commissioner energy 0x00050000 2 32 1000 fdde:ad00:beef:0:0:ff:fe00:c00
Done
Energy: 00050000 0 0 0 0

CLI 和 API 参考文档

• 委托人启动
• otCommissionerEnergyScan

佣金 ID (get,set)

获取或设置 OpenThread 调试器 ID 名称。

参数

commissioner id name

示例

commissioner id OpenThread Commissioner
Done

commissioner id
OpenThread Commissioner
Done

CLI 和 API 参考文档

• otCommissionerSetId

委托人加入添加

添加联接条目。

注意 ：请仅在使用 commissioner start 命令成功启动调试器角色后使用此命令。

参数

commissioner joiner add eui64|discerner pksd [timeout]

• eui64：Joiner 的 IEEE EUI-64。如需匹配任何联接函数，请使用 *。
• discerner：采用 number/length 格式的“连接符”标识符。
• pksd：联接器的预共享密钥。
• timeout：联接器超时（以秒为单位）。

示例

commissioner joiner add d45e64fa83f81cf7 J01NME
Done

commissioner joiner add 0xabc/12 J01NME
Done

CLI 和 API 参考文档

• 委托人启动
• otCommissionerAddJoiner
• otCommissionerAddJoinerWithDiscerner

专员：联接移除

移除“连接符”条目。

注意 ：请仅在使用 commissioner start 命令成功启动调试器角色后使用此命令。

参数

commissioner joiner remove eui64|discerner

• eui64：联接者的 IEEE EUI-64。如需匹配任何联接函数，请使用 *。
• discerner：采用 number/length 格式的联接标识符。

示例

commissioner joiner remove d45e64fa83f81cf7
Done

commissioner joiner remove 0xabc/12
Done

CLI 和 API 参考文档

• 委托人启动
• otCommissionerRemoveJoiner
• otCommissionerRemoveJoinerWithDiscerner

专员联接表

以表格式列出所有“连接符”条目。

参数

无参数。

示例

commissioner joiner table
| ID                    | PSKd                             | Expiration |
+-----------------------+----------------------------------+------------+
|                     * |                           J01NME |      81015 |
|      d45e64fa83f81cf7 |                           J01NME |     101204 |
| 0x0000000000000abc/12 |                           J01NME |     114360 |
Done

CLI 和 API 参考文档

• 没有关联的 API

专员管理

向主要副本发送 MGMT_GET (Management Get) 消息。系统会返回使用 commissioner mgmtset 命令设置的变量值。

参数

commissioner mgmtget [locator] [sessionid] [steeringdata] [joinerudpport] [-x TLVs]

• locator：边界路由器 RLOC16。
• sessionid：委员会的会话 ID。
• steeringdata：流量导向。
• joinerudpport：联接器 UDP 端口。
• TLVs：要检索的 TLV 集。

示例

commissioner mgmtget locator sessionid
Done

CLI 和 API 参考文档

• otCommissionerSendMgmtGet

专员管理

向主要副本发送 MGMT_SET（管理集）消息，并将变量设置为指定的值。

参数

commissioner mgmtset [locator locator] [sessionid sessionid] [steeringdata steeringdata] [joinerudpport joinerudpport] [-x TLVs]

• locator：边界路由器 RLOC16。
• sessionid：委员会的会话 ID。
• steeringdata：流量导向。
• joinerudpport：联接器 UDP 端口。
• TLVs：要检索的 TLV 集。

示例

commissioner mgmtset joinerudpport 9988
Done

CLI 和 API 参考文档

• otCommissionerSendMgmtSet

Commissioner Panid

发送 PAN ID 查询。在收到命令输出时即返回该输出。

注意 ：请仅在使用 commissioner start 命令成功启动调试器角色后使用此命令。

参数

commissioner panid panid mask destination

• paind：用于检查是否存在冲突的 PAN ID。
• mask；用于标识要执行 IEEE 802.15.4 主动扫描的通道的位掩码。
• destination：消息的 IPv6 目标地址。该消息可以是多播的。

示例

commissioner panid 0xdead 0x7fff800 fdde:ad00:beef:0:0:ff:fe00:c00
Done
Conflict: dead, 00000800

CLI 和 API 参考文档

• 委托人启动
• otCommissionerPanIdQuery

佣金器配置网址

设置调试器配置网址。

参数

commissioner provisioningurl provisioningurl

示例

commissioner provisioningurl http://github.com/openthread/openthread
Done

CLI 和 API 参考文档

• otCommissionerSetProvisioningUrl

专员 sessionid

获取当前的调试器会话 ID。

参数

无参数。

示例

commissioner sessionid
0
Done

CLI 和 API 参考文档

• otCommissionerGetSessionId

专员开始

启动 Thread Commissioner 角色。

注意 ：commissioner 命令仅在设置了 OPENTHREAD_CONFIG_COMMISSIONER_ENABLE 和 OPENTHREAD_FTD 时可用。

参数

无参数。

示例

commissioner start
Commissioner: petitioning
Done
Commissioner: active

CLI 和 API 参考文档

• otCommissionerStart

专员州

返回调试器的当前状态。可能的值包括 active、disabled 或 petition（申请成为委员）。

参数

无参数。

示例

commissioner state
active
Done

CLI 和 API 参考文档

• otCommissionerState

专员停止

停止 Thread Commissioner 角色。

参数

无参数。

示例

commissioner stop
Done

CLI 和 API 参考文档

• otCommissionerStop

contextreusedelay（获取、设置）

获取或设置 CONTEXT_ID_REUSE_DELAY 值。

参数

contextreusedelay delay

使用可选的 delay 参数来设置 CONTEXT_ID_REUSE_DELAY。

示例

contextreusedelay
11
Done

contextreusedelay 11
Done

CLI 和 API 参考文档

• otThreadGetContextIdReuseDelay
• otThreadSetContextIdReuseDelay

计数器（Mac）

获取 MAC 层计数器。

参数

counters mac

示例

counters mac
TxTotal: 10
   TxUnicast: 3
   TxBroadcast: 7
   TxAckRequested: 3
   TxAcked: 3
   TxNoAckRequested: 7
   TxData: 10
   TxDataPoll: 0
   TxBeacon: 0
   TxBeaconRequest: 0
   TxOther: 0
   TxRetry: 0
   TxErrCca: 0
   TxErrBusyChannel: 0
RxTotal: 2
   RxUnicast: 1
   RxBroadcast: 1
   RxData: 2
   RxDataPoll: 0
   RxBeacon: 0
   RxBeaconRequest: 0
   RxOther: 0
   RxAddressFiltered: 0
   RxDestAddrFiltered: 0
   RxDuplicated: 0
   RxErrNoFrame: 0
   RxErrNoUnknownNeighbor: 0
   RxErrInvalidSrcAddr: 0
   RxErrSec: 0
   RxErrFcs: 0
   RxErrOther: 0
Done

CLI 和 API 参考文档

• otLinkGetCounters

计数器（mle）

获取 Thread MLE 计数器。

参数

counters mle

示例

counters mle
Role Disabled: 0
Role Detached: 1
Role Child: 0
Role Router: 0
Role Leader: 1
Attach Attempts: 1
Partition Id Changes: 1
Better Partition Attach Attempts: 0
Parent Changes: 0
Done

CLI 和 API 参考文档

• otThreadGetMleCounters

计数器

获取支持的计数器名称。

参数

无参数。

示例

counters
ip
mac
mle
Done

CLI 和 API 参考文档

• 没有关联的 API

计数器 IP

获取 IPv6 计数器。

参数

counters ip

示例

counters ip
TxSuccess: 10
TxFailed: 0
RxSuccess: 5
RxFailed: 0
Done

CLI 和 API 参考文档

• otThreadGetIp6Counters

计数器 IP 重置

重置 IPv6 计数器。

参数

counters ip reset

示例

counters ip reset
Done

CLI 和 API 参考文档

• otThreadResetIp6Counters

计数器 mac 重置

重置 MAC 层计数器。

参数

counters mac reset

示例

counters mac reset
Done

CLI 和 API 参考文档

• otLinkResetCounters

计数器 MLE 重置

重置 Thread MLE 计数器。

参数

counters mle reset

示例

counters mle reset
Done

CLI 和 API 参考文档

• otThreadResetMleCounters

CSL 渠道

设置 CSL 渠道。

参数

csl channel channel

示例

csl channel 20
Done

CLI 和 API 参考文档

• otLinkSetCslChannel

客户服务代表

获取 CSL 配置。

参数

无参数。

示例

csl
Channel: 11
Period: 160000us
Timeout: 1000s
Done

CLI 和 API 参考文档

• otLinkGetCslChannel
• otLinkGetCslPeriod
• otLinkGetCslPeriod
• otLinkGetCslTimeout

CSL 期限

设置 CSL 周期（以微秒为单位）。

将此参数设置为 0 即可停用 CSL。

CSL 周期必须是 OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC 的倍数，否则返回 OT_ERROR_INVALID_ARGS。

参数

csl period period

示例

csl period 3000000
Done

CLI 和 API 参考文档

• otLinkSetCslPeriod

CSS 超时

设置 CSL 超时（以秒为单位）。

参数

csl timeout timeout

示例

cls timeout 10
Done

CLI 和 API 参考文档

• otLinkSetCslTimeout

活跃数据集

获取活跃的运营数据集。

OT CLI 使用 otOperationalDataset 成员将数据集值返回到控制台。

参数

dataset active [-x]

可选的 -x 参数会将活跃操作数据集值输出为十六进制编码的 TLV。

示例

dataset active
Active Timestamp: 1
Channel: 13
Channel Mask: 0x07fff800
Ext PAN ID: d63e8e3e495ebbc3
Mesh Local Prefix: fd3d:b50b:f96d:722d::/64
Network Key: dfd34f0f05cad978ec4e32b0413038ff
Network Name: OpenThread-8f28
PAN ID: 0x8f28
PSKc: c23a76e98f1a6483639b1ac1271e2e27
Security Policy: 0, onrcb
Done

dataset active -x
0e08000000000001000000030000103506000...3023d82c841eff0e68db86f35740c030000ff
Done

CLI 和 API 参考文档

• otDatasetGetActive

数据集活动时间戳（get、set）

获取或设置 otOperationalDataset::mActiveTimestamp。

参数

dataset activetimestamp [timestamp]

传递可选的 timestamp 参数以设置活跃时间戳。

示例

dataset activetimestamp
123456789
Done

dataset activetimestamp 123456789
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集渠道 (get,set)

获取或设置 otOperationalDataset::mChannel。

参数

dataset channel [channel-num]

使用可选的 channel-num 参数来设置渠道。

示例

dataset channel
12
Done

dataset channel 12
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集通道掩码 (get,set)

获取或设置 otOperationalDataset::mChannelMask

参数

dataset channelmask [channel-mask]

使用可选的 channel-mask 参数设置通道掩码。

示例

dataset channelmask
0x07fff800
Done

dataset channelmask 0x07fff800
Done

CLI 和 API 参考文档

• 没有关联的 API

清除数据集

重置操作数据集缓冲区。

参数

无参数。

示例

dataset clear
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集提交处于活跃状态

将操作数据集缓冲区提交到有效的操作数据集。

参数

无参数。

示例

dataset commit active
Done

CLI 和 API 参考文档

• 数据集提交待处理
• otDatasetSetPending

数据集提交待处理

将操作数据集缓冲区提交到待处理的操作数据集。

参数

无参数。

示例

dataset commit pending
Done

CLI 和 API 参考文档

• 数据集提交处于活跃状态
• otDatasetSetActive

数据集延迟 (get,set)

获取或设置 otOperationalDataset::mDelay。

参数

dataset delay [delay]

使用可选的 delay 参数来设置延迟计时器值。

示例

dataset delay
1000
Done

dataset delay 1000
Done

CLI 和 API 参考文档

• otDatasetSetDelayTimerMinimal

数据集 extpanid（get、set）

获取或设置 otOperationalDataset::mExtendedPanId。

注意 ：更改此值后，数据集缓冲区中的调试凭据会过时。请使用 dataset pskc 进行重置。

参数

dataset extpanid [extpanid]

使用可选 extpanid 参数设置扩展个人局域网 ID。

示例

dataset extpanid
000db80123456789
Done

dataset extpanid 000db80123456789
Done

CLI 和 API 参考文档

• dataset pskc（get、set）

数据集帮助

获取 dataset CLI 命令列表。如需了解详情，请参阅使用 OT CLI 显示和管理数据集。

参数

无参数。

示例

dataset help
help
active
activetimestamp
channel
channelmask
clear
commit
delay
extpanid
init
meshlocalprefix
mgmtgetcommand
mgmtsetcommand
networkkey
networkname
panid
pending
pendingtimestamp
pskc
securitypolicy
set
tlvs
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集 init（活动、新、待处理、tlvs）

OT CLI 会检查 active、pending 或 tlvs，并返回相应的值。否则，OT CLI 会创建一个新的随机网络并返回一个新的数据集。

参数

dataset init {active|new|pending|tlvs} [hex-encoded-tlvs]

使用 new 初始化新数据集，然后输入命令 dataset commit active。对于十六进制编码的 TLV，请使用 tlvs。

示例

dataset init new
Done

CLI 和 API 参考文档

• 数据集提交处于活跃状态
• 活跃数据集

数据集 Meshlocalprefix（get,set）

获取或设置 otOperationalDataset::mMeshLocalPrefix。

参数

dataset meshlocalprefix [meshlocalprefix]

使用可选 meshlocalprefix 参数设置 Mesh-Local 前缀。

示例

dataset meshlocalprefix
fd00:db8:0:0::/64
Done

dataset meshlocalprefix fd00:db8:0:0::
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集 mgmtgetcommand 处于活动状态

发送 MGMT_ACTIVE_GET。

OT CLI 会发送包含相关参数的 MGMT_ACTIVE_GET。如需详细了解这些参数和参数映射，请参阅使用 OT CLI 显示和管理数据集。

注意 ：此命令主要仅用于测试。

参数

dataset mgmtgetcommand active [address leader-address] [dataset-components] [-x tlv-list]

• 使用 address 指定 IPv6 目标；否则，系统会使用主要 ALOC 作为默认值。
• 对于 dataset-components，您可以传递 otOperationalDatasetComponents 的任意组合，例如 activetimestamp、pendingtimestamp 或 networkkey。
• 可选的 -x 参数指定要请求的原始 TLV。

示例

dataset mgmtgetcommand active address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp securitypolicy
Done

dataset mgmtgetcommand active networkname
Done

CLI 和 API 参考文档

• otDatasetSendMgmtActiveGet
• dataset mgmtgetcommand 待处理
• dataset mgmtsetcommand 已启用
• dataset mgmtsetcommand 待处理

数据集 mgmtgetcommand 待处理

发送 MGMT_PENDING_GET。

注意 ：此命令主要仅用于测试。

参数

dataset mgmtgetcommand pending [address leader-address] [dataset-components] [-x tlv-list]

如需详细了解这些参数和参数映射，请参阅使用 OT CLI 显示和管理数据集。

示例

dataset mgmtgetcommand pending address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp securitypolicy
Done

dataset mgmtgetcommand pending networkname
Done

CLI 和 API 参考文档

• otDatasetSendMgmtPendingGet
• dataset mgmtgetcommand 已启用
• dataset mgmtsetcommand 已启用
• dataset mgmtsetcommand 待处理

数据集 mgmtsetcommand 处于活动状态

发送 MGMT_ACTIVE_SET。

注意 ：此命令主要仅用于测试。

参数

dataset mgmtsetcommand active [dataset-components] [-x tlv-list]

如需详细了解这些参数和参数映射，请参阅使用 OT CLI 显示和管理数据集。

示例

dataset mgmtsetcommand active activetimestamp 123 securitypolicy 1 onrcb
Done

CLI 和 API 参考文档

• otDatasetSendMgmtActiveSet
• dataset mgmtgetcommand 已启用
• dataset mgmtgetcommand 待处理
• dataset mgmtsetcommand 待处理

数据集 mgmtsetcommand 待处理

发送 MGMT_PENDING_SET。

注意 ：此命令主要仅用于测试。

参数

dataset mgmtsetcommand pending [dataset-components] [-x tlv-list]

如需详细了解这些参数和参数映射，请参阅使用 OT CLI 显示和管理数据集。

示例

dataset mgmtsetcommand pending activetimestamp 123 securitypolicy 1 onrcb
Done

CLI 和 API 参考文档

• otDatasetSendMgmtPendingSet
• dataset mgmtgetcommand 已启用
• dataset mgmtgetcommand 待处理
• dataset mgmtsetcommand 已启用

数据集网络密钥（get、set）

获取或设置 otOperationalDataset::mNetworkKey。

参数

dataset networkkey [key]

使用可选的 key 参数来设置网络键。

示例

dataset networkkey
00112233445566778899aabbccddeeff
Done

dataset networkkey 00112233445566778899aabbccddeeff
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集网络名称 (get,set)

获取或设置 otOperationalDataset::mNetworkName。

注意 ：更改此值后，数据集缓冲区中的调试凭据会过时。请使用 dataset pskc 进行重置。

参数

dataset networkname [name]

使用可选的 name 参数来设置网络名称。

示例

dataset networkname
OpenThread
Done

dataset networkname OpenThread
Done

CLI 和 API 参考文档

• dataset pskc（get、set）

数据集 panid（get、set）

获取或设置 otOperationalDataset::mPanId。

参数

dataset panid [panid]

使用可选的 panid 参数设置 PAN ID。

示例

dataset panid
0x1234
Done

dataset panid 0x1234
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集 pendingtimestamp（get,set）

获取或设置 otOperationalDataset::mPendingTimestamp。

参数

dataset pendingtimestamp [timestamp]

使用可选 timestamp 参数设置待处理时间戳（秒）。

示例

dataset pendingtimestamp
123456789
Done

dataset pendingtimestamp 123456789
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集 pskc（get、set）

获取或设置 otOperationalDataset::mPskc。

参数

dataset pskc [-p passphrase] | [key]

仅针对 FTD，将 -p 与 passphrase 参数搭配使用。-p 会根据您提供的 UTF-8 编码的 passphrase 以及网络名称和扩展 PAN ID 生成一个 pskc。如果已设置，-p 将使用数据集缓冲区；否则，它会使用当前堆栈。或者，您可以将 pskc 设置为 key（十六进制格式）。

示例

dataset pskc
67c0c203aa0b042bfb5381c47aef4d9e
Done

dataset pskc -p 123456
Done

dataset pskc 67c0c203aa0b042bfb5381c47aef4d9e
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集安全政策（get、set）

获取或设置数据集安全政策。

参数

dataset securitypolicy [rotationtime [onrcCepR]]

• 使用 rotationtime 表示 thrKeyRotation（以小时为单位）。
• 安全政策命令使用 onrcCepR 参数映射来获取和设置 otSecurityPolicy 成员，例如 o 表示 otSecurityPolicy::m 辅助网络密钥启用。如需了解详情，请参阅使用 OT CLI 显示和管理数据集。

示例

dataset securitypolicy
672 onrc
Done

dataset securitypolicy 672 onrc
Done

CLI 和 API 参考文档

• 没有关联的 API

数据集集（活跃、待处理）

设置活跃操作数据集。

如果数据集不包含活跃时间戳，则表示数据集仅部分完成。

如果在具有部分完整有效数据集的设备上启用 Thread，则设备将尝试使用数据集中的任何现有信息连接到现有 Thread 网络。只需使用 Thread 网络键即可连接到网络。

如果数据集中不包含通道，则设备将跨不同通道发送 MLE 公告消息，以查找其他通道上的相邻通道。

如果设备成功连接到 Thread 网络，则会从其父级检索完整的有效数据集。请注意，支持路由器的设备在拥有完整的活跃数据集之前，不会转换为 Router 或 Leader 角色。

CLI dataset set 命令使用十六进制编码的 TLV 设置活跃操作数据集。

参数

dataset set {active|pending} tlvs

示例

dataset set active 0e08000000000001000000030000103506000...3023d82c841eff0e68db86f35740c030000ff
Done

dataset set pending 0e08000000000001000000030000103506000...3023d82c841eff0e68db86f35740c030000ff
Done

CLI 和 API 参考文档

• otDatasetSetActive

数据集 tlv

将指定的操作数据集转换为 otOperationalDatasetTlvs 。

参数

无参数。

示例

dataset tlvs
0e080000000000010000000300001635060004001fffe0020...f7f8
Done

CLI 和 API 参考文档

• otDatasetConvertToTlvs

数据集更新程序取消

取消正在进行的操作数据集更新请求（如果有）。

启用 OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE 后可用。

参数

无参数。

示例

@dataset updater cancel
Done

CLI 和 API 参考文档

• otDatasetUpdaterCancelUpdate

数据集更新程序

指示是否有正在进行的操作数据集更新请求。

启用 OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE 后可用。

参数

无参数。

示例

dataset updater
Enabled
Done

CLI 和 API 参考文档

• otDatasetUpdaterIsUpdateOngoing

数据集更新程序启动

请求更新操作数据集。

启用 OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE 后可用。

aDataset 应包含要更新的字段及其新值。此字段不得包含“有效”或“待处理时间戳”字段。Delay 字段为可选字段；如果未提供，系统将使用默认值（1000 毫秒）。

参数

无参数。

示例

channel
19
Done
dataset clear
Done
dataset channel 15
Done
dataset
Channel: 15
Done
dataset updater start
Done
dataset updater
Enabled
Done
Dataset update complete: OK
channel
15
Done

CLI 和 API 参考文档

• otDatasetUpdaterRequestUpdate

debug

执行一系列 CLI 命令以收集有关设备和线程网络的信息。它用于调试。输出将显示每个已执行的 CLI 命令，后跟 $，后跟相应命令生成的输出。生成的输出包含以下信息：

• 版本
• 当前状态
• RLOC16，扩展 MAC 地址
• 单播和多播 IPv6 地址列表
• 渠道
• PAN ID 和扩展 PAN ID
• 网络数据
• 分区 ID
• 主要数据

如果设备以 FTD 运行：

• 子表和相邻表
• 路由器表和下一个跃点信息
• 地址缓存表
• 已注册的 MTD 子 IPv6 地址
• 设备属性

如果设备支持并充当 SRP 客户端：

• SRP 客户端状态
• SRP 客户端服务和主机信息

如果设备支持并充当 SRP 服务器：

• SRP 服务器状态和地址模式
• SRP 服务器注册的主机和服务

如果设备支持 TREL：

• TREL 状态和对等表

如果设备支持并充当边界路由器：

• 巴西州
• BR 前缀（OMR、链路、NAT64）
• 发现的前缀表

参数

无参数。

示例

CLI 和 API 参考文档

• 没有关联的 API

delaytimermin（已设置）

设置最短延迟计时器（以秒为单位）。

参数

delaytimermin delaytimermin

示例

delaytimermin 60
Done

CLI 和 API 参考文档

• otDatasetSetDelayTimerMinimal

延迟计时器

获取最短延迟计时器（以秒为单位）。

参数

无参数。

示例

delaytimermin
30
Done

CLI 和 API 参考文档

• otDatasetGetDelayTimerMinimal

detach async

启动类似于 detach 命令的优雅分离进程，而不会阻塞并等待指示分离已完成的回调。

参数

无参数。

示例

detach async
Done

CLI 和 API 参考文档

• 分离
• otThreadDetachGracefully

detach

如需启动安全分离过程，首先通知其他节点（如果充当路由器，则发送地址释放；如果作为子节点，则将父节点的“子超时”值设为零），然后停止 Thread 协议操作。

参数

无参数。

示例

detach
Finished detaching
Done

CLI 和 API 参考文档

• otThreadDetachGracefully

deviceprops（设置）

设置设备属性。

参数

deviceprops powerSupply isBr supportsCcm isUnstable weightAdjustment

powerSupply：应为“battery”“external”“external-stable”“external-unstable”。

示例

deviceprops battery 0 0 0 -5
Done

deviceprops
PowerSupply      : battery
IsBorderRouter   : no
SupportsCcm      : no
IsUnstable       : no
WeightAdjustment : -5
Done

CLI 和 API 参考文档

• leaderweight
• leaderweight（已设置）
• otThreadSetDeviceProperties

设备属性

获取当前设备属性。

需要 OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE。

参数

无参数。

示例

deviceprops
PowerSupply      : external
IsBorderRouter   : yes
SupportsCcm      : no
IsUnstable       : no
WeightAdjustment : 0
Done

CLI 和 API 参考文档

• otThreadGetDeviceProperties

discover

执行 MLE 发现操作。

参数

discover [channel]

channel：要查找的频道。如果未提供任何频道，发现操作将覆盖所有有效频道。

示例

discover
| J | Network Name     | Extended PAN     | PAN  | MAC Address      | Ch | dBm | LQI |
+---+------------------+------------------+------+------------------+----+-----+-----+
| 0 | OpenThread       | dead00beef00cafe | ffff | f1d92a82c8d8fe43 | 11 | -20 |   0 |
Done

CLI 和 API 参考文档

• otThreadDiscover

Discover reqCallback（启用、停用）

设置回调以接收 MLE 发现请求数据。

参数

discover reqcallback enable|disable

示例

discover reqcallback enable
Done

CLI 和 API 参考文档

• otThreadSetDiscoveryRequestCallback

DNS 浏览

发送浏览（服务实例枚举）DNS 查询，以获取指定服务名称的服务列表

service-name 后面的参数是可选的。这些可选参数的任何未指定（或零）值都将替换为当前默认配置中的值 (dns config)。

注意 ：DNS 服务器 IP 可以是 IPv4 地址，系统会使用网络数据中的首选 NAT64 前缀将该地址合成为 IPv6 地址。当 DNS 服务器 IP 是 IPv4 地址但首选 NAT64 前缀不可用时，该命令将返回 InvalidState。测试 DNS-SD 发现代理时，可用区不是 local，而是 default.service.arpa。“OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE”为必填字段。

参数

dns browse service-name [dns-server-IP] [dns-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

示例

dns browse _service._udp.example.com
DNS browse response for _service._udp.example.com.
inst1
    Port:1234, Priority:1, Weight:2, TTL:7200
    Host:host.example.com.
    HostAddress:fd00:0:0:0:0:0:0:abcd TTL:7200
    TXT:[a=6531, b=6c12] TTL:7300
instance2
    Port:1234, Priority:1, Weight:2, TTL:7200
    Host:host.example.com.
    HostAddress:fd00:0:0:0:0:0:0:abcd TTL:7200
    TXT:[a=1234] TTL:7300
Done

dns browse _airplay._tcp.default.service.arpa
DNS browse response for _airplay._tcp.default.service.arpa.
Mac mini
    Port:7000, Priority:0, Weight:0, TTL:10
    Host:Mac-mini.default.service.arpa.
    HostAddress:fd97:739d:386a:1:1c2e:d83c:fcbe:9cf4 TTL:10
Done

CLI 和 API 参考文档

• otDnsClientBrowse

DNS 压缩（启用、停用）

设置“DNS 名称压缩”模式。

默认情况下，DNS 名称压缩处于启用状态。停用后，DNS 名称会附加为完整名称，且永不压缩。这适用于 OpenThread 的 DNS 和 SRP 客户端/服务器模块。"OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE为必填项。

参数

dns compression [enable|disable]

示例

dns compression enable
Enabled

dns compression disable
Done
dns compression
Disabled
Done

CLI 和 API 参考文档

• otDnsSetNameCompressionEnabled

DNS 压缩

指明是否已启用“DNS 名称压缩”模式。

此命令仅用于测试目的，在启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 配置后可用。

默认情况下，DNS 名称压缩处于启用状态。停用后，DNS 名称会附加为完整名称，且永不压缩。这适用于 OpenThread 的 DNS 和 SRP 客户端/服务器模块。"OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE为必填项。

参数

dns compression [enable|disable]

示例

dns compression
Enabled

CLI 和 API 参考文档

• otDnsIsNameCompressionEnabled

DNS 配置（已设置）

在 DNS 客户端上设置默认查询配置。

注意 ：任何正在进行的查询都将继续使用其启动时的配置。新的默认配置将用于将来的所有 DNS 查询。

在非 NULL aConfig 中，调用方可以选择不指定 otDnsQueryConfig 实例中的某些字段（值 0）。未指定的字段会被相应的 OT 配置选项定义 OPENTHREAD_CONFIG_DNS_CLIENTDEFAULT{} 替换，从而形成默认查询配置。

启用 OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_ADDRESS_AUTO_SET_ENABLE 后，DNS 客户端会自动设置和更新默认配置中的服务器 IPv6 地址。只有在用户没有明确设置或指定该属性时，系统才会执行此操作。此行为需要启用 SRP 客户端及其自动启动功能。然后，SRP 客户端会监控 DNS/SRP 服务条目的 Thread 网络数据，以选择 SRP 服务器。所选的 SRP 服务器地址也会设置为默认配置中的 DNS 服务器地址。

我们可以不指定某些字段（或使用值“0”）。未指定的字段会被相应的 OT 配置选项定义 OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT 替换，从而形成默认查询配置。“OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE”为必填字段。

参数

dns config [dns-server-IP] [dns-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean] [service-mode]

示例

dns config fd00::1 1234 5000 2 0
Done

dns config
Server: [fd00:0:0:0:0:0:0:1]:1234
ResponseTimeout: 5000 ms
MaxTxAttempts: 2
RecursionDesired: no
Done

dns config fd00::2
Done

dns config
Server: [fd00:0:0:0:0:0:0:2]:53
ResponseTimeout: 3000 ms
MaxTxAttempts: 3
RecursionDesired: yes
Done

CLI 和 API 参考文档

• otDnsClientSetDefaultConfig

DNS 配置

获取 DNS 客户端使用的当前默认查询配置。

OpenThread 堆栈启动时，系统会根据 OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_IP6_ADDRESS、_DEFAULT_SERVER_PORT、_DEFAULT_RESPONSE_TIMEOUT 等一组 OT 配置选项确定默认的 DNS 查询配置（如需了解所有相关的配置选项，请参阅 config/dns_client.h）。

配置包括服务器 IPv6 地址和端口、响应超时（以 msec 为单位的等待时间）、报告失败前的 tx 尝试次数上限、指示服务器能否以递归方式解析查询的布尔值标志。OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE为必填项。

参数

无参数。

示例

dns config
Server: [fd00:0:0:0:0:0:0:1]:1234
ResponseTimeout: 5000 ms
MaxTxAttempts: 2
RecursionDesired: no
ServiceMode: srv
Nat64Mode: allow
Done

CLI 和 API 参考文档

• otDnsClientGetDefaultConfig

DNS 解析

针对指定主机名的 AAAA (IPv6) 记录发送地理编码 DNS 查询。

aConfig 可以为 NULL。在这种情况下，默认配置（来自 otDnsClientGetDefaultConfig() ）将用作此查询的配置。在非 NULL aConfig 中，某些字段可以保留未指定（值 0）。然后，未指定的字段会替换为默认配置中的值。

发送 DNS 查询以获取给定主机名的 IPv6 地址。

主机名后面的参数是可选的。这些可选参数未指定（或零）值都将替换为当前默认配置（dns 配置）中的值。

DNS 服务器 IP 可以是 IPv4 地址，系统会使用网络数据中的首选 NAT64 前缀将该地址合成为 IPv6 地址。

注意 ：当 DNS 服务器 IP 是 IPv4 地址但首选 NAT64 前缀不可用时，该命令将返回 InvalidState。“OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE”为必填字段。

参数

dns resolve hostname [dns-server-IP] [dns-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

示例

dns resolve ipv6.google.com
DNS response for ipv6.google.com - 2a00:1450:401b:801:0:0:0:200e TTL: 300

dns resolve example.com 8.8.8.8
Synthesized IPv6 DNS server address: fdde:ad00:beef:2:0:0:808:808
DNS response for example.com. - fd4c:9574:3720:2:0:0:5db8:d822 TTL:20456
Done

CLI 和 API 参考文档

• otDnsClientResolveAddress

DNS 服务

启动给定服务实例的 DNS 服务实例解析。

在启用 OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE 后可用。

aConfig 可以为 NULL。在这种情况下，默认配置（来自 otDnsClientGetDefaultConfig() ）将用作此查询的配置。在非 NULL aConfig 中，某些字段可以保留未指定（值 0）。然后，未指定的字段会替换为默认配置中的值。

该函数会发送对指定服务实例的 SRV 和/或 TXT 记录的查询。 otDnsQueryConfig 中的 mServiceMode 字段确定要查询的记录（仅限 SRV、仅限 TXT，或 SRV 和 TXT）以及如何执行查询（在同一消息中合并、单独并行或在优化模式下执行。在优化模式下，客户端会先尝试搜索同一条消息，若未能获得响应，则会分别尝试）。

SRV 记录提供有关服务端口、优先级和权重的信息，以及与服务实例关联的主机名。此函数不会对从 SRV 记录中发现的主机名执行地理编码。服务器/解析器可能会在对 SRV/TXT 查询的响应的“其他数据”部分提供主机名的 AAAA/A 记录，并可使用 otDnsServiceCallback 中的 otDnsServiceResponseGetServiceInfo() 检索此信息。此 API 的用户不得假定主机地址始终可从 otDnsServiceResponseGetServiceInfo() 获得。

发送针对给定服务实例的服务实例解析 DNS 查询。首先提供服务实例标签，后跟服务名称（请注意，服务实例标签可以包含点“.”字符）。

service-name 后面的参数是可选的。这些可选参数的任何未指定（或零）值都将替换为当前默认配置中的值 (dns config)。

注意 ：DNS 服务器 IP 可以是 IPv4 地址，系统会使用网络数据中的首选 NAT64 前缀将该地址合成为 IPv6 地址。当 DNS 服务器 IP 是 IPv4 地址但首选 NAT64 前缀不可用时，该命令将返回 InvalidState。“OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE”为必填字段。

参数

dns service service-instance-label service-name [DNS-server-IP] [DNS-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

示例

CLI 和 API 参考文档

• otDnsClientResolveService

DNS servicehost

启动给定服务实例的 DNS 服务实例解析，并采用为服务实例发现的主机名可能的后续地址解析。

在启用 OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE 后可用。

aConfig 可以为 NULL。在这种情况下，默认配置（来自 otDnsClientGetDefaultConfig() ）将用作此查询的配置。在非 NULL aConfig 中，某些字段可以保留未指定（值 0）。然后，未指定的字段会替换为默认配置中的值。此函数无法与设置为 OT_DNS_SERVICE_MODE_TXT 的 DNS 配置中的 mServiceMode 一起使用（即仅查询 TXT 记录），并返回 OT_ERROR_INVALID_ARGS。

其行为类似于为 otDnsClientResolveService() 发送 SRV 和 TXT 记录查询。但是，如果服务器/解析器未在响应 SRV 查询（在“Additional Data”部分）中提供主机名的 AAAA/A 记录，则会对从 SRV 记录中发现的主机名执行主机名解析（发送 AAAA 查询）。收到所有查询的响应（即服务和主机地址解析都完成后）时，系统会调用 aCallback 回调函数。

发送针对给定服务实例的服务实例解析 DNS 查询，并可能进行后续主机名解析。首先提供服务实例标签，后跟服务名称（请注意，服务实例标签可以包含点“.”字符）。

service-name 后面的参数是可选的。这些可选参数的任何未指定（或零）值都将替换为当前默认配置中的值 (dns config)。

注意 ：DNS 服务器 IP 可以是 IPv4 地址，系统会使用网络数据中的首选 NAT64 前缀将该地址合成为 IPv6 地址。当 DNS 服务器 IP 是 IPv4 地址但首选 NAT64 前缀不可用时，该命令将返回 InvalidState。“OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE”为必填字段。

参数

dns servicehost service-instance-label service-name [DNS-server-IP] [DNS-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

示例

CLI 和 API 参考文档

• otDnsClientResolveServiceAndHostAddress

域名（已设置）

设置 Thread 域名。

只有在停用线程协议时才会成功。

注意 ：从 Thread 1.2 开始提供。

参数

domainname name

请使用 backslash 对空格进行转义。

示例

domainname Test\ Thread
Done

CLI 和 API 参考文档

• otThreadSetDomainName

域名

获取 Thread 域名。

注意 ：从 Thread 1.2 开始提供。

参数

无参数。

示例

domainname
Thread
Done

CLI 和 API 参考文档

• otThreadGetDomainName

dua iid (set,clear)

设置或清除为 Thread 网域 Unicast 地址手动指定的接口标识符。

启用 OPENTHREAD_CONFIG_DUA_ENABLE 后可用。

注意 ：仅适用于 Thread 1.2 之后的版本。

参数

dua iid iid|clear

dua iid clear 将 nullptr 传递给 otThreadSetFixedDuaInterfaceIdentifier。否则，您可以传递 iid。

示例

dua iid 0004000300020001
Done

dua iid clear
Done

CLI 和 API 参考文档

• otThreadSetFixedDuaInterfaceIdentifier

Dua IID

获取为 Thread 网域 Unicast 地址手动指定的接口标识符。

启用 OPENTHREAD_CONFIG_DUA_ENABLE 后可用。

注意 ：仅适用于 Thread 1.2 之后的版本。

参数

无参数。

示例

dua iid
0004000300020001
Done

CLI 和 API 参考文档

• otThreadGetFixedDuaInterfaceIdentifier

eidcache

返回 EID-to-RLOC 缓存条目。

参数

无参数。

示例

eidcache
fd49:caf4:a29f:dc0e:97fc:69dd:3c16:df7d 2000 cache canEvict=1 transTime=0 eid=fd49:caf4:a29f:dc0e:97fc:69dd:3c16:df7d
fd49:caf4:a29f:dc0e:97fc:69dd:3c16:df7f fffe retry canEvict=1 timeout=10 retryDelay=30
Done

CLI 和 API 参考文档

• otThreadGetNextCacheEntry

eui64

获取此接口在出厂指定的 IEEE EUI-64。

参数

无参数。

示例

eui64
0615aae900124b00
Done

CLI 和 API 参考文档

• otPlatRadioGetIeeeEui64

extaddr（集）

设置 IEEE 802.15.4 扩展地址。

注意 ：只有在停用线程协议时才会成功。

参数

extaddr extaddr

示例

extaddr dead00beef00cafe
dead00beef00cafe
Done

CLI 和 API 参考文档

• otLinkSetExtendedAddress

Exaddr

获取 IEEE 802.15.4 扩展地址。

参数

无参数。

示例

extaddr
dead00beef00cafe
Done

CLI 和 API 参考文档

• otLinkGetExtendedAddress

extpanid（集）

设置 IEEE 802.15.4 扩展 PAN ID。

注意 ：只能在停用线程协议时调用。成功调用此函数会使非易失性内存中的活跃和待处理操作数据集失效。

注意 ：更改此值后，当前调试凭据会过时。请使用 pskc 进行重置。

参数

extpanid extpanid

示例

extpanid dead00beef00cafe
Done

CLI 和 API 参考文档

• otThreadSetExtendedPanId

扩展程序

获取 IEEE 802.15.4 扩展 PAN ID。

参数

无参数。

示例

extpanid
dead00beef00cafe
Done

CLI 和 API 参考文档

• otThreadGetExtendedPanId

恢复出厂设置

删除存储在非易失性内存中的所有设置，然后触发平台重置。

参数

无参数。

示例

factoryreset

CLI 和 API 参考文档

• otInstanceFactoryReset

假 (a,an)

发送虚假的 Thread 消息。

启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 后可用。

参数

fake /a/an dst-ipaddr target meshLocalIid

示例

fake /a/an fdde:ad00:beef:0:0:ff:fe00:a800 fd00:7d03:7d03:7d03:55f2:bb6a:7a43:a03b 1111222233334444
Done

CLI 和 API 参考文档

• otThreadSendAddressNotification

fem

获取外部 FEM 参数。

参数

无参数。

示例

fem
LNA gain 11 dBm
Done

CLI 和 API 参考文档

• otPlatRadioGetFemLnaGain

fem lnagain（获取）

获取外部 FEM 的 Rx LNA 增益（以 dBm 为单位）。

参数

无参数。

示例

fem lnagain
11
Done

CLI 和 API 参考文档

• otPlatRadioGetFemLnaGain

fem lnagain（已设置）

设置外部 FEM 的 Rx LNA 增益（以 dBm 为单位）。

参数

无参数。

示例

fem lnagain 8
Done

CLI 和 API 参考文档

• otPlatRadioSetFemLnaGain

历史记录 ipaddr

以表格或列表格式显示单播 IPv6 地址历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 事件：可能的值为 Added 或 Removed。
• 地址/前缀长度：单播地址及其前缀长度（以位为单位）。
• 来源：可能的值为 thread、slaac、dhcp6 或 manual。
• 范围：IPv6 地址范围。
• P：首选标志。
• V：标记有效。
• RLOC (R)：此标志指示 IPv6 地址是否为路由定位器。

注意 ：history 下的所有命令都需要启用 OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE 功能。

参数

history ipaddr [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history ipaddr
| Age                  | Event   | Address / Prefix Length                     | Origin |Scope| P | V | R |
+----------------------+---------+---------------------------------------------+--------+-----+---+---+---+
|         00:00:04.991 | Removed | 2001:dead:beef:cafe:c4cb:caba:8d55:e30b/64  | slaac  |  14 | Y | Y | N |
|         00:00:44.647 | Added   | 2001:dead:beef:cafe:c4cb:caba:8d55:e30b/64  | slaac  |  14 | Y | Y | N |
|         00:01:07.199 | Added   | fd00:0:0:0:0:0:0:1/64                       | manual |  14 | Y | Y | N |
|         00:02:17.885 | Added   | fdde:ad00:beef:0:0:ff:fe00:fc00/64          | thread |   3 | N | Y | N |
|         00:02:17.885 | Added   | fdde:ad00:beef:0:0:ff:fe00:5400/64          | thread |   3 | N | Y | Y |
|         00:02:20.107 | Removed | fdde:ad00:beef:0:0:ff:fe00:5400/64          | thread |   3 | N | Y | Y |
|         00:02:21.575 | Added   | fdde:ad00:beef:0:0:ff:fe00:5400/64          | thread |   3 | N | Y | Y |
|         00:02:21.575 | Added   | fdde:ad00:beef:0:ecea:c4fc:ad96:4655/64     | thread |   3 | N | Y | N |
|         00:02:23.904 | Added   | fe80:0:0:0:3c12:a4d2:fbe0:31ad/64           | thread |   2 | Y | Y | N |
Done

history ipaddr list 5
00:00:20.327 -> event:Removed address:2001:dead:beef:cafe:c4cb:caba:8d55:e30b prefixlen:64 origin:slaac scope:14 preferred:yes valid:yes rloc:no
00:00:59.983 -> event:Added address:2001:dead:beef:cafe:c4cb:caba:8d55:e30b prefixlen:64 origin:slaac scope:14 preferred:yes valid:yes rloc:no
00:01:22.535 -> event:Added address:fd00:0:0:0:0:0:0:1 prefixlen:64 origin:manual scope:14 preferred:yes valid:yes rloc:no
00:02:33.221 -> event:Added address:fdde:ad00:beef:0:0:ff:fe00:fc00 prefixlen:64 origin:thread scope:3 preferred:no valid:yes rloc:no
00:02:33.221 -> event:Added address:fdde:ad00:beef:0:0:ff:fe00:5400 prefixlen:64 origin:thread scope:3 preferred:no valid:yes rloc:yes
Done

CLI 和 API 参考文档

• otHistoryTrackerEntryAgeToString
• otHistoryTrackerIterateUnicastAddressHistory

历史记录 ipmaddr

以表格或列表格式显示多播 IPv6 地址历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 事件：可能的值为 Subscribed 或 Unsubscribed。
• 多播地址
• 来源：可能的值是 Thread 或 Manual。

参数

history ipmaddr [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history ipmaddr
| Age                  | Event        | Multicast Address                       | Origin |
+----------------------+--------------+-----------------------------------------+--------+
|         00:00:08.592 | Unsubscribed | ff05:0:0:0:0:0:0:1                      | Manual |
|         00:01:25.353 | Subscribed   | ff05:0:0:0:0:0:0:1                      | Manual |
|         00:01:54.953 | Subscribed   | ff03:0:0:0:0:0:0:2                      | Thread |
|         00:01:54.953 | Subscribed   | ff02:0:0:0:0:0:0:2                      | Thread |
|         00:01:59.329 | Subscribed   | ff33:40:fdde:ad00:beef:0:0:1            | Thread |
|         00:01:59.329 | Subscribed   | ff32:40:fdde:ad00:beef:0:0:1            | Thread |
|         00:02:01.129 | Subscribed   | ff03:0:0:0:0:0:0:fc                     | Thread |
|         00:02:01.129 | Subscribed   | ff03:0:0:0:0:0:0:1                      | Thread |
|         00:02:01.129 | Subscribed   | ff02:0:0:0:0:0:0:1                      | Thread |
Done

history ipmaddr list
00:00:25.447 -> event:Unsubscribed address:ff05:0:0:0:0:0:0:1 origin:Manual
00:01:42.208 -> event:Subscribed address:ff05:0:0:0:0:0:0:1 origin:Manual
00:02:11.808 -> event:Subscribed address:ff03:0:0:0:0:0:0:2 origin:Thread
00:02:11.808 -> event:Subscribed address:ff02:0:0:0:0:0:0:2 origin:Thread
00:02:16.184 -> event:Subscribed address:ff33:40:fdde:ad00:beef:0:0:1 origin:Thread
00:02:16.184 -> event:Subscribed address:ff32:40:fdde:ad00:beef:0:0:1 origin:Thread
00:02:17.984 -> event:Subscribed address:ff03:0:0:0:0:0:0:fc origin:Thread
00:02:17.984 -> event:Subscribed address:ff03:0:0:0:0:0:0:1 origin:Thread
00:02:17.984 -> event:Subscribed address:ff02:0:0:0:0:0:0:1 origin:Thread
Done

CLI 和 API 参考文档

• otHistoryTrackerEntryAgeToString
• otHistoryTrackerIterateMulticastAddressHistory

历史邻居

以表格或列表格式显示邻近项历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 类型：Child 或 Router。
• 事件：可能的值有 Added、Removed 或 Changed。
• 扩展地址
• RLOC16
• 模式：MLE 链接模式。可能的值包括：
  • -：未设置标志（rx-off-when-idle、最小 Thread 设备、稳定的网络数据）。
  • r：rx-on-when-idle
  • d：全线程设备。
  • n：完整的网络数据
• Ave RSS：记录条目时从邻居接收到的平均帧数（以 dBm 为单位）。

参数

history neighbor [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history neighbor
| Age                  | Type   | Event     | Extended Address | RLOC16 | Mode | Ave RSS |
+----------------------+--------+-----------+------------------+--------+------+---------+
|         00:00:29.233 | Child  | Added     | ae5105292f0b9169 | 0x8404 | -    |     -20 |
|         00:01:38.368 | Child  | Removed   | ae5105292f0b9169 | 0x8401 | -    |     -20 |
|         00:04:27.181 | Child  | Changed   | ae5105292f0b9169 | 0x8401 | -    |     -20 |
|         00:04:51.236 | Router | Added     | 865c7ca38a5fa960 | 0x9400 | rdn  |     -20 |
|         00:04:51.587 | Child  | Removed   | 865c7ca38a5fa960 | 0x8402 | rdn  |     -20 |
|         00:05:22.764 | Child  | Changed   | ae5105292f0b9169 | 0x8401 | rn   |     -20 |
|         00:06:40.764 | Child  | Added     | 4ec99efc874a1841 | 0x8403 | r    |     -20 |
|         00:06:44.060 | Child  | Added     | 865c7ca38a5fa960 | 0x8402 | rdn  |     -20 |
|         00:06:49.515 | Child  | Added     | ae5105292f0b9169 | 0x8401 | -    |     -20 |
Done

history neighbor list
00:00:34.753 -> type:Child event:Added extaddr:ae5105292f0b9169 rloc16:0x8404 mode:- rss:-20
00:01:43.888 -> type:Child event:Removed extaddr:ae5105292f0b9169 rloc16:0x8401 mode:- rss:-20
00:04:32.701 -> type:Child event:Changed extaddr:ae5105292f0b9169 rloc16:0x8401 mode:- rss:-20
00:04:56.756 -> type:Router event:Added extaddr:865c7ca38a5fa960 rloc16:0x9400 mode:rdn rss:-20
00:04:57.107 -> type:Child event:Removed extaddr:865c7ca38a5fa960 rloc16:0x8402 mode:rdn rss:-20
00:05:28.284 -> type:Child event:Changed extaddr:ae5105292f0b9169 rloc16:0x8401 mode:rn rss:-20
00:06:46.284 -> type:Child event:Added extaddr:4ec99efc874a1841 rloc16:0x8403 mode:r rss:-20
00:06:49.580 -> type:Child event:Added extaddr:865c7ca38a5fa960 rloc16:0x8402 mode:rdn rss:-20
00:06:55.035 -> type:Child event:Added extaddr:ae5105292f0b9169 rloc16:0x8401 mode:- rss:-20
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateNeighborHistory

网络历史记录

以表格或列表格式显示网络信息历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 角色：设备角色。可能的值是 router、child、detached 或 disabled。
• 模式：MLE 链接模式。可能的值包括：
  • -：未设置标志（rx-off-when-idle、最小 Thread 设备、稳定的网络数据）。
  • r：rx-on-when-idle
  • d：全线程设备。
  • n：完整的网络数据
• RLOC16
• 分区 ID。

参数

history netinfo [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history netinfo
| Age                  | Role     | Mode | RLOC16 | Partition ID |
+----------------------+----------+------+--------+--------------+
|         00:00:10.069 | router   | rdn  | 0x6000 |    151029327 |
|         00:02:09.337 | child    | rdn  | 0x2001 |    151029327 |
|         00:02:09.338 | child    | rdn  | 0x2001 |    151029327 |
|         00:07:40.806 | child    | -    | 0x2001 |    151029327 |
|         00:07:42.297 | detached | -    | 0x6000 |            0 |
|         00:07:42.968 | disabled | -    | 0x6000 |            0 |
Done

history netinfo list
00:00:59.467 -> role:router mode:rdn rloc16:0x6000 partition-id:151029327
00:02:58.735 -> role:child mode:rdn rloc16:0x2001 partition-id:151029327
00:02:58.736 -> role:child mode:rdn rloc16:0x2001 partition-id:151029327
00:08:30.204 -> role:child mode:- rloc16:0x2001 partition-id:151029327
00:08:31.695 -> role:detached mode:- rloc16:0x6000 partition-id:0
00:08:32.366 -> role:disabled mode:- rloc16:0x6000 partition-id:0
Done

history netinfo 2
| Age                  | Role     | Mode | RLOC16 | Partition ID |
+----------------------+----------+------+--------+--------------+
|         00:02:05.451 | router   | rdn  | 0x6000 |    151029327 |
|         00:04:04.719 | child    | rdn  | 0x2001 |    151029327 |
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateNetInfoHistory

历史记录前缀

以表格或列表格式显示网格前缀历史记录的网络数据。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 事件：可能的值为 Added 或 Removed。
• 前缀
• 标志/含义：
  • p：首选标志
  • a：无状态 IPv6 地址自动配置标志。
  • d：DHCPv6 IPv6 地址配置标志。
  • c：DHCPv6 其他配置标志。
  • r：默认路由标志。
  • o：表示网格标记。
  • s：稳定标志。
  • n：Nd Dns 标志。
  • D：域名前缀标志。
• 偏好设置：Preference. 值可以是 high、med 或 low。
• RLOC16

参数

history prefix [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history prefix
| Age                  | Event   | Prefix                                      | Flags     | Pref | RLOC16 |
+----------------------+---------+---------------------------------------------+-----------+------+--------+
|         00:00:10.663 | Added   | fd00:1111:2222:3333::/64                    | paro      | med  | 0x5400 |
|         00:01:02.054 | Removed | fd00:dead:beef:1::/64                       | paros     | high | 0x5400 |
|         00:01:21.136 | Added   | fd00:abba:cddd:0::/64                       | paos      | med  | 0x5400 |
|         00:01:45.144 | Added   | fd00:dead:beef:1::/64                       | paros     | high | 0x3c00 |
|         00:01:50.944 | Added   | fd00:dead:beef:1::/64                       | paros     | high | 0x5400 |
|         00:01:59.887 | Added   | fd00:dead:beef:1::/64                       | paros     | med  | 0x8800 |
Done

history prefix list
00:04:12.487 -> event:Added prefix:fd00:1111:2222:3333::/64 flags:paro pref:med rloc16:0x5400
00:05:03.878 -> event:Removed prefix:fd00:dead:beef:1::/64 flags:paros pref:high rloc16:0x5400
00:05:22.960 -> event:Added prefix:fd00:abba:cddd:0::/64 flags:paos pref:med rloc16:0x5400
00:05:46.968 -> event:Added prefix:fd00:dead:beef:1::/64 flags:paros pref:high rloc16:0x3c00
00:05:52.768 -> event:Added prefix:fd00:dead:beef:1::/64 flags:paros pref:high rloc16:0x5400
00:06:01.711 -> event:Added prefix:fd00:dead:beef:1::/64 flags:paros pref:med rloc16:0x8800
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateOnMeshPrefixHistory

历史路线

以表格或列表格式显示网络数据外部路由历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 事件：可能的值为 Added 或 Removed。
• 路由
• 标志/含义：
  • s：稳定标志。
  • n：NAT64 标志。
• 偏好设置：Preference. 值可以是 high、med 或 low。
• RLOC16

参数

history route [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history route
| Age                  | Event   | Route                                       | Flags     | Pref | RLOC16 |
+----------------------+---------+---------------------------------------------+-----------+------+--------+
|         00:00:05.456 | Removed | fd00:1111:0::/48                            | s         | med  | 0x3c00 |
|         00:00:29.310 | Added   | fd00:1111:0::/48                            | s         | med  | 0x3c00 |
|         00:00:42.822 | Added   | fd00:1111:0::/48                            | s         | med  | 0x5400 |
|         00:01:27.688 | Added   | fd00:aaaa:bbbb:cccc::/64                    | s         | med  | 0x8800 |
Done

history route list 2
00:00:48.704 -> event:Removed route:fd00:1111:0::/48 flags:s pref:med rloc16:0x3c00
00:01:12.558 -> event:Added route:fd00:1111:0::/48 flags:s pref:med rloc16:0x3c00
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateExternalRouteHistory

历史记录路由器

以表或列表格式显示路由表历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 事件：可能的值包括 Added、Removed、NextHopChanged 或 CostChanged。
• ID (RLOC16)：路由器 ID 和 RLOC16。
• 下一个跃点：路由器 ID 和下一个跃点的 RLOC16。如果没有下一个跃点，则显示 none。
• 路径费用：旧费用 -> 新费用。值 inf 表示路径费用无限。

参数

history router [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history router
| Age                  | Event          | ID (RLOC16) | Next Hop    | Path Cost  |
+----------------------+----------------+-------------+-------------+------------+
|         00:00:05.258 | NextHopChanged |  7 (0x1c00) | 34 (0x8800) | inf ->   3 |
|         00:00:08.604 | NextHopChanged | 34 (0x8800) | 34 (0x8800) | inf ->   2 |
|         00:00:08.604 | Added          |  7 (0x1c00) |        none | inf -> inf |
|         00:00:11.931 | Added          | 34 (0x8800) |        none | inf -> inf |
|         00:00:14.948 | Removed        | 59 (0xec00) |        none | inf -> inf |
|         00:00:14.948 | Removed        | 54 (0xd800) |        none | inf -> inf |
|         00:00:14.948 | Removed        | 34 (0x8800) |        none | inf -> inf |
|         00:00:14.948 | Removed        |  7 (0x1c00) |        none | inf -> inf |
|         00:00:54.795 | NextHopChanged | 59 (0xec00) | 34 (0x8800) |   1 ->   5 |
|         00:02:33.735 | NextHopChanged | 54 (0xd800) |        none |  15 -> inf |
|         00:03:10.915 | CostChanged    | 54 (0xd800) | 34 (0x8800) |  13 ->  15 |
|         00:03:45.716 | NextHopChanged | 54 (0xd800) | 34 (0x8800) |  15 ->  13 |
|         00:03:46.188 | CostChanged    | 54 (0xd800) | 59 (0xec00) |  13 ->  15 |
|         00:04:19.124 | CostChanged    | 54 (0xd800) | 59 (0xec00) |  11 ->  13 |
|         00:04:52.008 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   9 ->  11 |
|         00:05:23.176 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   7 ->   9 |
|         00:05:51.081 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   5 ->   7 |
|         00:06:48.721 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   3 ->   5 |
|         00:07:13.792 | NextHopChanged | 54 (0xd800) | 59 (0xec00) |   1 ->   3 |
|         00:09:28.681 | NextHopChanged |  7 (0x1c00) | 34 (0x8800) | inf ->   3 |
|         00:09:31.882 | Added          |  7 (0x1c00) |        none | inf -> inf |
|         00:09:51.240 | NextHopChanged | 54 (0xd800) | 54 (0xd800) | inf ->   1 |
|         00:09:54.204 | Added          | 54 (0xd800) |        none | inf -> inf |
|         00:10:20.645 | NextHopChanged | 34 (0x8800) | 34 (0x8800) | inf ->   2 |
|         00:10:24.242 | NextHopChanged | 59 (0xec00) | 59 (0xec00) | inf ->   1 |
|         00:10:24.242 | Added          | 34 (0x8800) |        none | inf -> inf |
|         00:10:41.900 | NextHopChanged | 59 (0xec00) |        none |   1 -> inf |
|         00:10:42.480 | Added          |  3 (0x0c00) |  3 (0x0c00) | inf -> inf |
|         00:10:43.614 | Added          | 59 (0xec00) | 59 (0xec00) | inf ->   1 |
Done

history router list 20
00:00:06.959 -> event:NextHopChanged router:7(0x1c00) nexthop:34(0x8800) old-cost:inf new-cost:3
00:00:10.305 -> event:NextHopChanged router:34(0x8800) nexthop:34(0x8800) old-cost:inf new-cost:2
00:00:10.305 -> event:Added router:7(0x1c00) nexthop:none old-cost:inf new-cost:inf
00:00:13.632 -> event:Added router:34(0x8800) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:59(0xec00) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:54(0xd800) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:34(0x8800) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:7(0x1c00) nexthop:none old-cost:inf new-cost:inf
00:00:56.496 -> event:NextHopChanged router:59(0xec00) nexthop:34(0x8800) old-cost:1 new-cost:5
00:02:35.436 -> event:NextHopChanged router:54(0xd800) nexthop:none old-cost:15 new-cost:inf
00:03:12.616 -> event:CostChanged router:54(0xd800) nexthop:34(0x8800) old-cost:13 new-cost:15
00:03:47.417 -> event:NextHopChanged router:54(0xd800) nexthop:34(0x8800) old-cost:15 new-cost:13
00:03:47.889 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:13 new-cost:15
00:04:20.825 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:11 new-cost:13
00:04:53.709 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:9 new-cost:11
00:05:24.877 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:7 new-cost:9
00:05:52.782 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:5 new-cost:7
00:06:50.422 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:3 new-cost:5
00:07:15.493 -> event:NextHopChanged router:54(0xd800) nexthop:59(0xec00) old-cost:1 new-cost:3
00:09:30.382 -> event:NextHopChanged router:7(0x1c00) nexthop:34(0x8800) old-cost:inf new-cost:3
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateRouterHistory

历史记录 rx

以表或列表格式显示 IPv6 消息 RX 历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 类型：
  • IPv6 消息类型，例如 UDP、TCP、HopOpts 和 ICMP6（及其子类型）。
  • src：来源 IPv6 地址和端口号。
  • dst：目标 IPv6 地址和端口号（端口号适用于 UDP/TCP，否则为 0）。
• Len：IPv6 载荷长度（不包括 IPv6 标头）。
• Chksum：消息校验和（对 UDP、TCP 或 ICMP6 消息有效）。
• 秒：指示是否使用了链路层安全性。
• Prio：消息优先级。可能的值包括 low、norm、high 或 net（针对线程控制消息）。
• RSS：接收信号强度（以 dBm 为单位），是构成消息的所有已接收片段帧的平均值。对于 TX 历史记录，系统会显示 NA（不适用）。
• 目录：显示消息是发送 (TX) 还是接收 (RX)。如果传输失败，则表格式为 TX-F，列表格式为 tx-success:no。对于任何消息片段，传输失败的示例包括 tx 被中止和没有从对等端发送任何 ack。
• 邻居：接收/接收邮件的邻居的短地址 (RLOC16)。如果帧是广播帧，则会显示为 bcast（表格格式）或 0xffff（列表格式）。如果邻居的短地址不可用，则显示为表格式的 unknwn 或列表格式的 0xfffe。
• 电台：用于接收/接收消息的电台链接（在启用 OPENTHREAD_CONFIG_MULTI_RADIO 时很有用）。可以是 15.4、trel 或 all（如果已通过所有电台链接发送）。

参数

history rx [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history rx
| Age                  | Type             | Len   | Chksum | Sec | Prio | RSS  |Dir | Neighb | Radio |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xbd26 |  no |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:07.640 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.263 | src: [fdde:ad00:beef:0:0:ff:fe00:4800]:0                                    |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    12 | 0x3f7d | yes |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.302 | src: [fdde:ad00:beef:0:0:ff:fe00:4800]:61631                                |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:4801]:61631                                |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReqst) |    16 | 0x942c | yes | norm |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.304 | src: [fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0                               |
|                      | dst: [fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.304 | src: [fdde:ad00:beef:0:0:ff:fe00:4800]:0                                    |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0x2e37 |  no |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:21.622 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xe177 |  no |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:26.640 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |   165 | 0x82ee | yes |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:30.000 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    93 | 0x52df |  no |  net |  -20 | RX | unknwn |  15.4 |
|         00:00:30.480 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0x5ccf |  no |  net |  -20 | RX | unknwn |  15.4 |
|         00:00:30.772 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
Done

history rx list 4
00:00:13.368
    type:UDP len:50 checksum:0xbd26 sec:no prio:net rss:-20 from:0x4800 radio:15.4
    src:[fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788
    dst:[ff02:0:0:0:0:0:0:1]:19788
00:00:14.991
    type:HopOpts len:44 checksum:0x0000 sec:yes prio:norm rss:-20 from:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:4800]:0
    dst:[ff03:0:0:0:0:0:0:2]:0
00:00:15.030
    type:UDP len:12 checksum:0x3f7d sec:yes prio:net rss:-20 from:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:4800]:61631
    dst:[fdde:ad00:beef:0:0:ff:fe00:4801]:61631
00:00:15.032
    type:ICMP6(EchoReqst) len:16 checksum:0x942c sec:yes prio:norm rss:-20 from:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0
    dst:[fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateRxHistory

历史记录 <x>

以表或列表格式显示合并的 IPv6 消息 RX 和 TX 历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 类型：
  • IPv6 消息类型，例如 UDP、TCP、HopOpts 和 ICMP6（及其子类型）。
  • src：来源 IPv6 地址和端口号。
  • dst：目标 IPv6 地址和端口号（端口号适用于 UDP/TCP，否则为 0）。
• Len：IPv6 载荷长度（不包括 IPv6 标头）。
• Chksum：消息校验和（对 UDP、TCP 或 ICMP6 消息有效）。
• 秒：指示是否使用了链路层安全性。
• Prio：消息优先级。可能的值包括 low、norm、high 或 net（针对线程控制消息）。
• RSS：接收信号强度（以 dBm 为单位），是构成消息的所有已接收片段帧的平均值。对于 TX 历史记录，系统会显示 NA（不适用）。
• 目录：显示消息是发送 (TX) 还是接收 (RX)。如果传输失败，则表格式为 TX-F，列表格式为 tx-success:no。对于任何消息片段，传输失败的示例包括 tx 被中止和没有从对等端发送任何 ack。
• 邻居：接收/接收邮件的邻居的短地址 (RLOC16)。如果帧是广播帧，则会显示为 bcast（表格格式）或 0xffff（列表格式）。如果邻居的短地址不可用，则显示为表格式的 unknwn 或列表格式的 0xfffe。
• 电台：用于接收/接收消息的电台链接（在启用 OPENTHREAD_CONFIG_MULTI_RADIO 时很有用）。可以是 15.4、trel 或 all（如果已通过所有电台链接发送）。

参数

history rxtx [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history rxtx
| Age                  | Type             | Len   | Chksum | Sec | Prio | RSS  |Dir | Neighb | Radio |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.267 | src: [fdde:ad00:beef:0:0:ff:fe00:800]:0                                     |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    12 | 0x6c6b | yes |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.290 | src: [fdde:ad00:beef:0:0:ff:fe00:800]:61631                                 |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:801]:61631                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReqst) |    16 | 0xc6a2 | yes | norm |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.292 | src: [fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0                               |
|                      | dst: [fdde:ad00:beef:0:af4c:3644:882a:3698]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReply) |    16 | 0xc5a2 | yes | norm |  NA  | TX | 0x0800 |  15.4 |
|         00:00:09.292 | src: [fdde:ad00:beef:0:af4c:3644:882a:3698]:0                               |
|                      | dst: [fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xaa0d | yes |  net |  NA  | TX | 0x0800 |  15.4 |
|         00:00:09.294 | src: [fdde:ad00:beef:0:0:ff:fe00:801]:61631                                 |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:800]:61631                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.296 | src: [fdde:ad00:beef:0:0:ff:fe00:800]:0                                     |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xc1d8 |  no |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.569 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0x3cb1 |  no |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:16.519 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xeda0 |  no |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:20.599 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |   165 | 0xbdfa | yes |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:21.059 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    64 | 0x1c11 |  no |  net |  NA  | TX | 0x0800 |  15.4 |
|         00:00:21.062 | src: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
|                      | dst: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    93 | 0xedff |  no |  net |  -20 | RX | unknwn |  15.4 |
|         00:00:21.474 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    44 | 0xd383 |  no |  net |  NA  | TX | bcast  |  15.4 |
|         00:00:21.811 | src: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:2]:19788                                             |
Done

history rxtx list 5
00:00:02.100
    type:UDP len:50 checksum:0xd843 sec:no prio:net rss:-20 from:0x0800 radio:15.4
    src:[fe80:0:0:0:54d9:5153:ffc6:df26]:19788
    dst:[ff02:0:0:0:0:0:0:1]:19788
00:00:15.331
    type:HopOpts len:44 checksum:0x0000 sec:yes prio:norm rss:-20 from:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:800]:0
    dst:[ff03:0:0:0:0:0:0:2]:0
00:00:15.354
    type:UDP len:12 checksum:0x6c6b sec:yes prio:net rss:-20 from:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:800]:61631
    dst:[fdde:ad00:beef:0:0:ff:fe00:801]:61631
00:00:15.356
    type:ICMP6(EchoReqst) len:16 checksum:0xc6a2 sec:yes prio:norm rss:-20 from:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0
    dst:[fdde:ad00:beef:0:af4c:3644:882a:3698]:0
00:00:15.356
    type:ICMP6(EchoReply) len:16 checksum:0xc5a2 sec:yes prio:norm tx-success:yes to:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:af4c:3644:882a:3698]:0
    dst:[fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateRxHistory
• otHistoryTrackerIterateTxHistory

历史交易

以表格或列表格式显示 IPv6 消息 TX 历史记录。

每个表格或列表条目提供：

• 存在时间：自命令发出以来经过的时间，格式为：hours:minutes:seconds:milliseconds
• 类型：
  • IPv6 消息类型，例如 UDP、TCP、HopOpts 和 ICMP6（及其子类型）。
  • src：来源 IPv6 地址和端口号。
  • dst：目标 IPv6 地址和端口号（端口号适用于 UDP/TCP，否则为 0）。
• Len：IPv6 载荷长度（不包括 IPv6 标头）。
• Chksum：消息校验和（对 UDP、TCP 或 ICMP6 消息有效）。
• 秒：指示是否使用了链路层安全性。
• Prio：消息优先级。可能的值包括 low、norm、high 或 net（针对线程控制消息）。
• RSS：接收信号强度（以 dBm 为单位），是构成消息的所有已接收片段帧的平均值。对于 TX 历史记录，系统会显示 NA（不适用）。
• 目录：显示消息是发送 (TX) 还是接收 (RX)。如果传输失败，则表格式为 TX-F，列表格式为 tx-success:no。对于任何消息片段，传输失败的示例包括 tx 被中止和没有从对等端发送任何 ack。
• 邻居：接收/接收邮件的邻居的短地址 (RLOC16)。如果帧是广播帧，则会显示为 bcast（表格格式）或 0xffff（列表格式）。如果邻居的短地址不可用，则显示为表格式的 unknwn 或列表格式的 0xfffe。
• 电台：用于接收/接收消息的电台链接（在启用 OPENTHREAD_CONFIG_MULTI_RADIO 时很有用）。可以是 15.4、trel 或 all（如果已通过所有电台链接发送）。

参数

history tx [list] [num-entries]

• 使用 list 选项以列表格式显示输出。否则，系统会以表格式显示输出。
• 使用 num-entries 选项将输出限制为指定的最新条目数。如果未使用此选项，则所有已存储的条目都会显示在输出中。

示例

history tx
| Age                  | Type             | Len   | Chksum | Sec | Prio | RSS  |Dir | Neighb | Radio |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReply) |    16 | 0x932c | yes | norm |  NA  | TX | 0x4800 |  15.4 |
|         00:00:18.798 | src: [fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0                               |
|                      | dst: [fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xce87 | yes |  net |  NA  | TX | 0x4800 |  15.4 |
|         00:00:18.800 | src: [fdde:ad00:beef:0:0:ff:fe00:4801]:61631                                |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:4800]:61631                                |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    64 | 0xf7ba |  no |  net |  NA  | TX | 0x4800 |  15.4 |
|         00:00:39.499 | src: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
|                      | dst: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    44 | 0x26d4 |  no |  net |  NA  | TX | bcast  |  15.4 |
|         00:00:40.256 | src: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
|                      | dst: [ff02:0:0:0:0:0:0:2]:19788                                             |
Done

history tx list
00:00:23.957
    type:ICMP6(EchoReply) len:16 checksum:0x932c sec:yes prio:norm tx-success:yes to:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0
    dst:[fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0
00:00:23.959
    type:UDP len:50 checksum:0xce87 sec:yes prio:net tx-success:yes to:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:4801]:61631
    dst:[fdde:ad00:beef:0:0:ff:fe00:4800]:61631
00:00:44.658
    type:UDP len:64 checksum:0xf7ba sec:no prio:net tx-success:yes to:0x4800 radio:15.4
    src:[fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788
    dst:[fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788
00:00:45.415
    type:UDP len:44 checksum:0x26d4 sec:no prio:net tx-success:yes to:0xffff radio:15.4
    src:[fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788
    dst:[ff02:0:0:0:0:0:0:2]:19788
Done

CLI 和 API 参考文档

• otHistoryTrackerIterateTxHistory

ifconfig（向上、向下）

打开或关闭 IPv6 接口。

调用此方法可启用或停用 IPv6 通信。

参数

ifconfig up|down

示例

ifconfig up
Done

ifconfig down
Done

CLI 和 API 参考文档

• otIp6SetEnabled

ifconfig

指明 IPv6 接口是否已启动。

参数

无参数。

示例

ifconfig
down
Done

ifconfig
up
Done

CLI 和 API 参考文档

• otIp6IsEnabled

实例 ID

获取实例标识符。

构建实例时，实例标识符会设置为一个随机值，初始化后其值不会更改。

参数

无参数。

示例

instanceid
468697314
Done

CLI 和 API 参考文档

• otInstanceGetId

ipaddr 添加

向 Thread 接口添加网络接口地址。

传入实例 aAddress 由 Thread 接口复制。Thread 接口仅支持固定数量的外部添加单播地址。请参阅OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS。

参数

ipaddr add aAddress

示例

ipaddr add 2001::dead:beef:cafe
Done

CLI 和 API 参考文档

• otIp6AddUnicastAddress

Ipaddr Del

从 Thread 接口中移除网络接口地址。

参数

ipaddr del aAddress

示例

ipaddr del 2001::dead:beef:cafe
Done

CLI 和 API 参考文档

• otIp6RemoveUnicastAddress

Ipaddr

获取分配给 Thread 接口的 IPv6 地址列表。

参数

ipaddr [-v]

使用 -v 可获取有关地址的更详细的信息：

• origin：可以是 thread、slaac、dhcp6、manual，并表示地址的来源
• plen：前缀长度
• preferred：首选标志（布尔值）
• valid：有效标志（布尔值）

示例

ipaddr
fdde:ad00:beef:0:0:ff:fe00:0
fdde:ad00:beef:0:558:f56b:d688:799
fe80:0:0:0:f3d9:2a82:c8d8:fe43
Done

ipaddr -v
fd5e:18fa:f4a5:b8:0:ff:fe00:fc00 origin:thread plen:64 preferred:0 valid:1
fd5e:18fa:f4a5:b8:0:ff:fe00:dc00 origin:thread plen:64 preferred:0 valid:1
fd5e:18fa:f4a5:b8:f8e:5d95:87a0:e82c origin:thread plen:64 preferred:0 valid:1
fe80:0:0:0:4891:b191:e277:8826 origin:thread plen:64 preferred:1 valid:1
Done

CLI 和 API 参考文档

• otIp6GetUnicastAddresses

ipaddr linklocal

获取 Thread 链路本地 IPv6 地址。

Thread 链接本地地址是使用 IEEE802.15.4 扩展地址作为接口标识符派生的。

参数

无参数。

示例

ipaddr linklocal
fe80:0:0:0:f3d9:2a82:c8d8:fe43
Done

CLI 和 API 参考文档

• otThreadGetLinkLocalIp6Address

IPaddr Mleid

获取网格本地 EID 地址。

参数

无参数。

示例

ipaddr mleid
fdde:ad00:beef:0:558:f56b:d688:799
Done

CLI 和 API 参考文档

• otThreadGetMeshLocalEid

ipaddr rloc

获取线程路由定位器 (RLOC) 地址。

参数

无参数。

示例

ipaddr rloc
fdde:ad00:beef:0:0:ff:fe00:0
Done

CLI 和 API 参考文档

• otThreadGetRloc

ipmaddr 添加

为 Thread 接口订阅网络接口多播地址。

Thread 接口会复制传入的实例 aAddress。Thread 接口仅支持固定数量的外部添加的多播地址。请参阅OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS。

参数

ipmaddr add aAddress

示例

ipmaddr add ff05::1
Done

CLI 和 API 参考文档

• otIp6SubscribeMulticastAddress

ipmaddr del

为 Thread 接口退订网络接口多播地址。

参数

ipmaddr del aAddress

示例

ipmaddr del ff05::1
Done

CLI 和 API 参考文档

• otIp6UnsubscribeMulticastAddress

ipmaddr

获取已订阅 Thread 接口的 IPv6 多播地址列表。

参数

无参数。

示例

ipmaddr
ff05:0:0:0:0:0:0:1
ff33:40:fdde:ad00:beef:0:0:1
ff32:40:fdde:ad00:beef:0:0:1
Done

CLI 和 API 参考文档

• otIp6GetMulticastAddresses

ipmaddr llatn

获取 Thread Link-Local All Thread Nodes 多播地址。

该地址是链路本地基于 Unicast 前缀的多播地址 [RFC 3306]，具有：

• flgs 设置为 3（P = 1 和 T = 1）
• scop 设置为 2
• plen 设置为 64
• 网络前缀设置为网格本地前缀
• 群组 ID 设置为 1

参数

无参数。

示例

ipmaddr llatn
ff32:40:fdde:ad00:beef:0:0:1
Done

CLI 和 API 参考文档

• otThreadGetLinkLocalAllThreadNodesMulticastAddress

ipmaddr 混杂（启用、停用）

在 Thread 接口上启用或停用多播混杂模式。

参数

ipmaddr promiscuous enable|disable

示例

ipmaddr promiscuous enable
Done

ipmaddr promiscuous disable
Done

CLI 和 API 参考文档

• otIp6SetMulticastPromiscuousEnabled

ipmaddr 杂质

检查 Thread 接口是否启用了多播混杂模式。

参数

无参数。

示例

ipmaddr promiscuous
Disabled
Done

CLI 和 API 参考文档

• otIp6IsMulticastPromiscuousEnabled

ipmaddr rlatn

获取 Thread Realm-Local 所有 Thread 节点多播地址。

该地址是领域本地基于 Unicast 前缀的多播地址 [RFC 3306]，具有：

• flgs 设置为 3（P = 1 和 T = 1）
• scop 设置为 3
• plen 设置为 64
• 网络前缀设置为网格本地前缀
• 群组 ID 设置为 1

参数

无参数。

示例

ipmaddr rlatn
ff33:40:fdde:ad00:beef:0:0:1
Done

CLI 和 API 参考文档

• otThreadGetRealmLocalAllThreadNodesMulticastAddress

Joiner Discerner（已设置）

设置“Joiner Discerner”。

注意： 在线程调试的联接会话期间，“Joiner Discerner”取代了“Joiner EUI-64”。

参数

joiner discerner discerner

• 使用 {number}/{length} 设置 discerner。
• joiner discerner clear 将 aDiscerner 设置为 nullptr。

示例

joiner discerner 0xabc/12
Done

CLI 和 API 参考文档

• otJoinerSetDiscerner

CANNOT TRANSLATE

清除细木识别器。

参数

无参数。

示例

joiner discerner clear
Done

CLI 和 API 参考文档

• 没有关联的 API

细木工人

获取 Joiner Discerner。

如需了解详情，请参阅 otJoinerSetDiscerner。

参数

无参数。

示例

joiner discerner
0xabc/12
Done

CLI 和 API 参考文档

• otJoinerGetDiscerner

Joiner 帮助

输出 joiner 帮助菜单。

参数

无参数。

示例

joiner help
help
id
start
state
stop
Done

CLI 和 API 参考文档

• 没有关联的 API

联接者 ID

获取连接器 ID。

如果未设置 Joiner ID，则通过出厂指定的 IEEE EUI-64 计算 SHA-256 的结果的前 64 位。否则，系统会根据“连接符”值计算连接符 ID。

在调试过程中，连接器 ID 还可用作设备的 IEEE 802.15.4 扩展地址。

参数

无参数。

示例

joiner id
d65e64fa83f81cf7
Done

CLI 和 API 参考文档

• otJoinerGetId

联接开始

启用 Thread Joiner 角色。

参数

joiner start joining-device-credential [provisioning-url]

• joining-device-credential：联接密码。必须是包含全部大写字母数字字符的字符串（0-9 和 A-Y，但为了便于阅读，I、O、Q 和 Z 除外），长度介于 6 到 32 个字符之间。
• provisioning-url：连接器的配置网址（可选）。

示例

joiner start J01NM3
Done

CLI 和 API 参考文档

• otJoinerStart

Joiner 州

获取联接器状态。

返回以下状态之一：

• Idle
• Discover
• Connecting
• Connected
• Entrust
• Joined

参数

无参数。

示例

joiner state
Idle
Done

CLI 和 API 参考文档

• otJoinerGetState

Joiner Stop

停用 Thread Joiner 角色。

参数

无参数。

示例

joiner stop
Done

CLI 和 API 参考文档

• otJoinerStop

Joinerport（已设置）

设置联接器 UDP 端口。

参数

joinerport udp-port

示例

joinerport 1000
Done

CLI 和 API 参考文档

• otThreadSetJoinerUdpPort

Jenerport

获取联接器 UDP 端口。

参数

无参数。

示例

joinerport
1000
Done

CLI 和 API 参考文档

• otThreadGetJoinerUdpPort

按键序列计数器（已设置）

设置 thrKeySequenceCounter。

注意 ：此 API 仅供测试和演示之用。使用此 API 更改设置将导致正式版应用不符合线程规范。

参数

keysequence counter counter

示例

keysequence counter 10
Done

CLI 和 API 参考文档

• otThreadSetKeySequenceCounter

按键序列计数器

获取 thrKeySequenceCounter。

参数

无参数。

示例

keysequence counter
10
Done

CLI 和 API 参考文档

• otThreadGetKeySequenceCounter

按键序列保护时间（已设置）

设置 thrKeySwitchGuardTime（以小时为单位）。

注意 ：此 API 仅供测试和演示之用。使用此 API 更改设置将导致正式版应用不符合线程规范。

参数

keysequence guardtime guardtime-hours

如果存在键索引匹配项，请使用 0 立即 Thread Key Switch。

示例

keysequence guardtime 0
Done

CLI 和 API 参考文档

• otThreadSetKeySwitchGuardTime

按键序列保护时间

获取 thrKeySwitchGuardTime（以小时为单位）。

参数

无参数。

示例

keysequence guardtime
0
Done

CLI 和 API 参考文档

• otThreadGetKeySwitchGuardTime

领先数据

获取线程前导数据。

参数

无参数。

示例

leaderdata
Partition ID: 1077744240
Weighting: 64
Data Version: 109
Stable Data Version: 211
Leader Router ID: 60
Done

CLI 和 API 参考文档

• otThreadGetLeaderData

leaderweight（已设置）

设置以 Leader 角色执行操作时使用的线程主管权重。

直接将主要副本权重设置为新值，以替换其先前的值（可能已从当前 otDeviceProperties 确定）。

参数

leaderweight weight

示例

leaderweight 128
Done

CLI 和 API 参考文档

• otThreadSetLocalLeaderWeight

全能

获取以 Leader 角色执行操作时使用的线程主管权重。

参数

无参数。

示例

leaderweight
128
Done

CLI 和 API 参考文档

• otThreadGetLocalLeaderWeight

linkmetrics mgmtenhanced-ack 清除

发送链接指标管理请求以清除基于增强型 ACK 的探测。

参数

linkmetrics mgmt peer-ipaddr enhanced-ack clear

peer-ipaddr 应为相邻设备的链路本地地址。

示例

linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 enhanced-ack clear
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: Success

CLI 和 API 参考文档

• otLinkMetricsConfigEnhAckProbing

linkmetrics mgmtenhanced-ack 注册

发送链接指标管理请求，以注册基于增强型 ACK 的探测。

参数

linkmetrics mgmt peer-ipaddr enhanced-ack register [qmr][r]

[q、m 和 r] 映射到 otLinkMetricsValues。根据规范 4.11.3.4.4.6，您最多只能同时使用两个选项，例如 q 或 qm。

• q：第 2 层 LQI。
• m：链接利润率。
• r：RSSI。

额外的 r 是可选的，仅用于参考设备。指定此选项时，每个类型 ID 标记的类型/平均枚举都会设置为预留。这用于验证探测主题是否正确处理了无效的类型 ID 标记，并且仅在启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 时可用。

示例

linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 enhanced-ack register qm
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: Success

> linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 enhanced-ack register qm r
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: Cannot support new series

CLI 和 API 参考文档

• otLinkMetricsConfigEnhAckProbing

linkmetrics 管理向前

发送 MLE 链接指标管理请求，以配置或清除前向跟踪系列。

参数

linkmetrics mgmt peer-ipaddr forward series-id [ldraX][pqmr]

• peer-ipaddr：对等地址。
• series-id：连续剧 ID。
• [l、d、r 和 a] 映射到 otLinkMetricsSeriesFlags。X 不表示 otLinkMetricsSeriesFlags，而是停止计费并移除系列。
  • l：MLE 链接探测。
  • d：MAC 数据。
  • r：MAC 数据请求。
  • a：MAC 确认。
  • X：只能与任何其他标记一起使用。
• [p、q、m 和 r] 映射到 otLinkMetricsValues。
  • p：收到的第 2 层 PDU 数量。
  • q：第 2 层 LQI。
  • m：链接利润率。
  • r：RSSI。

示例

linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 forward 1 dra pqmr
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: SUCCESS

CLI 和 API 参考文档

• otLinkMetricsConfigForwardTrackingSeries

linkmetrics 探测

发送 MLE 链接探测消息。

参数

linkmetrics probe peer-ipaddr series-id length

• peer-ipaddr：对等地址。
• series-id：此 Probe 消息针对的连续剧 ID。
• length：探测消息的长度。有效范围为 [0, 64]。

示例

linkmetrics probe fe80:0:0:0:3092:f334:1455:1ad2 1 10
Done

CLI 和 API 参考文档

• otLinkMetricsSendLinkProbe

linkmetrics 查询转发

执行“链接指标”查询（前向跟踪系列）。

参数

linkmetrics query peer-ipaddr forward series-id

• peer-ipaddr：对等地址。
• series-id：连续剧 ID。

示例

linkmetrics query fe80:0:0:0:3092:f334:1455:1ad2 forward 1
Done
> Received Link Metrics Report from: fe80:0:0:0:3092:f334:1455:1ad2
- PDU Counter: 2 (Count/Summation)
- LQI: 76 (Exponential Moving Average)
- Margin: 82 (dB) (Exponential Moving Average)
- RSSI: -18 (dBm) (Exponential Moving Average)

CLI 和 API 参考文档

• otLinkMetricsQuery

linkmetrics 查询（单个）

执行“链接指标”查询（单个探测）。

参数

linkmetrics query peer-ipaddr single [pqmr]

• peer-ipaddr：对等地址。
• [p、q、m 和 r] 映射到 otLinkMetrics。
  • p：收到的第 2 层 PDU 数量。
  • q：第 2 层 LQI。
  • m：链接利润率。
  • r：RSSI。

示例

linkmetrics query fe80:0:0:0:3092:f334:1455:1ad2 single qmr
Done
> Received Link Metrics Report from: fe80:0:0:0:3092:f334:1455:1ad2
- LQI: 76 (Exponential Moving Average)
- Margin: 82 (dB) (Exponential Moving Average)
- RSSI: -18 (dBm) (Exponential Moving Average)

CLI 和 API 参考文档

• otLinkMetricsQuery

linkmetricsmgr（启用、停用）

启用或停用关联指标管理器。

参数

linkmetricsmgr enable|disable

示例

linkmetricmgr enable
Done

linkmetricmgr disable
Done

CLI 和 API 参考文档

• otLinkMetricsManagerSetEnabled

linkmetricsmgr 显示

按扩展地址获取邻域的链接指标数据。

参数

无参数。

示例

linkmetricsmgr show
ExtAddr:827aa7f7f63e1234, LinkMargin:80, Rssi:-20
Done

CLI 和 API 参考文档

• otLinkMetricsManagerGetMetricsValueByExtAddr

定位（设置）

找到某个任播地址最近的目的地（即查找该目的地的网状网本地 EID 和 RLOC16）。

最近的目的地根据线程网格内的当前路由表和路径成本确定。

启用 OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE 后可用。

参数

locate anycastaddr

示例

locate fdde:ad00:beef:0:0:ff:fe00:fc00
fdde:ad00:beef:0:d9d3:9000:16b:d03b 0xc800
Done

CLI 和 API 参考文档

• otThreadLocateAnycastDestination

定位

获取任播定位器的当前状态（In Progress 或 Idle）。

启用 OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE 后可用。

参数

无参数。

示例

locate
Idle
Done

locate fdde:ad00:beef:0:0:ff:fe00:fc10

locate
In Progress
Done

CLI 和 API 参考文档

• otThreadIsAnycastLocateInProgress

日志文件名

指定用于捕获 otPlatLog() 消息的文件名，当日志记录会破坏自动化测试脚本时，当您在 Linux 上调试自动化测试脚本时非常有用。

需要 OPENTHREAD_CONFIG_LOG_OUTPUT == OPENTHREAD_CONFIG_LOG_OUTPUT_DEBUG_UART 和 OPENTHREAD_POSIX。

参数

log filename filename

示例

CLI 和 API 参考文档

• otPlatDebugUart_logfile

日志级别（已设置）

设置日志级别。

注意 ：此函数需要 OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1。

参数

log level level

示例

log level 4
Done

CLI 和 API 参考文档

• otLoggingSetLevel

日志级别

获取日志级别。

参数

无参数。

示例

log level
1
Done

CLI 和 API 参考文档

• otLoggingGetLevel

mac 重试直接 (get,set)

获取或设置 MAC 层上的直接 TX 重试次数。

参数

mac retries direct [number]

使用可选的 number 参数设置直接 TX 重试次数。

示例

mac retries direct
3
Done

mac retries direct 5
Done

CLI 和 API 参考文档

• otLinkGetMaxFrameRetriesDirect
• otLinkSetMaxFrameRetriesDirect

mac 重试间接 (get,set)

获取或设置 MAC 层上的间接 TX 重试次数。

参数

mac retries indirect [number]

使用可选的 number 参数设置间接 Tx 重试次数。

示例

mac retries indirect
3
Done

 max retries indirect 5
Done

CLI 和 API 参考文档

• otLinkGetMaxFrameRetriesIndirect
• otLinkSetMaxFrameRetriesIndirect

Mac 发送

指示 Rx-Off-When-Idle 设备将 MAC 帧发送到其父级。此命令用于认证，只能在启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 时使用。

参数

mac send datarequest | emptydata

您必须从以下两个参数中选择一个：

• datarequest：将 IEEE 802.15.4 数据请求消息加入队列进行传输。
• emptydata：指示设备发送一个空的 IEEE 802.15.4 数据帧。

示例

mac send datarequest
Done

mac send emptydata
Done

CLI 和 API 参考文档

• otLinkSendDataRequest
• otLinkSendEmptyData

macfilter addr 添加

只有在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后才可用。

向 MAC 过滤器列表添加 IEEE 802.15.4 扩展地址。如果您指定可选的 rss 参数，则此操作会修复来自该地址的邮件的接收信号强度。如果您不使用 rss 选项，则地址将使用您设置的任何默认值。如果您未设置默认值，则信号强度将为无线网络信号。

参数

macfilter addr add extaddr [rss]

示例

macfilter addr add 0f6127e33af6b403 -95
Done

macfilter addr add 0f6127e33af6b402
Done

CLI 和 API 参考文档

• otLinkFilterAddAddress

macfilter 添加程序许可名单

启用 allowlist MAC 过滤器模式，这意味着只有 MAC 过滤器列表中的 MAC 地址才能访问。

参数

无参数。

示例

macfilter addr allowlist
Done

CLI 和 API 参考文档

• otLinkFilterSetAddressMode

macfilter addr 清除

在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后可用。

此命令会从 MAC 过滤器列表中清除所有扩展地址。

注意 ：此命令不会影响 RssIn 列表中的条目。该列表包含的扩展地址，其 rss 已设为不同于默认值的固定值。

参数

无参数。

示例

macfilter addr clear
Done

CLI 和 API 参考文档

• otLinkFilterClearAddresses

macfilter addr 拒绝名单

启用 denylist MAC 过滤器模式，这意味着 MAC 过滤器列表中的所有 MAC 地址都将被拒绝访问。

参数

无参数。

示例

macfilter addr denylist
Done

CLI 和 API 参考文档

• otLinkFilterSetAddressMode

macfilter addr 停用

停用 MAC 过滤器模式。

参数

无参数。

示例

macfilter addr disable
Done

CLI 和 API 参考文档

• 没有关联的 API

macfilter addr

在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后可用。

提供以下信息：

• MAC 过滤器列表的当前模式：AllowList、DenyList, 或 Disabled
• 过滤器中所有扩展地址的列表。如果设置为不同于默认值，则地址旁边会列出接收信号强度 (rss) 和链路质量指示器 (lqi)。

参数

无参数。

示例

macfilter addr
Allowlist
0f6127e33af6b403 : rss -95 (lqi 1)
0f6127e33af6b402
Done

CLI 和 API 参考文档

• otLinkFilterGetAddressMode

macfilter addr 移除

在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后可用。

此命令会从 MAC 过滤器列表中移除指定的扩展地址。

注意 ：如果指定的扩展地址与 MAC 过滤器列表中的条目不匹配，则系统不会执行任何操作。

参数

macfilter addr remove extaddr

示例

macfilter addr remove 0f6127e33af6b402
Done

CLI 和 API 参考文档

• otLinkFilterRemoveAddress

macfilter

提供以下信息：

• Address Mode：MAC 过滤器的当前模式：AllowList、DenyList, 或 Disabled
• MAC 过滤器列表中所有扩展地址的列表。如果设置为不同于默认值，则地址旁边会列出接收信号强度 (rss) 和链路质量指示器 (lqi)。
• 一个单独的列表 (RssIn List)，其中显示了已将 rss 设置为不同于默认值的所有扩展地址。
• Default rss：显示 rss 和 lqi 设置的默认值（如适用）。

注意 ：扩展地址可以在 RssIn 列表中，但不能在 MAC 过滤器列表中。

参数

无参数。

示例

macfilter
Address Mode: Allowlist
0f6127e33af6b403 : rss -95 (lqi 1)
0f6127e33af6b402
RssIn List:
0f6127e33af6b403 : rss -95 (lqi 1)
Default rss: -50 (lqi 3)
Done

CLI 和 API 参考文档

• otLinkFilterSetAddressMode
• otLinkFilterGetNextAddress
• otLinkFilterGetNextRssIn

macfilter rss 添加

将指定的扩展地址添加到 RssIn 列表（或修改 RssIn 列表中的现有地址），并为来自该地址的邮件设置接收信号强度（以 dBm 为单位）条目。

注意 ：RssIn 列表包含扩展地址，这些地址的 rss 或链接质量指示器 (lqi) 值已设置为与默认值不同。

参数

macfilter rss add extaddr rss

如需为所有已接收消息设置接收信号强度的默认值，请使用 * 作为 extaddr 参数。

示例

macfilter rss add * -50
Done

macfilter rss add 0f6127e33af6b404 -85
Done

CLI 和 API 参考文档

• otLinkFilterAddRssIn

macfilter rss add-lqi

将指定的扩展地址添加到 RssIn 列表（或修改 RssIn 列表中的现有地址），并为来自该地址的邮件设置固定链接质量指示器。扩展地址无需位于 address allowlist/denylist 过滤器中即可设置 lqi。

注意 ：RssIn 列表包含的扩展地址的 lqi 或接收信号强度 (rss) 值已设置为与默认值不同。lqi 将自动转换为相应的 rss 值。

此项在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后可用。

参数

macfilter rss add-lqi extaddr lqi

如需为所有收到的消息设置链接质量指示器的默认值，请使用 * 作为 extaddr 参数。允许的范围为 0 到 3。

示例

macfilter rss add-lqi * 3
Done

macfilter rss add-lqi 0f6127e33af6b404 2
Done

CLI 和 API 参考文档

• otLinkConvertLinkQualityToRss
• otLinkFilterSetDefaultRssIn

macfilter rss clear

清除 RssIn 列表中收到的所有信号强度 (rss) 和链路质量指示器 (lqi) 条目（包括默认值）。

执行此操作后，所有扩展地址都将使用直播信号。

在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后可用。

参数

无参数。

示例

macfilter rss clear
Done

CLI 和 API 参考文档

• otLinkFilterClearAllRssIn

macfilters rss

提供以下信息：

• 接收信号强度 (rss) 设置为与默认值不同的所有扩展地址的列表。系统还会显示链接质量指示器 (lqi)。rss 和 lqi 设置会相互映射。如果您设置其中一个，系统会自动设置另一个的值。此列表称为 RssIn List。设置 rsi 或 lqi 会将相应的扩展地址添加到 RssIn 列表中。
• Default rss：显示 rss 和 lqi 设置的默认值（如适用）。

参数

无参数。

示例

macfilter rss
0f6127e33af6b403 : rss -95 (lqi 1)
Default rss: -50 (lqi 3)
Done

CLI 和 API 参考文档

• otLinkFilterGetNextRssIn

macfilters rss 移除

从 RssIn 列表中移除指定的扩展地址。

从 RssIn 列表中移除后，此 MAC 地址将改用默认的 rss 和 lqi 设置（假设已设定默认值）。（如果未设置默认值，系统会使用无线信号）。

在启用 OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 配置后可用。

如果 RssIn 列表中没有与指定的扩展地址匹配的现有条目，则不会执行任何操作。

参数

macfilter rss remove extaddr

如果您想移除默认的接收信号强度和链路质量指示器设置，请使用 * 作为 extaddr。这会取消设置默认值，但不会从 RssIn 列表中移除条目。

示例

macfilter rss remove *
Done

macfilter rss remove 0f6127e33af6b404
Done

CLI 和 API 参考文档

• otLinkFilterRemoveRssIn

Meshdiag childip6

向父级发送查询以检索其所有 MTD 子级的 IPv6 地址。

参数

meshdiag childip6 parent-rloc16

示例

meshdiag childip6 0xdc00
child-rloc16: 0xdc02
    fdde:ad00:beef:0:ded8:cd58:b73:2c21
    fd00:2:0:0:c24a:456:3b6b:c597
    fd00:1:0:0:120b:95fe:3ecc:d238
child-rloc16: 0xdc03
    fdde:ad00:beef:0:3aa6:b8bf:e7d6:eefe
    fd00:2:0:0:8ff8:a188:7436:6720
    fd00:1:0:0:1fcf:5495:790a:370f
Done

CLI 和 API 参考文档

• otMeshDiagQueryChildrenIp6Addrs

Meshdiag 子表

启动对具有给定 RLOC16 的路由器的子表的查询。输出会列出所有子条目。每位儿童的信息：

• RLOC16
• 扩展的 MAC 地址
• 线程版本
• 超时（以秒为单位）
• 存在时间（自上次收听以来的秒数）
• 监管时间间隔（以秒为单位）
• 已加入队列的消息数（以防孩子处于休眠状态）
• 设备模式
• RSS（平均值和最新数据）
• 错误率：帧 tx（在 MAC 层）、IPv6 消息 tx（在 MAC 层）
• 连接时间（链接建立后的秒数{dd}d.{hh}:{mm}:{ss}格式）
• CSL 信息：
  • 如果同步
  • 周期（以 10 个符号的时间为单位）
  • 超时（以秒为单位）

参数

无参数。

示例

meshdiag childtable 0x6400
rloc16:0x6402 ext-addr:8e6f4d323bbed1fe ver:4
    timeout:120 age:36 supvn:129 q-msg:0
    rx-on:yes type:ftd full-net:yes
    rss - ave:-20 last:-20 margin:80
    err-rate - frame:11.51% msg:0.76%
    conn-time:00:11:07
    csl - sync:no period:0 timeout:0 channel:0
rloc16:0x6403 ext-addr:ee24e64ecf8c079a ver:4
    timeout:120 age:19 supvn:129 q-msg:0
    rx-on:no type:mtd full-net:no
    rss - ave:-20 last:-20  margin:80
    err-rate - frame:0.73% msg:0.00%
    conn-time:01:08:53
    csl - sync:no period:0 timeout:0 channel:0
Done

CLI 和 API 参考文档

• 没有关联的 API

Meshdiag Routerneighbortable

开始查询具有给定 RLOC16 的路由器的路由器相邻表。输出会列出所有路由器相邻条目。每个条目的信息：

• RLOC16
• 扩展的 MAC 地址
• 线程版本
• RSS（平均值和最后一个值）和链接利润率
• 错误率、帧 tx（在 MAC 层）、IPv6 消息 tx（在 MAC 层）
• 连接时间（链接建立后的秒数{dd}d.{hh}:{mm}:{ss}格式）

参数

meshdiag routerneighbortable router-rloc16

示例

meshdiag routerneighbortable 0x7400
rloc16:0x9c00 ext-addr:764788cf6e57a4d2 ver:4
   rss - ave:-20 last:-20 margin:80
   err-rate - frame:1.38% msg:0.00%
   conn-time:01:54:02
rloc16:0x7c00 ext-addr:4ed24fceec9bf6d3 ver:4
   rss - ave:-20 last:-20 margin:80
   err-rate - frame:0.72% msg:0.00%
   conn-time:00:11:27
Done

CLI 和 API 参考文档

• otMeshDiagQueryRouterNeighborTable

Meshdiag 拓扑

了解网络拓扑（路由器及其连接的列表）。参数为可选参数，用于表示要发现的其他项。可按任意顺序添加。

• ip6-addrs 用于发现每个路由器的 IPv6 地址列表。
• children，用于发现每个路由器的子表。

每个路由器的信息：

• 路由器 ID
• RLOC16
• 扩展的 MAC 地址
• 线程版本（如果已知）
• 路由器是否为此设备本身 (me)
• 当设备是儿童时，该路由器是否为此设备的家长 (parent)
• 路由器是否处于 leader 状态
• 路由器是否充当提供外部连接的边界路由器 (br)
• 此路由器与之建立链路的路由器的列表：
  • 3-links：此路由器与链路质量为 3 的传入链路的路由器 ID
  • 2-links：此路由器与链路质量为 2 的传入链路的路由器 ID
  • 1-links：此路由器与链路质量为 1 的传入链路的路由器 ID
  • 如果列表为空，则输出中会将其省略。
• 如果为 ip6-addrs，则为路由器的 IPv6 地址列表
• 如果为 children，则列出路由器的所有子节点。每个儿童的信息：
  • RLOC16
  • 从父级到子级的传入链路质量（零表示未知）
  • 子设备模式（r rx-on-when-idle、d 全线程设备、n 完整网络数据、- 未设置任何标志）
  • 孩子是否为此设备本身 (me)
  • 子节点是否充当提供外部连接的边界路由器 (br)

参数

meshdiag topology [ip6-addrs] [children]

示例

meshdiag topology
id:02 rloc16:0x0800 ext-addr:8aa57d2c603fe16c ver:4 - me - leader
   3-links:{ 46 }
id:46 rloc16:0xb800 ext-addr:fe109d277e0175cc ver:4
   3-links:{ 02 51 57 }
id:33 rloc16:0x8400 ext-addr:d2e511a146b9e54d ver:4
   3-links:{ 51 57 }
id:51 rloc16:0xcc00 ext-addr:9aab43ababf05352 ver:4
   3-links:{ 33 57 }
   2-links:{ 46 }
id:57 rloc16:0xe400 ext-addr:dae9c4c0e9da55ff ver:4
   3-links:{ 46 51 }
   1-links:{ 33 }
Done

CLI 和 API 参考文档

• otMeshDiagDiscoverTopology

Mleadvimax

获取通告计时器使用的当前间隔最大值。

此 API 需要 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE，且仅用于测试。

参数

无参数。

示例

mleadvimax
12000
Done

CLI 和 API 参考文档

• otThreadGetAdvertisementTrickleIntervalMax

米利德

设置网格本地 IID（用于测试）。

需要 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE。

它必须在启用线程堆栈之前使用。

仅用于测试/参照设备。

参数

mliid iid

示例

mliid 1122334455667788
Done

CLI 和 API 参考文档

• otIp6SetMeshLocalIid

Mr reg

将多播监听器注册到主骨干路由器。

必须启用 OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE 和 OPENTHREAD_CONFIG_COMMISSIONER_ENABLE。

省略超时可以在主骨干路由器上使用默认 MLR 超时。

使用 timeout = 0 取消注册多播监听器。

参数

mlr reg ipaddr [timeout]

示例

mlr reg ff04::1
status 0, 0 failed
Done

mlr reg ff04::1 ff04::2 ff02::1
status 2, 1 failed
ff02:0:0:0:0:0:0:1
Done

mlr reg ff04::1 ff04::2 1000
status 0, 0 failed
Done

mlr reg ff04::1 ff04::2 0
status 0, 0 failed
Done

CLI 和 API 参考文档

• otIp6RegisterMulticastListeners

模式（get、set）

设置 MLE 链接模式配置。

参数

mode [rdn]

• -：未设置标志（rx-off-when-idle、最小 Thread 设备、稳定的网络数据）
• r：rx-on-when-idle
• d：全线程设备
• n：完整的网络数据

示例

mode rdn
Done

mode -
Done

CLI 和 API 参考文档

• otThreadSetLinkMode

多电台

获取设备支持的电台链接列表。

此命令始终可用，即使设备仅支持单个无线装置也是如此。

参数

无参数。

示例

multiradio
[15.4, TREL]
Done

CLI 和 API 参考文档

• 没有关联的 API

多无线装置邻域列表

获取与具有给定扩展地址的相邻项相关联的多无线装置链接信息。

“OPENTHREAD_CONFIG_MULTI_RADIO”必须启用。

参数

无参数。

示例

multiradio neighbor list
ExtAddr:3a65bc38dbe4a5be, RLOC16:0xcc00, Radios:[15.4(255), TREL(255)]
ExtAddr:17df23452ee4a4be, RLOC16:0x1300, Radios:[15.4(255)]
Done

CLI 和 API 参考文档

• otMultiRadioGetNeighborInfo

多无线电邻域

获取与具有给定扩展地址的相邻项相关联的多无线装置链接信息。

“OPENTHREAD_CONFIG_MULTI_RADIO”必须启用。

参数

multiradio neighbor ext-address

示例

multiradio neighbor 3a65bc38dbe4a5be
[15.4(255), TREL(255)]
Done

CLI 和 API 参考文档

• otMultiRadioGetNeighborInfo

nat64（启用、停用）

启用或停用 NAT64 函数。

注意 ：这包括 NAT64 翻译器（启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 时）和 NAT64 前缀管理器（启用 OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE 时）。

启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 后，如果将停用设置为 true，则会重置翻译器中的映射表。

在启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 或 OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE 后可用。

参数

nat64 enable|disable

示例

nat64 enable
Done

nat64 disable
Done

CLI 和 API 参考文档

• otNat64SetEnabled

nat64 cidr

参数

无参数。

示例

nat64 cidr 192.168.255.0/24
Done

CLI 和 API 参考文档

nat64 cidr

获取在 NAT64 转换器中配置的 IPv4 CIDR。

启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 后可用。

参数

无参数。

示例

nat64 cidr
192.168.255.0/24
Done

CLI 和 API 参考文档

• otNat64GetCidr

nat64 计数器

获取 NAT64 转换器数据包和错误计数器。

启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 后可用。

参数

无参数。

示例

nat64 counters
|               | 4 to 6                  | 6 to 4                  |
+---------------+-------------------------+-------------------------+
| Protocol      | Pkts     | Bytes        | Pkts     | Bytes        |
+---------------+----------+--------------+----------+--------------+
|         Total |       11 |          704 |       11 |          704 |
|           TCP |        0 |            0 |        0 |            0 |
|           UDP |        0 |            0 |        0 |            0 |
|          ICMP |       11 |          704 |       11 |          704 |
| Errors        | Pkts                    | Pkts                    |
+---------------+-------------------------+-------------------------+
|         Total |                       8 |                       4 |
|   Illegal Pkt |                       0 |                       0 |
|   Unsup Proto |                       0 |                       0 |
|    No Mapping |                       2 |                       0 |
Done

CLI 和 API 参考文档

• otNat64GetCounters
• otNat64GetErrorCounters

nat64 映射

获取下一个 AddressMapping 信息（使用迭代器）。

启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 后可用。

参数

无参数。

示例

nat64 mappings
|          | Address                   |        | 4 to 6       | 6 to 4       |
+----------+---------------------------+--------+--------------+--------------+
| ID       | IPv6       | IPv4         | Expiry | Pkts | Bytes | Pkts | Bytes |
+----------+------------+--------------+--------+------+-------+------+-------+
| 00021cb9 | fdc7::df79 | 192.168.64.2 |  7196s |    6 |   456 |   11 |  1928 |
|          |                                TCP |    0 |     0 |    0 |     0 |
|          |                                UDP |    1 |   136 |   16 |  1608 |
|          |                               ICMP |    5 |   320 |    5 |   320 |

CLI 和 API 参考文档

• otNat64GetNextAddressMapping

nat64 状态

获取 NAT64 函数的状态。

启用 OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE 后，PrefixManager 状态可用。启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 后，Translator 状态可用。

启用 OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE 后，PrefixManager 会返回以下状态之一：

• Disabled：NAT64 前缀管理器已停用。
• NotRunning：NAT64 前缀管理器已启用，但尚未运行。这可能意味着路由管理器已停用。
• Idle：NAT64 前缀管理器已启用且正在运行，但未发布 NAT64 前缀。当另一个边界路由器发布一个优先级更高的 NAT64 前缀时，可能会发生这种情况。
• Active：启用 NAT64 前缀管理器，运行并发布 NAT64 前缀。

启用 OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE 后，Translator 会返回以下状态之一：

• Disabled：NAT64 转换器已停用。
• NotRunning：NAT64 转换器已启用，但尚未转换数据包。这可能意味着译者没有为 NAT64 配置 NAT64 前缀或 CIDR。
• Active：NAT64 转换器已启用，并且正在转换数据包。

参数

无参数。

示例

nat64 state
PrefixManager: Active
Translator: Active
Done

CLI 和 API 参考文档

• otNat64GetPrefixManagerState
• otNat64GetTranslatorState

相邻 conntime 列表

输出相邻对象的连接时间和存在时间。此命令与 neighbor conntime 类似，但以列表格式显示信息。年龄和连接时间均以秒为单位显示。

参数

无参数。

示例

neighbor conntime list
0x8401 1a28be396a14a318 age:63 conn-time:644
0x5c00 723ebf0d9eba3264 age:23 conn-time:852
0xe800 ce53628a1e3f5b3c age:23 conn-time:180
Done

CLI 和 API 参考文档

• 邻居 conntime

邻居 Conntime

输出相邻对象的连接时间和存在时间。每个相邻的信息：

• RLOC16
• 扩展 MAC
• 上次听到的时间（年龄）：距离上次听到邻居内容的天数（以秒为单位）。
• 连接时间：与相邻节点建立链接后经过的秒数。如果时长不到一天，时长间隔将采用 {hh}:{mm}:{ss} 格式（表示小时、分钟和秒）。如果时长超过一天，则格式为 {dd}d.{hh}:{mm}:{ss}。

参数

无参数。

示例

neighbor conntime
| RLOC16 | Extended MAC     | Last Heard (Age) | Connection Time  |
+--------+------------------+------------------+------------------+
| 0x8401 | 1a28be396a14a318 |         00:00:13 |         00:07:59 |
| 0x5c00 | 723ebf0d9eba3264 |         00:00:03 |         00:11:27 |
| 0xe800 | ce53628a1e3f5b3c |         00:00:02 |         00:00:15 |
Done

CLI 和 API 参考文档

• 邻居 conntime 列表

邻居链接质量

输出有关所有相邻项的链接质量信息。

参数

无参数。

示例

neighbor linkquality
| RLOC16 | Extended MAC     | Frame Error | Msg Error | Avg RSS | Last RSS | Age   |
+--------+------------------+-------------+-----------+---------+----------+-------+
| 0xe800 | 9e2fa4e1b84f92db |      0.00 % |    0.00 % |     -46 |      -48 |     1 |
| 0xc001 | 0ad7ed6beaa6016d |      4.67 % |    0.08 % |     -68 |      -72 |    10 |
Done

CLI 和 API 参考文档

• 没有关联的 API

相邻列表

列出每个相邻项的 RLOC16。

参数

无参数。

示例

neighbor list
0xcc01 0xc800 0xf000
Done

CLI 和 API 参考文档

• 没有关联的 API

相邻表

以表格格式输出有关所有相邻项的信息。

对于 Role，此表只能使用 C（子级）或 R（路由器）。

以下列提供有关相邻项的设备模式的信息。每列的值均为 0（关闭）或 1（开启）。

• R：空闲时 RX 开启
• D：全线程设备
• N：完整的网络数据

参数

无参数。

示例

neighbor table
| Role | RLOC16 | Age | Avg RSSI | Last RSSI |R|D|N| Extended MAC     |
+------+--------+-----+----------+-----------+-+-+-+------------------+
|   C  | 0xcc01 |  96 |      -46 |       -46 |1|1|1| 1eb9ba8a6522636b |
|   R  | 0xc800 |   2 |      -29 |       -29 |1|1|1| 9a91556102c39ddb |
|   R  | 0xf000 |   3 |      -28 |       -28 |1|1|1| 0ad7ed6beaa6016d |
Done

CLI 和 API 参考文档

• otThreadGetNextNeighborInfo

netdata 已满

输出“yes”或“no”，指示是否在 Thread 操作开始或上次使用 netdata full reset 重置该标志后调用了“net data full”回调。此命令需要安装 OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL。在以下情况下，系统会调用“净数据已满”回调：

• 设备充当主要设备，并从边界路由器 (BR) 接收网络数据注册，但设备无法将其添加到网络数据（空间不足）。
• 设备作为 BR，新条目无法添加到其本地网络数据。
• 设备充当 BR，并尝试向主要副本注册其本地网络数据条目，但确定其本地条目不适合。

参数

无参数。

示例

netdata full
no
Done

CLI 和 API 参考文档

• otBorderRouterSetNetDataFullCallback

netdata 完全重置

重置标志跟踪是否调用了“net data full”回调。

参数

无参数。

示例

netdata full reset
Done

CLI 和 API 参考文档

• 没有关联的 API

网络数据长度

获取分区的 Thread 网络数据的当前长度（字节数）。

参数

无参数。

示例

netdata length
23
Done

CLI 和 API 参考文档

• otNetDataGetLength

网络数据最大长度

获取自 OT 堆栈初始化或上次调用 otNetDataResetMaxLength() 以来观察到的线程网络数据的最大长度。

参数

无参数。

示例

netdata maxlength
40
Done

CLI 和 API 参考文档

• otNetDataGetMaxLength

重置 netdata maxlength

重置 Thread 网络数据跟踪的最大长度。

参数

无参数。

示例

netdata maxlength reset
Done

CLI 和 API 参考文档

• otNetDataResetMaxLength

netdata 发布 dnssrp Anycast

发布带有序列号的 DNS/SRP 服务任播地址。系统会移除通过之前的 publish dnssrp{anycast|unicast} 命令发布的任何当前 DNS/SRP 服务条目，并将其替换为新参数。

“OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE”必须启用。

参数

netdata publish dnssrp anycast seq-num

示例

netdata publish dnssrp anycast 1
Done

CLI 和 API 参考文档

• netdata publish dnssrp unicast (addr,port)
• netdata publish dnssrp unicast (mle)
• otNetDataPublishDnsSrpServiceAnycast

netdata publish dnssrp 单播 (addr,port)

发布包含地址和端口号的 DNS/SRP 服务单播地址。地址和端口信息包含在服务 TLV 数据中。系统会移除通过之前的 publish dnssrp{anycast|unicast} 命令发布的任何当前 DNS/SRP 服务条目，并将其替换为新参数。

“OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE”必须启用。

参数

netdata publish dnssrp unicast address port

示例

netdata publish dnssrp unicast fd00::1234 51525
Done

CLI 和 API 参考文档

• netdata publish dnssrp unicast (mle)
• netdata publish dnssrp Anycast
• otNetDataPublishDnsSrpServiceUnicast

netdata publish dnssrp 单播 (mle)

发布设备的 Mesh-Local EID 及端口号。MLE 和端口信息包含在服务器 TLV 数据中。如需使用其他 Unicast 地址，请使用 netdata publish dnssrp unicast (addr,port) 命令。

系统会移除通过之前的 publish dnssrp{anycast|unicast} 命令发布的任何当前 DNS/SRP 服务条目，并将其替换为新参数。

“OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE”必须启用。

参数

netdata publish dnssrp unicast port

示例

netdata publish dnssrp unicast 50152
Done

CLI 和 API 参考文档

• netdata publish dnssrp unicast (addr,port)
• netdata publish dnssrp Anycast
• otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

netdata 发布前缀

发布网状前缀条目。如需了解详情，请参阅使用 OT CLI 显示和管理网络数据。

参数

netdata publish prefix prefix [padcrosnD] [high|med|low]

OT CLI 使用映射的参数来配置 otBorderRouterConfig 值。如需了解详情，请参阅 OpenThread CLI 概览。

示例

netdata publish prefix fd00:1234:5678::/64 paos med
Done

CLI 和 API 参考文档

• otNetDataPublishOnMeshPrefix

netdata 发布替换

替换之前发布的外部路由条目。如需了解详情，请参阅使用 OT CLI 显示和管理网络数据。

参数

netdata publish replace oldprefix prefix [sn] [high|med|low]

OT CLI 使用映射的参数来配置 otExternalRouteConfig 值。如需了解详情，请参阅 OpenThread CLI 概览。

示例

netdata publish replace ::/0 fd00:1234:5678::/64 s high
Done

CLI 和 API 参考文档

• otNetDataReplacePublishedExternalRoute

netdata 发布路由

发布外部路由条目。如需了解详情，请参阅使用 OT CLI 显示和管理网络数据。

参数

publish route prefix [sn] [high|med|low]

OT CLI 使用映射的参数来配置 otExternalRouteConfig 值。如需了解详情，请参阅 OpenThread CLI 概览。

示例

netdata publish route fd00:1234:5678::/64 s high
Done

CLI 和 API 参考文档

• otNetDataPublishExternalRoute

netdata 寄存器

向 Leader 注册已配置的前缀、路由和服务。

OT CLI 会检查 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE。如果 OTBR 已启用，它会向主要副本注册本地网络数据。否则，它会调用 CLI 函数 otServerRegister。如需了解详情，请参阅使用 OT CLI 显示和管理网络数据。

参数

无参数。

示例

netdata register
Done

CLI 和 API 参考文档

• 添加前缀
• otBorderRouterRegister
• otServerAddService

netdata steeringdata 检查（识别器）

检查导向数据是否包含具有给定鉴别值的联接器。

参数

netdata steeringdata check discerner

• discerner：{number}/{length} 格式的连接符标识符。

示例

netdata steeringdata check 0xabc/12
Done

netdata steeringdata check 0xdef/12
Error 23: NotFound

CLI 和 API 参考文档

• otNetDataSteeringDataCheckJoinerWithDiscerner
• 接字员

netdata steeringdata 检查 (eui64)

检查导向数据是否包含连接符。

参数

netdata steeringdata check eui64

• eui64：Joiner 的 IEEE EUI-64。

示例

netdata steeringdata check d45e64fa83f81cf7
Done

CLI 和 API 参考文档

• otNetDataSteeringDataCheckJoiner
• eui64

netdata unpublish（前缀）

取消发布之前发布的网状网或外部路由前缀。

“OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE”必须启用。

如需了解详情，请参阅使用 OT CLI 显示和管理网络数据。

参数

netdata unpublish prefix

示例

netdata unpublish fd00:1234:5678::/64
Done

CLI 和 API 参考文档

• otNetDataUnpublishPrefix

netdata 取消发布 dnssrp

从 Thread 网络数据中取消发布之前添加的任何 DNS/SRP（任播或 Unicast）服务条目。

“OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE”必须启用。

参数

无参数。

示例

netdata unpublish dnssrp
Done

CLI 和 API 参考文档

• otNetDataUnpublishDnsSrpService

netstat

获取 UDP 套接字关联列表的头。

参数

无参数。

示例

netstat
| Local Address                                   | Peer Address                                    |
+-------------------------------------------------+-------------------------------------------------+
| [0:0:0:0:0:0:0:0]:49153                         | [0:0:0:0:0:0:0:0]:0                             |
| [0:0:0:0:0:0:0:0]:49152                         | [0:0:0:0:0:0:0:0]:0                             |
| [0:0:0:0:0:0:0:0]:61631                         | [0:0:0:0:0:0:0:0]:0                             |
| [0:0:0:0:0:0:0:0]:19788                         | [0:0:0:0:0:0:0:0]:0                             |
Done

CLI 和 API 参考文档

• otUdpGetSockets

网络诊断信息

发送网络诊断请求，以检索指定地址的指定类型长度值 (TLV)。

参数

networkdiagnostic get addr type(s)

对于 addr，单播地址会触发 Diagnostic Get。多播地址会触发 Diagnostic Query。您可以指定的 TLV 值（如果您指定了多个 TLV，则以空格分隔）：

• 0：MAC 扩展地址 TLV
• 1：Address16 TLV
• 2：模式 TLV
• 3：超时 TLV（SED 的最长轮询时间段）
• 4：连接 TLV
• 5：Route64 TLV
• 6：主要数据 TLV
• 7：网络数据 TLV
• 8：IPv6 地址列表 TLV
• 9：MAC 计数器 TLV
• 14：电池电量 TLV
• 15：电源电压 TLV
• 16：子表 TLV
• 17：频道页 TLV
• 19：子级超时 TLV 上限
• 23：EI64 TLV
• 24：版本 TLV（协议和功能的版本号）
• 25：供应商名称 TLV
• 26：供应商型号 TLV
• 27：供应商 SW 版本 TLV
• 28：线程堆栈版本 TLV（线程堆栈代码库/提交/版本的 UTF-8 字符串形式的版本标识符）
• 29：子级 TLV
• 34：MLE 计数器 TLV
• 35：供应商应用网址 TLV

示例

networkdiagnostic get fdde:ad00:beef:0:0:ff:fe00:fc00 0 1 6 23
DIAG_GET.rsp/ans: 00080e336e1c41494e1c01020c000608640b0f674074c503
Ext Address: 0e336e1c41494e1c
Rloc16: 0x0c00
Leader Data:
    PartitionId: 0x640b0f67
    Weighting: 64
    DataVersion: 116
    StableDataVersion: 197
    LeaderRouterId: 0x03
EUI64: 18b4300000000004
Done

networkdiagnostic get ff02::1 0 1
DIAG_GET.rsp/ans: 00080e336e1c41494e1c01020c00
Ext Address: '0e336e1c41494e1c'
Rloc16: 0x0c00
Done
DIAG_GET.rsp/ans: 00083efcdb7e3f9eb0f201021800
Ext Address: 3efcdb7e3f9eb0f2
Rloc16: 0x1800
Done

CLI 和 API 参考文档

• otThreadSendDiagnosticGet

网络诊断重置

发送网络诊断请求，以重置指定地址的指定类型长度值 (TLV)。此命令仅支持以下 TLV 值：9（MAC 计数器 TLV）或 34（MLE 计数器 TLV）

参数

networkdiagnostic reset addr type(s)

示例

networkdiagnostic reset fd00:db8::ff:fe00:0 9
Done

CLI 和 API 参考文档

• otThreadSendDiagnosticReset

networkidtimeout（get、set）

获取或设置 NETWORK_ID_TIMEOUT 参数。

注意 ：此命令预留用于测试和演示目的。使用此 API 更改设置将导致生产应用不符合线程规范。

参数

networkidtimeout [timeout]

使用可选的 timeout 实参来设置 NETWORK_ID_TIMEOUT 参数的值。

示例

networkidtimeout 120
Done

networkidtimeout
120
Done

CLI 和 API 参考文档

• otThreadGetNetworkIdTimeout
• otThreadSetNetworkIdTimeout

networkkey（键）

设置 Thread 网络键。

只有在停用线程协议时才会成功。成功调用此函数会使非易失性内存中的活跃和待处理操作数据集失效。

参数

networkkey key

示例

networkkey 00112233445566778899aabbccddeeff
Done

CLI 和 API 参考文档

• otThreadSetNetworkKey

网络密钥

获取 Thread 网络键。

参数

无参数。

示例

networkkey
00112233445566778899aabbccddeeff
Done

CLI 和 API 参考文档

• otThreadGetNetworkKey

networkname（名称）

设置 Thread 网络名称。

只有在停用线程协议时才会成功。成功调用此函数会使非易失性内存中的活跃和待处理操作数据集失效。

注意 ：更改此值后，当前的调试凭据会过时。请使用 pskc 进行重置。

参数

networkname name

示例

networkname OpenThread
Done

CLI 和 API 参考文档

• otThreadSetNetworkName

网络名称

获取 Thread 网络名称。

参数

无参数。

示例

networkname
OpenThread
Done

CLI 和 API 参考文档

• otThreadGetNetworkName

networktime（已设置）

设置时间同步参数。

• timesyncperiod：时间同步时间段（以秒为单位）。
• xtalthreshold：设备成为支持路由器的设备的 XTAL 准确度阈值，以 PPM 为单位。

参数

networktime timesyncperiod xtalthreshold

示例

networktime 100 300
Done

CLI 和 API 参考文档

• otNetworkTimeSetSyncPeriod
• otNetworkTimeSetXtalThreshold

网络时间

获取 Thread 网络时间和时间同步参数。

参数

无参数。

示例

networktime
Network Time:     21084154us (synchronized)
Time Sync Period: 100s
XTAL Threshold:   300ppm
Done

CLI 和 API 参考文档

• otNetworkTimeGet
• otNetworkTimeGetSyncPeriod
• otNetworkTimeGetXtalThreshold

Nexthop（获取）

获取前往给定 RLOC16 目标的下一个跃点和路径费用。

可与 aNextHopRloc16 或 aPathCost 为 NULL 时一起使用，表示调用方不想获取该值。

参数

nexthop rloc16

示例

nexthop 0xc000
0xc000 cost:0
Done

nexthop 0x8001
0x2000 cost:3
Done

CLI 和 API 参考文档

• otThreadGetNextHopAndPathCost

下一个跃点

显示每个路由器的已分配路由器 ID 和当前下一个跃点和路径费用的输出表。

参数

无参数。

示例

nexthop
| ID   |NxtHop| Cost |
+------+------+------+
|    9 |    9 |    1 |
|   25 |   25 |    0 |
|   30 |   30 |    1 |
|   46 |    - |    - |
|   50 |   30 |    3 |
|   60 |   30 |    2 |
Done

CLI 和 API 参考文档

• otThreadGetNextHopAndPathCost
• otThreadIsRouterIdAllocated

panid (panid)

设置 IEEE 802.15.4 PAN ID。

只有在停用线程协议时才会成功。成功调用此函数也会使非易失性内存中的活跃和待处理操作数据集失效。

参数

panid panid

示例

panid 0xdead
Done

CLI 和 API 参考文档

• otLinkSetPanId

恐慌

获取 IEEE 802.15.4 PAN ID。

参数

无参数。

示例

panid
0xdead
Done

CLI 和 API 参考文档

• otLinkGetPanId

parent

获取线程路由器的诊断信息（作为父级）。

在启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 的情况下，作为 Thread Router 运行时，此命令将返回设备之前作为线程子项连接时的缓存信息。必须返回缓存的信息，以支持 Thread 自动化测试框架 - 测试场景 8.2.x 请求之前的父级（即联接路由器）的 MAC 地址，即使设备已提升为路由器也是如此。

注意 ：启用 OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE 后，此命令将返回两行额外的行，其中包含与 CSL 接收器操作相关的信息。

参数

无参数。

示例

parent
Ext Addr: be1857c6c21dce55
Rloc: 5c00
Link Quality In: 3
Link Quality Out: 3
Age: 20
Version: 4
Done

CLI 和 API 参考文档

• otThreadGetParentInfo

家长搜索

启动子流程，让子项搜索更好的父项，同时与当前父项保持关联。

当设备以儿童身份连接时，必须使用。

参数

无参数。

示例

parent search
Done

CLI 和 API 参考文档

• otThreadSearchForBetterParent

父级优先级 (get,set)

获取或设置已分配的父级优先级值：1、0、-1 或 -2。-2 表示未分配。

参数

parentpriority [parentpriority]

示例

parentpriority
1
Done

parentpriority 1
Done

CLI 和 API 参考文档

• otThreadGetParentPriority
• otThreadSetParentPriority

分区 ID

获取 Thread 网络分区 ID。

参数

无参数。

示例

partitionid
4294967295
Done

CLI 和 API 参考文档

• otThreadGetPartitionId

首选分区 ID (get,set)

OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE为必填项。

参数

partitionid preferred partitionid

示例

partitionid preferred
4294967295
Done

partitionid preferred 0xffffffff
Done

CLI 和 API 参考文档

• otThreadGetPreferredLeaderPartitionId
• otThreadSetPreferredLeaderPartitionId

platform

输出当前平台

参数

无参数。

示例

platform
NRF52840
Done

CLI 和 API 参考文档

• 没有关联的 API

轮询期（get,set）

获取或设置休眠终端设备的自定义数据轮询周期（以毫秒为单位）。仅用于认证测试。

参数

无参数。

示例

pollperiod
0
Done

pollperiod 10
Done

CLI 和 API 参考文档

• otLinkGetPollPeriod
• otLinkSetPollPeriod

首选路由

指定主服务器在收到请求时应提供的首选路由器 ID。

参数

preferrouterid routerid

示例

preferrouterid 16
Done

CLI 和 API 参考文档

• otThreadSetPreferredRouterId

添加前缀

向网络数据添加有效的前缀。

参数

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

OT CLI 使用映射的参数来配置 otBorderRouterConfig 值。如需了解详情，请参阅 OpenThread CLI 概览。

示例

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

prefix add fd00:7d03:7d03:7d03::/64 prosD low
Done

CLI 和 API 参考文档

• otBorderRouterAddOnMeshPrefix

前缀 Meshlocal

获取网格本地前缀。

参数

无参数。

示例

prefix meshlocal
fdde:ad00:beef:0::/64
Done

CLI 和 API 参考文档

• 没有关联的 API

前缀

获取本地网络数据中的前缀列表。

注意 ：对于具有骨干网功能的 Thread 1.2 边界路由器，系统还会列出本地域名前缀，并包含 D 标志。如果 Backbone 功能被停用，则本地域名前缀前会显示短划线 -。

如需详细了解 otBorderRouterConfig 标志，请参阅 OpenThread CLI 概览。

参数

无参数。

示例

prefix
2001:dead:beef:cafe::/64 paros med
- fd00:7d03:7d03:7d03::/64 prosD med
Done

CLI 和 API 参考文档

• otBorderRouterGetNextOnMeshPrefix

移除前缀

从本地网络数据中移除边界路由器配置。

参数

无参数。

示例

prefix remove 2001:dead:beef:cafe::/64
Done

CLI 和 API 参考文档

• otBorderRouterRemoveOnMeshPrefix

混杂（启用、停用）

启用或停用链路层混杂模式。

注意 ：仅当 Thread 接口处于停用状态时，才能启用混杂模式。

参数

promiscuous enable|disable

示例

promiscuous enable
Done

promiscuous disable
Done

CLI 和 API 参考文档

• otLinkSetPromiscuous

混杂的

指示是否在链路层启用混杂模式。

参数

无参数。

示例

promiscuous
Disabled
Done

CLI 和 API 参考文档

• otLinkIsPromiscuous
• otPlatRadioGetPromiscuous

pskc（集）

设置十六进制格式的 pskc。

参数

pskc key

示例

pskc 67c0c203aa0b042bfb5381c47aef4d9e
Done

CLI 和 API 参考文档

• 没有关联的 API

pskc -p

根据口令（采用 UTF-8 编码）生成 pskc，以及当前网络名称和扩展 PAN ID。

参数

pskc -p passphrase

示例

pskc -p 123456
Done

CLI 和 API 参考文档

• 没有关联的 API

PKC

获取 Thread PSKc。

参数

无参数。

示例

pskc
67c0c203aa0b042bfb5381c47aef4d9e
Done

CLI 和 API 参考文档

• otThreadGetPskc

pskcref（设置）

将键引用设置为线程 PSKc。

需要启用构建时功能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE。

只有在停用线程协议时才会成功。操作成功后，非易失性内存中的活跃和待处理操作数据集也会失效。

参数

pskc keyref

示例

pskc 0x20017
Done

CLI 和 API 参考文档

• otThreadSetPskcRef

pskcref

获取存储的对线程 PSKc 的键引用。

需要启用构建时功能 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE。

参数

无参数。

示例

pskcref
0x80000000
Done

CLI 和 API 参考文档

• otThreadGetPskcRef

无线装置（启用、停用）

启用或停用无线装置。

参数

radio enable|disable

示例

radio enable
Done

radio disable
Done

CLI 和 API 参考文档

• otLinkSetEnabled

清除电台统计数据

重置电台统计信息。

所有时间都重置为 0。

参数

无参数。

示例

radio stats clear
Done

CLI 和 API 参考文档

• otRadioTimeStatsReset

电台统计数据

获取电台统计信息。

无线装置统计信息包括无线装置处于 TX/RX/休眠状态的时间。这些时间以微秒为单位。所有时间都是根据上次重置无线装置统计信息计算得出的。

参数

无参数。

示例

radio stats
Radio Statistics:
Total Time: 67.756s
Tx Time: 0.022944s (0.03%)
Rx Time: 1.482353s (2.18%)
Sleep Time: 66.251128s (97.77%)
Disabled Time: 0.000080s (0.00%)
Done

CLI 和 API 参考文档

• otRadioTimeStatsGet

RCP 版本

获取电台版本字符串。

参数

无参数。

示例

rcp version
OPENTHREAD/20191113-00825-g82053cc9d-dirty; SIMULATION; Jun  4 2020 17:53:16
Done

CLI 和 API 参考文档

• otPlatRadioGetVersionString

地区（已设置）

设置地区代码。

无线电区域格式是 ISO 3166 alpha-2 代码的 2 字节 ASCII 表示。

更改此设置可能会影响传输功率限制。

参数

无参数。

示例

region US
Done

CLI 和 API 参考文档

• otLinkSetRegion

地区

获取地区代码。

无线电区域格式是 ISO 3166 alpha-2 代码的 2 字节 ASCII 表示。

参数

无参数。

示例

region
US
Done

CLI 和 API 参考文档

• otLinkGetRegion

releaserouterid (routerid)

释放由担任 Leader 角色的设备分配的路由器 ID。

注意 ：此 API 仅供测试和演示之用。使用此 API 更改设置将导致正式版应用不符合线程规范。

参数

releaserouterid [routerid]

示例

releaserouterid 16
Done

CLI 和 API 参考文档

• otThreadReleaseRouterId

rloc16

获取 RLOC16。

参数

无参数。

示例

rloc16
0xdead
Done

CLI 和 API 参考文档

• otThreadGetRloc16

添加路线

对于参数，请使用：

• s：稳定版标记
• n：NAT64 标志
• prf：默认路由器偏好设置，[high, med, low]。

为网络数据添加有效的外部路由。

参数

route add prefix [sn] [high|med|low]

示例

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

CLI 和 API 参考文档

• otExternalRouteConfig

路由移除

从本地网络数据中移除外部路由配置。

参数

route remove [prefix]

示例

route remove 2001:dead:beef:cafe::/64
Done

CLI 和 API 参考文档

• otBorderRouterRemoveRoute

路线

获取本地网络数据中的外部路由列表。

参数

无参数。

示例

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

CLI 和 API 参考文档

• otBorderRouterGetNextRoute

路由器 (ID)

该函数会保留给定线程路由器的诊断信息。

输出 Thread Router 的诊断信息。该 ID 可以是路由器 ID 或 RLOC16。

参数

router [id]

示例

router 50
Alloc: 1
Router ID: 50
Rloc: c800
Next Hop: c800
Link: 1
Ext Addr: e2b3540590b0fd87
Cost: 0
Link Quality In: 3
Link Quality Out: 3
Age: 3
Done

router 0xc800
Alloc: 1
Router ID: 50
Rloc: c800
Next Hop: c800
Link: 1
Ext Addr: e2b3540590b0fd87
Cost: 0
Link Quality In: 3
Link Quality Out: 3
Age: 7
Done

CLI 和 API 参考文档

• otThreadGetRouterInfo

路由器列表

列出分配的路由器 ID。

参数

无参数。

示例

router list
8 24 50
Done

CLI 和 API 参考文档

• otThreadGetRouterInfo

路由器表

以表格式输出路由器列表。

参数

无参数。

示例

router table
| ID | RLOC16 | Next Hop | Path Cost | LQ In | LQ Out | Age | Extended MAC     | Link |
+----+--------+----------+-----------+-------+--------+-----+------------------+------+
| 22 | 0x5800 |       63 |         0 |     0 |      0 |   0 | 0aeb8196c9f61658 |    0 |
| 49 | 0xc400 |       63 |         0 |     3 |      3 |   0 | faa1c03908e2dbf2 |    1 |
Done

CLI 和 API 参考文档

• otThreadGetRouterInfo

路由器降级阈值（get、set）

获取或设置 ROUTER_DOWNGRADE_THRESHOLD 值。

参数

routerdowngradethreshold [threshold]

示例

 routerdowngradethreshold
23
Done

 routerdowngradethreshold 23
Done

CLI 和 API 参考文档

• otThreadGetRouterDowngradeThreshold
• otThreadSetRouterDowngradeThreshold

符合路由器要求（启用、停用）

启用或停用路由器角色。

参数

routereligible [enable|disable]

示例

routereligible enable
Done

routereligible disable
Done

CLI 和 API 参考文档

• otThreadSetRouterEligible

符合路由器条件

指示是启用还是停用了路由器角色。

参数

无参数。

示例

routereligible
Enabled
Done

CLI 和 API 参考文档

• otThreadIsRouterEligible

路由器选择抖动

获取或设置 ROUTER_SELECTION_JITTER 值。

参数

routerselectionjitter [jitter]

示例

routerselectionjitter
120
Done

routerselectionjitter 120
Done

CLI 和 API 参考文档

• otThreadGetRouterSelectionJitter
• otThreadSetRouterSelectionJitter

Routerupgradethreshold（get、set）

获取或设置 ROUTER_UPGRADE_THRESHOLD 值。

参数

routerupgradethreshold [threshold]

示例

routerupgradethreshold
16
Done

routerupgradethreshold 16
Done

CLI 和 API 参考文档

• otThreadGetRouterUpgradeThreshold
• otThreadSetRouterUpgradeThreshold

扫描能量

执行 IEEE 802.15.4 能量扫描，并显示用于扫描每个频道的时间（以毫秒为单位）。除非您使用渠道选项指定某个渠道，否则系统会显示所有渠道。

参数

scan energy [duration] [channel]

示例

scan energy 10
| Ch | RSSI |
+----+------+
| 11 |  -59 |
| 12 |  -62 |
| 13 |  -67 |
| 14 |  -61 |
| 15 |  -87 |
| 16 |  -86 |
| 17 |  -86 |
| 18 |  -52 |
| 19 |  -58 |
| 20 |  -82 |
| 21 |  -76 |
| 22 |  -82 |
| 23 |  -74 |
| 24 |  -81 |
| 25 |  -88 |
| 26 |  -71 |
Done

scan energy 10 20
| Ch | RSSI |
+----+------+
| 20 |  -82 |
Done

CLI 和 API 参考文档

• otLinkEnergyScan

扫描

执行有效的 IEEE 802.15.4 扫描。如果未指定频道，则扫描涵盖所有频道；否则，跨度将仅覆盖指定的频道。

参数

scan [channel]

示例

scan
| PAN  | MAC Address      | Ch | dBm | LQI |
+------+------------------+----+-----+-----+
| ffff | f1d92a82c8d8fe43 | 11 | -20 |   0 |
Done

CLI 和 API 参考文档

• otLinkActiveScan

服务添加

将服务添加到网络数据。

• EnterpriseNumber：IANA 企业编号
• serviceData：十六进制编码的二进制服务数据
• serverData：十六进制编码的二进制服务器数据

注意 ：对于每项服务注册更改生效，请在运行 service add 命令后运行 netdata register 命令以通知主要副本。

参数

service add enterpriseNumber serviceData serverData

示例

service add 44970 112233 aabbcc
Done

netdata register
Done

CLI 和 API 参考文档

• otServerAddService
• netdata 寄存器

服务移除

从网络数据中移除服务。

• EnterpriseNumber：IANA 企业编号
• serviceData：十六进制编码的二进制服务数据

注意 ：对于每项服务注册更改生效，请在运行 service remove 命令后运行 netdata register 命令以通知主要副本。

参数

service remove enterpriseNumber serviceData

示例

service remove 44970 112233
Done

netdata register
Done

CLI 和 API 参考文档

• otServerRemoveService
• netdata 寄存器

单例

指示某个节点是否是网络中唯一的路由器。返回 true 或 false。

参数

无参数。

示例

singleton
true
Done

CLI 和 API 参考文档

• otThreadIsSingleton

sntp 查询

发送 SNTP 查询以获取当前的 unix 纪元时间（自 1970 年 1 月 1 日起）。

• SNTP 服务器的默认 IP 地址：2001:4860:4806:8::（Google IPv6 NTP 服务器）
• SNTP 服务器默认端口：123

注意 ：此命令仅在 OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE 启用时才可用。

参数

sntp query [SNTP server IP] [SNTP server port]

示例

sntp query
SNTP response - Unix time: 1540894725 (era: 0)
Done

sntp query 64:ff9b::d8ef:2308
SNTP response - Unix time: 1540898611 (era: 0)
Done

CLI 和 API 参考文档

• otSntpClientQuery

srp 客户端自动启动 (get)

指示自动启动模式的当前状态（启用或停用）。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp client autostart
Disabled
Done

CLI 和 API 参考文档

• otSrpClientIsAutoStartModeEnabled

Srp 客户端自动启动停用

停用自动启动模式。

停用自动启动模式不会停止正在运行的客户端。但是，SRP 客户端会停止监控 Thread 网络数据。

参数

无参数。

示例

srp client autostart disable
Done

CLI 和 API 参考文档

• otSrpClientDisableAutoStartMode

srp 客户端自动启动启用

启用自动启动模式。

启用自动启动后，SRP 客户端会监控 Thread 网络数据，以发现 SRP 服务器、选择首选服务器，并在检测到 SRP 服务器时自动启动和停止客户端。

三类网络数据条目表示存在 SRP 服务器，按以下顺序优先应用：

1. 服务数据中包含服务器地址的 Unicast 条目。如果有多个选项，最好选择数值最低的 IPv6 地址选项。
2. 每个任播条目都具有序列号。首选在 RFC-1982 中由序列号算术逻辑指定的最大序列号。
3. 包含服务器地址信息的 Unicast 条目。如果有多个选项，最好选择数值最低的 IPv6 地址选项。

参数

无参数。

示例

srp client autostart enable
Done

CLI 和 API 参考文档

• otSrpClientEnableAutoStartMode

srp 客户端回调（get、enable、disable）

获取或启用/停用来自 SRP 客户端的打印回调事件。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp client callback [enable|disable]

示例

srp client callback enable
Done

srp client callback
Enabled
Done

CLI 和 API 参考文档

• otSrpClientSetCallback

Srp 客户端主机地址 (get)

指明是否已启用自动地址模式。如果未启用自动地址模式，则系统会返回 SRP 客户端主机地址列表。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp client host address
auto
Done

srp client host address
fd00:0:0:0:0:0:0:1234
fd00:0:0:0:0:0:0:beef
Done

CLI 和 API 参考文档

• otSrpClientGetHostInfo

srp 客户端主机地址（已设置）

启用自动主机地址模式或明确设置主机地址列表。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp client host address [auto|address...]

• 使用 auto 参数启用自动主机地址模式。启用后，客户端会自动使用除链路本地和网状网本地地址以外的所有首选 Thread netif 单播地址。如果没有有效的地址，系统会添加网状网本地 EID 地址。如果线程 netif 上的地址被添加或移除或标记为非首选，SRP 客户端会自动重新注册。
• 明确指定主机地址列表，并用空格分隔各个地址。您可以在客户端运行时设置此列表。此操作还会停用自动主机地址模式。

示例

srp client host address auto
Done

srp client host address fd00::cafe
Done

CLI 和 API 参考文档

• otSrpClientEnableAutoHostAddress
• otSrpClientSetHostAddresses

srp 客户端主机清除

清除所有主机信息和所有服务。

参数

无参数。

示例

srp client host clear
Done

CLI 和 API 参考文档

• otSrpClientBuffersFreeAllServices
• otSrpClientClearHostAndServices

srp 客户端主机名 (get,set)

获取或设置 SRP 客户端的主机名。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp client host name [name]

若要在主机已被移除或尚未向服务器注册时设置客户端主机名，请使用 name 参数。

示例

srp client host name dev4312
Done

srp client host name
dev4312
Done

CLI 和 API 参考文档

• otSrpClientSetHostName

srp 客户端主机移除

从 SRP 服务器中移除 SRP 客户端主机信息和所有服务。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp client host remove [removekeylease] [sendunregtoserver]

• 参数 removekeylease 是一个可选的布尔值，指示是否也移除主机密钥租期（默认值为 false）。
• 参数 sendunregtoserver 是一个可选的布尔值，指示客户端主机是否应向服务器发送“更新”消息（即使客户端主机信息尚未在服务器中注册（默认值为 false）。只有在命令中首先指定 removekeylease 参数时，才能指定该参数。

示例

srp client host remove 1
Done

CLI 和 API 参考文档

• otSrpClientRemoveHostAndServices
• otSrpClientSetHostName

Srp 客户端主机

获取主机信息。

参数

无参数。

示例

srp client host
name:"dev4312", state:Registered, addrs:[fd00:0:0:0:0:0:0:1234, fd00:0:0:0:0:0:0:beef]
Done

CLI 和 API 参考文档

• otSrpClientGetHostInfo

srp 客户端主机状态

返回 SRP 客户端主机的状态。可能的状态：

• ToAdd：要添加/注册的内容。
• Adding：正在添加/注册内容。
• ToRefresh：要刷新以进行租借续订的内容。
• Refreshing：已刷新商品。
• ToRemove：要移除的内容。
• Removing：正在移除内容。
• Registered：项已在服务器注册。
• Removed：内容已被移除。

参数

无参数。

示例

srp client host state
Registered
Done

CLI 和 API 参考文档

• 没有关联的 API

srp 客户端 keyleaseinterval（get、set）

获取或设置密钥租用间隔（以秒为单位）。

参数

srp client keyleaseinterval [interval]

示例

srp client keyleaseinterval 864000
Done

srp client keyleaseinterval
864000
Done

CLI 和 API 参考文档

• otSrpClientGetKeyLeaseInterval
• otSrpClientSetKeyLeaseInterval

srp client leaseinterval (get,set)

获取或设置租期（以秒为单位）。

参数

srp client leaseinterval [interval]

示例

srp client leaseinterval 3600
Done

srp client leaseinterval
3600
Done

CLI 和 API 参考文档

• otSrpClientGetLeaseInterval
• otSrpClientSetLeaseInterval

SRP 客户端服务器地址

返回服务器的 IPv6 地址。

参数

无参数。

示例

srp client server address
fd00:0:0:0:d88a:618b:384d:e760
Done

CLI 和 API 参考文档

• 没有关联的 API

srp 客户端服务器端口

返回服务器的端口号。

参数

无参数。

示例

srp client server port
4724
Done

CLI 和 API 参考文档

• 没有关联的 API

srp 客户端服务器

获取 SRP 客户端使用的 SRP 服务器的套接字地址（IPv6 地址和端口号）。如果客户端未运行，则地址未指定（全为零），端口号为 0。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp client server
[fd00:0:0:0:d88a:618b:384d:e760]:4724
Done

CLI 和 API 参考文档

• otSrpClientGetServerAddress

SRP 客户端服务添加

添加具有给定实例名称、服务名称和端口号的服务。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp client service add instancename servicename port [priority] [weight] [txt]

servicename 参数可以选择包含服务子类型标签的列表（以英文逗号分隔）。此处的示例使用的是通用命名方式。priority 和 weight（都是 uint16_t 值）都是可选的；如果未提供，则使用零。可选的 txt 参数用于设置与服务关联的 TXT 数据。txt 值必须采用十六进制字符串格式，并且会被视为已编码的 TXT 数据字节序列。

示例

srp client service add ins1 _test1._udp 777
Done

srp client service add ins2 _test2._udp,_sub1,_sub2 111 1 1
Done

CLI 和 API 参考文档

• otSrpClientAddService

srp 客户端服务密钥 (get,set)

获取或设置 SRP 客户端中的服务密钥记录包含模式。此命令仅用于测试目的，并要求启用 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp client service key enable
Done

srp client service key
Enabled
Done

CLI 和 API 参考文档

• otSrpClientIsServiceKeyRecordEnabled

清除 srp 客户端服务名称

清除服务，立即将其从客户端服务列表中移除，而不与 SRP 服务器交互。

参数

srp client service clear instancename servicename

示例

srp client service clear ins2 _test2._udp
Done

CLI 和 API 参考文档

• otSrpClientClearService

srp 客户端服务 - 已删除

请求向 SRP 服务器取消注册服务。

参数

srp client service remove instancename servicename

示例

srp client service remove ins2 _test2._udp
Done

CLI 和 API 参考文档

• otSrpClientRemoveService

SRP 客户端服务

获取客户端管理的服务的列表。

参数

无参数。

示例

srp client service
instance:"ins2", name:"_test2._udp,_sub1,_sub2", state:Registered, port:111, priority:1, weight:1
instance:"ins1", name:"_test1._udp", state:Registered, port:777, priority:0, weight:0
Done

CLI 和 API 参考文档

• otSrpClientGetServices

SRP 客户启动

启动 SRP 客户端操作。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp client start serveraddr serverport

示例

srp client start fd00::d88a:618b:384d:e760 4724
Done

CLI 和 API 参考文档

• otSrpClientStart

Srp 客户状态

指明 SRP 客户端是否正在运行。

参数

无参数。

示例

srp client state
Enabled
Done

CLI 和 API 参考文档

• otSrpClientIsRunning

srp 客户端停止

停止 SRP 客户端操作。

停止与 SRP 服务器之间的任何进一步交互。请注意，此操作不会移除或清除主机信息和/或服务列表。它会标记在客户端重启后再次添加/移除的所有服务。

参数

无参数。

示例

srp client stop
Done

CLI 和 API 参考文档

• otSrpClientStop

srp 客户端 ttl（获取、设置）

获取或设置 ttl（存留时间）值（以秒为单位）。

参数

srp client ttl [value]

示例

srp client ttl 3600
Done

srp client ttl
3600
Done

CLI 和 API 参考文档

• otSrpClientGetTtl
• otSrpClientSetTtl

srp 服务器（启用、停用）

启用或停用 SRP 服务器。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp server [enable|disable]

示例

srp server disable
Done

CLI 和 API 参考文档

• otSrpServerSetEnabled

srp 服务器 addrmode（获取、设置）

获取或设置 SRP 服务器使用的地址模式。

地址模式会告知 SRP 服务器如何确定其地址和端口号，这些内容随后会在 Thread 网络数据中发布。

参数

srp server addrmode [anycast|unicast]

示例

srp server addrmode anycast
Done

srp server addrmode
anycast
Done

CLI 和 API 参考文档

• otSrpServerGetAddressMode
• otSrpServerSetAddressMode

srp 服务器自动（启用、停用）

启用或停用 SRP 服务器上的自动启用模式。

启用此模式后，边界路由管理器将控制是否以及何时启用或停用 SRP 服务器。

此命令要求启用 OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

srp server auto [enable|disable]

示例

srp server auto enable
Done

srp server auto
Enabled
Done

CLI 和 API 参考文档

• otSrpServerIsAutoEnableMode
• otSrpServerSetAutoEnableMode

Srp 服务器域名 (get,set)

获取或设置 SRP 服务器的域名。

参数

srp server domain [domain-name]

示例

srp server domain thread.service.arpa.
Done

srp server domain
thread.service.arpa.
Done

CLI 和 API 参考文档

• otSrpServerGetDomain
• otSrpServerSetDomain

srp 服务器主机

返回有关所有已注册主机的信息。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp server host
srp-api-test-1.default.service.arpa.
    deleted: false
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
srp-api-test-0.default.service.arpa.
    deleted: false
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
Done

CLI 和 API 参考文档

• otSrpServerGetNextHost
• otSrpServerHostGetAddresses
• otSrpServerHostGetFullName

Srp 服务器租赁（获取、设置）

获取或设置 SRP 服务器租期值（以秒为单位）。

参数

srp server lease [min-lease max-lease min-key-lease max-key-lease]

示例

srp server lease 1800 7200 86400 1209600
Done

srp server lease
min lease: 1800
max lease: 7200
min key-lease: 86400
max key-lease: 1209600
Done

CLI 和 API 参考文档

• otSrpServerGetLeaseConfig
• otSrpServerSetLeaseConfig

srp 服务器 seqnum（获取、设置）

获取或设置用于任播地址模式的序列号。序列号包含在“网络数据”发布的“DNS/SRP 服务任播地址”条目中。

参数

srp server seqnum [seqnum]

示例

srp server seqnum 20
Done

srp server seqnum
20
Done

CLI 和 API 参考文档

• otSrpServerGetAnycastModeSequenceNumber
• otSrpServerSetAnycastModeSequenceNumber

SRP 服务器服务

返回有关已注册服务的信息。

TXT 记录显示为条目数组。如果某个条目包含键，则以 ASCII 格式输出该键。值部分以十六进制字节为单位输出。如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp server service
srp-api-test-1._ipps._tcp.default.service.arpa.
    deleted: false
    subtypes: (null)
    port: 49152
    priority: 0
    weight: 0
    ttl: 7200
    lease: 7200
    key-lease: 1209600
    TXT: [616263, xyz=585960]
    host: srp-api-test-1.default.service.arpa.
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
srp-api-test-0._ipps._tcp.default.service.arpa.
    deleted: false
    subtypes: _sub1,_sub2
    port: 49152
    priority: 0
    weight: 0
    ttl: 3600
    lease: 3600
    key-lease: 1209600
    TXT: [616263, xyz=585960]
    host: srp-api-test-0.default.service.arpa.
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
Done

CLI 和 API 参考文档

• otSrpServerServiceGetInstanceName
• otSrpServerServiceGetServiceName
• otSrpServerServiceGetSubTypeServiceNameAt

Srp 服务器状态

返回 SRP 服务器的以下某种可能状态：

• disabled：未启用 SRP 服务器。
• stopped：SRP 服务器已启用，但由于现有的 SRP 服务器在 Thread 网络中已处于活动状态，因此尚未处于活动状态。当 Thread 网络中的现有 SRP 服务器不再处于活动状态时，SRP 服务器可能会变为活动状态。
• running：SRP 服务器处于活跃状态，可以处理服务注册。

如需了解详情，请参阅利用 OT CLI 设置服务注册协议 (SRP) 服务器客户端连接。

参数

无参数。

示例

srp server state
running
Done

CLI 和 API 参考文档

• otSrpServerGetState

state

返回 Thread 设备的当前角色，或更改使用某个选项指定的角色。查询设备角色时可能返回的值：

• child：设备目前以线程子项运行。
• router：设备目前作为 Thread 路由器运行。
• leader：设备目前以线程主模式运行。
• detached：设备目前未加入 Thread 网络/分区。
• disabled：线程堆栈目前已停用。

使用其中某个选项，您可以更改设备的当前角色，而无需更改为 disabled 状态或从该状态更改为 disabled 状态。

参数

state [child|router|leader|detached]

示例

state
child
Done

state leader
Done

CLI 和 API 参考文档

• otThreadGetDeviceRole
• otThreadBecomeChild
• otThreadBecomeRouter
• otThreadBecomeLeader
• otThreadBecomeDetached

TCP 取消

无意中终止了与示例 TCP 端点关联的 TCP 连接，将 TCP 端点转换为关闭状态。

参数

无参数。

示例

tcp abort
TCP: Connection reset
Done

CLI 和 API 参考文档

• otTcpAbort

tcp 基准结果

显示 TCP 基准测试的最新结果。可能的状态值：

• 进行中
• 已完成
• 未经测试

此命令主要用于创建自动执行 TCP 基准测试的脚本。

参数

无参数。

示例

tcp benchmark result
TCP Benchmark Status: Ongoing
Done

tcp benchmark result
TCP Benchmark Status: Completed
TCP Benchmark Complete: Transferred 73728 bytes in 7056 milliseconds
TCP Goodput: 83.592 kb/s

CLI 和 API 参考文档

• 没有关联的 API

tcp 基准运行

使用当前与 tcp CLI 提供的示例 TCP 端点相关联的 TCP 连接传输指定的字节数。

注意 ：您必须先建立 TCP 连接，然后才能运行此命令。

参数

tcp benchmark run [size]

使用 size 参数指定要为基准发送的字节数。如果您不使用 size 参数，则系统会使用默认值 (OPENTHREAD_CONFIG_CLI_TCP_DEFAULT_BENCHMARK_SIZE)。

示例

tcp benchmark run
Done
TCP Benchmark Complete: Transferred 73728 bytes in 7233 milliseconds
TCP Goodput: 81.546 kb/s

CLI 和 API 参考文档

• 没有关联的 API

TCP 绑定

将 IPv6 地址和端口关联到 tcp CLI 提供的示例 TCP 端点。将 TCP 端点与 IPv6 地址和端口相关联称为“命名 TCP 端点”。这会绑定端点以进行通信。如需了解详情，请参阅使用 OT CLI 测试 TCP 功能。

参数

tcp bind ip port

• ip：要绑定到的 IPv6 地址。如果您希望 TCP/IPv6 堆栈分配绑定 IPv6 地址，请使用未指定的 IPv6 地址：::。
• port：要绑定到的 TCP 端口号。

示例

tcp bind :: 30000
Done

CLI 和 API 参考文档

• otTcpBind

TCP 连接

与指定对等方建立连接。

如果连接建立成功，所建立的 TCP 连接会与示例 TCP 端点相关联。如需了解详情，请参阅使用 OT CLI 测试 TCP 功能。

参数

tcp connect ip port [fastopen]

• ip：对等方的 IP 地址。地址可以是 IPv4 地址，使用网络数据中的首选 NAT64 前缀合成为 IPv6 地址。如果首选 NAT64 前缀不可用，该命令会返回 InvalidState。
• port：对等方的 TCP 端口号。
• fastopen：此参数为可选参数。如果设置为 fast，系统会为此连接启用 TCP Fast Open。否则，如果此参数设置为 slow 或未使用，系统会停用 TCP Fast Open。

示例

tcp connect fe80:0:0:0:a8df:580a:860:ffa4 30000
Done
TCP: Connection established

tcp connect 172.17.0.1 1234
Connecting to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done

CLI 和 API 参考文档

• otTcpConnect

TCP Deinit

取消初始化此 TCP 端点。

这意味着 OpenThread 不再跟踪此 TCP 端点，并取消分配它在内部为此 TCP 端点分配的所有资源。应用可以根据需要重复使用支持 TCP 端点的内存。

如果它对应于实时 TCP 连接，则连接会被意外终止（如 otTcpAbort()）。应用为此 TCP 端点提供的所有资源（发送缓冲区的链接缓冲区、接收缓冲区的内存、aEndpoint 结构本身等）会立即返回给应用。

参数

无参数。

示例

tcp deinit
Done

CLI 和 API 参考文档

• otTcpEndpointDeinitialize

TCP 初始化

初始化 tcp CLI 提供的示例 TCP 监听器和示例 TCP 端点。

参数

tcp init [mode] [size]

• mode 有三个可能的值：
  • tls：指定两个节点之间的 TCP 连接还应使用基于 TCP 的 TLS 协议。当两个节点通过 TCP 进行通信时，两个节点都必须使用 TLS，或者都不应使用 TLS，因为非 TLS 端点无法与 TLS 端点通信。
  • linked 或 circular：上述任一选项均表示不使用 TLS，而应为 TCP 缓冲使用指定的缓冲类型。linked 和 circular 的行为相同。检查代码，了解这两种缓冲类型之间的区别。TCP 连接的两个端点不需要使用相同的缓冲类型。
• size 参数用于设置要与示例 TCP 端点相关联的接收缓冲区大小。如果未指定，则使用最大大小。大小上限在 OPENTHREAD_CONFIG_CLI_TCP_RECEIVE_BUFFER_SIZE 中设置。

示例

tcp init tls
Done

CLI 和 API 参考文档

• otTcpListenerInitialize
• otTcpEndpointInitialize

TCP 监听

使用示例 TCP 监听器来监听指定 IPv6 地址和端口上的传入连接。如需了解详情，请参阅使用 OT CLI 测试 TCP 功能。

参数

tcp listen ip port

以下是必填参数：

• ip：tcp CLI 提供的示例 TCP 监听器的 IPv6 地址或未指定的 IPv6 地址 (::)。
• port：示例 TCP 监听器的 TCP 端口。如果没有与示例 TCP 端点相关联的 TCP 连接，则系统会接受与指定的 IPv6 地址和端口匹配的所有传入连接，并将其与示例 TCP 端点相关联。

示例

tcp listen :: 30000
Done

CLI 和 API 参考文档

• otTcpListen

TCP 发送

通过与 tcp CLI 提供的示例 TCP 端点关联的 TCP 连接发送数据。如需了解详情，请参阅使用 OT CLI 测试 TCP 功能。

参数

tcp send message

message 参数包含您要发送到远程 TCP 端点的消息。

示例

tcp send hello
Done

CLI 和 API 参考文档

• 没有关联的 API

TCP 发送端

通过与 tcp CLI 提供的示例 TCP 端点相关联的 TCP 连接发送“数据流结束”信号。这将提醒对等方不会再通过此 TCP 连接接收任何数据。

参数

无参数。

示例

tcp sendend
Done

CLI 和 API 参考文档

• otTcpSendEndOfStream

TCP 停止监听

指示示例 TCP 监听器停止监听传入的 TCP 连接。

参数

无参数。

示例

tcp stoplistening
Done

CLI 和 API 参考文档

• otTcpStopListening

消息串开始

启动 Thread 协议操作。

注意 ：运行此命令时，接口必须处于启动状态。

参数

无参数。

示例

thread start
Done

CLI 和 API 参考文档

• otThreadSetEnabled

线程停止

停止 Thread 协议操作。

参数

无参数。

示例

thread stop
Done

CLI 和 API 参考文档

• 没有关联的 API

线程版本

获取 Thread 协议版本。

参数

无参数。

示例

 thread version
2
Done

CLI 和 API 参考文档

• otThreadGetVersion

排队时间上限

获取 TX 队列中消息的最长排队时间。

需要 OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE。

排队时间仅针对直接传输进行跟踪，测量为从消息添加到传输队列到消息传递到 MAC 层进行传输或丢弃的时长。

可以通过调用 otThreadResetTimeInQueueStat() 重置收集的统计信息。

参数

无参数。

示例

timeinqueue max
281
Done

CLI 和 API 参考文档

• otThreadGetMaxTimeInQueue
• timeinqueue 重置

队列重置时间

重置 TX 队列排队时间统计信息。

需要 OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE。

参数

无参数。

示例

timeinqueue reset
Done

CLI 和 API 参考文档

• otThreadResetTimeInQueueStat

排入队列时间

获取 TX 队列中消息的排队时间直方图。

需要 OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE。

收集传输队列中消息的排队时间直方图。排队时间仅针对直接传输进行跟踪，测量为从消息添加到传输队列到消息传递到 MAC 层进行传输或丢弃的时长。

直方图以包含 aNumBins 个条目的 uint32_t 值数组形式返回。数组中的第一个条目（位于索引 0 处）表示排队时间小于 aBinInterval 的消息数量。第二个条目表示队列时间大于或等于 aBinInterval 但小于 2 * aBinInterval 的消息数量。等等。 最后一个条目表示排队时间大于或等于 (aNumBins - 1) * aBinInterval 的消息数量。

可以通过调用 otThreadResetTimeInQueueStat() 重置收集的统计信息。自初始化 OpenThread 实例或自上次通过调用 otThreadResetTimeInQueueStat() 重置统计信息收集以来，系统会收集直方图信息。

aNumBins 和 aBinInterval 指针不得为 NULL。

参数

无参数。

示例

timeinqueue
| Min  | Max  |Msg Count|
+------+------+---------+
|    0 |    9 |    1537 |
|   10 |   19 |     156 |
|   20 |   29 |      57 |
|   30 |   39 |     108 |
|   40 |   49 |      60 |
|   50 |   59 |      76 |
|   60 |   69 |      88 |
|   70 |   79 |      51 |
|   80 |   89 |      86 |
|   90 |   99 |      45 |
|  100 |  109 |      43 |
|  110 |  119 |      44 |
|  120 |  129 |      38 |
|  130 |  139 |      44 |
|  140 |  149 |      35 |
|  150 |  159 |      41 |
|  160 |  169 |      34 |
|  170 |  179 |      13 |
|  180 |  189 |      24 |
|  190 |  199 |       3 |
|  200 |  209 |       0 |
|  210 |  219 |       0 |
|  220 |  229 |       2 |
|  230 |  239 |       0 |
|  240 |  249 |       0 |
|  250 |  259 |       0 |
|  260 |  269 |       0 |
|  270 |  279 |       0 |
|  280 |  289 |       0 |
|  290 |  299 |       1 |
|  300 |  309 |       0 |
|  310 |  319 |       0 |
|  320 |  329 |       0 |
|  330 |  339 |       0 |
|  340 |  349 |       0 |
|  350 |  359 |       0 |
|  360 |  369 |       0 |
|  370 |  379 |       0 |
|  380 |  389 |       0 |
|  390 |  399 |       0 |
|  400 |  409 |       0 |
|  410 |  419 |       0 |
|  420 |  429 |       0 |
|  430 |  439 |       0 |
|  440 |  449 |       0 |
|  450 |  459 |       0 |
|  460 |  469 |       0 |
|  470 |  479 |       0 |
|  480 |  489 |       0 |
|  490 |  inf |       0 |
Done

CLI 和 API 参考文档

• otThreadGetTimeInQueueHistogram
• timeinqueue 重置

trel（启用、停用）

启用或停用 TREL 无线电操作。

参数

trel enable|disable

示例

trel enable
Done

trel disable
Done

CLI 和 API 参考文档

• otTrelSetEnabled

trel 计数器已重置

重置 TREL 计数器。

参数

无参数。

示例

trel counters reset
Done

CLI 和 API 参考文档

• otTrelResetCounters

trel 计数器

获取 TREL 计数器。

参数

无参数。

示例

trel counters
Inbound:  Packets 32 Bytes 4000
Outbound: Packets 4 Bytes 320 Failures 1
Done

CLI 和 API 参考文档

• otTrelGetCounters

trel 过滤器（启用、停用）

启用或停用 TREL 过滤器模式。

参数

trel filter enable|disable

示例

trel filter enable
Done

trel filter disable
Done

CLI 和 API 参考文档

• otTrelSetFilterEnabled

trel 过滤条件

指示是否已启用 TREL 过滤模式。

启用过滤模式后，通过 TREL 接口发送的所有 Rx 和 Tx 流量都将被静默丢弃。

注意 ：此模式主要用于测试。

参数

无参数。

示例

trel filter
Disabled
Done

CLI 和 API 参考文档

• otTrelIsFilterEnabled

Trel 类似应用

获取表或列表格式的 TREL 对等表。

参数

trel peers [list]

示例

trel peers
| No  | Ext MAC Address  | Ext PAN Id       | IPv6 Socket Address                              |
+-----+------------------+------------------+--------------------------------------------------+
|   1 | 5e5785ba3a63adb9 | f0d9c001f00d2e43 | [fe80:0:0:0:cc79:2a29:d311:1aea]:9202            |
|   2 | ce792a29d3111aea | dead00beef00cafe | [fe80:0:0:0:5c57:85ba:3a63:adb9]:9203            |
Done

trel peers list
001 ExtAddr:5e5785ba3a63adb9 ExtPanId:f0d9c001f00d2e43 SockAddr:[fe80:0:0:0:cc79:2a29:d311:1aea]:9202
002 ExtAddr:ce792a29d3111aea ExtPanId:dead00beef00cafe SockAddr:[fe80:0:0:0:5c57:85ba:3a63:adb9]:9203
Done

CLI 和 API 参考文档

• otTrelGetNextPeer

Trel

指示是否已启用 TREL 操作。

注意 ：所有 trel 子命令都需要 OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE。

参数

无参数。

示例

trel
Enabled
Done

CLI 和 API 参考文档

• otTrelIsEnabled

tvcheck（启用、停用）

在升级到路由器或主服务器时，启用或停用线程版本检查。此检查默认处于启用状态。

注意 ：OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 是必需的。

参数

无参数。

示例

tvcheck enable
Done

tvcheck disable
Done

CLI 和 API 参考文档

• otThreadSetThreadVersionCheckEnabled

txpower（get、set）

获取（或使用可选的 txpower 参数设置）发射功率（以 dBm 为单位）。

参数

txpower [txpower]

示例

txpower -10
Done

txpower
-10 dBm
Done

CLI 和 API 参考文档

• otPlatRadioGetTransmitPower
• otPlatRadioSetTransmitPower

udp 绑定

为开放套接字分配 IPv6 地址和端口，以绑定套接字以进行通信。分配 IPv6 地址和端口称为为套接字命名。如需了解详情，请参阅使用 OT CLI 测试 UDP 功能。

参数

udp bind [netif] ip port

• netif：绑定网络接口，确定如下：
  • 无值（从命令中省略此参数）：使用线程网络接口。
  • -u：未指定的网络接口，表示 UDP/IPv6 堆栈确定要将套接字绑定到哪个网络接口。
  • -b：使用骨干网接口。
• ip：要绑定到的 IPv6 地址。如果您希望 UDP/IPv6 堆栈分配绑定 IPv6 地址，则可以使用以下值来使用未指定的 IPv6 地址：::。每个示例都使用未指定的 IPv6 地址。
• port：要绑定到的 UDP 端口号。每个示例使用的都是端口号 1234。

示例

udp bind :: 1234
Done

udp bind -u :: 1234
Done

udp bind -b :: 1234
Done

CLI 和 API 参考文档

• otUdpBind

udp 关闭

关闭 UDP/IPv6 套接字。

参数

无参数。

示例

udp close
Done

CLI 和 API 参考文档

• otUdpClose

udp connect

连接 UDP/IPv6 套接字。

参数

udp connect ip port

以下是必填参数：

• ip：对等方的 IP 地址。
• port：对等方的 UDP 端口号。地址可以是 IPv4 地址，它会使用网络数据中的首选 NAT64 前缀合成为 IPv6 地址。如果首选 NAT64 前缀不可用，该命令会返回 InvalidState。

示例

udp connect fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234
Done

udp connect 172.17.0.1 1234
Connecting to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done

CLI 和 API 参考文档

• otUdpConnect

udp linksecurity（启用、停用）

启用或停用链接安全。

参数

无参数。

示例

udp linksecurity enable
Done

udp linksecurity disable
Done

CLI 和 API 参考文档

• 没有关联的 API

udp linksecurity

指明是启用还是停用链接安全。

参数

无参数。

示例

udp linksecurity
Enabled
Done

CLI 和 API 参考文档

• 没有关联的 API

udp 打开

打开 UDP/IPv6 套接字。

参数

无参数。

示例

udp open
Done

CLI 和 API 参考文档

• otUdpOpen

UDP 发送

使用套接字发送 UDP 消息。如需了解详情，请参阅使用 OT CLI 测试 UDP 功能。

参数

udp send [ip port] [type] value

ip 和 port 是可选的，但如果您指定这两者，则必须指定另一个。如果未指定 ip 和 port，则使用来自 udp connect 的套接字对等地址。

• ip：目的地地址。此地址可以是 IPv4 或 IPv6 地址，IPv4 地址会合成为具有网络数据中首选 NAT64 前缀的 IPv6 地址。（如果首选 NAT64 前缀不可用，该命令会返回 InvalidState）。
• port：UDP 目标端口。
• type/value 组合：
  • -t：value 参数中的载荷被视为文本。如果未输入 type 值，value 参数中的载荷也会被视为文本。
  • -s：自动生成的载荷，具有 value 参数中指定的长度。
  • -x：value 参数中指定的十六进制表示形式的二进制数据。

示例

udp send hello
Done

udp send -t hello
Done

udp send -x 68656c6c6f
Done

udp send -s 800
Done

udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 hello
Done

udp send 172.17.0.1 1234 hello
Sending to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done

udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -t hello
Done

udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -x 68656c6c6f
Done

udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -s 800
Done

CLI 和 API 参考文档

• udp 打开
• udp 绑定
• udp connect
• otUdpSend

不安全获取

列出允许的不安全端口列表中的所有端口。

参数

无参数。

示例

unsecure get
1234
Done

CLI 和 API 参考文档

• otIp6GetUnsecurePorts

unsecureport 添加

将端口添加到允许的不安全端口列表中。

参数

unsecureport add port

示例

unsecureport add 1234
Done

CLI 和 API 参考文档

• otIp6AddUnsecurePort

unsecureport 移除

从允许的不安全端口列表中移除指定端口或所有端口。

参数

unsecureport remove port|all

示例

unsecureport remove 1234
Done

unsecureport remove all
Done

CLI 和 API 参考文档

• otIp6AddUnsecurePort
• otIp6RemoveAllUnsecurePorts

正常运行时间（毫秒）

返回当前实例的正常运行时间（以毫秒为单位）。

需要启用 OPENTHREAD_CONFIG_UPTIME_ENABLE。

正常运行时间以自 OpenThread 实例初始化以来的毫秒数表示。

参数

无参数。

示例

uptime ms
426238
Done

CLI 和 API 参考文档

• otInstanceGetUptime

uptime

以直观易懂的字符串返回当前实例的正常运行时间。

需要启用 OPENTHREAD_CONFIG_UPTIME_ENABLE。

该字符串会采用“::.”格式，以表示小时、分钟、秒和毫秒（如果正常运行时间少于一天）或“

d.::." （如果超过一天）。

如果生成的字符串不适合 aBuffer（位于其 aSize 字符中），该字符串将被截断，但输出的字符串始终以空字符结尾。

参数

无参数。

示例

uptime
12:46:35.469
Done

CLI 和 API 参考文档

• otInstanceGetUptimeAsString

供应商 appurl（已设置）

设置供应商应用网址字符串。

需要 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE。

“aVendorAppUrl”应为 UTF8 编码格式，长度上限为 64 个字符 (MAX_VENDOR_APPL_URL_TLV_LENGTH)。长度上限不包括空的 \0 字符。

参数

vendor appurl url

示例

vendor appurl http://www.example.com
Done

CLI 和 API 参考文档

• otThreadSetVendorAppUrl

供应商应用网址

获取供应商应用网址字符串。

参数

无参数。

示例

vendor appurl
http://www.example.com
Done

CLI 和 API 参考文档

• otThreadGetVendorAppUrl

供应商型号（已设置）

设置供应商型号字符串。

需要 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE。

aVendorModel应为 UTF8 编码格式，长度上限为 32 个字符 (MAX_VENDOR_MODEL_TLV_LENGTH)。长度上限不包括空的 \0 字符。

参数

vendor model name

示例

vendor model Hub\ Max
Done

CLI 和 API 参考文档

• otThreadSetVendorModel

供应商模式

获取供应商型号字符串。

参数

无参数。

示例

vendor model
Hub Max
Done

CLI 和 API 参考文档

• otThreadGetVendorModel

供应商名称（已设置）

设置供应商名称字符串。

需要 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE。

aVendorName应为 UTF8 编码格式，长度上限为 32 个字符 (MAX_VENDOR_NAME_TLV_LENGTH)。长度上限不包括空的 \0 字符。

参数

vendor name name

示例

vendor name nest
Done

CLI 和 API 参考文档

• otThreadSetVendorName

供应商名称

获取供应商名称字符串。

参数

无参数。

示例

vendor name
nest
Done

CLI 和 API 参考文档

• otThreadGetVendorName

供应商 Swversion（设置）

设置供应商软件版本字符串。

需要 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE。

“aVendorSwVersion”应采用 UTF8 编码，且长度不得超过 16 个字符(MAX_VENDOR_SW_VERSION_TLV_LENGTH)。长度上限不包括空的 \0 字符。

参数

vendor swversion version

示例

vendor swversion Marble3.5.1
Done

CLI 和 API 参考文档

• otThreadSetVendorSwVersion

供应商 Swversion

获取供应商软件版本字符串。

参数

无参数。

示例

vendor swversion
Marble3.5.1
Done

CLI 和 API 参考文档

• otThreadGetVendorSwVersion

verhoeff 计算

计算给定十进制字符串的 Verhoeff 校验和。

需要 OPENTHREAD_CONFIG_VERHOEFF_CHECKSUM_ENABLE。

参数

verhoeff calculate decimalstring

示例

verhoeff calculate 30731842
1
Done

CLI 和 API 参考文档

• otVerhoeffChecksumCalculate

verhoeff 验证

验证给定十进制字符串的 Verhoeff 校验和。

需要 OPENTHREAD_CONFIG_VERHOEFF_CHECKSUM_ENABLE。

参数

verhoeff validate decimalstring

示例

verhoeff validate 307318421
Done

CLI 和 API 参考文档

• otVerhoeffChecksumValidate

版本 API

输出 API 版本号。

参数

无参数。

示例

version api
28
Done

CLI 和 API 参考文档

• 没有关联的 API

版本

获取 OpenThread 版本字符串。

参数

无参数。

示例

version
OPENTHREAD/gf4f2f04; Jul 1 2016 17:00:09
Done

CLI 和 API 参考文档

• otGetVersionString