OpenThread CLI 從指令列介面公開設定和管理 API。使用 OT CLI 建立 OpenThread 開發環境,或是將其作為含有其他應用程式程式碼的工具。例如,OpenThread 測試指令碼會使用 CLI 執行測試案例。
開始使用
使用 Docker 完成模擬程式碼研究室,並檢視 CLI 指令參考資料。
使用 OT CLI
您可以將 OT CLI 與 OpenThread Border 路由器 (OTBR) 和 Thread 裝置搭配使用。CLI 指令會因裝置類型和建構標記而異。
OTBR
如要搭配 OTBR 使用 OT CLI,請在每個指令之前輸入以下前置字串:
sudo ot-ctl
執行緒裝置
如要在 Thread 裝置上使用 CLI 指令,請參閱平台的說明文件、程式碼研究室或指南。針對許多範例,您可以開始輸入不含前置字串的指令:
state
router
Done
以下資源可協助您快速上手:
- 查看 OpenThread 平台
- 北歐硬體程式碼研究室
- Silicon Labs 硬體程式碼研究室
- GitHub 上的平台範例
特殊字元
空白字元 (' '
) 可用來限制指令名稱和不同的引數,以及 Tab 字元 ('\t'
) 和新行字元 ('\r'
、'\n'
)。
部分引數可能包含空格,例如 Thread 網路名稱。如要傳送包含空格的引數,請使用反斜線字元 ('\'
) 來逸出分隔符或反斜線本身:
networkname Test\ Network
Donenetworkname
Test Network Done
引數對應
OT CLI 使用對應至 API 設定值的預先定義引數。這些對應可透過 CLI 指令傳遞,並可能會回到 CLI 主控台,查看各種網路資料指令,例如 netdata show。
otBorderRouterConfig
部分指令 (例如 prefix add
) 需要 otBorderRouterConfig 值。如要從指令列設定 otBorderRouterConfig
成員,OT CLI 會剖析每個成員對應的字母引數。例如,引數組合 paros
會連續設定 mPreferred、mSlaac、mDefaultRoute、mOnMesh 和 mStable 成員。
語法
以下範例為 prefix
,且 otBorderRouterConfig 引數為選用項目,對應為 p
、a
、d
、c
、r
、o
、s
、n
及 D
:
prefix add prefix [padcrosnD]
用量
若要使用引數對應,請勿在字母之間輸入空格:
prefix add 2001:dead:beef:cafe::/64 paros
OTRoutePreference
如要設定 otRoutePreference,請使用 OT CLI 指令中的 high
、med
或 low
。
語法
prefix add prefix [padcrosnD] [high|med|low]
用量
以下示範如何使用對應的 otBorderRouterConfig
和 otRoutePreference
參數:
prefix add 2001:dead:beef:cafe::/64 paros med
Done
otExternalRouteConfig
對於 otExternalRouteConfig 值,s
會對應至 mStable
,n
則對應至 mNat64
。
語法
publish route prefix [sn]
用量
route add 2001:dead:beef:cafe::/64 s
Done
回傳值
大部分指令會傳回要求的值,後面接著 Done
:
br onlinkprefix
fd41:2650:a6f5:0::/64
Done
包含網路資料的其他指令可能會傳回前置字串、路徑和服務記錄的引數對應。詳情請參閱「使用 OT CLI 顯示及管理網路資料」。