Omówienie interfejsu wiersza poleceń OpenThread

Wyświetl źródło na GitHubie

Interfejs wiersza poleceń OpenThread udostępnia interfejsy API konfiguracji i zarządzania z interfejsu wiersza poleceń. Tworzenie programowania w OpenThread w interfejsie wiersza poleceń OT lub używać go jako narzędzia z dodatkowym kodem aplikacji. Przykład: OpenThread skrypty testowe, użycie interfejsu wiersza poleceń do wykonywania przypadków testowych.

Rozpocznij

Wykonaj nasze symulacyjne ćwiczenia z programowania przy użyciu Dockera i przejrzyj materiały referencyjne interfejsu wiersza poleceń.

Przejdź do ćwiczeń z programowania. Przejdź do materiałów na temat poleceń interfejsu wiersza poleceń

Użyj interfejsu wiersza poleceń OT

Z interfejsu OT CLI możesz używać z urządzeniami OpenThread Border Router (OTBR) i Thread. CLI różnią się w zależności od typu urządzenia i flag kompilacji.

OTBR

Aby używać OT CLI z OTBR, wpisz: przed każdym poleceniem:

sudo ot-ctl

Urządzenia Thread

Aby użyć poleceń interfejsu wiersza poleceń na urządzeniu Thread, zapoznaj się z dokumentacją platformy lub ćwiczenie w Codelabs. W wielu przykładach możesz zacząć wpisywać polecenia bez prefiks:

state
router
Done

Oto kilka zasobów, które pomogą Ci zacząć:

Znaki specjalne

Znak odstępu (' ') służy do oddzielania nazwy polecenia i parametru różne argumenty, łącznie ze znakami tabulacji ('\t') i znakiem nowego wiersza ('\r', '\n').

Niektóre argumenty mogą zawierać spacje, na przykład nazwa sieci Thread. Do wyślij argumenty zawierające spacje, użyj ukośnika lewego ('\'), aby separatorów ucieczki lub ukośnika lewego:

networkname Test\ Network
Done
networkname
Test Network
Done

Mapowania argumentów

Interfejs wiersza poleceń OT 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ń, a także mogą wracać do interfejsu wiersza poleceń do różnych poleceń sieciowych do obsługi danych, netdata show.

otBorderRouterConfig

Niektóre polecenia, na przykład prefix add, wymagają otBorderRouterConfig . Aby ustawić otBorderRouterConfig użytkowników z poziomu wiersza poleceń, użyj interfejsu wiersza poleceń OT analizuje zmapowany argument litery dla każdego elementu. Na przykład argument kombinacja paros ustawia mPreferred, mSlaac, mDefaultRoute, mOnMesh, i mStable członków następujących po sobie.

Składnia

W poniższym przykładzie pole prefix jest wymagane oraz otBorderRouterConfig argumenty 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

otRoutePreference

Aby ustawić otRoutePreference, 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 otBorderRouterConfig i otRoutePreference parametry:

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

otExternalRouteConfig

Dla otExternalRouteConfig wartości s są mapowane na mStable i n są mapowane 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 ciąg Done:

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

Inne polecenia zawierające dane sieciowe mogą zwrócić mapowania argumentów dla rekordów prefiksów, tras i usług. Więcej informacji: Wyświetlanie danych sieci i zarządzanie nimi za pomocą OT CLI.