Interfejs wiersza poleceń OpenThread udostępnia interfejsy API konfiguracji i zarządzania z poziomu wiersza poleceń. Użyj interfejsu OT CLI, aby utworzyć środowisko programistyczne OpenThread lub użyć go jako narzędzia z dodatkowym kodem aplikacji. Na przykład skrypty testowe OpenThread używają interfejsu wiersza poleceń do wykonywania przypadków testowych.
Pierwsze kroki
Ukończ nasze ćwiczenia z symulacji za pomocą Dockera i zapoznaj się z materiałami poleceń wiersza poleceń.
Otwórz ćwiczenia z symulacji kodu Otwórz stronę z listą poleceń interfejsu wiersza poleceń
Użyj interfejsu wiersza poleceń OT
Funkcji OT CLI możesz używać z routerem OpenThread Border Router (OTBR) i urządzeniem z wątkami. Polecenia interfejsu wiersza poleceń różnią się w zależności od typu urządzenia i flag flagi kompilacji.
OTBR
Aby używać interfejsu OT CLI z OTBR, przed każdym poleceniem wpisz ten prefiks:
sudo ot-ctl
Urządzenia z wątkami
Jeśli chcesz użyć poleceń interfejsu wiersza poleceń na urządzeniu Thread, zapoznaj się z dokumentacją platformy, ćwiczeniami z programowania lub przewodnikiem. W wielu przykładach możesz zacząć wpisywać polecenia bez prefiksu:
state
router
Done
Oto kilka zasobów, które pomogą Ci zacząć:
- Przejrzyj platformy OpenThread
- Ćwiczenia z programowania dotyczące sprzętu nordyckiego
- Ćwiczenia z programowania w Silicon Labs
- Przykłady platform w GitHubie
Znaki specjalne
Odstęp (' '
) służy do oddzielenia nazwy polecenia i różnych argumentów razem z tabulatorami ('\t'
) i nowymi znakami wiersza ('\r'
, '\n'
).
Niektóre argumenty mogą zawierać spacje, na przykład nazwę sieci typu Thread. Aby wysłać argumenty ze spacjami, użyj znaku ukośnika lewego ('\'
) w celu zmiany separatora lub samego ukośnika lewego:
networkname Test\ Network
Donenetworkname
Test Network Done
Mapowanie argumentów
Interfejs OT CLI korzysta ze wstępnie zdefiniowanych argumentów, które odpowiadają wartościom konfiguracji interfejsu API. Te mapowania można przekazywać za pomocą poleceń interfejsu wiersza poleceń. Mogą one też być zwracane do konsoli interfejsu wiersza poleceń w przypadku różnych poleceń danych sieciowych, na przykład netdata show.
Konfiguracja OTBorderRouter
Niektóre polecenia, na przykład prefix add
, wymagają wartości otBorderRouterConfig. Aby ustawić otBorderRouterConfig
użytkowników w wierszu poleceń, OT CLI analizuje zmapowany argument litery każdego użytkownika. Kombinacja argumentów paros
ustawia na przykład elementy mpreferred, mSlaac, mDefaultRoute, mOnMesh i mStable.
Składnia
W tym przykładzie wymagany jest parametr prefix
, a argumenty otBorderRouterConfig są opcjonalne i zmapowane jako p
, a
, d
, c
, r
, o
, s
, n
i D
:
prefix add prefix [padcrosnD]
Wykorzystanie
Aby użyć mapowania argumentów, nie wpisuj spacji między literami:
prefix add 2001:dead:beef:cafe::/64 paros
Preferowana trasa
Aby ustawić otRoutePrefer, użyj high
, med
lub low
w poleceniach OT CLI.
Składnia
prefix add prefix [padcrosnD] [high|med|low]
Wykorzystanie
Oto przykład użycia zmapowanych parametrów otBorderRouterConfig
i otRoutePreference
:
prefix add 2001:dead:beef:cafe::/64 paros med
Done
Konfiguracja OTExternalRoute
W przypadku wartości otExternalRouteConfig s
jest mapowany na mStable
, a n
na mNat64
.
Składnia
publish route prefix [sn]
Wykorzystanie
route add 2001:dead:beef:cafe::/64 s
Done
Zwracane wartości
Większość poleceń zwraca żądaną wartość, po której następuje Done
:
br onlinkprefix
fd41:2650:a6f5:0::/64
Done
Inne polecenia zawierające dane sieciowe mogą zwracać mapowanie argumentów prefiksu, trasy i rekordów usługi. Więcej informacji znajdziesz w artykule Wyświetlanie danych sieci i zarządzanie nimi za pomocą interfejsu wiersza poleceń.