Übersicht über die OpenThread-Befehlszeile

Quelle auf GitHub ansehen

Die OpenThread CLI macht Konfigurations- und Verwaltungs-APIs über eine Befehlszeile verfügbar. Verwenden Sie die OT-Befehlszeile, um eine OpenThread-Entwicklungsumgebung zu erstellen, oder verwenden Sie sie als Tool mit zusätzlichem Anwendungscode. Beispielsweise führen die Testskripts von OpenThread die Befehlszeile zum Ausführen von Testläufen aus.

Erste Schritte

Schließen Sie unser Simulations-Codelab mit Docker ab und sehen Sie sich die CLI-Befehlsreferenz an.

Zum Simulations-Codelab Zur CLI-Befehlsreferenz

OT-Befehlszeile verwenden

Sie können die OT CLI mit OpenThread Border Router (OTBR) und Thread-Geräten verwenden. CLI-Befehle variieren je nach Gerätetyp und Build-Flags.

OTBR

Geben Sie vor jedem Befehl das folgende Präfix ein, um die OT CLI mit OTBR zu verwenden:

sudo ot-ctl

Thread-Geräte

Informationen zur Verwendung von CLI-Befehlen auf einem Thread-Gerät finden Sie in der Plattformdokumentation, im Codelab oder in der Anleitung. Für viele Beispiele können Sie Befehle ohne Präfix eingeben:

state
router
Done

Hier sind einige Ressourcen, die Ihnen den Einstieg erleichtern:

• OpenThread-Plattformen
• Nordisches Hardware-Codelab
• Silicon Labs-Hardware-Codelab
• Plattformbeispiele auf GitHub

Sonderzeichen

Das Leerzeichen (' ') wird zum Trennen des Befehlsnamens und der verschiedenen Argumente zusammen mit dem Tabulatorzeichen ('\t') und neuen Zeilenzeichen ('\r', '\n') verwendet.

Einige Argumente können Leerzeichen enthalten, z. B. ein Thread-Netzwerkname. Wenn Sie Argumente mit Leerzeichen senden möchten, verwenden Sie den umgekehrten Schrägstrich ('\'), um Trennzeichen oder den umgekehrten Schrägstrich zu maskieren:

networkname Test\ Network
Done
networkname
Test Network
Done

Argumentzuordnungen

Die OT CLI verwendet vordefinierte Argumente, die den API-Konfigurationswerten entsprechen. Diese Zuordnungen können mit CLI-Befehlen übergeben oder auch für verschiedene Netzwerkdatenbefehle an die CLI-Konsole zurückgegeben werden, z. B. netdata show.

OTBorderRouter-Konfiguration

Für einige Befehle, z. B. prefix add, sind otBorderRouterConfig-Werte erforderlich. Die OT CLI parst für jedes Mitglied ein zugeordnetes Buchstabenargument, um otBorderRouterConfig-Mitglieder über die Befehlszeile festzulegen. Beispielsweise werden mit der Argumentkombination paros die Mitglieder mPreferred, mSlaac, mDefaultRoute, mOnMesh und mStable nacheinander festgelegt.

Syntax

Im folgenden Beispiel ist prefix erforderlich und otBorderRouterConfig-Argumente sind optional. Sie werden als p, a, d, c, r, o, s, n und D zugeordnet:

prefix add prefix [padcrosnD]

Nutzung

Wenn Sie Argumentzuordnungen verwenden möchten, dürfen Sie zwischen den Buchstaben keine Leerzeichen eingeben:

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

OTRoutePriorität

Verwenden Sie high, med oder low in OT CLI-Befehlen, um otRoutePreferences festzulegen.

Syntax

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

Nutzung

Hier ein Beispiel für die Verwendung der zugeordneten otBorderRouterConfig- und otRoutePreference-Parameter:

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

otExternalRouteConfig

Bei otExternalRouteConfig-Werten gilt s für mStable und n für mNat64.

Syntax

publish route prefix [sn]

Nutzung

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

Rückgabewerte

Die meisten Befehle geben den angeforderten Wert zurück, gefolgt von Done:

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

Andere Befehle, die Netzwerkdaten enthalten, können Argumentzuordnungen für Präfix-, Routen- und Diensteinträge zurückgeben. Weitere Informationen finden Sie unter Netzwerkdaten mit OT-Befehlszeile aufrufen und verwalten.